Once you've got it "looking pretty", please consider contributing that code to awk.info,
so our code library can grow. To do so, either email mail@awk.info
with the URL of your pretty code or zip up the files and email them across.
HTML-based Commenting Conventions
The first paragraph of the file will be ignored. Use this first para
for copyright notices or comments about down-in-the weeds trivia. Note: the
first para ends with one blank line.
The next paragraph should start with
#.H1 <join>Title</join>
The code could should be topped and tailed as follows:
#<pre>
code
#</pre>
All other comment lines should start with a single "#" at front-of-line.
These comment characters will be stripped away by the awk.info renderer.
Awk.info's renderer adopts the following html shorthand. If a line starts with
#.WORD other words
this this is replaced with
<WORD> other words</WORD>
If no other words follow #.WORD then the line becomes just <WORD>
Awk.info's renderer supports a few HTML extensions:
#.IN path includes a file found in the LAWKER repositoriy at some path inside the trunk.
#.CODE path includes the contents
of path, wrapped in <pre> tags, and prefixed by the path.
#.BODY path is the same as #.CODE but it
skips the first paragraph (this is useful when the first paragraph includes tedious details
you want to hite from the user).
Note that, for #.IN, #.CODE, #.BODY, the path must appear after a single space.
That's it. Now you can pretty print your code on the web just be adding
a little html in the comments.
