| << Prev | - Up - |
The format of a database entry was chosen for simplicity and familiarity. It looks exactly like an email message: it begins with a sequence of headers. It may also have a body separated from the headers by 1 or more empty lines.
There can be no empty line in the header part! The first empty line is interpreted as the separation between headers and body. However, one header may extend over several lines provided none is empty and all but the 1st one begin with a space or tab character. This is the usual convention for email headers too!
You can include arbitrary headers in an entry. However, only certain headers are meaningful to the MOGUL Librarian. Below we take a look at each of the 3 types of database entries and describe for each one the meaningful headers and their interpretation.
Header type
Only one header is mandatory for all database entries, namely the type header. It is required in order to identify the type of the entry.
Header id
It is not necessary to provide an id header since an entry can only be reached via a ``section'' entry, which already gives both its id and its url. However doing so is good practice. It is also safer: the MOGUL Librarian performs a sanity check; if a header id is provided, it must contain the expected id otherwise an error is reported (and eventually will find its way back to you via automated email).
| << Prev | - Up - |