mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2025-04-06 18:56:56 +00:00
deleted since changes were mainly on styles, like em or en dash instead of regular dash
This commit is contained in:
techmagus
parent
653f3c22cf
commit
973b83d04b
@ -1,8 +0,0 @@
|
||||
title: $:/language/Help/clearpassword
|
||||
description: Clear a password for subsequent cryptography operations
|
||||
|
||||
Clear the password for subsequent cryptography operations
|
||||
|
||||
```
|
||||
--clearpassword
|
||||
```
|
||||
@ -1,38 +0,0 @@
|
||||
title: $:/language/Help/fetch
|
||||
description: Fetch tiddlers from wiki by URL
|
||||
|
||||
Fetch one or more files over HTTP/HTTPS, and import the tiddlers matching a filter, optionally transforming the incoming titles.
|
||||
|
||||
```
|
||||
--fetch file <url> <import-filter> <transform-filter>
|
||||
--fetch files <url-filter> <import-filter> <transform-filter>
|
||||
--fetch raw-file <url> <transform-filter>
|
||||
--fetch raw-files <url-filter> <transform-filter>
|
||||
```
|
||||
|
||||
The "file" and "files" variants fetch the specified files and attempt to import the tiddlers within them (the same processing as if the files were dragged into the browser window). The "raw-file" and "raw-files" variants fetch the specified files and then store the raw file data in tiddlers, without applying the import logic.
|
||||
|
||||
With the "file" and "raw-file" variants only a single file is fetched and the first parameter is the URL of the file to read.
|
||||
|
||||
With the "files" and "raw-files" variants, multiple files are fetched and the first parameter is a filter yielding a list of URLs of the files to read. For example, given a set of tiddlers tagged "remote-server" that have a field "url" the filter `[tag[remote-server]get[url]]` will retrieve all the available URLs.
|
||||
|
||||
For the "file" and "files" variants, the `<import-filter>` parameter specifies a filter determining which tiddlers are imported. It defaults to `[all[tiddlers]]` if not provided.
|
||||
|
||||
For all variants, the `<transform-filter>` parameter specifies an optional filter that transforms the titles of the imported tiddlers. For example, `[addprefix[$:/myimports/]]` would add the prefix `$:/myimports/` to each title.
|
||||
|
||||
Preceding the `--fetch` command with `--verbose` will output progress information during the import.
|
||||
|
||||
Note that TiddlyWiki will not fetch an older version of an already loaded plugin.
|
||||
|
||||
The following example retrieves all the non–system tiddlers from https://tiddlywiki.com and saves them to a JSON file:
|
||||
|
||||
```
|
||||
tiddlywiki --verbose --fetch file "https://tiddlywiki.com/" "[!is[system]]" "" --rendertiddler "$:/core/templates/exporters/JsonFile" output.json text/plain "" exportFilter "[!is[system]]"
|
||||
```
|
||||
|
||||
The following example retrieves the "favicon" file from tiddlywiki.com and saves it in a file called "output.ico". Note that the intermediate tiddler "Icon Tiddler" is quoted in the "--fetch" command because it is being used as a transformation filter to replace the default title, while there are no quotes for the "--savetiddler" command because it is being used directly as a title.
|
||||
|
||||
```
|
||||
tiddlywiki --verbose --fetch raw-file "https://tiddlywiki.com/favicon.ico" "[[Icon Tiddler]]" --savetiddler "Icon Tiddler" output.ico
|
||||
```
|
||||
|
||||
@ -1,23 +0,0 @@
|
||||
title: $:/language/Help/init
|
||||
description: Initialize a new wiki folder
|
||||
|
||||
Initialize 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 initialized 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,35 +0,0 @@
|
||||
title: $:/language/Help/listen
|
||||
description: Provides an HTTP server interface to TiddlyWiki
|
||||
|
||||
Serves a wiki over HTTP.
|
||||
|
||||
The listen command uses NamedCommandParameters:
|
||||
|
||||
```
|
||||
--listen [<name>=<value>]...
|
||||
```
|
||||
|
||||
All parameters are optional with safe defaults, and can be specified in any order. The recognized parameters are:
|
||||
|
||||
* ''host'': optional hostname to serve from (defaults to "127.0.0.1" aka "localhost")
|
||||
* ''path-prefix'': optional prefix for paths
|
||||
* ''port'': port number on which to listen; non–numeric values are interpreted as a system environment variable from which the port number is extracted (defaults to "8080")
|
||||
* ''credentials'': pathname of credentials CSV file (relative to wiki folder)
|
||||
* ''anon-username'': the username for signing edits for anonymous users
|
||||
* ''username'': optional username for basic authentication
|
||||
* ''password'': optional password for basic authentication
|
||||
* ''authenticated-user-header'': optional name of request header to be used for trusted authentication.
|
||||
* ''readers'': comma-separated list of principals allowed to read from this wiki
|
||||
* ''writers'': comma-separated list of principals allowed to write to this wiki
|
||||
* ''csrf-disable'': set to "yes" to disable CSRF checks (defaults to "no")
|
||||
* ''root-tiddler'': the tiddler to serve at the root (defaults to "$:/core/save/all")
|
||||
* ''root-render-type'': the content type to which the root tiddler should be rendered (defaults to "text/plain")
|
||||
* ''root-serve-type'': the content type with which the root tiddler should be served (defaults to "text/html")
|
||||
* ''tls-cert'': pathname of TLS certificate file (relative to wiki folder)
|
||||
* ''tls-key'': pathname of TLS key file (relative to wiki folder)
|
||||
* ''debug-level'': optional debug level; set to "debug" to view request details (defaults to "none")
|
||||
* ''gzip'': set to "yes" to enable gzip compression for some HTTP endpoints (defaults to "no")
|
||||
* ''use-browser-cache'': set to "yes" to allow the browser to cache responses to save bandwidth (defaults to "no")
|
||||
|
||||
For information on opening up your instance to the entire local network, and possible security concerns, see the WebServer tiddler at TiddlyWiki.com.
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
title: $:/language/Help/password
|
||||
description: Set a password for subsequent cryptography operations
|
||||
|
||||
Set a password for subsequent cryptography operations
|
||||
|
||||
```
|
||||
--password <password>
|
||||
```
|
||||
|
||||
''Note'': This should not be used for serving TiddlyWiki with password protection. Instead, see the password option under the [[ServerCommand]].
|
||||
@ -1,35 +0,0 @@
|
||||
title: $:/language/Help/render
|
||||
description: Renders individual tiddlers to files
|
||||
|
||||
Render individual tiddlers identified by a filter and save the results to the specified files.
|
||||
|
||||
Optionally, the title of a template tiddler can be specified. In this case, instead of directly rendering each tiddler, the template tiddler is rendered with the "currentTiddler" variable set to the title of the tiddler that is being rendered.
|
||||
|
||||
A name and value for an additional variable may optionally also be specified.
|
||||
|
||||
```
|
||||
--render <tiddler-filter> [<filename-filter>] [<render-type>] [<template>] [ [<name>] [<value>] ]*
|
||||
```
|
||||
|
||||
* ''tiddler-filter'': A filter identifying the tiddler(s) to be rendered
|
||||
* ''filename-filter'': Optional filter transforming tiddler titles into pathnames. If omitted, defaults to `[is[tiddler]addsuffix[.html]]`, which uses the unchanged tiddler title as the filename
|
||||
* ''render-type'': Optional render type: `text/html` (the default) returns the full HTML text and `text/plain` just returns the text content (i.e. it ignores HTML tags and other unprintable material)
|
||||
* ''template'': Optional template through which each tiddler is rendered
|
||||
* ''name'': Name of optional variables
|
||||
* ''value'': Value of optional variables
|
||||
|
||||
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.
|
||||
|
||||
Notes:
|
||||
|
||||
* The output directory is not cleared of any existing files
|
||||
* Any missing directories in the path to the filename are automatically created.
|
||||
* When referring to a tiddler with spaces in its title, take care to use both the quotes required by your shell and also TiddlyWiki's double square brackets: `--render "[[Motovun Jack.jpg]]"`
|
||||
* The filename filter is evaluated with the selected items being set to the title of the tiddler currently being rendered, allowing the title to be used as the basis for computing the filename. For example `[encodeuricomponent[]addprefix[static/]]` applies URI encoding to each title, and then adds the prefix `static/`
|
||||
* Multiple ''name''/''value'' pairs can be used to pass more than one variable
|
||||
* The `--render` command is a more flexible replacement for both the `--rendertiddler` and `--rendertiddlers` commands, which are deprecated
|
||||
|
||||
Examples:
|
||||
|
||||
* `--render '[!is[system]]' '[encodeuricomponent[]addprefix[tiddlers/]addsuffix[.html]]'` ﹘ renders all non–system tiddlers as files in the subdirectory "tiddlers" with URL-encoded titles and the extension HTML
|
||||
* `--render '.' 'tiddlers.json' 'text/plain' '$:/core/templates/exporters/JsonFile' 'exportFilter' '[tag[HelloThere]]'` ﹘ renders the tiddlers tagged "HelloThere" to a JSON file named "tiddlers.json"
|
||||
@ -1,25 +0,0 @@
|
||||
title: $:/language/Help/save
|
||||
description: Saves individual raw tiddlers to files
|
||||
|
||||
Saves individual tiddlers identified by a filter in their raw text or binary format to the specified files.
|
||||
|
||||
```
|
||||
--save <tiddler-filter> <filename-filter>
|
||||
```
|
||||
|
||||
* ''tiddler-filter'': A filter identifying the tiddler(s) to be saved
|
||||
* ''filename-filter'': Optional filter transforming tiddler titles into pathnames. If omitted, defaults to `[is[tiddler]]`, which uses the unchanged tiddler title as the 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.
|
||||
|
||||
Notes:
|
||||
|
||||
* The output directory is not cleared of any existing files
|
||||
* Any missing directories in the path to the filename are automatically created.
|
||||
* When saving a tiddler with spaces in its title, take care to use both the quotes required by your shell and also TiddlyWiki's double square brackets: `--save "[[Motovun Jack.jpg]]"`
|
||||
* The filename filter is evaluated with the selected items being set to the title of the tiddler currently being saved, allowing the title to be used as the basis for computing the filename. For example `[encodeuricomponent[]addprefix[static/]]` applies URI encoding to each title, and then adds the prefix `static/`
|
||||
* The `--save` command is a more flexible replacement for both the `--savetiddler` and `--savetiddlers` commands, which are deprecated
|
||||
|
||||
Examples:
|
||||
|
||||
* `--save "[!is[system]is[image]]" "[encodeuricomponent[]addprefix[tiddlers/]]"` ﹘ saves all non–system image tiddlers as files in the subdirectory "tiddlers" with URL-encoded titles
|
||||
@ -1,34 +0,0 @@
|
||||
title: $:/language/Help/savewikifolder
|
||||
description: Saves a wiki to a new wiki folder
|
||||
|
||||
<<.from-version "5.1.20">> Saves the current wiki as a wiki folder, including tiddlers, plugins and configuration:
|
||||
|
||||
```
|
||||
--savewikifolder <wikifolderpath> [<filter>] [ [<name>=<value>] ]*
|
||||
```
|
||||
|
||||
* The target wiki folder must be empty or non–existent
|
||||
* The filter specifies which tiddlers should be included. It is optional, defaulting to `[all[tiddlers]]`
|
||||
* Plugins from the official plugin library are replaced with references to those plugins in the `tiddlywiki.info` file
|
||||
* Custom plugins are unpacked into their own folder
|
||||
|
||||
The following options are supported:
|
||||
|
||||
* ''filter'': a filter expression that defines the tiddlers to include in the output.
|
||||
* ''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 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:
|
||||
|
||||
```
|
||||
tiddlywiki --load ./mywiki.html --savewikifolder ./mywikifolder
|
||||
```
|
||||
|
||||
Save the plugin to the tiddlers directory of the target wiki folder:
|
||||
|
||||
```
|
||||
tiddlywiki --load ./mywiki.html --savewikifolder ./mywikifolder explodePlugins=no
|
||||
```
|
||||
@ -1,43 +0,0 @@
|
||||
title: $:/language/Help/server
|
||||
description: (deprecated: see 'listen' command) Provides an HTTP server interface to TiddlyWiki
|
||||
|
||||
Legacy command to serve a wiki over HTTP.
|
||||
|
||||
```
|
||||
--server <port> <root-tiddler> <root-render-type> <root-serve-type> <username> <password> <host> <path-prefix> <debug-level>
|
||||
```
|
||||
|
||||
The parameters are:
|
||||
|
||||
* ''port'': port number on which to listen; non–numeric values are interpreted as a system environment variable from which the port number is extracted (defaults to "8080")
|
||||
* ''root-tiddler'': the tiddler to serve at the root (defaults to "$:/core/save/all")
|
||||
* ''root-render-type'': the content type to which the root tiddler should be rendered (defaults to "text/plain")
|
||||
* ''root-serve-type'': 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")
|
||||
* ''path-prefix'': optional prefix for paths
|
||||
* ''debug-level'': optional debug level; set to "debug" to view request details (defaults to "none")
|
||||
|
||||
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 should only be used on a trusted network or over HTTPS.
|
||||
|
||||
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
|
||||
```
|
||||
|
||||
Using an address like this exposes your system to the local network. For information on opening up your instance to the entire local network, and possible security concerns, see the WebServer tiddler at TiddlyWiki.com.
|
||||
|
||||
To run multiple TiddlyWiki servers at the same time you'll need to put each one on a different port. It can be useful to use an environment variable to pass the port number to the Node.js process. This example references an environment variable called "MY_PORT_NUMBER":
|
||||
|
||||
```
|
||||
--server MY_PORT_NUMBER $:/core/save/all text/plain text/html MyUserName passw0rd
|
||||
```
|
||||
@ -1,17 +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 finalized//
|
||||
|
||||
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
|
||||
* ''rendertype'': the text type to render (defaults to "text/plain"; "text/html" can be used to include HTML tags)
|
||||
Loading…
x
Reference in New Issue
Block a user