diff options
Diffstat (limited to 'contrib/mom/momdoc/macrolist.html')
| -rw-r--r-- | contrib/mom/momdoc/macrolist.html | 128 |
1 files changed, 71 insertions, 57 deletions
diff --git a/contrib/mom/momdoc/macrolist.html b/contrib/mom/momdoc/macrolist.html index 3b0669c0..74bc28ad 100644 --- a/contrib/mom/momdoc/macrolist.html +++ b/contrib/mom/momdoc/macrolist.html @@ -46,34 +46,35 @@ references found elsewhere in the documentation. <pre> TYPESETTING MACROS DOCUMENT PROCESSING MACROS ================== ========================== -<a href="#1">Paper size, margins, line length</a> <a href="#18">Reference macros</a> -<a href="#2">Family, font, point size</a> <a href="#19">General document formatting directives</a> -<a href="#3">Font modifications</a> <a href="#20">Line numbering</a> -<a href="#4">Linespacing (leading)</a> <a href="#21">Set documents in columns</a> -<a href="#5">Justification, quad, breaking lines</a> <a href="#22">TYPEWRITE control macros</a> -<a href="#6">Hyphenation</a> <a href="#23">Initiate document processing</a> -<a href="#7">Word and sentence spacing</a> <a href="#24">Epigraphs</a> -<a href="#8">Kerning, ligatures, smartquotes</a> <a href="#25">Main heads</a> -<a href="#9">Horizontal/vertical motions, columns</a> <a href="#26">Subheads</a> -<a href="#10">Indents</a> <a href="#27">Paragraph heads</a> -<a href="#11">Tabs</a> <a href="#28">Paragraphs</a> -<a href="#12">Underscoring, underlining</a> <a href="#29">Quotes (line by line verbatim quotes)</a> -<a href="#13">Superscipts</a> <a href="#30">Blockquotes (cited passages of text)</a> -<a href="#14">Nested lists</a> <a href="#32">Author linebreaks (section breaks)</a> -<a href="#15">Colour</a> <a href="#33">Document termination string</a> -<a href="#16">Dropcaps</a> <a href="#34">Footnotes</a> -<a href="#17">Utilities</a> <a href="#35">Endnotes</a> - <a href="#36">Margin notes</a> - <a href="#37">Bibliographic references</a> - <a href="#38">Tables of contents</a> - <a href="#39">Letter (correspondence) macros</a> - <a href="#40">Changing global print style parameters after START</a> - <a href="#41">Managing a document's first-page header</a> - <a href="#42">Managing page headers and footers</a> - <a href="#43">Recto/verso page headers and footers</a> - <a href="#44">Pagination</a> - <a href="#45">Document and section cover (title) pages</a> - <a href="#46">Utilities</a> +<a href="#1">Paper size, margins, line length</a> <a href="#19">Reference macros</a> +<a href="#2">Family, font, point size</a> <a href="#20">General document formatting directives</a> +<a href="#3">Font modifications</a> <a href="#21">Line numbering</a> +<a href="#4">Linespacing (leading)</a> <a href="#22">Set documents in columns</a> +<a href="#5">Justification, quad, breaking lines</a> <a href="#23">TYPEWRITE control macros</a> +<a href="#6">Hyphenation</a> <a href="#24">Initiate document processing</a> +<a href="#7">Word and sentence spacing</a> <a href="#25">Epigraphs</a> +<a href="#8">Kerning, ligatures, smartquotes</a> <a href="#26">Main heads</a> +<a href="#9">Horizontal/vertical motions, columns</a> <a href="#27">Subheads</a> +<a href="#10">Indents</a> <a href="#28">Paragraph heads</a> +<a href="#11">Tabs</a> <a href="#29">Paragraphs</a> +<a href="#12">Underscoring, underlining</a> <a href="#30">Quotes (line by line verbatim quotes)</a> +<a href="#13">Superscipts</a> <a href="#31">Blockquotes (cited passages of text)</a> +<a href="#14">Nested lists</a> <a href="#32">Code snippets (inserting bits of programming code)</a> +<a href="#15">Colour</a> <a href="#33">Author linebreaks (section breaks)</a> +<a href="#16">Dropcaps</a> <a href="#34">Document termination string</a> +<a href="#17">Utilities</a> <a href="#35">Footnotes</a> +<a href="#18">Graphical Objects</a> <a href="#36">Endnotes</a> + <a href="#37">Margin notes</a> + <a href="#38">Bibliographic references</a> + <a href="#39">Tables of contents</a> + <a href="#40">Letter (correspondence) macros</a> + <a href="#41">Changing global print style parameters after START</a> + <a href="#42">Managing a document's first-page header (the "docheader")</a> + <a href="#43">Managing page headers and footers</a> + <a href="#44">Recto/verso page headers and footers</a> + <a href="#45">Pagination</a> + <a href="#46">Document and section cover (title) pages</a> + <a href="#47">Utilities</a> </pre> <hr/> @@ -196,6 +197,7 @@ TYPESETTING MACROS <a href="goodies.html#SUP">\*[SUP]...\*[SUPX]</a> -- set characters superscript (inline) <a href="goodies.html#SUP">\*[CONDSUP]...\*[CONDSUPX]</a> -- set pseudo condensed characters superscript (inline) <a href="goodies.html#SUP">\*[EXTSUP]...\*[EXTSUPX]</a> -- set pseudo extended characters superscript (inline) + <a href="goodies.html#SUP_RAISE">SUPERSCRIPT_RAISE_AMOUNT</a> -- set vertical raise of superscript <a name="14">+++ Nested lists</a> <a href="docelement.html#LIST">LIST</a> -- initiate a nested list @@ -219,6 +221,7 @@ TYPESETTING MACROS <a href="goodies.html#DROPCAP_GUTTER">DROPCAP_GUTTER</a> -- adjust space between a dropcap and regular text <a name="17">+++ Utilities</a> + <a href="goodies.html#ALIAS">ALIAS</a> -- give a macro a new name <a href="goodies.html#CAPS">CAPS</a> -- set type all caps <a href="goodies.html#SILENT">COMMENT</a> -- silently embed comments in a document <a href="goodies.html#ESC_CHAR">ESC_CHAR</a> -- change the default escape character @@ -228,8 +231,17 @@ TYPESETTING MACROS <a href="goodies.html#PAD">PAD</a> -- insert equalized regions of whitespace into a line <a href="goodies.html#PAD_MARKER">PAD_MARKER</a> -- change the character that identifes padding locations <a href="inlines.html#INLINE_RULE_MOM">\*[RULE]</a> -- draw a full measure rule + <a href="goodies.html#SIZESPECS">SIZESPECS</a> -- get cap-height, x-height and descender depth of a font <a href="goodies.html#SILENT">SILENT</a> -- turn output processing off or on <a href="goodies.html#TRAP">TRAP</a> -- enable or disable page position traps + +<a name="18">+++ Graphical objects</a> + <a href="graphical.html#DRH">DRH</a> -- draw a horizontal rule + <a href="graphical.html#DRV">DRV</a> -- draw a vertical rule + <a href="graphical.html#DBX">DBX</a> -- draw a box + <a href="graphical.html#DCL">DCL</a> -- draw a circle (ellipse) + <a href="inlines.html#RULE_WEIGHT">RULE_WEIGHT</a> -- set weight of rules drawn with \*[RULE] + <a href="docelement.html#PSPIC">PSPIC</a> -- insert a PostScript image </pre> <hr width="66%" align="left"/> @@ -238,7 +250,7 @@ TYPESETTING MACROS DOCUMENT PROCESSING MACROS ========================== -<a name="18">+++ Reference macros</a> +<a name="19">+++ Reference macros</a> <a href="docprocessing.html#TITLE">TITLE</a> -- document title <a href="docprocessing.html#DOCTITLE">DOCTITLE</a> -- overall document title (if different from TITLE) <a href="docelement.html#ENDNOTE_TITLE">ENDNOTE_TITLE</a> -- document/chapter identification string for endnotes @@ -256,37 +268,37 @@ DOCUMENT PROCESSING MACROS <a href="docprocessing.html#REVISION">REVISION</a> -- document's revision number <a href="docprocessing.html#REVISION_STRING">REVISION_STRING</a> -- what to use in place of "Revision" -<a name="19">+++ General document formatting directives</a> +<a name="20">+++ General document formatting directives</a> <a href="docprocessing.html#DOCTYPE">DOCTYPE</a> -- general document type <a href="docprocessing.html#COPYSTYLE">COPYSTYLE</a> -- draft or final copy <a href="docprocessing.html#PRINTSTYLE">PRINTSTYLE</a> -- typeset or "typewritten" -<a name="20">+++ Line numbering</a> +<a name="21">+++ Line numbering</a> <a href="docelement.html#NUMBER_LINES">NUMBER_LINES</a> -- turn automatic line numbering on or off <a href="docelement.html#NUMBER_LINES_CONTROL">Control macros</a> <a href="docelement.html#NUMBER_QUOTE_LINES">NUMBER_QUOTE_LINES</a> -- turn numbering of lines inside QUOTE on or off <a href="docelement.html#NUMBER_BLOCKQUOTE_LINES">NUMBER_BLOCKQUOTE_LINES</a> -- turn numbering of lines inside BLOCKQUOTE on or off -<a name="21">+++ Set documents in columns</a> +<a name="22">+++ Set documents in columns</a> <a href="docprocessing.html#COLUMNS">COLUMNS</a> <a href="docprocessing.html#COL_NEXT">COL_NEXT</a> <a href="docprocessing.html#COL_BREAK">COL_BREAK</a> -<a name="22">+++ TYPEWRITE control macros</a> +<a name="23">+++ TYPEWRITE control macros</a> <a href="docprocessing.html#TYPEWRITE_CONTROL">UNDERLINE_ITALIC</a> -- turn underlining of italics on <a href="docprocessing.html#UNDERLINE_QUOTES">UNDERLINE_QUOTES</a> -- turn underlining of line for line quotes on or off <a href="docprocessing.html#TYPEWRITE_CONTROL">ITALIC_MEANS_ITALIC</a> -- turn underlining of italics off (use italics) <a href="docprocessing.html#TYPEWRITE_CONTROL">UNDERLINE_SLANT</a> -- turn underlining of pseudo italics on <a href="docprocessing.html#TYPEWRITE_CONTROL">SLANT_MEANS_SLANT</a> -- turn underlining of pseudo italics off (use pseudo italics) -<a name="23">+++ Initiate document processing</a> +<a name="24">+++ Initiate document processing</a> <a href="docprocessing.html#START">START</a> -- begin document processing -<a name="24">+++ Epigraphs</a> +<a name="25">+++ Epigraphs</a> <a href="docelement.html#EPIGRAPH">EPIGRAPH</a> -- set an epigraph underneath the docheader <a href="docelement.html#EPIGRAPH_CONTROL">Control macros</a> -- change default style of epigraphs -<a name="25">+++ Main heads</a> +<a name="26">+++ Main heads</a> <a href="docelement.html#HEAD">HEAD</a> -- set a main head <a href="docelement.html#HEAD_GENERAL">Control macros</a> -- change default style of heads <a href="docelement.html#HEAD_SPACE">HEAD_SPACE</a> -- control spacing around heads @@ -294,21 +306,21 @@ DOCUMENT PROCESSING MACROS <a href="docelement.html#PREFIX_CHAPTER_NUMBER">PREFIX_CHAPTER_NUMBER</a> -- prefix chapter number to head numbering scheme <a href="docelement.html#RESET_HEAD_NUMBER">RESET_HEAD_NUMBER</a> -- reset head number to "1" -<a name="26">+++ Subheads</a> +<a name="27">+++ Subheads</a> <a href="docelement.html#SUBHEAD">SUBHEAD</a> -- set a subhead <a href="docelement.html#SUBHEAD_GENERAL">Control macros</a> -- change default style of subheads <a href="docelement.html#NUMBER_SUBHEADS">NUMBER_SUBHEADS</a> -- number subheads <a href="docelement.html#PREFIX_CHAPTER_NUMBER">PREFIX_CHAPTER_NUMBER</a> -- prefix chapter number to subhead numbering scheme <a href="docelement.html#RESET_SUBHEAD_NUMBER">RESET_SUBHEAD_NUMBER</a> -- reset subhead number to "1" -<a name="27">+++ Paragraph heads</a> +<a name="28">+++ Paragraph heads</a> <a href="docelement.html#PARAHEAD">PARAHEAD</a> -- set a paragraph head (joined to body of paragraph) <a href="docelement.html#PARAHEAD_GENERAL">Control macros</a> -- change default style of paraheads <a href="docelement.html#NUMBER_PARAHEADS">NUMBER_PARAHEADS</a> -- number paraheads <a href="docelement.html#PREFIX_CHAPTER_NUMBER">PREFIX_CHAPTER_NUMBER</a> -- prefix chapter number to parahead numbering scheme <a href="docelement.html#RESET_PARAHEAD_NUMBER">RESET_PARAHEAD_NUMBER</a> -- reset parahead number to "1" -<a name="28">+++ Paragraphs</a> +<a name="29">+++ Paragraphs</a> <a href="docelement.html#PP">PP</a> -- set a paragraph <a href="docelement.html#PP_CONTROL">Paragraph style</a> -- managing paragraph style concerns <a href="docelement.html#PP_FONT">PP_FONT</a> -- globally change the font used in regular paragraphs @@ -316,32 +328,32 @@ DOCUMENT PROCESSING MACROS <a href="docelement.html#INDENT_FIRST_PARAS">INDENT_FIRST_PARAS</a> -- indenting of paragraph first-lines on or off <a href="docelement.html#PP_SPACE">PARA_SPACE</a> -- spacing of paragraphs (single blank line) on or off -<a name="29">+++ Quotes (line by line verbatim quotes)</a> +<a name="30">+++ Quotes (line by line verbatim quotes)</a> <a href="docelement.html#QUOTE">QUOTE</a> -- set cited text line by line <a href="docelement.html#QUOTE_GENERAL">Control macros</a> -- change default style of quotes <a href="docelement.html#ALWAYS_FULLSPACE_QUOTES">ALWAYS_FULLSPACE_QUOTES</a> -- control spacing around quotes <a href="docelement.html#BREAK_QUOTE">BREAK_QUOTE</a> -- deprecated -<a name="30">+++ Blockquotes (cited passages of text)</a> +<a name="31">+++ Blockquotes (cited passages of text)</a> <a href="docelement.html#BLOCKQUOTE">BLOCKQUOTE</a> -- set longer passages of cited text <a href="docelement.html#BLOCKQUOTE_GENERAL">Control macros</a> -- change default style of blockquotes <a href="docelement.html#ALWAYS_FULLSPACE_QUOTES">ALWAYS_FULLSPACE_QUOTES</a> -- control spacing around quotes <a href="docelement.html#BREAK_QUOTE">BREAK_BLOCKQUOTE</a> -- deprecated -<a name="31">+++ Code snippets</a> +<a name="32">+++ Code snippets</a> <a href="docelement.html#CODE">CODE</a> -- set a code snippet -<a name="32">+++ Author linebreaks (section breaks)</a> +<a name="33">+++ Author linebreaks (section breaks)</a> <a href="docelement.html#LINEBREAK">LINEBREAK</a> -- insert an author linebreak (section break) <a href="docelement.html#LINEBREAK_CHAR">LINEBREAK_CHAR</a> -- character to use for author linebreaks <a href="docelement.html#LINEBREAK_COLOR">LINEBREAK_COLOR</a> -- colour of author linebreak character -<a name="33">+++ Document termination string</a> +<a name="34">+++ Document termination string</a> <a href="docelement.html#FINIS">FINIS</a> -- insert a document termination string (e.g. --END--) <a href="docelement.html#FINIS_STRING">FINIS_STRING</a> -- set the document termination string <a href="docelement.html#FINIS_COLOR">FINIS_COLOR</a> -- set the document termination string colour -<a name="34">+++ Footnotes</a> +<a name="35">+++ Footnotes</a> <a href="docelement.html#FOOTNOTE">FOOTNOTE</a> -- set a footnote <a href="docelement.html#FOOTNOTE_GENERAL">Control macros</a> -- change default style of footnotes <a href="docelement.html#FOOTNOTE_MARKERS">FOOTNOTE_MARKERS</a> -- turn footnote markers on or off @@ -354,23 +366,24 @@ DOCUMENT PROCESSING MACROS begin on a new line; only for use with footnotes identified by document line number) -<a name="35">+++ Endnotes</a> +<a name="36">+++ Endnotes</a> <a href="docelement.html#ENDNOTE">ENDNOTE</a> -- set an endnote <a href="docelement.html#EN-MARK">\*[EN-MARK]</a> -- mark initial line of a range of line numbers (for use with line numbered endnotes) <a href="docelement.html#ENDNOTES">ENDNOTES</a> -- output endnotes pages <a href="docelement.html#ENDNOTE_CONTROL">Control macros</a> -- change just about anything to do with endnotes <a href="docelement.html#ENDNOTES_GENERAL">Endnotes pages general style control</a> + <a href="docelement.html#ENDNOTES_PAGINATION">Pagination of endnotes</a> <a href="docelement.html#ENDNOTES_HEADER_CONTROL">Endotes pages header/footer control</a> <a href="docelement.html#ENDNOTES_MAIN_TITLE">Endnotes pages main title control</a> <a href="docelement.html#ENDNOTES_MAIN_TITLE">Endnotes pages document/section identification control</a> <a href="docelement.html#ENDNOTES_NUMBERING">Endnote identification style</a> -<a name="36">+++ Margin notes</a> +<a name="37">+++ Margin notes</a> <a href="docelement.html#MN_INIT">MN_INIT</a> -- initialize margin notes <a href="docelement.html#MN">MN</a> -- set a margin note -<a name="37">+++ Bibliographic references</a> +<a name="38">+++ Bibliographic references</a> <a href="refer.html#REF">REF</a> -- begin a bibliographic reference <a href="refer.html#FOOTNOTE_REFS">FOOTNOTE_REFS</a> -- place bibliographic references in footnotes <a href="refer.html#ENDNOTE_REFS">ENDNOTE_REFS</a> -- place bibliographic references in endnotes @@ -384,7 +397,7 @@ DOCUMENT PROCESSING MACROS <a href="refer.html#BIBLIO_HEADER_CONTROL">Bibliography pages header/footer control</a> <a href="refer.html#BIBLIO_MAIN_TITLE">Bibliography pages main head control</a> -<a name="38">+++ Tables of contents</a> +<a name="39">+++ Tables of contents</a> <a href="docelement.html#TOC">TOC</a> <a href="docelement.html#TOC_CONTROL">Control macros</a> -- change just about anything to do with table of contents pages <a href="docelement.html#TOC_GENERAL">Table of contents general style control</a> @@ -393,7 +406,7 @@ DOCUMENT PROCESSING MACROS <a href="docelement.html#TOC_STYLE">Changing the style of the different table of contents entry types</a> <a href="docelement.html#TOC_ADDITIONAL">Additional table of contents control macros</a> -<a name="39">+++ Letter (correspondence) macros</a> +<a name="40">+++ Letter (correspondence) macros</a> <a href="letters.html#DATE">DATE</a> -- letter's date <a href="letters.html#FROM">FROM</a> -- letter's addresser <a href="letters.html#TO">TO</a> -- letter's addressee @@ -401,7 +414,7 @@ DOCUMENT PROCESSING MACROS <a href="letters.html#CLOSING">CLOSING</a> -- letter's closing salutation <a href="letters.html#NO_SUITE">NO_SUITE</a> -- turn printing of "next page number" off or on -<a name="40">+++ Changing global print style parameters after START</a> +<a name="41">+++ Changing global print style parameters after START</a> <a href="docprocessing.html#DOC_LEFT_MARGIN">DOC_LEFT_MARGIN</a> -- left margin of everything on the page <a href="docprocessing.html#DOC_RIGHT_MARGIN">DOC_RIGHT_MARGIN</a> -- right margin of everything on the page <a href="docprocessing.html#DOC_LINE_LENGTH">DOC_LINE_LENGTH</a> -- document's base line length @@ -410,11 +423,11 @@ DOCUMENT PROCESSING MACROS <a href="docprocessing.html#DOC_LEAD">DOC_LEAD</a> -- document's base lead <a href="docprocessing.html#DOC_QUAD">DOC_QUAD</a> -- document's base quad directions -<a name="41">+++ Managing a document's first-page header</a> +<a name="42">+++ Managing a document's first-page header</a> <a href="docprocessing.html#DOCHEADER">DOCHEADER</a> -- document first-page header on or off <a href="docprocessing.html#DOCHEADER_CONTROL_INDEX">Control macros</a> -- change default style of docheader elements -<a name="42">+++ Managing page headers and footers</a> +<a name="43">+++ Managing page headers and footers</a> <a href="headfootpage.html#HEADERS">HEADERS</a> -- turn page headers on or off <a href="headfootpage.html#FOOTERS">FOOTERS</a> -- turn page footers on or off <a href="headfootpage.html#HEADERS_AND_FOOTERS">HEADERS_AND_FOOTERS</a> -- enable or disable generation of both headers and footers @@ -426,7 +439,7 @@ DOCUMENT PROCESSING MACROS <a href="headfootpage.html#VERTICAL">Vertical placement</a> -- vertical location of headers and/or footers <a href="headfootpage.html#SEPARATOR_RULE">Separator rule</a> -- manage the header/footer separator rule -<a name="43">+++ Recto/verso page headers and footers</a> +<a name="44">+++ Recto/verso page headers and footers</a> <a href="rectoverso.html#RECTO_VERSO">RECTO_VERSO</a> -- turn recto/verso headers and/or footers on or off <a href="rectoverso.html#SWITCH_HDRFTR">SWITCH_HEADERS</a> -- switch recto or verso header <a href="rectoverso.html#SWITCH_HDRFTR">SWITCH_FOOTERS</a> -- switch recto or verso footer @@ -435,7 +448,7 @@ DOCUMENT PROCESSING MACROS <a href="headfootpage.html#HDRFTR_RECTOVERSO">FOOTER_RECTO</a> -- string that constitutes a recto footer <a href="headfootpage.html#HDRFTR_RECTOVERSO">FOOTER_VERSO</a> -- string that constitutes a recto footer -<a name="44">+++ Pagination</a> +<a name="45">+++ Pagination</a> <a href="headfootpage.html#PAGINATE">PAGINATE</a> -- pagination on or off <a href="headfootpage.html#PAGINATE_CONTROL">Control macros</a> -- change default style for pagination <a href="headfootpage.html#PAGENUMBER">PAGENUMBER</a> -- user-defined (starting) page number @@ -443,14 +456,15 @@ DOCUMENT PROCESSING MACROS <a href="headfootpage.html#PAGENUM_ON_FIRST_PAGE">PAGENUM_ON_FIRST_PAGE</a> -- when footers are enabled <a href="headfootpage.html#DRAFT_WITH_PAGENUMBER">DRAFT_WITH_PAGENUMBER</a> -- attach draft/revision information to page numbers -<a name="45">+++ Document and section cover (title) pages</a> +<a name="46">+++ Document and section cover (title) pages</a> <a href="cover.html#COVER">COVER</a> -- information to include in a section cover <a href="cover.html#COVER">DOC_COVER</a> -- information to include in a document cover <a href="cover.html#ON_OFF">COVERS</a> -- turn printing of section covers on or off <a href="cover.html#ON_OFF">DOC_COVERS</a> -- turn printing of document covers on or off <a href="cover.html#COVER_CONTROL_INDEX">Control macros</a> -- change style defaults for covers -<a name="46">+++ Utilities</a> +<a name="47">+++ Utilities</a> + <a href="typemacdoc.html#ADD_SPACE">ADD_SPACE</a> -- add space to the top of a page <a href="docelement.html#BLANK_PAGE">BLANKPAGE</a> -- output one or more blank pages <a href="docprocessing.html#DOC_LEAD_ADJUST">DOC_LEAD_ADJUST</a> -- adjust document linespacing (lead) to fill pages <a href="rectoverso.html#COLLATE">COLLATE</a> -- join documents or chapters of a document together |