saait.1: improve wording, thanks biniar! - 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 d4a58cdd0964fdd4fee0e036bfbb06bd7e6f9c43
(DIR) parent 4d966052a22a4b5ebb9c0cc3c5a380482330014e
(HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Fri, 21 Feb 2020 15:18:00 +0100
saait.1: improve wording, thanks biniar!
Diffstat:
M saait.1 | 25 +++++++++++++------------
1 file changed, 13 insertions(+), 12 deletions(-)
---
(DIR) diff --git a/saait.1 b/saait.1
@@ -22,15 +22,16 @@ The options are as follows:
.Bl -tag -width Ds
.It Fl c Ar configfile
The global configuration file, the default is "config.cfg".
-Each page configuration file inherits the values from this file.
-The values can be overwritten per page.
+Each page configuration file inherits variables from this file.
+These variables can be overwritten per page.
.It Fl o Ar outputdir
The output directory, the default is "output".
.It Fl t Ar templatesdir
The templates directory, the default is "templates".
.El
.Sh DIRECTORY AND FILE STRUCTURE
-A recommended directory structure for pages, but the names can be anything:
+A recommended directory structure for pages, although the names can be
+anything:
.Bl -tag -width Ds -compact
.It pages/001-page.cfg
.It pages/001-page.html
@@ -38,7 +39,7 @@ A recommended directory structure for pages, but the names can be anything:
.It pages/002-page.html
.El
.Pp
-The directory and files structure for templates must be:
+The directory and file structure for templates must be:
.Bl -tag -width Ds -compact
.It templates/<templatename>/header.ext
.It templates/<templatename>/item.ext
@@ -57,13 +58,13 @@ Footer block.
.El
.Pp
The files are saved as output/<templatename>, for example
-templates/atom.xml/* will become: output/atom.xml .
-If a file for a template block does not exist then it is treated as if it was
-an empty file.
+templates/atom.xml/* will become: output/atom.xml.
+If a template block file does not exist then it is treated as if it was
+empty.
.Pp
-Hidden template directories (starting with ".") are ignored.
+Template directories starting with a dot (".") are ignored.
.Pp
-The templatename "page" is special and will be used per page.
+The "page" templatename is special and will be used per page.
.Sh CONFIG FILE
A config file has a simple key=value configuration syntax, for example:
.Bd -literal
@@ -75,7 +76,7 @@ created = 2009-04-12
updated = 2009-04-14
.Ed
.Pp
-The following variables names are special with their respective default values:
+The following variable names are special with their respective defaults:
.Bl -tag -width Ds
.It contentfile
Path to the input content filename, by default this is the path of
@@ -156,8 +157,8 @@ templates/index.html/header.html
.El
.It
Create any new pages in the pages 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
+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: