From 2714e0939f559519b332dcea95eb895623d2f602 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Fri, 28 Feb 2014 15:48:12 +0000 Subject: [PATCH] Docs updates --- editions/tw5.com/tiddlers/Features.tid | 5 ++- .../TiddlyWiki5_Static_Site_Generation.tid | 20 ----------- ...enerating Static Sites with TiddlyWiki.tid | 34 +++++++++++++++++++ 3 files changed, 38 insertions(+), 21 deletions(-) delete mode 100644 editions/tw5.com/tiddlers/editions/TiddlyWiki5_Static_Site_Generation.tid create mode 100644 editions/tw5.com/tiddlers/howtos/Generating Static Sites with TiddlyWiki.tid diff --git a/editions/tw5.com/tiddlers/Features.tid b/editions/tw5.com/tiddlers/Features.tid index 839b5e3b6..476fe118e 100644 --- a/editions/tw5.com/tiddlers/Features.tid +++ b/editions/tw5.com/tiddlers/Features.tid @@ -1,5 +1,5 @@ created: 20130822172800000 -modified: 20131213100612914 +modified: 20140228154616490 tags: introduction title: Features type: text/vnd.tiddlywiki @@ -8,10 +8,13 @@ type: text/vnd.tiddlywiki <$fieldmangler tiddler="SampleAlert"><$set name="currentTiddler" value="SampleAlert"><$button message="tw-add-tag" param="$:/tags/Alert" class="btn btn-inverse">alerts \end * The ability to save changes on almost any desktop HTML5 compatible-browser, with custom apps to enable [[Saving on iPad/iPhone]] and [[Android|Saving on Android]], and a cross-platform [[Firefox extension|Saving with TiddlyFox]] that even runs on Android +* Support for pluggable themes and colour palettes (see the [[control panel|$:/ControlPanel]]) +* The ability to [[render static HTML snapshots|Generating Static Sites with TiddlyWiki]] that can be used without JavaScript * [[Bitmap images|Motovun Jack.jpg]] and [[SVG images|UsingSVG]] are first-class citizens alongside text * Concise and expressive WikiText that generates semantic HTML * Integrated [[AES encryption|Saving with Encryption]] * TiddlyWiki isn't just a wiki - you can build custom applications with it like this TaskManagementExample +* Full internationalization support, with TiddlyWiki itself available in several languages (see the [[control panel|$:/ControlPanel]]) * Familiar user interface elements like <>, <$button message="tw-modal" param="SampleWizard" class="btn btn-inverse">wizards and <$button message="tw-notify" param="SampleNotification" class="btn btn-inverse">notifications * Easily [[import|ImportTiddlers]] content via drag and drop, copy and paste, or browsing for local files * Clone existing tiddlers (for example, <$button message="tw-new-tiddler" param=<>>clone this tiddler) diff --git a/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Static_Site_Generation.tid b/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Static_Site_Generation.tid deleted file mode 100644 index b3a1b1bbd..000000000 --- a/editions/tw5.com/tiddlers/editions/TiddlyWiki5_Static_Site_Generation.tid +++ /dev/null @@ -1,20 +0,0 @@ -created: 20130828190200000 -modified: 20131129095228854 -tags: howto -title: TiddlyWiki5 Static Site Generation -type: text/vnd.tiddlywiki - -TiddlyWiki5 can be used to generate a static HTML representation of a TiddlyWiki that doesn't need JavaScript. - -! Example - -You can explore a static representation of the TiddlyWiki5 site at static.html. That file is a static representation of the current DefaultTiddlers. Any tiddlers that it links to are referred to via URLs of the form `/static/HelloThere.html` that point to HTML representations 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: - -``` ---rendertiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/static.html text/plain \ ---rendertiddler $:/core/templates/static.template.css $TW5_BUILD_OUTPUT/static/static.css text/plain \ ---rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html $TW5_BUILD_OUTPUT/static text/plain \ -``` -The first RenderTiddlerCommand saves the static version of the DefaultTiddlers, the second saves the stylesheet, and the final RenderTiddlersCommand generates the HTML representations of individual tiddlers. 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 new file mode 100644 index 000000000..c9d9e805e --- /dev/null +++ b/editions/tw5.com/tiddlers/howtos/Generating Static Sites with TiddlyWiki.tid @@ -0,0 +1,34 @@ +created: 20130828190200000 +modified: 20140228154328066 +tags: howto +title: Generating Static Sites with TiddlyWiki +type: text/vnd.tiddlywiki + +TiddlyWiki5 can be used to generate static HTML representations of a TiddlyWiki that doesn't need JavaScript. + +There is much flexibility in how the static HTML is generated. The following scenarios are all illustrated on http://tiddlywiki.com. + +! Wiki Snapshots and Tiddler Snapshots + +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: + +``` +--rendertiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/static.html text/plain \ +--rendertiddler $:/core/templates/static.template.css $TW5_BUILD_OUTPUT/static/static.css text/plain \ +--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html $TW5_BUILD_OUTPUT/static text/plain \ +``` +The first RenderTiddlerCommand saves the static version of the DefaultTiddlers, the second saves the stylesheet, and the final RenderTiddlersCommand generates the HTML representations of individual tiddlers. + +! Wiki Snapshot with Internal Links + +It is also possible to produce a single HTML file that contains static representations of tiddlers, and uses standard HTML anchor links to jump between them. + +For example: alltiddlers.html + +The example is built by the following line in `bld.sh`: + +``` +--rendertiddler $:/core/templates/alltiddlers.template.html $TW5_BUILD_OUTPUT/alltiddlers.html text/plain \ +```