Natural Docs Version 0.9 |
NDMarkupA markup format used by the parser, both internally and in NaturalDocs::Parser::ParsedTopic objects. Text formatted in NDMarkup will only have the tags documented below. Summary
Top-Level TagsAll content will be surrounded by one of the top-level tags. These tags will not appear within each other.
List Item TagsThese tags will only appear within their respective lists.
Text TagsThese tags will only appear in paragraphs, headings, or description list descriptions.
General Tag PropertiesSince the tags are generated, they will always have the following properties, which will make pattern matching much easier.
So, for example, you can match symbol links with /<link>([^<]+)<\/link>/ and $1 will be the symbol. No surprises or gotchas. No need for sophisticated parsing routines. Remember that for symbol definitions, the text should appear as is, but internally (such as for the anchor) they need to be passed through NaturalDocs::SymbolTable::Defines() so that the output file is just as tolerant as NaturalDocs::SymbolTable. NaturalDocs:: NDMarkupA package of support functions for dealing with NDMarkup. Usage and DependenciesThe package doesn’t depend on any Natural Docs packages and is ready to use right away. ConvertAmpChars
Substitutes certain characters with their NDMarkup amp chars. Parameters
ReturnsThe converted text block. RestoreAmpChars
Replaces NDMarkup amp chars with their original symbols. Parameters
ReturnsThe restored text. |