This document contains a automatically generated reference for the @macros() defined by the NST project. For the developer, this involves the following files:
${SRCDIR}/include/atmacros/colors.xml
This is the source file for the @macros() which are described in this document.
${SRCDIR}/config/colors.at
The @macros() file produced from
${SRCDIR}/include/atmacros/colors.xml which is used to produce
HTML output.
${SRCDIR}/docs/build/colors/colors.xml
The source DocBook file which is generated from
${SRCDIR}/include/atmacros/colors.xml.
${HTMLROOT}/nst/docs/colors/index.html
The resulting documentation (this file you are viewing now).
${SRCDIR}/include/xsl/atmacros2at.xsl
The XSL file used to translate
${SRCDIR}/include/atmacros/colors.xml
into ${SRCDIR}/config/colors.at.
${SRCDIR}/include/xsl/atmacros2docbook.xsl
The XSL file used to translate
${SRCDIR}/include/atmacros/colors.xml
into ${SRCDIR}/docs/build/colors/colors.xml.
Unfortunately, this document only includes information for the macros we've defined in the NST project. There are MANY other @macros() which are available. You can find a bit of documentation for the Java based macros in the com.ccg.macros.at package documentation.
You can also use the
@htmlDumpDefinitions() macro to generate a complete
(and sorted) list of macros which are defined. This can be done as
shown below:
[root@probe root]#echo "@htmlDumpDefinitions()" |\ java com.ccg.macros.at.All > macros.html[root@probe root]#elinks macros.html[root@probe root]#
There is also a @dumpDefinitions()
macro. It generates a text dump of the defined @macros(), but it is
pretty tough to read.