Sections
|
<( Files and Directories )>
DML2 operates by reading in source files (it is customary for DML2 source files to have the .dml2 extension). DML2 source files (I'll be calling them DML2 files) may specify custom objects and tags that are used to output files. A single DML2 file may output any number (even zero) of files.
You should place all of your DML2 source files into a directory (usually named dml2). Files will be output to the directory that contains your dml2 directory. (This means that you don't need to prefix your file names with ../ even though they are being written to the parent directory). You can override this with the -o parameter (so that the files will be output to whatever directory you specify).
| ! | Note:
If you are running Windows, the standard directory delimiter is a backslash (\). However, in order for DML2 to function correctly, you must use only forward slash (e.g. docs/file.html). If you're a web developer, you should already be used to this syntax.
|
Inside of a DML2 file, every line is interpreted as a DML2 statement. If you would like to include a comment inside of your source file, just start the line with two slashes (//) or a pound sign (#). You may also find it helpful to use C-style indenting inside of DML2 files (this is the style that will be used in this documentation.
If you find that you are having trouble with learning DML2, try taking a look in the docs/dml2 directory where you unpacked DML2 to. This directory contains all of the source that was used to generate the documentation you're currently reading.
|
|