mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-02-03 12:49:09 +00:00
Code Issues Releases Wiki Activity

Create Reference Tiddlers.tid

Browse Source
This commit is contained in:
Astrid Elocson 2014-12-26 19:28:24 +00:00
parent f952b8f1df
commit dfd4c480d2
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
editions/tw5.com/tiddlers/about/Reference Tiddlers.tid Normal file
View File

@ -0,0 +1,25 @@
created: 20141226192500000
title: Reference Tiddlers
tags: documenting
Reference tiddlers offer raw information in a comprehensive interlinked way. The reader is likely to be an intermediate or expert user.
There are several subcategories:
* ''Concepts''
** With definitions, together forming a glossary
* ''User manual''
** Presenting technical details of ~WikiText features
** Subcategorised: messages, operators, widgets, etc
* ''Developer manual''
** Presenting technical details of ~TiddlyWiki's internal architecture
Reference material is written in a terse, formal style that avoids referring to the reader, and instead focuses on how ~TiddlyWiki itself behaves. The passive voice is often suitable:
* "the template can be specified as a tiddler" rather than "specify the template as a tiddler"
* "the widget can be used for various purposes" rather than "you can use the widget for various purposes"
* But "this widget has several possible uses" is better, because it is more succinct
Contracted verb forms are normally avoided in reference tiddlers.
To reduce the risk that the reader will overlook the word "not", it can be italicised.