From f740468a40984ad6e500e858651915d3c080e8de Mon Sep 17 00:00:00 2001 From: Jeffrey Armstrong Date: Sat, 4 Feb 2017 12:25:46 -0500 Subject: Added support for generatingan RSS feed from posts. Added config file for blogs. --- readme.txt | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) (limited to 'readme.txt') diff --git a/readme.txt b/readme.txt index e1c5b59..af97cb3 100644 --- a/readme.txt +++ b/readme.txt @@ -65,11 +65,36 @@ POSTFTR.HTM HTML code to be appended to the page and post processed HTML fragments, including template tags + + CONFIG.INI Simple configuration file that provides a blog + name, description, and base URL in addition to + any other user-defined variables for the + template engine. Text files containing page and post Textile must end in a ".TXT" extension. While pages can be named anything, posts must be encoded as a date in the format: YYYYMMDD.TXT + Blog Configuration File + ----------------------- + + The file CONFIG.INI is used to set up variables used by the template + engine and the RSS feed generator. The configuration file is a simple + file containing pairs: + + label=value + + Lines that are blank or start with a "#" sign are ignored. + + The RSS generator code requires the following values to be defined: + + * blog - the name of the blog + * description - a brief, one-line description + * url - the base URL from where the blog is served + + These values are also available in the templates, and may be included + in the POSTHDR.HTM and POSTFTR.HTM files, as described later. + Writing Posts and Pages ----------------------- @@ -112,7 +137,17 @@ * postlist - A valid HTML link to a page with a list of all posts * date - The date of the current post (blank on pages) * pages - An unordered HTML list of links to all static pages + + Additionally, the following values are available from the CONFIG.INI + file: + * blog - the name of the blog + * description - a brief, one-line description + * url - the base URL from where the blog is served + + The user may define more variables for use in the template within the + CONFIG.INI file. + The template engine does not handle conditionals or any unlisted variables. Unlisted variables can cause the template engine to lock up. The template variables are only filled in for the HTML header -- cgit v1.2.3