diff --git a/HACKING.rst b/HACKING.rst index 055eae4..e90b690 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -9,12 +9,16 @@ How to modify the template ========================== The template is in the ``template.html`` file. Note that comment markers are -used to control how the ``split-template`` Awk script generates the C header +used to control how the ``template.awk`` Awk script generates the C header which gets ultimately included in the compiled object code. Comment markers have the ```` format. Here ``identifier`` must be a valid C identifier. All the text following the marker until the next marker will be flattened into a C string. +If the identifier is ``NONE`` (capitalized) the text from that marker up to +the next marker will be discarded. + + Regenerating the C header ~~~~~~~~~~~~~~~~~~~~~~~~~ You will need Awk. I hope any decent implementation will do, but the GNU one @@ -22,32 +26,5 @@ is known to work flawlessly. Just do:: $ awk -f template.awk template.html > template.h - -Template identifier order -~~~~~~~~~~~~~~~~~~~~~~~~~ -t01_head1 - Outputs the HTML header and must end with something like - ``Index of``, because the code inserts the path of the URI just - after this piece. -t02_head2 - Outputs the rest of the header, usually will close the ```` tag - opened in the previous template and add further output until the closing - ```` tag. -t03_body1 - - -t04_body2 - - -t05_list1 - - -t06_list2 - - -t07_body3 - - -t08_body4 - - -t09_foot1 - - - - .. vim: spell spelllang=en expandtab diff --git a/README.rst b/README.rst index b4b98f7..3dc090a 100644 --- a/README.rst +++ b/README.rst @@ -97,7 +97,7 @@ fancyindex_readme :Description: Specifies which file should be inserted alongside with directory listings. If set to an empty string, no extra textual content is included. See - `fancyindex_readme_options`_ in order to learn more about how the readme + `fancyindex_readme_mode`_ in order to learn more about how the readme file may be included. fancyindex_readme_mode