$Cambridge: exim/doc/doc-docbook/AdMarkup.txt,v 1.2 2005/11/10 12:30:13 ph10 Exp $ Asciidoc markup used in the Exim documentation ---------------------------------------------- This file contains a summary of the AsciiDoc markup that is used in the source files of the Exim documentation. The source files are in plain text that can be edited by any text editor. They are converted by the AsciiDoc application into DocBook XML for subsequent processing into the various output formats. This markup requires AsciiDoc release 6.0.3 or later. The advantage of using AsciiDoc format as a "back end" is that is uses relatively simple markup in the majority of the text, making it easier to read and edit. The disadvantage is that it is tricky to deal with complicated formatting - though that is probably true of any markup language - and there are a few gotchas. The Exim documentation uses the default AsciiDoc markup with some additions. I have created a special AsciiDoc configuration file for use with the Exim documentation. You must use this configuration if you want to get sensible results, SPECIAL CHARACTERS When typing paragraphs of text, the following character sequences are recognized as markup if they occur surrounding a "word phrase" within a paragraph. In the list below, ... represents the text that is enclosed. '...' single quotes italic: used for email addresses, domains, local parts, header names, user names *...* asterisks bold used for things like "*Note:*" `...` backticks monospaced text used for literal quoting $...$ dollar Exim variable maps to XML with leading $ %...% percent Exim option, command line option maps to XML