The TiddlyWiki5 repository contains several scripts that are used to build and deploy TiddlyWiki (.sh for *nix and .cmd for Windows). They can serve as a useful starting point for your own scripts.
All the scripts expect to be run from the root folder of the repository.
bld: builds tw5.comThis script builds several variants of TiddlyWiki5 for deployment on tiddlywiki.com.
By default, files are output to a folder called jermolene.github.com, sibling to the TiddlyWiki5 repo directory. For example:
/TiddlyWork/ - Directory for working with TiddlyWiki5
+ |
+ +--+-- /TiddlyWiki5/ - Directory containing the TiddlyWiki5 repo from GitHub
+ |
+ +-- /jermolene.github.com/ - Directory for output filesYou can override the build output directory by defining the environment variable TW5_BUILD_OUTPUT. The easiest way to do this is to create a personal batch file to invoke TiddlyWiki5 that first sets the environment variable and then invokes bld.
The files output by bld are:
readme.md main readme file, output to the TiddlyWiki5 directoryindex.html TiddlyWiki5 standalone HTML file with content from the tw5.com editionempty.html TiddlyWiki5 standalone HTML file with no contentencrypted.html TiddlyWiki5 standalone HTML file encrypted with the password passwordtest.html TiddlyWiki5 browser-based test suite (see TestingMechanism)static.html static HTML version of the DefaultTiddlers of the tw5.com editionstatic/*.html and static/static.css static HTML versions of individual tiddlersbld also runs the TiddlyWiki5 Node.js-based test suite (see TestingMechanism)
serve: serves tw5.comserve.sh <username> [<password>]Or:
serve.cmd <username> [<password>]This script starts TiddlyWiki5 running as an HTTP server with the content from the tw5.com-server edition. By default, the Node.js serves on port 8080. If the optional username parameter is provided, it is used for signing edits. If the password is provided then HTTP basic authentication is used.
To experiment with this configuration, run the script and then visit http://127.0.0.1:8080 in a browser.
Changes made in the browser propagate to the server over HTTP (use the browser developer console to see these requests). The server then syncs changes to the file system (and logs each change to the screen).
test: build and run testsThis script runs the test edition of TiddlyWiki on the server to perform the server-side tests and to build test.html for running the tests in the browser.
lazy: serves tw5.com with lazily loaded imageslazy.sh <username> [<password>]Or:
lazy.cmd <username> [<password>]This script serves the tw5.com-server edition content with LazyLoading applied to images.
wbld: builds TiddlyWiki for TiddlyWebThis script builds and deploys the code for TiddlyWiki in the Sky for TiddlyWeb. If you want to experiment with your own builds of TiddlyWiki5 for TiddlyWeb you could use this batch file as a base.
2bld: builds TiddlyWiki 2.6.5This script builds TiddlyWiki 2.6.5 from the original source and then displays the differences between them (diff is used for *nix, fc for Windows).
deploy & verbump: deploy TiddlyWiki and bump the TiddlyWiki version numberThese scripts are concerned with releasing a new version of TiddlyWiki. See Releasing a new version of TiddlyWiki5. +
\ No newline at end of file diff --git a/serve.cmd b/bin/serve.cmd similarity index 100% rename from serve.cmd rename to bin/serve.cmd diff --git a/serve.sh b/bin/serve.sh similarity index 100% rename from serve.sh rename to bin/serve.sh diff --git a/tankbld.cmd b/bin/tankbld.cmd similarity index 100% rename from tankbld.cmd rename to bin/tankbld.cmd diff --git a/tankbld.sh b/bin/tankbld.sh similarity index 100% rename from tankbld.sh rename to bin/tankbld.sh diff --git a/test.cmd b/bin/test.cmd similarity index 100% rename from test.cmd rename to bin/test.cmd diff --git a/test.sh b/bin/test.sh similarity index 100% rename from test.sh rename to bin/test.sh diff --git a/verbump.cmd b/bin/verbump.cmd similarity index 100% rename from verbump.cmd rename to bin/verbump.cmd diff --git a/verbump.sh b/bin/verbump.sh similarity index 100% rename from verbump.sh rename to bin/verbump.sh diff --git a/wbld.cmd b/bin/wbld.cmd similarity index 100% rename from wbld.cmd rename to bin/wbld.cmd diff --git a/wbld.sh b/bin/wbld.sh similarity index 100% rename from wbld.sh rename to bin/wbld.sh diff --git a/editions/tw5.com/tiddlers/Developing plugins using Node.js and GitHub.tid b/editions/tw5.com/tiddlers/Developing plugins using Node.js and GitHub.tid index 6de630501..97fbeb635 100644 --- a/editions/tw5.com/tiddlers/Developing plugins using Node.js and GitHub.tid +++ b/editions/tw5.com/tiddlers/Developing plugins using Node.js and GitHub.tid @@ -1,5 +1,5 @@ created: 20140320055936611 -modified: 20140320075440176 +modified: 20140908152942119 tags: howto title: Developing plugins using Node.js and GitHub type: text/vnd.tiddlywiki @@ -79,7 +79,7 @@ Create the file plugin.info with content: ``` -!!4. Create your plugin's files +!!4. Create the files for you plugin For example files see the plugins in the tiddlywiki5 repository i.e. those located at plugins/tiddlywiki/ - Note in particular that files need to contain information that is used to tell tiddlywiki the name of the tiddler that is to be used in the tiddlywiki in place of the name of the file within the file system. @@ -90,7 +90,7 @@ Modify editions/tw5.com/tiddlywiki.info to include a reference to your plugin di From the TW5 directory issue command ``` -./qbld.sh +./bin/qbld.sh ``` the resultant file (index.html) will be placed in the build directory, the default build directory is `../jermolene.github.com` relative to TW5/ diff --git a/editions/tw5.com/tiddlers/dev/Procedure for releasing a new version of TiddlyWiki5.tid b/editions/tw5.com/tiddlers/dev/Procedure for releasing a new version of TiddlyWiki5.tid index 560c0b4ee..066fbbe3c 100644 --- a/editions/tw5.com/tiddlers/dev/Procedure for releasing a new version of TiddlyWiki5.tid +++ b/editions/tw5.com/tiddlers/dev/Procedure for releasing a new version of TiddlyWiki5.tid @@ -1,5 +1,5 @@ created: 20131130132123707 -modified: 20140619212123707 +modified: 20140908153054348 tags: dev title: Releasing a new version of TiddlyWiki5 type: text/vnd.tiddlywiki @@ -9,8 +9,8 @@ type: text/vnd.tiddlywiki # Adjust the modified time of HelloThere # Make sure ''Jermolene/TiddlyWiki5'' is fully committed # Edit `package.json` to the new version number -# Run `bld.sh` to build the deployment files +# Run `bin/bld.sh` to build the deployment files # Restore `package.json` to the previous version number -# Run `verbump "5.0.8-beta"`, substituting the new version number -# Run `deploy.sh` -# Run `wbld.shTiddlyWiki is a web application you can download for free, store wherever you like, customize however you wish, and use to take / organize / share your notes in ways that word processors and other note-taking tools cannot. TiddlyWiki is designed in a "non-linear" way, using tags, hyperlinks, and many other features, so that you can organize and retrieve your notes in ways that conform to your personal thought patterns, rather than feel chained to one pre-set organizational structure.
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 Node.js application that treats each of your notes as a separate file and accesses them through a central hub.
How can you make TiddlyWiki work for you? We recommend you start with our introductory documentation, listed below, then browse the TableOfContents, always available in the Contents tab in the sidebar. Or just download an empty TiddlyWiki now and try it out for yourself!
Running TiddlyWiki on Node.js brings several important benefits over and above the single file version:
npm install -g tiddlywikiIf it fails with an error you may need to re-run the command as an administrator:
npm install -g tiddlywiki(Windows)
sudo npm install -g tiddlywiki(Mac/Linux)
tiddlywiki --version
5.0.8-beta; you may also see other debugging information reported)tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related componentstiddlywiki mynewwiki --server to start TiddlyWikiThe -g flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.
A slightly different method for installation is recommended if you plan on forking the source code in order to study it or contribute to it. See Working with the TiddlyWiki5 repository. +
Welcome to TiddlyWiki, a versatile note-taking web application you can download for free, store wherever you like, customize however you wish, and use to take / organize / share your notes in ways that word processors and other note-taking tools cannot. TiddlyWiki is designed in a "non-linear" way, using tags, hyperlinks, and many other features, so that you can organize and retrieve your notes in ways that conform to your personal thought patterns, rather than feel chained to one pre-set organizational structure.
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 Node.js application that treats each of your notes as a separate file and accesses them through a central hub.
How can you make TiddlyWiki work for you? We recommend you start with our introductory documentation, listed below, then browse the TableOfContents, always available in the Contents tab in the sidebar. Or just download an empty TiddlyWiki now and try it out for yourself!
Running TiddlyWiki on Node.js brings several important benefits over and above the single file version:
npm install -g tiddlywikiIf it fails with an error you may need to re-run the command as an administrator:
npm install -g tiddlywiki(Windows)
sudo npm install -g tiddlywiki(Mac/Linux)
tiddlywiki --version
5.0.8-beta; you may also see other debugging information reported)tiddlywiki mynewwiki --init server to create a folder for a new wiki that includes server-related componentstiddlywiki mynewwiki --server to start TiddlyWikiThe -g flag causes TiddlyWiki to be installed globally. Without it, TiddlyWiki will only be available in the directory where you installed it.
A slightly different method for installation is recommended if you plan on forking the source code in order to study it or contribute to it. See Working with the TiddlyWiki5 repository.
TiddlyWiki5 can be used on the command line to perform an extensive set of operations based on TiddlyWikiFolders, TiddlerFiles and TiddlyWikiFiles.
For example, the following command loads the tiddlers from a TiddlyWiki HTML file and then saves one of them in static HTML:
tiddlywiki --verbose --load mywiki.html --rendertiddler ReadMe ./readme.htmlRunning tiddlywiki from the command line boots the TiddlyWiki 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.
The first argument is the optional path to the TiddlyWikiFolder to be loaded. If not present, then the current directory is used.
The commands and their individual arguments follow, each command being identified by the prefix --.
tiddlywiki [<wikipath>] [--<command> [<arg>[,<arg>]]]The available commands are:
See also:
If you've installed TiddlyWiki on Node.js on the usual way, when a new version is released you can upgrade it with this command:
npm update -g tiddlywikiOn Mac or Linux you'll need to add sudo like this:
sudo npm update -g tiddlywikiMario Pietsch has created a short video tutorial on working with the TiddlyWiki5 GitHub repository.
If you plan on working with the TiddlyWiki5 source code then follow these steps:
npm link (Windows) or sudo npm link (Mac/Linux) to tell npm to use this copy of the repo as the globally installed oneAfter this procedure you can work with TiddlyWiki5 via npm as though it were installed in the usual way with npm install -g tiddlywiki.
See also Scripts for TiddlyWiki on Node.js.
This readme file was automatically generated by TiddlyWiki
\ No newline at end of file