 |
All macros have an underscore ('_') as prefix. The macros may be divided
into three groups; general m4-macros, general html-macros and defines and
SU-specific macros and defines.
General macros
- _INCLUDE(file)
- includes another m4 file
- _SET(variable, value)
- assigns a value to a variable
- _VALUE(variable)
- inserts the value of a variable
- _IF_DEF(variable)
- inserts the following text until _ELSE or _FI/_END_IF if a variable
has been defined with _SET
- _IF_EQU(variable, value)
- inserts the following text until _ELSE or _FI/_END_IF if the variable
is equal to the value
- _IF_NOT_EQU(variable, value)
- inserts the following text until _ELSE or _FI/_END_IF if the variable
is different from the value
- _ELSE
- inserts the following text if the previous _IF_DEF, _IF_EQU or
_IF_NOT_EQU failed
- _FI, _END_IF
- ends insertion after _IF or _ELSE
HTML macros
- _TITLE(title)
- Header - title element
- _DESCRIPTION(description)
- Header - description meta-tag
- _KEYWORDS(keywords)
- Header - keywords meta-tag
- _STYLE(style)
- Header - in-line style sheet
- _LINK(label, URL)
- Body - link (a href)
- _ANCHOR(label, tag)
- Body - anchor (a name)
- _MAIL(name, address)
- Body - mailto:-link
- _ADDR(name, address, URL)
- Body - address with e-mail and home-page
- <!--, -->
- Comments (removed during parsing)
SU macros
- _TITLE(title)
- Set the document title
- _SUBTITLE(title)
- Set the document subtitle
- _AUTHOR(name, mail, url)
- Name, address and home-page url of author
- _WEBMASTER(name, mail, url)
- Name, address and home-page url of webmaster
- _DOC_INDEX(url)
- URL to TOC
- _DOC_PREV(url)
- URL to previous document
- _DOC_NEXT(url)
- URL to next document
- _NAVIGATION
- Navigation bar.
Uses data from _DOC_INDEX, _DOC_PREV and _DOC_NEXT
- _DOC_BEGIN
- Start of document body
- _DOC_END
- End of document
Typical document
_TITLE(chapter)
_SUBTITLE(verse)
_AUTHOR(my name, me@somewhere, www.somewhere/~moi)
_WEBMASTER(somebody, somebody@somewhere, somewhere/~root)
_DOC_INDEX(/)
_DOC_PREV(/1.html)
_DOC_NEXT(/3.html)
_DOC_BEGIN
Exciting content
_DOC_END
Entities
| _alpha | α |
| _beta | β |
| ... | ... |
| _omega | ω |
| _Alpha | Α |
| _Beta | Β |
| ... | ... |
| _Omega | Ω |
| _l_arrow | ← |
| _r_arrow | → |
| _u_arrow | ↑ |
| _d_arrow | ↓ |
| _dbl_arrow | ↔ |
| _deg | ° |
| _micro | µ |
|