diff options
| -rw-r--r-- | skaldpress.1 | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/skaldpress.1 b/skaldpress.1 index 718557a..dfa8ea8 100644 --- a/skaldpress.1 +++ b/skaldpress.1 @@ -19,6 +19,36 @@ Will output all documents which had the specified tag, using the specified templ If a field to sort by is specified, it will output ascending based on that field, or reversed if a fourth argument \fBreversed\fR is specified. +.PP +All input files can have a metadata-block at the beginning. +Any keys will be defined as macros as \fBMETADATA_<key>\fR. +There are a few special keys which has a specific effect: + +.IP "\fBskip_smp\fR" +If this is \fItrue\fR, macro processing will be skipped for the file, and it will be +included verbatim. + +.IP "\fBskip_build\fR" +If this is \fItrue\fR, the file will not be written to build-dir, but it will be compiled and available for macros like \fBall_tagged_by\fR. + +.IP "\fBtags\fR" +This is a list, and all files with entries here will be registered during the first compilation round. +During the second compilation, macros like \fBall_tagged_by\fR will then +make all files with the relevant content available and compile it in. + +.IP "\fBtarget_filename\fR" +By default, a file will have the same name in the \fIoutput\fR-directory (unless a template has a different extension). +This overrides the output-filename, but it keeps the file in the same directory, and it will not affect the extension. + +.IP "\fBtemplate\fR" +If specified, the file will be compiled using a template. +In the template, all \fBMETADATA_<key>\fR macros will be available, +additionally templates can use the \fBCONTENT\fR-macro to get the expanded content of the file. +This is recursive, meaning that templates can use other templates, with their own metadata-block, +since it is recursive, any metadata in templates will overwrite any metadata from their children, +but will keep metadata that is not overwritten. +This means templates can add additional context. + .SH OPTIONS .IP "\fB-o, --out, --output\fR \fIpath\fR Specifies the directory to output the compiled files to, defaults to \fIbuild\fR. |