Readme updates for Node.js

2024-11-27 03:57:21 +00:00 · 2014-09-20 15:06:33 +01:00 · 2014-09-20 15:06:33 +01:00 · 15e9e21d2a
commit 15e9e21d2a
parent ebb911f934
5 changed files with 207 additions and 22 deletions
--- a/editions/tw5.com/tiddlers/Working
+++ b/editions/tw5.com/tiddlers/Working
@ -0,0 +1,9 @@
+created: 20140920133836765
+modified: 20140920134005568
+tags: [[Working with the TiddlyWiki5 repository]]
+title: Working with the TiddlyWiki5 repository video
+type: text/vnd.tiddlywiki
+
+Mario Pietsch has created a short video tutorial on [[working with the TiddlyWiki5 GitHub repository|Working with the TiddlyWiki5 repository]].
+
+<iframe width="560" height="315" src="http://www.youtube.com/embed/6ElUruH92tc" frameborder="0" allowfullscreen></iframe>
--- a/editions/tw5.com/tiddlers/nodejs/Using
+++ b/editions/tw5.com/tiddlers/nodejs/Using
@ -1,5 +1,5 @@
 created: 20131219100520659
-modified: 20140912141913837
+modified: 20140920135025757
 tags: [[TiddlyWiki on Node.js]]
 title: Using TiddlyWiki on Node.js
 type: text/vnd.tiddlywiki
@ -24,8 +24,4 @@ tiddlywiki [<wikipath>] [--<command> [<arg>[,<arg>]]]

 The available commands are:

-<ul><$list filter="[tag[command]]"><li><$link to={{!!title}}><$view field="title"/></$link></li></$list></ul>
-
-See also:
-
-* [[Environment Variables on Node.js]]
+<<list-links "[tag[Commands]]">>
--- a/editions/tw5.com/tiddlers/nodejs/Working
+++ b/editions/tw5.com/tiddlers/nodejs/Working
@ -1,19 +1,18 @@
 created: 20131219100444289
-modified: 20140104120500001
-tags: dev howto
+modified: 20140920134404247
+tags: [[TiddlyWiki on Node.js]]
 title: Working with the TiddlyWiki5 repository
 type: text/vnd.tiddlywiki

 ! Introduction

-Mario Pietsch has created a short video tutorial on working with the TiddlyWiki5 ~GitHub repository.
+If you want to [[contribute|Contributing]] to TiddlyWiki's development, rather than [[installing TiddlyWiki in the usual way|Installing TiddlyWiki on Node.js]], you can work directly with the GitHub repository. 

-<iframe width="560" height="315" src="http://www.youtube.com/embed/6ElUruH92tc" frameborder="0" allowfullscreen></iframe>
+Mario Pietsch has created a [[short video introduction|Working with the TiddlyWiki5 repository video]].

 ! Setting Up

-If you plan on working with the TiddlyWiki5 source code then follow these steps:
-
+# Create an account on GitHub if you don't already have one
 # Fork the TiddlyWiki5 GitHub repository from https://github.com/Jermolene/TiddlyWiki5
 # Clone a local copy of your fork
 # Open a command line terminal and change the current working directory to the root of the repo
--- a/editions/tw5.com/tiddlers/readme/ReadMe.tid
+++ b/editions/tw5.com/tiddlers/readme/ReadMe.tid
@ -1,19 +1,34 @@
 created: 20131129094758194
-modified: 20131222161808390
+modified: 20140920135213536
 title: ReadMe
 type: text/vnd.tiddlywiki

 \define tv-wikilink-template() http://tiddlywiki.com/static/$uri_doubleencoded$.html
-! Welcome to TiddlyWiki

-{{HelloThere}}
+<$importvariables filter="[[$:/core/ui/PageMacros]] [all[shadows+tiddlers]tag[$:/tags/Macro]!has[draft.of]]">

-! Getting started with TiddlyWiki under Node.js
+Welcome to TiddlyWiki, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.

-{{TiddlyWiki on Node.js}}
+TiddlyWiki is a complete interactive wiki in JavaScript. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable WikiText.

-! Working with the TiddlyWiki5 repository
+Learn more and see it in action at http://tiddlywiki.com

-{{Working with the TiddlyWiki5 repository}}
+! Installing TiddlyWiki on Node.js
+
+{{Installing TiddlyWiki on Node.js}}
+
+! Using TiddlyWiki on Node.js
+
+{{Using TiddlyWiki on Node.js}}
+
+! Upgrading TiddlyWiki on Node.js
+
+{{Upgrading TiddlyWiki on Node.js}}
+
+! Also see
+
+<<list-links "[tag[TiddlyWiki on Node.js]] -[[Installing TiddlyWiki on Node.js]] -[[Using TiddlyWiki on Node.js]] -[[Upgrading TiddlyWiki on Node.js]]">>

 //This readme file was automatically generated by TiddlyWiki//
+
+</$importvariables>
--- a/readme.md
+++ b/readme.md
@ -1,2 +1,168 @@
-<h1 class=''>Welcome to <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a></h1><p>Welcome to TiddlyWiki, a versatile note-taking web application you can download for free, store wherever you like, customise however you wish, and use to take / organise / share your notes in ways that word processors and other note-taking tools cannot. TiddlyWiki is designed to be non-linear, structuring content with stories, tags, hyperlinks, and other features, so that you can organise and retrieve your notes in ways that conform to your personal thought patterns, rather than feel chained to one preset organisational structure.</p><p>You can use TiddlyWiki as a single file that you view and edit through any web browser, whether you are online or offline. Or you can use it as a powerful <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki%2520on%2520Node.js.html'>Node.js application</a> that stores each of your notes as a separate file.</p><blockquote><p><em>Note that <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> is currently in beta, with the full release scheduled for Saturday, September 20th 2014</em></p></blockquote><p>How can you make TiddlyWiki work for you? We recommend you start with our introductory documentation listed below, and then browse the <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TableOfContents.html'>TableOfContents</a>, always available in the Contents tab in the sidebar. Or just <a class='tc-tiddlylink tc-tiddlylink-shadow tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/GettingStarted.html'>follow our simple instructions</a> and try it out for yourself!</p><ul><li><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Discover%2520TiddlyWiki.html'>Discover TiddlyWiki</a></li><li><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Some%2520of%2520the%2520things%2520you%2520can%2520do%2520with%2520TiddlyWiki.html'>Some of the things you can do with TiddlyWiki</a></li><li><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Ten%2520reasons%2520to%2520switch%2520to%2520TiddlyWiki.html'>Ten reasons to switch to TiddlyWiki</a></li><li><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Examples.html'>Examples of TiddlyWiki being used in the wild</a></li><li><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/History%2520of%2520TiddlyWiki.html'>History of TiddlyWiki</a> </li><li><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/What%2520happened%2520to%2520the%2520original%2520TiddlyWiki%253F.html'>What happened to the original TiddlyWiki?</a></li><li><a class='tc-tiddlylink-external' href='./dev/index.html' target='_blank'>Developer Documentation</a></li></ul><h1 class=''>Getting started with <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> under Node.js</h1><p>Running <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> on <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Node.js.html'>Node.js</a> brings several important benefits over and above the single file version:</p><ul><li>You can edit your content on any suitably compatible HTML5 browser, including smartphones and tablets</li><li>Individual tiddlers are stored in separate files, which you can organise as you wish</li><li>The ability to build multiple wikis that blend different combinations of shared and unique content</li></ul><p>For more information see:</p><ul><li><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Installing%2520TiddlyWiki%2520on%2520Node.js.html'>Installing TiddlyWiki on Node.js</a></li><li><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Using%2520TiddlyWiki%2520on%2520Node.js.html'>Using TiddlyWiki on Node.js</a></li><li><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Upgrading%2520TiddlyWiki%2520on%2520Node.js.html'>Upgrading TiddlyWiki on Node.js</a></li></ul><h1 class=''>Working with the <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> repository</h1><p><em>This readme file was automatically generated by <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a></em>
-</p>
+<p>Welcome to <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a>, a non-linear personal web notebook that anyone can use and keep forever, independently of any corporation.</p><p><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> is a complete interactive wiki in <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/JavaScript.html'>JavaScript</a>. It can be used as a single HTML file in the browser or as a powerful Node.js application. It is highly customisable: the entire user interface is itself implemented in hackable <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/WikiText.html'>WikiText</a>.</p><p>Learn more and see it in action at <a class='tc-tiddlylink-external' href='http://tiddlywiki.com' target='_blank'>http://tiddlywiki.com</a></p><h1 class=''>Installing <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> on Node.js</h1><ol><li>Install <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Node.js.html'>Node.js</a> from <a class='tc-tiddlylink-external' href='http://nodejs.org' target='_blank'>http://nodejs.org</a></li><li>Open a command line terminal and type:<blockquote><p><code>npm install -g tiddlywiki</code></p><p>If it fails with an error you may need to re-run the command as an administrator:</p><p><code>npm install -g tiddlywiki</code> (Windows)</p><p><code>sudo npm install -g tiddlywiki</code> (Mac/Linux)</p></blockquote></li><li>Check <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> is installed by typing:<blockquote><p><code>tiddlywiki --version</code></p></blockquote></li><li>In response, you should see <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> report its current version (eg <code>5.0.8-beta</code>; you may also see other debugging information reported)</li><li>Try it out:<ol><li><code>tiddlywiki mynewwiki --init server</code> to create a folder for a new wiki that includes server-related components</li><li><code>tiddlywiki mynewwiki --server</code> to start <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a></li><li>Visit <a class='tc-tiddlylink-external' href='http://127.0.0.1:8080/' target='_blank'>http://127.0.0.1:8080/</a> in your browser</li><li>Try editing and creating tiddlers</li></ol></li></ol><p>The <code>-g</code> flag causes <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> to be installed globally. Without it, <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> will only be available in the directory where you installed it.
+</p><h1 class=''>Using <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> on Node.js</h1><p><a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki5.html'>TiddlyWiki5</a> can be used on the command line to perform an extensive set of operations based on <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWikiFolders.html'>TiddlyWikiFolders</a>, <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlerFiles.html'>TiddlerFiles</a> and <a class='tc-tiddlylink tc-tiddlylink-missing' href='http://tiddlywiki.com/static/TiddlyWikiFiles.html'>TiddlyWikiFiles</a>.</p><p>For example, the following command loads the tiddlers from a <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> HTML file and then saves one of them in static HTML:</p><pre><code>tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.html</code></pre><p>Running <code>tiddlywiki</code> from the command line boots the <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> kernel, loads the core plugins and establishes an empty wiki store. It then sequentially processes the command line arguments from left to right. The arguments are separated with spaces.</p><p>The first argument is the optional path to the <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWikiFolders.html'>TiddlyWikiFolder</a> to be loaded. If not present, then the current directory is used.</p><p>The commands and their individual arguments follow, each command being identified by the prefix <code>--</code>.</p><pre><code>tiddlywiki [&lt;wikipath&gt;] [--&lt;command&gt; [&lt;arg&gt;[,&lt;arg&gt;]]]</code></pre><p>The available commands are:</p><p><ul>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/BuildCommand.html'>
+BuildCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/ClearPasswordCommand.html'>
+ClearPasswordCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/HelpCommand.html'>
+HelpCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/InitCommand.html'>
+InitCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/LoadCommand.html'>
+LoadCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/MakeLibraryCommand.html'>
+MakeLibraryCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/OutputCommand.html'>
+OutputCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/PasswordCommand.html'>
+PasswordCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/RenderTiddlerCommand.html'>
+RenderTiddlerCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/RenderTiddlersCommand.html'>
+RenderTiddlersCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/SaveTiddlerCommand.html'>
+SaveTiddlerCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/SaveTiddlersCommand.html'>
+SaveTiddlersCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/ServerCommand.html'>
+ServerCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/SetFieldCommand.html'>
+SetFieldCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/VerboseCommand.html'>
+VerboseCommand
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/VersionCommand.html'>
+VersionCommand
+</a>
+</li>
+
+</ul></p><h1 class=''>Upgrading <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a> on Node.js</h1><p>If you've installed <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki%2520on%2520Node.js.html'>TiddlyWiki on Node.js</a> on the usual way, when a new version is released you can upgrade it with this command:</p><pre><code>npm update -g tiddlywiki</code></pre><p>On Mac or Linux you'll need to add <strong>sudo</strong> like this:</p><pre><code>sudo npm update -g tiddlywiki</code></pre><h1 class=''>Also see</h1><p><ul>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWikiFolders.html'>
+TiddlyWikiFolders
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/MultiTiddlerFiles.html'>
+MultiTiddlerFiles
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlerFiles.html'>
+TiddlerFiles
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Generating%2520Static%2520Sites%2520with%2520TiddlyWiki.html'>
+Generating Static Sites with TiddlyWiki
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/How%2520to%2520build%2520a%2520TiddlyWiki5%2520from%2520individual%2520tiddlers.html'>
+How to build a TiddlyWiki5 from individual tiddlers
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Using%2520TiddlyWiki%2520for%2520GitHub%2520Pages%2520project%2520documentation.html'>
+Using TiddlyWiki for GitHub Pages project documentation
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Using%2520a%2520custom%2520path%2520prefix%2520with%2520the%2520client-server%2520edition.html'>
+Using a custom path prefix with the client-server edition
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Building%2520TiddlyWikiClassic.html'>
+Building TiddlyWikiClassic
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Environment%2520Variables%2520on%2520Node.js.html'>
+Environment Variables on Node.js
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Scripts%2520for%2520TiddlyWiki%2520on%2520Node.js.html'>
+Scripts for TiddlyWiki on Node.js
+</a>
+</li>
+
+<li>
+<a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/Working%2520with%2520the%2520TiddlyWiki5%2520repository.html'>
+Working with the TiddlyWiki5 repository
+</a>
+</li>
+
+</ul></p><p><em>This readme file was automatically generated by <a class='tc-tiddlylink tc-tiddlylink-resolves' href='http://tiddlywiki.com/static/TiddlyWiki.html'>TiddlyWiki</a></em></p>