Clarify savewikifolder docs

See discussion at https://github.com/Jermolene/TiddlyWiki5/pull/7490#discussion_r1247708635
This commit is contained in:
jeremy@jermolene.com 2023-07-01 11:11:08 +01:00
parent ee1200bde1
commit 9589e3df33
1 changed files with 5 additions and 1 deletions

View File

@ -15,7 +15,11 @@ description: Saves a wiki to a new wiki folder
The following options are supported:
* ''filter'': a filter expression that defines the tiddlers to include in the output.
* ''explodePlugins'': set to "no" to save plugins to the tiddlers directory of the target wiki folder, to suppress breaking plugins into their constituent shadow tiddlers (default is "yes").
* ''explodePlugins'': defaults to "yes"
** ''yes'' will "explode" plugins into separate tiddler files and save them to the plugin directory within the wiki folder
** ''no'' will suppress exploding plugins into their constituent tiddler files. It will save the plugin as a single JSON tiddler in the tiddlers folder
Note that both ''explodePlugins'' options will produce wiki folders that build the same exact same original wiki. The difference lies in how plugins are represented in the wiki folder.
A common usage is to convert a TiddlyWiki HTML file into a wiki folder: