TiddlyWiki5/editions/tw5.com/tiddlers/concepts/TiddlyWikiFolders.tid

created: 20130825214200000
modified: 20161015134454785
tags: [[TiddlyWiki on Node.js]]
title: TiddlyWikiFolders
type: text/vnd.tiddlywiki

As well as traditional single file wikis, [[TiddlyWiki on Node.js]] supports wikis that are stored as a folder of individual tiddler files.

! Wiki Folder Structure

Wiki folders can contain the following files and folders:

* ''tiddlywiki.info'' - JSON file containing metadata for the wiki -- see [[tiddlywiki.info Files]]
* ''\tiddlers'' - folder containing tiddler files comprising the wiki
* ''\plugins'' - folder containing [[plugin folders|PluginFolders]] to be included in the wiki
* ''\languages'' - folder containing [[plugin folders|PluginFolders]] for language plugins to be included in the wiki
* ''\themes'' - folder containing [[plugin folders|PluginFolders]] for theme plugins to be included in the wiki

Only the ''tiddlywiki.info'' file is required; everything else is optional. Any files and folders not listed above are ignored.

!! Plugin processing

To be usable in the browser, plugins just need to be included in the wiki. For wikis that are generated on the server, TiddlyWikiFolders can contain a [[tiddlywiki.info file|tiddlywiki.info Files]] that identifies the plugins to be included in this wiki:

```
{
	"plugins": [
		"tiddlywiki/slider",
		"tiddlytools/chooser"
	]
}
```

Plugins names refer to plugin folders listed in TiddlyWiki5's root `plugins` folder. Plugins can also be included manually by copying them into the `plugins` subfolder of the wiki.

!! Processing of `tiddlers` folder

All the TiddlerFiles in the `tiddlers` folder are read into the wiki at startup. Sub-folders are scanned recursively for TiddlerFiles. Newly created tiddlers are stored in TiddlerFiles directly beneath the `tiddlers` folder, unless [[configured otherwise|Customising Tiddler File Naming]].

The default processing for sub-folders within the `tiddlers` folder can  be overridden by providing a JSON file called `tiddlywiki.files` -- see [[tiddlywiki.files Files]].
Lotsa docs updates 2013-11-29 12:26:48 +00:00			`created: 20130825214200000`
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`modified: 20161015134454785`
Lots more docs updates 2014-09-12 15:05:37 +00:00			`tags: [[TiddlyWiki on Node.js]]`
Docs updates 2013-04-17 15:38:32 +00:00			`title: TiddlyWikiFolders`
Lotsa docs updates 2013-11-29 12:26:48 +00:00			`type: text/vnd.tiddlywiki`
Docs updates 2013-04-17 15:38:32 +00:00
Docs updates 2013-12-12 09:48:08 +00:00			`As well as traditional single file wikis, [[TiddlyWiki on Node.js]] supports wikis that are stored as a folder of individual tiddler files.`
Docs updates 2013-04-17 15:38:32 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`! Wiki Folder Structure`
Docs updates 2013-04-17 15:38:32 +00:00
			`Wiki folders can contain the following files and folders:`

Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`* ''tiddlywiki.info'' - JSON file containing metadata for the wiki -- see [[tiddlywiki.info Files]]`
Docs updates 2013-04-17 15:38:32 +00:00			`* ''\tiddlers'' - folder containing tiddler files comprising the wiki`
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`* ''\plugins'' - folder containing [[plugin folders\|PluginFolders]] to be included in the wiki`
			`* ''\languages'' - folder containing [[plugin folders\|PluginFolders]] for language plugins to be included in the wiki`
			`* ''\themes'' - folder containing [[plugin folders\|PluginFolders]] for theme plugins to be included in the wiki`
Docs updates 2013-04-17 15:38:32 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`Only the ''tiddlywiki.info'' file is required; everything else is optional. Any files and folders not listed above are ignored.`
Docs updates 2013-04-17 15:38:32 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`!! Plugin processing`
Docs updates 2013-04-17 15:38:32 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`To be usable in the browser, plugins just need to be included in the wiki. For wikis that are generated on the server, TiddlyWikiFolders can contain a [[tiddlywiki.info file\|tiddlywiki.info Files]] that identifies the plugins to be included in this wiki:`
Docs updates 2013-04-17 15:38:32 +00:00
			```
			`{`
Add `--build` command First pass at the build system described in #356. To test it, move to a new, empty directory and try `tiddlywiki editions/tw5.com --verbose --build` 2014-04-25 21:41:59 +00:00			`"plugins": [`
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			`"tiddlywiki/slider",`
			`"tiddlytools/chooser"`
Add `--build` command First pass at the build system described in #356. To test it, move to a new, empty directory and try `tiddlywiki editions/tw5.com --verbose --build` 2014-04-25 21:41:59 +00:00			`]`
Lots of docs updates 2013-08-30 19:06:23 +00:00			`}`
			```

Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			Plugins names refer to plugin folders listed in TiddlyWiki5's root `plugins` folder. Plugins can also be included manually by copying them into the `plugins` subfolder of the wiki.
Lots of docs updates 2013-08-30 19:06:23 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			!! Processing of `tiddlers` folder

			All the TiddlerFiles in the `tiddlers` folder are read into the wiki at startup. Sub-folders are scanned recursively for TiddlerFiles. Newly created tiddlers are stored in TiddlerFiles directly beneath the `tiddlers` folder, unless [[configured otherwise\|Customising Tiddler File Naming]].
Allow tiddlywiki.files to load directories recursively 2015-09-15 12:35:54 +00:00
Improve support for bulk loading tiddlers under Node.js Fixes #2610 2016-10-15 15:21:51 +00:00			The default processing for sub-folders within the `tiddlers` folder can be overridden by providing a JSON file called `tiddlywiki.files` -- see [[tiddlywiki.files Files]].