mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2025-01-11 09:50:27 +00:00
Move command documentation into the core
This commit is contained in:
parent
cadeb9654c
commit
e5103c32f3
22
core/language/en-GB/Help/default.tid
Normal file
22
core/language/en-GB/Help/default.tid
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
title: $:/language/Help/default
|
||||||
|
|
||||||
|
\define commandTitle()
|
||||||
|
$:/language/Help/$(command)$
|
||||||
|
\end
|
||||||
|
```
|
||||||
|
usage: tiddlywiki [<wikifolder>] [--<command> [<args>...]...]
|
||||||
|
```
|
||||||
|
|
||||||
|
Available commands:
|
||||||
|
|
||||||
|
<ul>
|
||||||
|
<$list filter="[commands[]sort[title]]" variable="command">
|
||||||
|
<li><$link to=<<commandTitle>>><$macrocall $name="command" $type="text/plain" $output="text/plain"/></$link>: <$transclude tiddler=<<commandTitle>> field="description"/></li>
|
||||||
|
</$list>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
To get detailed help on a command:
|
||||||
|
|
||||||
|
```
|
||||||
|
tiddlywiki --help <command>
|
||||||
|
```
|
10
core/language/en-GB/Help/help.tid
Normal file
10
core/language/en-GB/Help/help.tid
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
title: $:/language/Help/help
|
||||||
|
description: Display help for TiddlyWiki commands
|
||||||
|
|
||||||
|
Displays help text for a command:
|
||||||
|
|
||||||
|
```
|
||||||
|
--help [<command>]
|
||||||
|
```
|
||||||
|
|
||||||
|
If the command name is omitted then a list of available commands is displayed.
|
23
core/language/en-GB/Help/init.tid
Normal file
23
core/language/en-GB/Help/init.tid
Normal file
@ -0,0 +1,23 @@
|
|||||||
|
title: $:/language/Help/init
|
||||||
|
description: Initialise a new wiki folder
|
||||||
|
|
||||||
|
Initialise an empty [[WikiFolder|WikiFolders]] with a copy of the specified edition.
|
||||||
|
|
||||||
|
```
|
||||||
|
--init <edition> [<edition> ...]
|
||||||
|
```
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```
|
||||||
|
tiddlywiki ./MyWikiFolder --init empty
|
||||||
|
```
|
||||||
|
|
||||||
|
Note:
|
||||||
|
|
||||||
|
* The wiki folder directory will be created if necessary
|
||||||
|
* The "edition" defaults to ''empty''
|
||||||
|
* The init command will fail if the wiki folder is not empty
|
||||||
|
* The init command removes any `includeWikis` definitions in the edition's `tiddlywiki.info` file
|
||||||
|
* When multiple editions are specified, editions initialised later will overwrite any files shared with earlier editions (so, the final `tiddlywiki.info` file will be copied from the last edition)
|
||||||
|
* `--help editions` returns a list of available editions
|
14
core/language/en-GB/Help/load.tid
Normal file
14
core/language/en-GB/Help/load.tid
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
title: $:/language/Help/load
|
||||||
|
description: Load tiddlers from a file
|
||||||
|
|
||||||
|
Load tiddlers from 2.x.x TiddlyWiki files (`.html`), `.tiddler`, `.tid`, `.json` or other files
|
||||||
|
|
||||||
|
```
|
||||||
|
--load <filepath>
|
||||||
|
```
|
||||||
|
|
||||||
|
To load tiddlers from an encrypted TiddlyWiki file you should first specify the password with the PasswordCommand. For example:
|
||||||
|
|
||||||
|
```
|
||||||
|
tiddlywiki ./MyWiki --password pa55w0rd --load my_encrypted_wiki.html
|
||||||
|
```
|
3
core/language/en-GB/Help/notfound.tid
Normal file
3
core/language/en-GB/Help/notfound.tid
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
title: $:/language/Help/notfound
|
||||||
|
|
||||||
|
No such help item
|
9
core/language/en-GB/Help/password.tid
Normal file
9
core/language/en-GB/Help/password.tid
Normal file
@ -0,0 +1,9 @@
|
|||||||
|
title: $:/language/Help/password
|
||||||
|
description: Set a password for subsequent crypto operations
|
||||||
|
|
||||||
|
Set a password for subsequent crypto operations
|
||||||
|
|
||||||
|
```
|
||||||
|
--password <password>
|
||||||
|
```
|
||||||
|
|
8
core/language/en-GB/Help/rendertiddler.tid
Normal file
8
core/language/en-GB/Help/rendertiddler.tid
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
title: $:/language/Help/rendertiddler
|
||||||
|
description: Render an individual tiddler as a specified ContentType
|
||||||
|
|
||||||
|
Render an individual tiddler as a specified ContentType, defaults to `text/html` and save it to the specified filename:
|
||||||
|
|
||||||
|
```
|
||||||
|
--rendertiddler <title> <filename> [<type>]
|
||||||
|
```
|
14
core/language/en-GB/Help/rendertiddlers.tid
Normal file
14
core/language/en-GB/Help/rendertiddlers.tid
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
title: $:/language/Help/rendertiddlers
|
||||||
|
description: Render tiddlers matching a filter to a specified ContentType
|
||||||
|
|
||||||
|
Render a set of tiddlers matching a filter to separate files of a specified ContentType (defaults to `text/html`) and extension (defaults to `.html`).
|
||||||
|
|
||||||
|
```
|
||||||
|
--rendertiddlers <filter> <template> <pathname> [<type>] [<extension>]
|
||||||
|
```
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```
|
||||||
|
--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html ./static text/plain
|
||||||
|
```
|
8
core/language/en-GB/Help/savetiddler.tid
Normal file
8
core/language/en-GB/Help/savetiddler.tid
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
title: $:/language/Help/savetiddler
|
||||||
|
description: Saves a raw tiddler to a file
|
||||||
|
|
||||||
|
Saves an individual tiddler in its raw text or binary format to the specified filename.
|
||||||
|
|
||||||
|
```
|
||||||
|
--savetiddler <title> <filename>
|
||||||
|
```
|
30
core/language/en-GB/Help/server.tid
Normal file
30
core/language/en-GB/Help/server.tid
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
title: $:/language/Help/server
|
||||||
|
description: Provides an HTTP server interface to TiddlyWiki
|
||||||
|
|
||||||
|
The server built in to TiddlyWiki5 is very simple. Although compatible with TiddlyWeb it doesn't support many of the features needed for robust Internet-facing usage.
|
||||||
|
|
||||||
|
At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for `GET`, `PUT` and `DELETE`.
|
||||||
|
|
||||||
|
```
|
||||||
|
--server <port> <roottiddler> <rendertype> <servetype> <username> <password> <host>
|
||||||
|
```
|
||||||
|
|
||||||
|
The parameters are:
|
||||||
|
|
||||||
|
* ''port'' - port number to serve from (defaults to "8080")
|
||||||
|
* ''roottiddler'' - the tiddler to serve at the root (defaults to "$:/core/save/all")
|
||||||
|
* ''rendertype'' - the content type to which the root tiddler should be rendered (defaults to "text/plain")
|
||||||
|
* ''servetype'' - the content type with which the root tiddler should be served (defaults to "text/html")
|
||||||
|
* ''username'' - the default username for signing edits
|
||||||
|
* ''password'' - optional password for basic authentication
|
||||||
|
* ''host'' - optional hostname to serve from (defaults to "127.0.0.1" aka "localhost")
|
||||||
|
|
||||||
|
If the password parameter is specified then the browser will prompt the user for the username and password. Note that the password is transmitted in plain text so this implementation isn't suitable for general use.
|
||||||
|
|
||||||
|
For example:
|
||||||
|
|
||||||
|
```
|
||||||
|
--server 8080 $:/core/save/all text/plain text/html MyUserName passw0rd
|
||||||
|
```
|
||||||
|
|
||||||
|
To run multiple TiddlyWiki servers at the same time you'll need to put each one on a different port.
|
8
core/language/en-GB/Help/verbose.tid
Normal file
8
core/language/en-GB/Help/verbose.tid
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
title: $:/language/Help/verbose
|
||||||
|
description: Triggers verbose output mode
|
||||||
|
|
||||||
|
Triggers verbose output, useful for debugging
|
||||||
|
|
||||||
|
```
|
||||||
|
--verbose
|
||||||
|
```
|
8
core/language/en-GB/Help/version.tid
Normal file
8
core/language/en-GB/Help/version.tid
Normal file
@ -0,0 +1,8 @@
|
|||||||
|
title: $:/language/Help/version
|
||||||
|
description: Displays the version number of TiddlyWiki
|
||||||
|
|
||||||
|
Displays the version number of TiddlyWiki.
|
||||||
|
|
||||||
|
```
|
||||||
|
--version
|
||||||
|
```
|
7
editions/tw5.com/tiddlers/commands/HelpCommand.tid
Normal file
7
editions/tw5.com/tiddlers/commands/HelpCommand.tid
Normal file
@ -0,0 +1,7 @@
|
|||||||
|
created: 20140225195548209
|
||||||
|
modified: 20140225195738745
|
||||||
|
tags: command
|
||||||
|
title: HelpCommand
|
||||||
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
|
{{$:/language/Help/help}}
|
@ -4,23 +4,4 @@ tags: command
|
|||||||
title: InitCommand
|
title: InitCommand
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
Initialise an empty [[WikiFolder|WikiFolders]] with a copy of the specified edition.
|
{{$:/language/Help/init}}
|
||||||
|
|
||||||
```
|
|
||||||
--init <edition> [<edition> ...]
|
|
||||||
```
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
```
|
|
||||||
tiddlywiki ./MyWikiFolder --init empty
|
|
||||||
```
|
|
||||||
|
|
||||||
Note:
|
|
||||||
|
|
||||||
* The edition directory will be created if necessary
|
|
||||||
* The "edition" defaults to ''empty''
|
|
||||||
* The init command will fail if the wiki folder does not exist, or is not empty
|
|
||||||
* The init command removes any `includeWikis` definitions in the edition's `tiddlywiki.info` file
|
|
||||||
* When multiple editions are specified, editions initialised later will overwrite any files shared with earlier editions (so, the final `tiddlywiki.info` file will be copied from the last edition)
|
|
||||||
|
|
||||||
|
@ -4,14 +4,4 @@ tags: command
|
|||||||
title: LoadCommand
|
title: LoadCommand
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
Load tiddlers from 2.x.x TiddlyWiki files (`.html`), `.tiddler`, `.tid`, `.json` or other files
|
{{$:/language/Help/load}}
|
||||||
|
|
||||||
```
|
|
||||||
--load <filepath>
|
|
||||||
```
|
|
||||||
|
|
||||||
To load tiddlers from an encrypted TiddlyWiki file you should first specify the password with the PasswordCommand. For example:
|
|
||||||
|
|
||||||
```
|
|
||||||
tiddlywiki ./MyWiki --password pa55w0rd --load my_encrypted_wiki.html
|
|
||||||
```
|
|
||||||
|
@ -1,9 +1,4 @@
|
|||||||
title: PasswordCommand
|
title: PasswordCommand
|
||||||
tags: command
|
tags: command
|
||||||
|
|
||||||
Set a password for subsequent crypto operations
|
{{$:/language/Help/password}}
|
||||||
|
|
||||||
```
|
|
||||||
--password <password>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
@ -1,8 +1,4 @@
|
|||||||
title: RenderTiddlerCommand
|
title: RenderTiddlerCommand
|
||||||
tags: command
|
tags: command
|
||||||
|
|
||||||
Render an individual tiddler as a specified ContentType, defaults to `text/html` and save it to the specified filename
|
{{$:/language/Help/rendertiddler}}
|
||||||
|
|
||||||
```
|
|
||||||
--rendertiddler <title> <filename> [<type>]
|
|
||||||
```
|
|
||||||
|
@ -1,14 +1,4 @@
|
|||||||
title: RenderTiddlersCommand
|
title: RenderTiddlersCommand
|
||||||
tags: command
|
tags: command
|
||||||
|
|
||||||
Render a set of tiddlers matching a filter to separate files of a specified ContentType (defaults to `text/html`) and extension (defaults to `.html`).
|
{{{$:/language/Help/rendertiddlers}}}
|
||||||
|
|
||||||
```
|
|
||||||
--rendertiddlers <filter> <template> <pathname> [<type>] [<extension>]
|
|
||||||
```
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
```
|
|
||||||
--rendertiddlers [!is[system]] $:/core/templates/static.tiddler.html ./static text/plain
|
|
||||||
```
|
|
||||||
|
@ -3,8 +3,4 @@ tags: command
|
|||||||
created: 20131218121606089
|
created: 20131218121606089
|
||||||
modified: 20131218121606089
|
modified: 20131218121606089
|
||||||
|
|
||||||
Saves an individual tiddler in its raw text or binary format to the specified filename.
|
{{$:/language/Help/savetiddler}}
|
||||||
|
|
||||||
```
|
|
||||||
--savetiddler <title> <filename>
|
|
||||||
```
|
|
||||||
|
@ -4,30 +4,4 @@ tags: command
|
|||||||
title: ServerCommand
|
title: ServerCommand
|
||||||
type: text/vnd.tiddlywiki
|
type: text/vnd.tiddlywiki
|
||||||
|
|
||||||
The server built in to TiddlyWiki5 is very simple. Although compatible with TiddlyWeb it doesn't support many of the features needed for robust Internet-facing usage.
|
{{$:/language/Help/server}}
|
||||||
|
|
||||||
At the root, it serves a rendering of a specified tiddler. Away from the root, it serves individual tiddlers encoded in JSON, and supports the basic HTTP operations for `GET`, `PUT` and `DELETE`.
|
|
||||||
|
|
||||||
```
|
|
||||||
--server <port> <roottiddler> <rendertype> <servetype> <username> <password> <host>
|
|
||||||
```
|
|
||||||
|
|
||||||
The parameters are:
|
|
||||||
|
|
||||||
* ''port'' - port number to serve from (defaults to "8080")
|
|
||||||
* ''roottiddler'' - the tiddler to serve at the root (defaults to "$:/core/save/all")
|
|
||||||
* ''rendertype'' - the content type to which the root tiddler should be rendered (defaults to "text/plain")
|
|
||||||
* ''servetype'' - the content type with which the root tiddler should be served (defaults to "text/html")
|
|
||||||
* ''username'' - the default username for signing edits
|
|
||||||
* ''password'' - optional password for basic authentication
|
|
||||||
* ''host'' - optional hostname to serve from (defaults to "127.0.0.1" aka "localhost")
|
|
||||||
|
|
||||||
If the password parameter is specified then the browser will prompt the user for the username and password. Note that the password is transmitted in plain text so this implementation isn't suitable for general use.
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
```
|
|
||||||
--server 8080 $:/core/save/all text/plain text/html MyUserName passw0rd
|
|
||||||
```
|
|
||||||
|
|
||||||
To run multiple TiddlyWiki servers at the same time you'll need to put each one on a different port.
|
|
||||||
|
@ -1,8 +1,4 @@
|
|||||||
title: VerboseCommand
|
title: VerboseCommand
|
||||||
tags: command
|
tags: command
|
||||||
|
|
||||||
Triggers verbose output, useful for debugging
|
{{$:/language/Help/verbose}}
|
||||||
|
|
||||||
```
|
|
||||||
--verbose
|
|
||||||
```
|
|
||||||
|
@ -1,8 +1,4 @@
|
|||||||
title: VersionCommand
|
title: VersionCommand
|
||||||
tags: command
|
tags: command
|
||||||
|
|
||||||
Displays the version number of TiddlyWiki.
|
{{$:/language/Help/version}}
|
||||||
|
|
||||||
```
|
|
||||||
--version
|
|
||||||
```
|
|
||||||
|
Loading…
Reference in New Issue
Block a user