mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-01-24 16:06:58 +00:00
Code Issues Releases Wiki Activity

Docs improvements

Browse Source
This commit is contained in:
Jermolene 2018-08-08 10:47:10 +01:00
parent 0a5633dd4a
commit bb9e2de861
6 changed files with 51 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
editions/tw5.com/tiddlers/concepts/SystemTags.tid
View File

@ -1,5 +1,5 @@
created: 20130822080600000
modified: 20180323092909513
modified: 20180808094618436
tags: Concepts
title: SystemTags
type: text/vnd.tiddlywiki
@ -46,6 +46,7 @@ These are the available system tags
|<<tag "$:/tags/SearchResults">> |for customised search results |
|<<tag "$:/tags/ServerConnection">> |for plugin import handling |
|<<tag "$:/tags/SideBar">> |for sidebar tabs |
|<<tag "$:/tags/SideBarSegment">> |for sidebar segments |
|<<tag "$:/tags/StartupAction">> |startup actions executed on all platforms |
|<<tag "$:/tags/StartupAction/Browser">> |startup actions only executed when running in the browser |
|<<tag "$:/tags/StartupAction/Node">> |startup actions only executed when running under Node.js |

19
editions/tw5.com/tiddlers/webserver/Using the read-only single tiddler view.tid
View File

@ -1,7 +1,22 @@
created: 20180703095435813
modified: 20180703100525994
modified: 20180808094239047
tags: [[WebServer Guides]]
title: Using the read-only single tiddler view
type: text/vnd.tiddlywiki
As well as serving the full interactive wiki at the path `/` (e.g. http://127.0.0.1:8080/), TiddlyWiki also serves an experimental single tiddler per page, read-only view of the wiki at the path `/<url-encoded-tiddler-title>` (e.g. http://127.0.0.1:8080/HelloThere). It uses a simplified page layout, and implements links between tiddlers, but there are no other interactive features.
TiddlyWiki's experimental single tiddler per page, read-only view uses a simplified page layout, and implements links between tiddlers, but there are no other interactive features. Compared to a full TiddlyWiki user interface, it is very lightweight and usable even over very slow connections.
Alongside serving the full interactive wiki at the path `/` (e.g. http://127.0.0.1:8080/), TiddlyWiki serves each tiddler at the path `/<url-encoded-tiddler-title>`. For example:
* http://127.0.0.1:8080/HelloThere
* http://127.0.0.1:8080/Philosophy%20of%20Tiddlers
Ordinary, non-system tiddlers are rendered through a special view template while system tiddlers are rendered through a template that returns the raw text of the rendered output. In this way ordinary tiddlers can be browsed by end users while system tiddlers can be included in their raw form to use them as JS, HTML or CSS templates.
The templates are controlled by these parameters:
* [[system-tiddler-render-type|WebServer Parameter: system-tiddler-render-type]]
* [[system-tiddler-template|WebServer Parameter: system-tiddler-template]]
* [[tiddler-render-type|WebServer Parameter: tiddler-render-type]]
* [[tiddler-template|WebServer Parameter: tiddler-template]]

8
editions/tw5.com/tiddlers/webserver/WebServer Parameter_ system-tiddler-render-template.tid Normal file
View File

@ -0,0 +1,8 @@
caption: system-tiddler-render-template
created: 20180808094408813
modified: 20180808094527464
tags: [[WebServer Parameters]]
title: WebServer Parameter: system-tiddler-render-template
type: text/vnd.tiddlywiki
The [[web server configuration parameter|WebServer Parameters]] ''system-tiddler-render-template'' is used to specify the template for serving system tiddlers in the [[read-only single tiddler view|Using the read-only single tiddler view]]. The default value is `$:/core/templates/wikified-tiddler` which renders the tiddler raw, without any special viewing template.

8
editions/tw5.com/tiddlers/webserver/WebServer Parameter_ system-tiddler-render-type.tid Normal file
View File

@ -0,0 +1,8 @@
caption: system-tiddler-render-type
created: 20180808092758577
modified: 20180808093056528
tags: [[WebServer Parameters]]
title: WebServer Parameter: system-tiddler-render-type
type: text/vnd.tiddlywiki
The [[web server configuration parameter|WebServer Parameters]] ''system-tiddler-render-type'' is used to specify the render type for serving system tiddlers in the [[read-only single tiddler view|Using the read-only single tiddler view]]. The default value is `text/plain`, causing the raw text of rendered system tiddlers to be returned. Alternatively, `text/html` can be used to cause the full HTML of the rendered tiddlers to be returned.

8
editions/tw5.com/tiddlers/webserver/WebServer Parameter_ tiddler-render-template.tid Normal file
View File

@ -0,0 +1,8 @@
caption: tiddler-render-template
created: 20180808094255388
modified: 20180808094407363
tags: [[WebServer Parameters]]
title: WebServer Parameter: tiddler-render-template
type: text/vnd.tiddlywiki
The [[web server configuration parameter|WebServer Parameters]] ''tiddler-render-template'' is used to specify the template for serving ordinary, non-system tiddlers in the [[read-only single tiddler view|Using the read-only single tiddler view]]. The default value is `$:/core/templates/server/static.tiddler.html` which renders tiddlers in a lightweight page with a simple sidebar.

8
editions/tw5.com/tiddlers/webserver/WebServer Parameter_ tiddler-render-type.tid Normal file
View File

@ -0,0 +1,8 @@
caption: tiddler-render-type
created: 20180808093108099
modified: 20180808093218128
tags: [[WebServer Parameters]]
title: WebServer Parameter: tiddler-render-type
type: text/vnd.tiddlywiki
The [[web server configuration parameter|WebServer Parameters]] ''tiddler-render-type'' is used to specify the render type for serving ordinary, non-system tiddlers in the [[read-only single tiddler view|Using the read-only single tiddler view]]. The default value is `text/html`, causing the full HTML of the rendered output to be returned. Alternatively, `text/html` can be used to cause the raw text of rendered system tiddlers to be returned.