1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-06-26 07:13:15 +00:00

Docs updates

This commit is contained in:
Jermolene 2014-09-19 23:02:03 +01:00
parent c5d0ae4c9b
commit 9eb2db791f
7 changed files with 48 additions and 83 deletions

View File

@ -1,81 +0,0 @@
title: Documentation progress
tags:
created: 201409041656
modified: 201409041656
Since new user documentation is a multiple-user, time-sensitive project, I have prepared the following list to help coordinate our efforts. Please sign up next to a tiddler to volunteer to write it. Feel free to add the names of other documentation tiddlers that you think are needed, and edit the titles or content of any tiddlers already edited. //(Note that developer tiddlers are moving from tiddlywiki.html to another location and so are not needed here).//
''~HelloThere section''
*HelloThere - first draft of rewrite done by Dave Gifford
*[[Discover TiddlyWiki]] - Dave Gifford (first draft done)
**[[TiddlyWiki is a tool]] - Dave Gifford (first draft done)
**[[TiddlyWiki is a toolbox]] - Dave Gifford (first draft done)
**[[TiddlyWiki is a community]] - Dave Gifford (first draft done)
**[[TiddlyWiki is a philosophy]] - Dave Gifford (first draft done)
*[[Ten reasons to switch to TiddlyWiki]] - Dave Gifford (first draft done)
*[[Some of the things you can do with TiddlyWiki]] - Dave Gifford (first draft done)
*[[Examples of TiddlyWiki in the wild]]
*[[The history of TiddlyWiki]]
*[[What happened to the other TiddlyWiki?]] - Dave Gifford (first draft done)
''Working with ~TiddlyWiki section''
*[[Working with TiddlyWiki]] - just needs a blank tiddler tagged TableOfContents and tc-no-link
*[[Downloading and saving]]
*[[Initial customisation]]
*[[Creating, tagging and editing tiddlers]] - Dave Gifford (first draft done)
*[[Navigating between tiddlers]] - Dave Gifford (will write)
*[[Searching in TiddlyWiki]] - Dave Gifford (first draft done)
*[[Formatting text in TiddlyWiki]]
*[[Upgrading TiddlyWiki and importing tiddlers]]
*[[Hosting your TiddlyWiki on the web]]
''Customise your ~TiddlyWiki section''
*[[Customise your TiddlyWiki]] - just needs a blank tiddler tagged TableOfContents and tc-no-link
*[[Initial customisation]]
*[[Button configuration]]
*[[Colours]]
*[[Page and tiddler layout customisation]] - Dave Gifford (will write)
*[[StoryView and animation speed]] - Dave Gifford (will write)
*[[Themes]]
*[[Using StyleSheets]]
''~TiddlyWiki advanced features section''
*[[TiddlyWiki advanced features]] - just needs a blank tiddler tagged TableOfContents and tc-no-link
*[[Filters overview]]
*[[Macros overview]]
*[[Plugins overview]]
*[[Widgets overview]]
''~TiddlyWiki editions and special uses section''
*[[TiddlyWiki editions and special uses]] - just needs a blank tiddler tagged TableOfContents and tc-no-link
*[[TiddlyWiki standalone]]
*[[Node.js edition]]
*[[TiddlyDesktop]]
*[[Windows HTA Hack]]
*[[Build a TiddlyWiki5 from individual tiddlers]]
*[[Building TiddlyWikiClassic]]
*[[Generating Static Sites with TiddlyWiki]]
''Get help and learn more section''
*[[Get help and learn more]] - just needs a blank tiddler tagged TableOfContents and tc-no-link
*[[The TiddlyWiki community]] - Dave Gifford (will write)
*[[Sites with resources for TiddlyWiki]] - Dave Gifford (will write)
*[[TiddlyWiki tutorials]] - Dave Gifford (will write)
*[[TiddlyWiki adaptations]] - Dave Gifford (will write)
*[[Articles about TiddlyWiki]] - Dave Gifford (will write)
''Get involved section''
*[[Get involved]] - just needs a blank tiddler tagged TableOfContents and tc-no-link
*[[Create support resources]]
*[[Develop for TiddlyWiki]]
*[[Help us with documentation]] - Dave Gifford (will rename [[Improving TiddlyWiki Documentation]] and double-check text for clarity)
*[[Promote TiddlyWiki]]
*[[Report bugs]]
*[[Translate TiddlyWiki into your language]]

View File

@ -1,9 +1,55 @@
created: 20140908131500000
modified: 20140919205321882
modified: 20140919214820549
tags: [[Working with TiddlyWiki]]
title: Formatting text in TiddlyWiki
type: text/vnd.tiddlywiki
Within the text of a tiddler you can use special formatting called WikiText to control how the text is displayed.
The simplest level of WikiText provides formatting
! Simple Formatting
At its simplest, WikiText lets you use familiar word-processing features like bold, italic, lists and tables. For example:
```
The ''quick'' brown ~~flea~~ fox //jumps// over the `lazy` dog
```
Displays as:
The ''quick'' brown ~~flea~~ fox //jumps// over the `lazy` dog
! Working with Tiddlers
WikiText allows you to link to tiddlers using double square brackets, or taking advantage of the automatic linking of CamelCase words:
```
This is a link to HelloThere, and one to [[History of TiddlyWiki]]
```
Displays as:
This is a link to HelloThere, and one to [[History of TiddlyWiki]]
! Macros
Macros let you package repetitive fragments of WikiText so that you can easily reuse them.
For example, here is the definition of a macro that generates a YouTube video URL from its unique identifier:
```
\define youtube(video)
https://www.youtube.com/watch?v=$video$
\end
```
With that definition in place, `<<youtube 1g66s7UbyuU>>` generates the URL https://www.youtube.com/watch?v=1g66s7UbyuU
! Advanced WikiText
Advanced WikiText features allow you to produce automated lists and interactive features like dropdown menus. In fact, the entire user interface of TiddlyWiki itself is written in WikiText, so any feature that you see in TiddlyWiki can be adapted for use in your own wikis.
Some of the advanced features require complex coding. TiddlyWiki includes several built-in macros that simplify common user interface tasks, like tabs, tables of content, and lists of tiddlers.
! Find out more
See [[WikiText]] for a detailed introduction to writing WikiText.