mkdoc

Introduction

The mkdoc tool is used to convert a simple markup language (similar to that used by the snipsnap wiki/blog system) to style-sheet driven html output.

The mkdoc tool walks a source directory tree, mirroring the content into a destination directory tree. Files starting with '#', '.', and files ending with '.inc', or '~' are ignored. Files ending with '.bml' are converted into '.html' files in the destination tree. Any other content is simply copied.

Command line options

    -s <dirname>       Source Directory
    -d <dirname>       Destination Directory
    -D <name>=<value>  Property Setting
    -f                 Force (convert even if destination is newer)
    -v                 Verbose

BML Markup

Most text is passed through straight to the produced HTML document. HTML markup should be avoided whenever possible. The mkdoc tool knows about 'macros' which are enclosed by curly braces {...}

{document:<name>} ... {/document}   
{section:<name>} ... {/section}     
{part:<name>} ... {/part}           
{p}                                 Paragraph Marker
{link:<url>:<name>}                 Named link to a URL
{class:<classname>}                 Link to javadoc
{code} ... {/code}   Source Code

code macros

The {code} macro is a little different than the others. No other macros are honored within it. Also, the {/code} macro end tag must be on the start of a new line to be recognized.