From 6e9cd5943703f7137e819fcb85376423b9c930d5 Mon Sep 17 00:00:00 2001
From: Jermolene
Date: Mon, 8 Sep 2014 16:32:32 +0100
Subject: [PATCH] Move scripts into bin directory
Fixes #807
---
2bld.cmd => bin/2bld.cmd | 0
2bld.sh => bin/2bld.sh | 0
bld-languages.sh => bin/bld-languages.sh | 0
bld.cmd => bin/bld.cmd | 2 +-
bld.sh => bin/bld.sh | 2 +-
deploy.cmd => bin/deploy.cmd | 0
deploy.sh => bin/deploy.sh | 0
ginsu.cmd => bin/ginsu.cmd | 0
ginsu.sh => bin/ginsu.sh | 0
lazy.cmd => bin/lazy.cmd | 0
lazy.sh => bin/lazy.sh | 0
qbld.cmd => bin/qbld.cmd | 0
qbld.sh => bin/qbld.sh | 0
bin/readme.md | 6 ++++
serve.cmd => bin/serve.cmd | 0
serve.sh => bin/serve.sh | 0
tankbld.cmd => bin/tankbld.cmd | 0
tankbld.sh => bin/tankbld.sh | 0
test.cmd => bin/test.cmd | 0
test.sh => bin/test.sh | 0
verbump.cmd => bin/verbump.cmd | 0
verbump.sh => bin/verbump.sh | 0
wbld.cmd => bin/wbld.cmd | 0
wbld.sh => bin/wbld.sh | 0
...oping plugins using Node.js and GitHub.tid | 6 ++--
...releasing a new version of TiddlyWiki5.tid | 10 +++----
.../dev/Scripts for TiddlyWiki on Node.js.tid | 28 +++++++++++++------
...enerating Static Sites with TiddlyWiki.tid | 6 ++--
...to create a translation for TiddlyWiki.tid | 4 +--
...for GitHub Pages project documentation.tid | 7 +++--
.../tiddlers/readme/ReadMeBinFolder.tid | 7 +++++
editions/tw5.com/tiddlywiki.info | 1 +
readme.md | 2 +-
33 files changed, 53 insertions(+), 28 deletions(-)
rename 2bld.cmd => bin/2bld.cmd (100%)
rename 2bld.sh => bin/2bld.sh (100%)
rename bld-languages.sh => bin/bld-languages.sh (100%)
rename bld.cmd => bin/bld.cmd (99%)
rename bld.sh => bin/bld.sh (99%)
rename deploy.cmd => bin/deploy.cmd (100%)
rename deploy.sh => bin/deploy.sh (100%)
rename ginsu.cmd => bin/ginsu.cmd (100%)
rename ginsu.sh => bin/ginsu.sh (100%)
rename lazy.cmd => bin/lazy.cmd (100%)
rename lazy.sh => bin/lazy.sh (100%)
rename qbld.cmd => bin/qbld.cmd (100%)
rename qbld.sh => bin/qbld.sh (100%)
create mode 100644 bin/readme.md
rename serve.cmd => bin/serve.cmd (100%)
rename serve.sh => bin/serve.sh (100%)
rename tankbld.cmd => bin/tankbld.cmd (100%)
rename tankbld.sh => bin/tankbld.sh (100%)
rename test.cmd => bin/test.cmd (100%)
rename test.sh => bin/test.sh (100%)
rename verbump.cmd => bin/verbump.cmd (100%)
rename verbump.sh => bin/verbump.sh (100%)
rename wbld.cmd => bin/wbld.cmd (100%)
rename wbld.sh => bin/wbld.sh (100%)
create mode 100644 editions/tw5.com/tiddlers/readme/ReadMeBinFolder.tid
diff --git a/2bld.cmd b/bin/2bld.cmd
similarity index 100%
rename from 2bld.cmd
rename to bin/2bld.cmd
diff --git a/2bld.sh b/bin/2bld.sh
similarity index 100%
rename from 2bld.sh
rename to bin/2bld.sh
diff --git a/bld-languages.sh b/bin/bld-languages.sh
similarity index 100%
rename from bld-languages.sh
rename to bin/bld-languages.sh
diff --git a/bld.cmd b/bin/bld.cmd
similarity index 99%
rename from bld.cmd
rename to bin/bld.cmd
index 0b988676a..3320b01d3 100644
--- a/bld.cmd
+++ b/bin/bld.cmd
@@ -118,4 +118,4 @@ echo tiddlywiki.com > %TW5_BUILD_OUTPUT%\CNAME
rem Run the test edition to run the Node.js tests and to generate test.html for tests in the browser
-.\test.cmd
+.\bin\test.cmd
diff --git a/bld.sh b/bin/bld.sh
similarity index 99%
rename from bld.sh
rename to bin/bld.sh
index 50ad509b9..ee3b263f2 100755
--- a/bld.sh
+++ b/bin/bld.sh
@@ -115,4 +115,4 @@ node ./tiddlywiki.js \
# Run the test edition to run the Node.js tests and to generate test.html for tests in the browser
-./test.sh
+./bin/test.sh
diff --git a/deploy.cmd b/bin/deploy.cmd
similarity index 100%
rename from deploy.cmd
rename to bin/deploy.cmd
diff --git a/deploy.sh b/bin/deploy.sh
similarity index 100%
rename from deploy.sh
rename to bin/deploy.sh
diff --git a/ginsu.cmd b/bin/ginsu.cmd
similarity index 100%
rename from ginsu.cmd
rename to bin/ginsu.cmd
diff --git a/ginsu.sh b/bin/ginsu.sh
similarity index 100%
rename from ginsu.sh
rename to bin/ginsu.sh
diff --git a/lazy.cmd b/bin/lazy.cmd
similarity index 100%
rename from lazy.cmd
rename to bin/lazy.cmd
diff --git a/lazy.sh b/bin/lazy.sh
similarity index 100%
rename from lazy.sh
rename to bin/lazy.sh
diff --git a/qbld.cmd b/bin/qbld.cmd
similarity index 100%
rename from qbld.cmd
rename to bin/qbld.cmd
diff --git a/qbld.sh b/bin/qbld.sh
similarity index 100%
rename from qbld.sh
rename to bin/qbld.sh
diff --git a/bin/readme.md b/bin/readme.md
new file mode 100644
index 000000000..4630b94a1
--- /dev/null
+++ b/bin/readme.md
@@ -0,0 +1,6 @@
+
Script Files
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.com
This 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 files
You 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 directory
index.htmlTiddlyWiki5 standalone HTML file with content from the tw5.com edition
empty.htmlTiddlyWiki5 standalone HTML file with no content
encrypted.htmlTiddlyWiki5 standalone HTML file encrypted with the password 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 tests
This 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 images
lazy.sh <username> [<password>]
Or:
lazy.cmd <username> [<password>]
This script serves the tw5.com-server edition content with LazyLoading applied to images.
\ 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.sh `
+# Run `bin/verbump "5.0.8-beta"`, substituting the new version number
+# Run `bin/deploy.sh`
+# Run `bin/wbld.sh `
diff --git a/editions/tw5.com/tiddlers/dev/Scripts for TiddlyWiki on Node.js.tid b/editions/tw5.com/tiddlers/dev/Scripts for TiddlyWiki on Node.js.tid
index 9ec4fe41f..96f3961fb 100644
--- a/editions/tw5.com/tiddlers/dev/Scripts for TiddlyWiki on Node.js.tid
+++ b/editions/tw5.com/tiddlers/dev/Scripts for TiddlyWiki on Node.js.tid
@@ -1,12 +1,14 @@
created: 20131219100637788
-modified: 20140206221215805
+modified: 20140908153149748
tags: howto dev
title: Scripts for TiddlyWiki on Node.js
type: text/vnd.tiddlywiki
! Script Files
-The TiddlyWiki5 repo contains several scripts that are used to build and deploy TiddlyWiki5 (.sh for *nix and .cmd for Windows). They can serve as a useful starting point for your own scripts.
+The TiddlyWiki5 repository contains several scripts in the `bin` folder 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.com
@@ -39,34 +41,38 @@ The files output by `bld` are:
!! `serve`: serves tw5.com
```
-serve.sh []
+./bin/serve.sh []
```
Or:
```
-serve.cmd []
+./bin/serve.cmd []
```
-This script starts TiddlyWiki5 running as an HTTP server with the content from the `clientserver` 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.
+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 tests
+
+This 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 images
```
-lazy.sh []
+./bin/lazy.sh []
```
Or:
```
-lazy.cmd []
+./bin/lazy.cmd []
```
-This script serves the `clientserver` edition content with LazyLoading applied to images.
+This script serves the `tw5.com-server` edition content with LazyLoading applied to images.
!! `wbld`: builds TiddlyWiki for TiddlyWeb
@@ -74,4 +80,8 @@ This script builds and deploys the code for [[TiddlyWiki in the Sky for TiddlyWe
!! `2bld`: builds TiddlyWiki 2.6.5
-This 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).
\ No newline at end of file
+This 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 number
+
+These scripts are concerned with releasing a new version of TiddlyWiki. See [[Releasing a new version of TiddlyWiki5]].
diff --git a/editions/tw5.com/tiddlers/howtos/Generating Static Sites with TiddlyWiki.tid b/editions/tw5.com/tiddlers/howtos/Generating Static Sites with TiddlyWiki.tid
index c9d9e805e..11037b5f2 100644
--- a/editions/tw5.com/tiddlers/howtos/Generating Static Sites with TiddlyWiki.tid
+++ b/editions/tw5.com/tiddlers/howtos/Generating Static Sites with TiddlyWiki.tid
@@ -1,5 +1,5 @@
created: 20130828190200000
-modified: 20140228154328066
+modified: 20140908153013180
tags: howto
title: Generating Static Sites with TiddlyWiki
type: text/vnd.tiddlywiki
@@ -12,7 +12,7 @@ There is much flexibility in how the static HTML is generated. The following sce
You can explore a static representation of this TiddlyWiki at static.html. That file is a static snapshot of the current DefaultTiddlers. Any tiddlers that it links to are referred to via URLs of the form `/static/HelloThere.html` that point to static snapshots of individual tiddlers. The tiddler HTML files reference a `static.css` stylesheet file.
-The included `bld.sh` script includes these commands that are involved in generating the sample static version of the TiddlyWiki5 site:
+The included `bin/bld.sh` script includes these commands that are involved in generating the sample static version of the TiddlyWiki5 site:
```
--rendertiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/static.html text/plain \
@@ -27,7 +27,7 @@ It is also possible to produce a single HTML file that contains static represent
For example: alltiddlers.html
-The example is built by the following line in `bld.sh`:
+The example is built by the following line in `bin/bld.sh`:
```
--rendertiddler $:/core/templates/alltiddlers.template.html $TW5_BUILD_OUTPUT/alltiddlers.html text/plain \
diff --git a/editions/tw5.com/tiddlers/howtos/How to create a translation for TiddlyWiki.tid b/editions/tw5.com/tiddlers/howtos/How to create a translation for TiddlyWiki.tid
index 71623bb63..36a66e84b 100644
--- a/editions/tw5.com/tiddlers/howtos/How to create a translation for TiddlyWiki.tid
+++ b/editions/tw5.com/tiddlers/howtos/How to create a translation for TiddlyWiki.tid
@@ -1,5 +1,5 @@
created: 20140217173715829
-modified: 20140217173730646
+modified: 20140908153034100
tags: howto
title: How to create a translation for TiddlyWiki
type: text/vnd.tiddlywiki
@@ -21,7 +21,7 @@ type: text/vnd.tiddlywiki
# Copy the contents of `/core/language/en-GB` into your translation folder
# Create a `plugin.info` file (see below) in your translation folder
# Edit `/editions/tw5.com/tiddlywiki.info` to add your language to the list
-# Run `./qbld.sh` to build TiddlyWiki
+# Run `./bin/qbld.sh` to build TiddlyWiki
# Open the TiddlyWiki file at `/MyTranslation/jermolene.github.com/index.html`
# You should see your translation listed in the control panel, but the text of the translation will still be in British English
# Edit the `.tid` and `.multids` files in your language folder to translate the English text
diff --git a/editions/tw5.com/tiddlers/howtos/Using TiddlyWiki for GitHub Pages project documentation.tid b/editions/tw5.com/tiddlers/howtos/Using TiddlyWiki for GitHub Pages project documentation.tid
index d285347d4..27c353e89 100644
--- a/editions/tw5.com/tiddlers/howtos/Using TiddlyWiki for GitHub Pages project documentation.tid
+++ b/editions/tw5.com/tiddlers/howtos/Using TiddlyWiki for GitHub Pages project documentation.tid
@@ -1,7 +1,8 @@
-created: 201308251501
-modified: 201308251501
+created: 20130825150100000
+modified: 20140908153204226
tags: dev howto
title: Using TiddlyWiki for GitHub Pages project documentation
+type: text/vnd.tiddlywiki
TiddlyWiki5 can be used to produce documentation for GitHub projects. It lets you maintain a single set of documentation as a [[TiddlyWikiFolder|TiddlyWikiFolders]] containing separate tiddler files under source code control, and then use it to produce `readme.md` files for inclusion in project folders, or HTML files for storage in [[GitHub Pages|http://pages.github.com/]]. Both features are demonstrated by TiddlyWiki5 itself.
@@ -9,7 +10,7 @@ TiddlyWiki5 can be used to produce documentation for GitHub projects. It lets yo
When displaying the contents of a folder GitHub will look for a `readme.md` file and display it. Note that it will not display full HTML files in this way, just static MarkDown files (this is a security measure). Happily MarkDown permits a safe subset of HTML, and thus to generate a `readme.md` file that is suitable for GitHub it is just necessary for TiddlyWiki5 to generate the content of the `` element of an HTML document, and give it the appropriate filename.
-This is done in `bld.sh` by this command:
+This is done in `bin/bld.sh` by this command:
```
--rendertiddler ReadMe ./readme.md text/html
diff --git a/editions/tw5.com/tiddlers/readme/ReadMeBinFolder.tid b/editions/tw5.com/tiddlers/readme/ReadMeBinFolder.tid
new file mode 100644
index 000000000..c7aaae0e0
--- /dev/null
+++ b/editions/tw5.com/tiddlers/readme/ReadMeBinFolder.tid
@@ -0,0 +1,7 @@
+created: 20140908150853120
+modified: 20140908150853120
+title: ReadMeBinFolder
+type: text/vnd.tiddlywiki
+
+\define tv-wikilink-template() http://tiddlywiki.com/static/$uri_doubleencoded$.html
+{{Scripts for TiddlyWiki on Node.js}}
diff --git a/editions/tw5.com/tiddlywiki.info b/editions/tw5.com/tiddlywiki.info
index 74eab359d..ff5620b2e 100644
--- a/editions/tw5.com/tiddlywiki.info
+++ b/editions/tw5.com/tiddlywiki.info
@@ -42,6 +42,7 @@
"--savetiddler","$:/green_favicon.ico","static/favicon.ico"],
"readmes": [
"--rendertiddler","ReadMe","readme.md","text/html",
+ "--rendertiddler","ReadMeBinFolder","bin/readme.md","text/html",
"--rendertiddler","ContributingTemplate","contributing.md","text/html",
"--rendertiddler","$:/core/copyright.txt","licenses/copyright.md","text/plain"],
"tw2": [
diff --git a/readme.md b/readme.md
index 9e35062e7..5e5a249ac 100644
--- a/readme.md
+++ b/readme.md
@@ -1,3 +1,3 @@
-
TiddlyWiki 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!
The -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!
The -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.
Running 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 --.