mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-11-27 03:57:21 +00:00
delete untranslated help for commands
This commit is contained in:
Andrey Yankin
parent
8ac31e9134
commit
d34bcc2ebb
@ -1,11 +0,0 @@
|
|||||||
title: $:/language/Help/build
|
|
||||||
description: Automatically run configured commands
|
|
||||||
|
|
||||||
Build the specified build targets for the current wiki. If no build targets are specified then all available targets will be built.
|
|
||||||
|
|
||||||
```
|
|
||||||
--build <target> [<target> ...]
|
|
||||||
```
|
|
||||||
|
|
||||||
Build targets are defined in the `tiddlywiki.info` file of a wiki folder.
|
|
||||||
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
title: $:/language/Help/clearpassword
|
|
||||||
description: Clear a password for subsequent crypto operations
|
|
||||||
|
|
||||||
Clear the password for subsequent crypto operations
|
|
||||||
|
|
||||||
```
|
|
||||||
--clearpassword
|
|
||||||
```
|
|
||||||
@ -1,22 +0,0 @@
|
|||||||
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>
|
|
||||||
```
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
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.
|
|
||||||
@ -1,23 +0,0 @@
|
|||||||
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)
|
|
||||||
* `--editions` returns a list of available editions
|
|
||||||
@ -1,16 +0,0 @@
|
|||||||
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
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that TiddlyWiki will not load an older version of an already loaded plugin.
|
|
||||||
@ -1,14 +0,0 @@
|
|||||||
title: $:/language/Help/makelibrary
|
|
||||||
description: Construct library plugin required by upgrade process
|
|
||||||
|
|
||||||
Constructs the `$:/UpgradeLibrary` tiddler for the upgrade process.
|
|
||||||
|
|
||||||
The upgrade library is formatted as an ordinary plugin tiddler with the plugin type `library`. It contains a copy of each of the plugins, themes and language packs available within the TiddlyWiki5 repository.
|
|
||||||
|
|
||||||
This command is intended for internal use; it is only relevant to users constructing a custom upgrade procedure.
|
|
||||||
|
|
||||||
```
|
|
||||||
--makelibrary <title>
|
|
||||||
```
|
|
||||||
|
|
||||||
The title argument defaults to `$:/UpgradeLibrary`.
|
|
||||||
@ -1,3 +0,0 @@
|
|||||||
title: $:/language/Help/notfound
|
|
||||||
|
|
||||||
No such help item
|
|
||||||
@ -1,10 +0,0 @@
|
|||||||
title: $:/language/Help/output
|
|
||||||
description: Set the base output directory for subsequent commands
|
|
||||||
|
|
||||||
Sets the base output directory for subsequent commands. The default output directory is the `output` subdirectory of the edition directory.
|
|
||||||
|
|
||||||
```
|
|
||||||
--output <pathname>
|
|
||||||
```
|
|
||||||
|
|
||||||
If the specified pathname is relative then it is resolved relative to the current working directory.
|
|
||||||
@ -1,9 +0,0 @@
|
|||||||
title: $:/language/Help/password
|
|
||||||
description: Set a password for subsequent crypto operations
|
|
||||||
|
|
||||||
Set a password for subsequent crypto operations
|
|
||||||
|
|
||||||
```
|
|
||||||
--password <password>
|
|
||||||
```
|
|
||||||
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
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>]
|
|
||||||
```
|
|
||||||
|
|
||||||
By default, the filename is resolved relative to the `output` subdirectory of the edition directory. The `--output` command can be used to direct output to a different directory.
|
|
||||||
|
|
||||||
Any missing directories in the path to the filename are automatically created.
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
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
|
|
||||||
```
|
|
||||||
|
|
||||||
By default, the pathname is resolved relative to the `output` subdirectory of the edition directory. The `--output` command can be used to direct output to a different directory.
|
|
||||||
|
|
||||||
Any files in the target directory are deleted. The target directory is recursively created if it is missing.
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
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>
|
|
||||||
```
|
|
||||||
|
|
||||||
By default, the filename is resolved relative to the `output` subdirectory of the edition directory. The `--output` command can be used to direct output to a different directory.
|
|
||||||
|
|
||||||
Any missing directories in the path to the filename are automatically created.
|
|
||||||
@ -1,12 +0,0 @@
|
|||||||
title: $:/language/Help/savetiddlers
|
|
||||||
description: Saves a group of raw tiddlers to a directory
|
|
||||||
|
|
||||||
Saves a group of tiddlers in their raw text or binary format to the specified directory.
|
|
||||||
|
|
||||||
```
|
|
||||||
--savetiddlers <filter> <pathname>
|
|
||||||
```
|
|
||||||
|
|
||||||
By default, the pathname is resolved relative to the `output` subdirectory of the edition directory. The `--output` command can be used to direct output to a different directory.
|
|
||||||
|
|
||||||
Any missing directories in the pathname are automatically created.
|
|
||||||
@ -1,37 +0,0 @@
|
|||||||
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> <pathprefix>
|
|
||||||
```
|
|
||||||
|
|
||||||
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")
|
|
||||||
* ''pathprefix'' - optional prefix for paths
|
|
||||||
|
|
||||||
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
|
|
||||||
```
|
|
||||||
|
|
||||||
The username and password can be specified as empty strings if you need to set the hostname or pathprefix and don't want to require a password:
|
|
||||||
|
|
||||||
```
|
|
||||||
--server 8080 $:/core/save/all text/plain text/html "" "" 192.168.0.245
|
|
||||||
```
|
|
||||||
|
|
||||||
To run multiple TiddlyWiki servers at the same time you'll need to put each one on a different port.
|
|
||||||
@ -1,18 +0,0 @@
|
|||||||
title: $:/language/Help/setfield
|
|
||||||
description: Prepares external tiddlers for use
|
|
||||||
|
|
||||||
//Note that this command is experimental and may change or be replaced before being finalised//
|
|
||||||
|
|
||||||
Sets the specified field of a group of tiddlers to the result of wikifying a template tiddler with the `currentTiddler` variable set to the tiddler.
|
|
||||||
|
|
||||||
```
|
|
||||||
--setfield <filter> <fieldname> <templatetitle> <rendertype>
|
|
||||||
```
|
|
||||||
|
|
||||||
The parameters are:
|
|
||||||
|
|
||||||
* ''filter'' - filter identifying the tiddlers to be affected
|
|
||||||
* ''fieldname'' - the field to modify (defaults to "text")
|
|
||||||
* ''templatetitle'' - the tiddler to wikify into the specified field. If blank or missing then the specified field is deleted
|
|
||||||
* ''type'' - the text type to render (defaults to "text/plain"; "text/html" can be used to include HTML tags)
|
|
||||||
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
title: $:/language/Help/verbose
|
|
||||||
description: Triggers verbose output mode
|
|
||||||
|
|
||||||
Triggers verbose output, useful for debugging
|
|
||||||
|
|
||||||
```
|
|
||||||
--verbose
|
|
||||||
```
|
|
||||||
@ -1,8 +0,0 @@
|
|||||||
title: $:/language/Help/version
|
|
||||||
description: Displays the version number of TiddlyWiki
|
|
||||||
|
|
||||||
Displays the version number of TiddlyWiki.
|
|
||||||
|
|
||||||
```
|
|
||||||
--version
|
|
||||||
```
|
|
||||||
Loading…
Reference in New Issue
Block a user