Rename "shadow" tiddlers to "system" tiddlers

What we have at the moment isn't really the same as TiddlyWiki
classic's shadow tiddlers, it's a much simpler system for excluding
tiddlers. We'll use the term "shadow" instead to refer to the way that
tiddlers in plugins behave, which is exactly like TiddlyWiki classic's
shadow tiddlers.
This commit is contained in:
Jeremy Ruston
2013-03-15 22:00:19 +00:00
parent e5443e27cb
commit 623a3ec8f8
30 changed files with 76 additions and 76 deletions
+1 -1
View File
@@ -5,7 +5,7 @@ Here are a few features of TiddlyWiki that you can explore:
* Invoke a demonstration wizard: <$button message="tw-modal" param="SampleWizard" class="btn btn-inverse">demo</$button> (the text of the wizard is in the tiddler SampleWizard)
* Save this wiki as a static HTML file: <$button message="tw-save-wiki" param="$:/core/templates/static.template.html" class="btn">Save Static</$button>
* Browse the list of AllTiddlers or the ShadowTiddlers
* Browse the list of AllTiddlers or the SystemTiddlers
* Examine the example [[bitmap images|Motovun Jack.jpg]] and [[SVG images|Motovun Jack.svg]]
* Check out the TaskManagementExample
+1 -1
View File
@@ -29,7 +29,7 @@ The machinery tying those concepts together includes:
* TiddlerTemplates
* DataTiddlers
* ContentType
* ShadowTiddlers
* SystemTiddlers
* [[Plugins]]
* [[Modules]] and [[ModuleType]]
@@ -17,12 +17,12 @@ Dump the fields of an individual tiddler
--dump tiddler <title>
```
!!! dump shadows
!!! dump system
Dump the titles of the shadow tiddlers in the wiki store
Dump the titles of the system tiddlers in the wiki store
```
--dump shadows
--dump systems
```
!!! dump config
@@ -10,5 +10,5 @@ Save a set of tiddlers matching a filter as separate files of a specified Conten
For example:
```
--savetiddlers [!is[shadow]] $:/core/templates/static.tiddler.html ./static text/plain
--savetiddlers [!is[system]] $:/core/templates/static.tiddler.html ./static text/plain
```
@@ -1,10 +0,0 @@
title: ShadowTiddlers
tags: docs concepts
TiddlyWiki models everything as [[tiddlers|Tiddlers]], including its internal components and configuration.
Thus, even an apparently empty TiddlyWiki actually contains dozens of tiddlers that are necessary to enable it function correctly. To prevent them from confusing or intimidating casual users, these system tiddlers are designated //shadow tiddlers// which means that they remain invisible unless one looks for them directly. They don't show up in lists or search results, but linking to one directly works in the usual way.
The current shadow tiddlers are:
<$list type="shadows" />
@@ -0,0 +1,10 @@
title: SystemTiddlers
tags: docs concepts
TiddlyWiki models everything as [[tiddlers|Tiddlers]], including its internal components and configuration.
Thus, even an apparently empty TiddlyWiki actually contains dozens of tiddlers that are necessary to enable it function correctly. To prevent them from confusing casual users, these system tiddlers are hidden from most operations. They don't show up in lists or search results, but linking to one directly works in the usual way.
The current system tiddlers are:
<$list type="system" />
@@ -48,7 +48,7 @@ The operator defaults to `title` if omitted, so `[[HelloThere]]` is equivalent t
The operands available with the `is` operator are:
* ''shadow'': selects all shadow tiddlers
* ''system'': selects all system tiddlers
* ''current'': selects the current ContextTiddler
! Runs
@@ -12,6 +12,6 @@ The included `bld.sh` script includes these commands that are involved in genera
```
--savetiddler $:/core/templates/static.template.html $TW5_BUILD_OUTPUT/static.html text/plain \
--savetiddler $:/core/templates/static.template.css $TW5_BUILD_OUTPUT/static/static.css text/plain \
--savetiddlers [!is[shadow]] $:/core/templates/static.tiddler.html $TW5_BUILD_OUTPUT/static text/plain \
--savetiddlers [!is[system]] $:/core/templates/static.tiddler.html $TW5_BUILD_OUTPUT/static text/plain \
```
The first SaveTiddlerCommand saves the static version of the DefaulTiddlers, the second saves the stylesheet, and the final SaveTiddlersCommand generates the HTML representations of individual tiddlers.
@@ -30,7 +30,7 @@ Each module is an ordinary `node.js`-style module, using the `require()` functio
In the browser, `core/boot.js` is packed into a template HTML file that contains the following elements in order:
* Ordinary and shadow tiddlers, packed as HTML `<DIV>` elements
* Ordinary and system tiddlers, packed as HTML `<DIV>` elements
* `core/bootprefix.js`, containing a few lines to set up the plugin environment
* JavaScript modules, packed as HTML `<SCRIPT>` blocks
* `core/boot.js`, containing the boot kernel