Clarified documentation

pull/4/head
Adrian Perez 2007-09-11 12:28:26 +02:00
parent a29f1d861e
commit 549d00bdae
2 changed files with 6 additions and 29 deletions

View File

@ -9,12 +9,16 @@ How to modify the template
========================== ==========================
The template is in the ``template.html`` file. Note that comment markers are 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 which gets ultimately included in the compiled object code. Comment markers
have the ``<!-- var identifier -->`` format. Here ``identifier`` must be have the ``<!-- var identifier -->`` format. Here ``identifier`` must be
a valid C identifier. All the text following the marker until the next a valid C identifier. All the text following the marker until the next
marker will be flattened into a C string. 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 Regenerating the C header
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
You will need Awk. I hope any decent implementation will do, but the GNU one 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 $ awk -f template.awk template.html > template.h
Template identifier order
~~~~~~~~~~~~~~~~~~~~~~~~~
t01_head1
Outputs the HTML header and must end with something like
``<title>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 ``</title>`` tag
opened in the previous template and add further output until the closing
``</head>`` tag.
t03_body1
-
t04_body2
-
t05_list1
-
t06_list2
-
t07_body3
-
t08_body4
-
t09_foot1
-
.. vim: spell spelllang=en expandtab .. vim: spell spelllang=en expandtab

View File

@ -97,7 +97,7 @@ fancyindex_readme
:Description: :Description:
Specifies which file should be inserted alongside with directory listings. Specifies which file should be inserted alongside with directory listings.
If set to an empty string, no extra textual content is included. See 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. file may be included.
fancyindex_readme_mode fancyindex_readme_mode