saait.1: improvements - saait - the most boring static page generator
(HTM) git clone git://git.codemadness.org/saait
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 53544bea37c0b6dab9050d9aedf64a0027424fce
(DIR) parent d641547794fb688746b5a12bc6acc1ce36b7c33f
(HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Sat, 15 Feb 2020 00:12:34 +0100
saait.1: improvements
- don't mention .cfg files explicitly, except in examples, because the last
extension is used for any path (so .ini or so would work too).
- document white-space rules for key = value assignment.
- don't mention the htmlfile exception in the example/usage steps.
- minor white-space tweak.
Diffstat:
M saait.1 | 41 ++++++++++++++-----------------
1 file changed, 19 insertions(+), 22 deletions(-)
---
(DIR) diff --git a/saait.1 b/saait.1
@@ -1,4 +1,4 @@
-.Dd January 7, 2020
+.Dd February 16, 2020
.Dt SAAIT 1
.Os
.Sh NAME
@@ -16,7 +16,7 @@ writes HTML pages to the output directory.
.Pp
The arguments
.Ar pages
-are page .cfg files, which are processed in the given order.
+are page config files, which are processed in the given order.
.Pp
The options are as follows:
.Bl -tag -width Ds
@@ -64,15 +64,15 @@ be the same result as if it was an empty file.
Hidden template directories (starting with ".") are ignored.
.Pp
The templatename "page" is special and will be used per page.
-.Sh CFG FILE
-A .cfg file has a simple key=value configuration syntax, for example:
+.Sh CONFIG FILE
+A config file has a simple key=value configuration syntax, for example:
.Bd -literal
-# an example page.
-filename=example.html
-title=Example page
-description=This is an example page
-created=2009-04-12
-updated=2009-04-14
+# this is a comment line.
+filename = example.html
+title = Example page
+description = This is an example page
+created = 2009-04-12
+updated = 2009-04-14
.Ed
.Pp
The following variables names are special with their respective default values:
@@ -83,17 +83,15 @@ The path is relative to the
.Ar outputdir .
.It htmlfile
Path to the input HTML content filename, by default this is the path of
-the .cfg file with .cfg replaced to .html.
-.It index
-If set to 0 then this page is not processed for templates except for the
-"page" template.
-This can be used to hide pages from templates such as index.html or from
-listing in an Atom feed.
+the config file with the last extension replaced to .html.
.El
.Pp
A line starting with # is ignored and can be used as a comment.
+.Pp
+TABs and spaces before and after a variable name are ignored.
+TABs and spaces before a value are ignored.
.Sh TEMPLATE SYNTAX
-The variables set in a .cfg file can be used inside templates, but not pages.
+The variables set in a config file can be used inside templates, but not pages.
.Pp
The possible operators for variables are:
.Bl -tag -width Ds
@@ -152,9 +150,9 @@ templates/index.html/header.html
.El
.It
Create any new pages in the pages directory.
-For each *.cfg file there has to be a corresponding *.html file.
-Optionally they can be overridden with the special variable "htmlfile".
-See the copied example pages in this directory.
+For each config file there has to be a corresponding html file.
+By default this html file has the path of the config file, but with the last
+extension (".cfg" in this case) replaced to ".html".
.It
Create an output directory:
.Bd -literal
@@ -190,8 +188,7 @@ run
after that as usual.
.Pp
In this example it uses smu for the Markdown processor, available at:
-.Lk https://github.com/Gottox/smu
-:
+.Lk https://github.com/Gottox/smu :
.Bd -literal
cd pages
for f in *.md; do