Minimalist Online Docmentation

File and directory names

One of the features of MOD is that it is self indexing. It will discover the structure of your documents, and generate an index them of for you (probably more like a table of contents than an index. Oh well). When you add, rename, or remove a MOD file from the tree, the next invocation of mod2html will update the destination appropriately.

Since MOD uses the file and directory names of your source tree to create the index of your documents, it makes sense to organize your topics logically in well-named files and directories. mod2html will convert underscores to spaces, and capitalize the first letter of each word. So, on unix systems, the most convenient naming convention for your files and directories is to use all lowercase letters and underscores to separate words. This method is fast to type, and appears nicely in the resulting html.

Files and directories will be ordered alphabetically in the index, within their own level.

File extensions

The usual file extension for files in a MOD tree is ".mod". This tells the interpreter that the file contains MOD tags to be indexed and converted to html, and that it should format the document by adding <p> tags to blank lines.

If you have files that contain formatted text, such as bulleted lists or text graphs, you can have mod respect the existing formatting by giving them the extension ".txt" instead. The interpreter will still index the page and insert it into the html template, but it won't look for mod tags or perform any processing on it. When it's inserted into the html template, it will be surrounded by <pre> </pre> html tags to tell the browser to use a non-proportional font and preserve the spacing in the document.