1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-13 17:16:48 +00:00

Docs updates

This commit is contained in:
Jeremy Ruston 2013-08-28 20:14:27 +01:00
parent 1b094b1d5c
commit 6333749d68
6 changed files with 42 additions and 15 deletions

View File

@ -0,0 +1,8 @@
created: 201308281853
creator: JeremyRuston
modified: 201308281853
modifier: JeremyRuston
tags: definitions
title: CamelCase
CamelCase is formed by taking a phrase, capitalising each initial letter and smashing them together to form a portmanteau word. Most wikis use CamelCase to signal phrases that should be automatically linked.

View File

@ -0,0 +1,11 @@
created: 201308281859
creator: JeremyRuston
modified: 201308281859
modifier: JeremyRuston
tags: definitions concepts
title: ContentType
Used in Internet protocols to indicate the type that should be used to interpret the content of a web resource.
Under TiddlyWiki5, the `type` field is gives the content type to apply to the main `text` field.

View File

@ -0,0 +1,8 @@
created: 201308281902
creator: JeremyRuston
modified: 201308281902
modifier: JeremyRuston
tags: definitions
title: Jermolene
Alias for JeremyRuston.

View File

@ -1,31 +1,27 @@
created: 201308251605
creator: JeremyRuston
modified: 201308251605
modified: 201308281850
modifier: JeremyRuston
tags: community
title: HelpingTiddlyWiki
If you find TiddlyWiki useful, there are lots of ways you can help assure its future and make it better.
! 1. Teach other people to use TiddlyWiki
! 1. Teach and Tell
OpenSource projects like TiddlyWiki thrive on the feedback and engagement of users. TiddlyWiki becomes more useful to everyone as more and more people use it.
! 2. Tell the world
If you find TiddlyWiki useful, spread the word. The best possible way to assure its future is for it to become a hundred times more popular than before.
OpenSource projects like TiddlyWiki thrive on the feedback and engagement of users. TiddlyWiki becomes more useful to everyone as more and more people use it. So, if you find TiddlyWiki useful, spread the word. The best possible way to assure its future is for it to become a hundred times more popular than before.
* [[Tweet about TiddlyWiki|https://twitter.com/intent/tweet?text=I+love+TiddlyWiki+because...&source=tiddlywiki5]]
! 3. Join the discussion
! 2. Join the discussion
There's lively discussion about TiddlyWiki in the Google Groups:
* The main TiddlyWiki group: http://groups.google.com/group/TiddlyWiki
* The TiddlyWikiDev group for developers: http://groups.google.com/group/TiddlyWikiDev
! 4. Improve the documentation and code
! 3. Improve the documentation and code
The main TiddlyWiki documentation and code lives on GitHub, and welcomes [[contributions||Contributing]]:
The main TiddlyWiki documentation and code lives on GitHub, and welcomes [[contributions|Contributing]]:
https://github.com/Jermolene/TiddlyWiki5
* https://github.com/Jermolene/TiddlyWiki5

View File

@ -1,6 +1,6 @@
created: 201308252142
creator: JeremyRuston
modified: 201308252142
modified: 201308281907
modifier: JeremyRuston
tags: dev
title: TiddlyWikiFolders
@ -21,7 +21,7 @@ Only the ''tiddlywiki.info'' file is required, the ''tiddlers'' and ''plugins''
The `tiddlywiki.info` file in a wiki folder contains a JSON object comprising the following fields:
* ''plugins'' - an array of CorePlugins to be included in the wiki
* ''plugins'' - an array of plugin names to be included in the wiki
* ''doNotSave'' - an array of tiddler titles that should not be saved by the FileSystemAdaptorPlugin
* ''includeWikis'' - an array of relative paths to external wiki folders to be included in the wiki

View File

@ -1,5 +1,9 @@
title: TiddlyWiki5 Static Site Generation
created: 201308281902
creator: JeremyRuston
modified: 201308281902
modifier: JeremyRuston
tags: edition
title: TiddlyWiki5 Static Site Generation
TiddlyWiki5 can be used to generate a static HTML representation of a TiddlyWiki that doesn't need JavaScript.
@ -14,4 +18,4 @@ The included `bld.sh` script includes these commands that are involved in genera
--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 DefaulTiddlers, the second saves the stylesheet, and the final RenderTiddlersCommand generates the HTML representations of individual tiddlers.
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.