mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-02-03 20:59:09 +00:00
Code Issues Releases Wiki Activity

Enhance rendertiddler command with support for additional variable

Browse Source 
Passing an arbitrary variable allows us to e.g. reuse the export
filters as shown in the example
This commit is contained in:
Jermolene 2017-02-18 13:17:44 +00:00
parent 91b341e8e0
commit 6f93ce6ea7
2 changed files with 17 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
core/language/en-GB/Help/rendertiddler.tid
View File

@ -1,12 +1,22 @@
title: $:/language/Help/rendertiddler title: $:/language/Help/rendertiddler
description: Render an individual tiddler as a specified ContentType description: Render an individual tiddler as a specified ContentType
Render an individual tiddler as a specified ContentType, defaulting to `text/html` and save it to the specified filename. Optionally a template can be specified, in which case the template tiddler is rendered with the "currentTiddler" variable set to the tiddler that is being rendered (the first parameter value). Render an individual tiddler as a specified ContentType, defaulting to `text/html` and save it to the specified filename.
Optionally the title of a template tiddler can be specified, in which case the template tiddler is rendered with the "currentTiddler" variable set to the tiddler that is being rendered (the first parameter value).
A name and value for an additional variable may optionally also be specified.
``` ```
--rendertiddler <title> <filename> [<type>] [<template>] --rendertiddler <title> <filename> [<type>] [<template>] [<name>] [<value>]
``` ```
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. 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. Any missing directories in the path to the filename are automatically created.
For example, the following command saves all tiddlers matching the filter `[tag[done]]` to a JSON file titled `output.json` by employing the core template `$:/core/templates/exporters/JsonFile`.
```
--rendertiddler "$:/core/templates/exporters/JsonFile" output.json text/plain "" exportFilter "[tag[done]]"
```

5
core/modules/commands/rendertiddler.js
View File

@ -34,12 +34,17 @@ Command.prototype.execute = function() {
filename = path.resolve(this.commander.outputPath,this.params[1]), filename = path.resolve(this.commander.outputPath,this.params[1]),
type = this.params[2] || "text/html", type = this.params[2] || "text/html",
template = this.params[3], template = this.params[3],
name = this.params[4],
value = this.params[5],
variables = {}; variables = {};
$tw.utils.createFileDirectories(filename); $tw.utils.createFileDirectories(filename);
if(template) { if(template) {
variables.currentTiddler = title; variables.currentTiddler = title;
title = template; title = template;
} }
if(name && value) {
variables[name] = value;
}
fs.writeFile(filename,this.commander.wiki.renderTiddler(type,title,{variables: variables}),"utf8",function(err) { fs.writeFile(filename,this.commander.wiki.renderTiddler(type,title,{variables: variables}),"utf8",function(err) {
self.callback(err); self.callback(err);
}); });