1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 10:07:19 +00:00

Move scripts into bin directory

Fixes #807
This commit is contained in:
Jermolene 2014-09-08 16:32:32 +01:00
parent 1c1a5c7252
commit 6e9cd59437
33 changed files with 53 additions and 28 deletions

View File

@ -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

View File

@ -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

6
bin/readme.md Normal file

File diff suppressed because one or more lines are too long

View File

@ -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/

View File

@ -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 <username> <password>`
# Run `bin/verbump "5.0.8-beta"`, substituting the new version number
# Run `bin/deploy.sh`
# Run `bin/wbld.sh <username> <password>`

View File

@ -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 <username> [<password>]
./bin/serve.sh <username> [<password>]
```
Or:
```
serve.cmd <username> [<password>]
./bin/serve.cmd <username> [<password>]
```
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 <username> [<password>]
./bin/lazy.sh <username> [<password>]
```
Or:
```
lazy.cmd <username> [<password>]
./bin/lazy.cmd <username> [<password>]
```
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
@ -75,3 +81,7 @@ 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).
!! `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]].

View File

@ -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 <a href="static.html">static.html</a>. 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: <a href="alltiddlers.html">alltiddlers.html</a>
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 \

View File

@ -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 `<repo>/core/language/en-GB` into your translation folder
# Create a `plugin.info` file (see below) in your translation folder
# Edit `<repo>/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

View File

@ -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 `<body>` 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

View File

@ -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}}

View File

@ -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": [

File diff suppressed because one or more lines are too long