man yodlmacros (Conventions) - Macros for the Yodl converters
NAME
yodlmacros - Macros for the Yodl converters
SYNOPSIS
This manual page lists the macros of the Yodl package.
DESCRIPTION
The following list shows the macros that the Yodl converters define and which can be used in Yodl documents. Refer the long Yodl user guide, distributed with the Yodl package, for a full description.
- CWabstract(text)
- Defines an abstract for an CWarticle or CWreport document. Abstracts are not implemented for CWbooks or CWmanpages. Must appear before starting the document with the CWarticle or CWreport macro.
- CWaffiliation(site)
- Defines an affiliation, to appear in the document titlepage below the author field. Must appear before starting the document with CWarticle, CWreport or CWbook. The affiliation is only printed when the author field is not empty.
- CWappendix()
- Start appendices
- CWarticle(title)(author)(date)
- Starts an article. The top-level sectioning command is CW(n)sect. In HTML conversions only one output file is written.
- CWbind(text)
- Issue binding char after text.
- CWbf(text)
- Sets CWtext in boldface.
- CWbook(title)(author)(date)
- Starts a book document. The top-level sectioning command is CW(n)chapter, CW(n)part being optional. In HTML output files are created for each chapter.
- CWcenter(text)
- Sets CWtext centered, when the output format permits. Use CWnl() in the text to break lines.
- CWchapter(title)
- Starts a new chapter in CWbooks or CWreports.
- CWlchapter(label)(title)
- Starts a new chapter in CWbooks or CWreports, setting a label at the beginning of the chapter.
- CWcite(1)
- Citation
- CWclearpage()
- Starts a new page, when the output format permits. Under HTML a horizontal line is drawn.
- CWsetlatexverbchar(char)
- Set the char used to quote latex() CW\verb sequences
- CWsetrofftableoptions(optionlist)
- Set the options for tbl table, default: CWallbox
- CWcode(text)
- Sets CWtext in code font, and prevents it from being expanded. For unbalanced parameter lists, use CWCHAR(4) to get CW( and CWCHAR(4) to get CW).
- CWdef(macroname)(nrofargs)(redefinition)
- Defines CWmacroname as a macro, having CWnrofargs arguments, and expanding to CWredefinition. This macro is a shorthand for CWDEFINEMACRO. An error occurs when the macro is already defined. Use CWredef() to unconditionally define or redefine a macro.
- CWdescription(list)
- Sets CWlist as a description list. Use CWdit(item) to indicate items in the list.
- CWdit(itemname)
- Starts an item named CWitemname in a descriptive list. The list is either enclosed by CWstartdit() and CWenddit(), or is an argument to CWdescription().
- CWellipsis()
- Set ellipsis.
- CWeit()
- Indicates an item in an enumerated list. The list is either enclosed by CWstarteit() and CWendeit(), or is an argument to CWenumerate().
- CWem(text)
- Sets CWtext as emphasized, usually italics.
- CWemail(address)
- In HTML, this macro sets the CWaddress in a CW<a href="mailto=.."> locator. In other output formats, the CWaddress is sent to the output. The CWemail macro is a special case of CWurl.
- CWnemail(n)(address)
- Named email (duh). A more consistent naming for url, lurl, email an nemail would be nice.
- CWendcenter()
- Ends centered text that is started with CWstartcenter().
- CWenddit()
- Ends a descriptive list that is started with CWstartdit().
- CWendeit()
- Ends an enumerated list that is started with CWstarteit().
- CWendit()
- Ends an itemized list that is started with CWstartit().
- CWendmenu()
- DEPRECATED Ends a menu that is started with CWstartmenu().
- CWenumerate(list)
- Sets CWlist as an enumerated list. Use CWeit() to indicate items in the list.
- CWfig(label)
- This macro is a shorthand for CWfigure ref(label) and just makes the typing shorter, as in CWsee fig(schematic) for .. See CWgetfigurestring() and CWsetfigurestring() for the CWfigure text.
- CWfigure(file)(caption)(label)
- Sets the picture in CWfile as a figure in the current document, using the descriptive text CWcaption. The CWlabel is defined as a placeholder for the figure number and can be used in a corresponding CWref statement. Note that the CWfile must be the filename without extension: YODL will supply CW.gif when in HTML mode, or CW.ps when in LaTeX mode. Figures in other modes are not (yet) implemented.
- CWfile(text)
- Sets CWtext as filename, usually boldface.
- CWfootnote(text)
- Sets CWtext as a footnote, or in parentheses when the output format does not allow footnotes.
- CWgagmacrowarning(name name ...)
- Prevents the CWyodl program from printing cannot expand possible user macro. E.g., if you have in your document CWthe file(s) are .. then you might want to put before that: CWgagmacrowarning(file). Synonym for CWNOUSERMACRO.
- CWgetaffilstring()
- Expands to the string that defines the name of Affiliation Information, by default AFFILIATION INFORMATION. Can be redefined for national language support by CWsetaffilstring(). Currently, it is relevant only for txt.
- CWgetauthorstring()
- Expands to the string that defines the name of Author Information, by default AUTHOR INFORMATION. Can be redefined for national language support by CWsetauthorstring(). Currently, it is relevant only for txt.
- CWgetchapterstring()
- Expands to the string that defines a `chapter' entry, by default Chapter. Can be redefined for national language support by CWsetchapterstring().
- CWgetdatestring()
- Expands to the string that defines the name of Date Information, by default DATE INFORMATION. Can be redefined for national language support by CWsetdatestring(). Currently, it is relevant only for txt.
- CWgetfigurestring()
- Returns the string that defines a `figure' text, in captions or in the CWfig() macro. The string can be redefined using the CWsetfiguretext() macro.
- CWgetpartstring()
- Expands to the string that defines a `part' entry, by default Part. Can be redefined for national language support by CWsetpartstring().
- CWgettitlestring()
- Expands to the string that defines the name of Title Information, by default TITLE INFORMATION. Can be redefined for national language support by CWsettitlestring(). Currently, it is relevant only for txt.
- CWgettocstring()
- Expands to the string that defines the name of the table of contents, by default Table of Contents. Can be redefined for national language support by CWsettocstring().
- CWhtmlbodyopt(option)(value)
- Adds CWoption="value" to the options of the CW<body ...> tag in HTML files. Useful options are, e.g., CWfgcolor and CWbgcolor, whose values are expressed as CW#rrggbb, where CWrr are two hexadecimal digits of the red component, CWgg two hexadecimal digits of the green component, and CWbb two hexadecimal digits of the blue component.
- CWhtmlcommand(cmd)
- Sets CWcmd when converting to HTML. The CWcmd is not further parsed by YODL.
- CWhtmlnewfile()
- In HTML output, starts a new file. All other formats are not affected. Note that you must take your own provisions to access the new file; say via links. Also, it's safe to start a new file just befoore opening a new section, since sections are accessible from the clickable table of contents. The HTML converter normally only starts new files prior to a CWchapter definition.
- CWhtmltag(tagname)(start)
- Sets CWtagname as a HTML tag, enclosed by CW< and CW>. When CWstart is zero, the CWtagname is prefixed with CW/.
- CWincludefile(file)
- Includes CWfile and defines a label with the same name. The default extension CW.yo is supplied if necessary.
- CWincludeverbatim(file)
-
Include CWfile into the output. No processing is done, CWfile should
be in preformatted form, e.g.:
whenhtml(includeverbatim(foo.html))
. - CWcindex()
- Generate an index entry for index c.
- CWfindex()
- Generate an index entry for index f.
- CWkindex()
- Generate an index entry for index k.
- CWpindex()
- Generate an index entry for index p.
- CWtindex()
- Generate an index entry for index t.
- CWvindex()
- Generate an index entry for index v.
- CWit()
- Indicates an item in an itemized list. The list is either surrounded by CWstartit() and CWendit(), or it is an argument to CWitemize().
- CWmit()
- DEPRECATED Indicates an item in a menu. The menu is surrounded by CWstartmenu() and CWendmenu().
- CWitemize(list)
- Sets CWlist as an itemized list. Use CWit() to indicate items in the list.
- CWlabel(labelname)
- Defines CWlabelname as an anchor for a CWlink command, or to stand for the last numbering of a section or figure in a CWref command.
- CWLaTeX()
- The LaTeX symbol.
- CWlatexcommand(cmd)
- Writes CWcmd to the output when converting to LaTeX. The CWcmd is not further expanded by YODL.
- CWlatexdocumentclass(class)
- Forces the LaTeX CW\documentclass{...} setting to CWclass. Normally the class is defined by the macros CWarticle, CWreport or CWbook. This macro is an escape route incase you need to specify your own document class for LaTeX. This option is a modifier and must appear before the CWarticle, CWreport or CWbook macros.
- CWlatexpackage(options)(name)
- Include latex package(s), a useful package is, e.g., CWepsf. This command must appear before the document type is stated by CWarticle, CWreport, etc..
- CWlatexoptions(options)
- Set latex options: CWdocumentclass[options]. Junk this? This command must appear before the document type is stated by CWarticle, CWreport, etc..
- CWlatexlayoutcmds(latexcommands)
- This macro is provided incase you want to put your own LaTeX layout commands into LaTeX output. The CWlatexcommands are pasted right after the CW\documentclass stanza. The default is, of course, no local LaTeX commands. Note that this macro does not overrule my favorite LaTeX layout. Use CWnosloppyhfuzz() and CWstandardlayout() to disable my favorite LaTeX layout.
- CWlangle()
- Char langle
- CWrangle()
- Char rangle
- CWlink(description)(labelname)
- In HTML output a clickable link with the text CWdescription is created that points to the place where CWlabelname is defined using the CWlabel macro. Using CWlink is similar to CWurl, except that a hyperlink is set pointing to a location in the same document. For output formats other than HTML, only the CWdescription appears.
- CWlref(description)(labelname)
- This macro is a combination of the CWref and CWlink macros. In HTML output a clickable link with the text CWdescription and the label value is created that points to the place where CWlabelname is defined using the CWlabel macro. For output formats other than HTML, only the CWdescription and the label value appears.
- CWmailto(address)
- Defines the default CWmailto address for HTML output. Must appear before the document type is stated by CWarticle, CWreport, etc..
- CWmancommand(cmd)
- Writes CWcmd to the output when converting to man. The CWcmd is not further expanded by YODL.
- CWmanpage(title)(section)(date)(source)(manual)
- Starts a manual page document. The CWsection argument must be a number, stating to which section the manpage belongs to. Most often used are commands (1), file formats (5) and macro packages (7). The sectioning commands in a manpage are not CW(n)sect etc., but CWmanpage...(). The first section must be the CWmanpagename, the last section must be the CWmanpageauthor. The standard manpage for section 1 contains the following sections (in the given order): CWmanpagename, CWmanpagesynopsis, CWmanpagedescription, CWmanpageoptions, CWmanpagefiles, CWmanpageseealso, CWmanpagediagnostics, CWmanpagebugs, CWmanpageauthor. Optional extra sections can be added with CWmanpagesection. Standard manpageframes for several manpagesections are provided in CW/usr/local/share/yodl/manframes.
- CWmanpageauthor()
- Starts the AUTHOR entry in a CWmanpage document. Must be the last section of a CWmanpage.
- CWmanpagebugs()
- Starts the BUGS entry in a CWmanpage document.
- CWmanpagedescription()
- Starts the DESCRIPTION entry in a CWmanpage document.
- CWmanpagediagnostics()
- Starts the DIAGNOSTICS entry in a CWmanpage document.
- CWmanpagefiles()
- Starts the FILES entry in a CWmanpage document.
- CWmanpagename(n)(short description)
- Starts the NAME entry in a CWmanpage document. The short description is used by, e.g., the CWwhatis database.
- CWmanpageoptions()
- Starts the OPTIONS entry in a CWmanpage document.
- CWmanpagesection(SECTIONNAME)
- Inserts a non-required section named CWSECTIONNAME in a CWmanpage document. This macro can be used to augment `standard' manual pages with extra sections, e.g., EXAMPLES. Note that the name of the extra section should appear in upper case, which is consistent with the normal typesetting of manual pages.
- CWmanpageseealso()
- Starts the SEE ALSO entry in a CWmanpage document.
- CWmanpagesynopsis()
- Starts the SYNOPSIS entry in a CWmanpage document.
- CWmakeindex()
- Make index for latex (urg).
- CWmbox()
- Inbreakable box. The roff command, anyone?
- CWmenu(list)
- DEPRICATED Sets CWlist as a menu.
- CWmetaCOMMENT(text)
- Put a comment in the output.
- CWmetalC(text)
- Put a line comment in the output. FIXME: howto check if text has line breaks?
- CWmscommand(cmd)
- Writes CWcmd to the output when converting to ms. The CWcmd is not further expanded by YODL.
- CWnchapter(title)
- Starts a chapter (in a CWbook or CWreport) without generating a number before the title and without placing an entry for the chapter in the table of contents.
- CWnl()
- Forces a newline; i.e., breaks the current line in two.
- CWnode(previous)(this)(next)(up)
- DEPRECATED Defines a node with name CWthis, and links to nodes CWprevious, CWnext and (up), for the CWnode command.
- CWnodename(text)
-
Use text as name for the next node, e.g.
nodename(Options)manpagesynopsis()
Currently used in texinfo descriptions only.
- CWnodeprefix(text)
-
Prepend text to node names, e.g.
nodeprefix(LilyPond) sect(Overview)
Currently used in texinfo descriptions only.
- CWnodetext(text)
-
Use text as description for the next node, e.g.
nodetext(The GNU Music Typesetter)chapter(LilyPond)
Currently used in texinfo descriptions only.
- CWnop(text)
- Expand to text, to avoid spaces before macros e.g.: a.
- CWnosloppyhfuzz()
- By default, LaTeX output contains commands that cause it to shut up about hboxes that are less than 4pt overfull. When CWnosloppyhfuzz() appears before stating the document type, LaTeX complaints are `vanilla'.
- CWnotableofcontents()
- Prevents the generation of a table of contents. This is default in, e.g., CWmanpage and CWplainhtml documents. When present, this option must appear before stating the document type with CWarticle, CWreport etc..
- CWnotitleclearpage()
- Prevents the generation of a CWclearpage() instruction after the typesetting of title information. This instruction is default in all non CWarticle documents. When present, must appear before stating the document type with CWarticle, CWbook or CWreport.
- CWnotocclearpage()
- Prevents the generation of a CWclearpage() instruction after the typesetting of a table of contents. This instruction is default in all documents. When present, must appear before stating the document type with CWarticle, CWbook or CWreport.
- CWnoxlatin()
- When used in the preamble, the LaTeX converter disables the inclusion of the file CWxlatin1.tex. Normally this file gets included in the LateX output files to ensure the conversion of high ASCII characters (like é) to LaTeX-understandable codes. (The file CWxlatin1.tex comes with the YODL distribution.)
- CWnparagraph(title)
- Starts a non-numbered paragraph (duh, corresponds to subparagraph in latex).
- CWnpart(title)
- Starts a part in a CWbook document, but without numbering it and without entering the title of the part in the table of contents.
- CWnsect(title)
- Starts a section, but does not generate a number before the CWtitle nor an entry in the table of contents. Further sectioning commands are CWnsubsect, CWnsubsubsect and CWnsubsubsubsect.
- CWnsubsect(title)
- Starts a non-numbered subsection.
- CWnsubsubsect(title)
- Starts a non-numbered sub-subsection.
- CWnsubsubsubsect(title)
- Starts a non-numbered sub-sub-subsection.
- CWparagraph(title)
- Starts a parapgraph. This level of sectioning is not numbered, in contrast to `higher' sectionings (duh, corresponds to subparagraph in latex).
- CWpart(title)
- Starts a new part in a CWbook document.
- CWplainhtml(title)
- Starts a document for only a plain HTML conversion. Not available in other output formats. Similar to CWarticle, except that an author- and date field are not needed.
- CWprintindex()
- Make index for texinfo (urg).
- CWquote(text)
- Sets the text as a quotation. Usually, the text is indented, depending on the output format.
- CWredef(macro)(nrofarguments)(redefinition)
- Defines macro CWmacro to expand to CWredefinition. Similar to CWdef, but any pre-existing definition is overruled. This command is a shorthand for CWredefinemacro.
- CWredefinemacro(n)(redefinition)
- Defines macro CWmacro to expand to CWredefinition. Similar to CWdef, but any pre-existing definition is overruled. Use CWARGx in the redefinition part to indicate where the arguments should be pasted. E.g., CWARG1 places the first argument, CWARG2 the second argument, etc..
- CWref(labelname)
- Sets the reference for CWlabelname. Use CWlabel to define a label.
- CWreport(title)(author)(date)
- Starts a report type document. The top-level sectioning command in a report is CWchapter.
- CWroffcmd(dotcmd)(sameline)(secondline)(thirdline)
- Sets a t/nroff command that starts with a dot, on its own line. The arguments are: CWdotcmd - the command itself, e.g., CW.IP; CWsameline - when not empty, set following the CWdotcmd on the same line; CWsecondline - when not empty, set on the next line; CWthirdline - when not empty, set on the third line. Note that CWdotcmd and CWthirdline are not further expanded by YODL, the other arguments are.
- CWsc(text)
- Set CWtext in small caps (or tt).
- CWsect(title)
- Starts a new section.
- CWlsect(label)(title)
- Starts a new section, setting a label at the beginning of the section.
- CWsetaffilstring(n)
- Defines CWname as the `affiliation information' string, by default AFFILIATION INFORMATION. E.g., after CWsetaffilstring(AFILIAÇÃO), YODL outputs this portuguese string to describe the affiliation information. Currently, it is relevant only for txt.
- CWsetauthorstring(n)
- Defines CWname as the `Author information' string, by default AUTHOR INFORMATION. E.g., after CWsetauthorstring(AUTOR), YODL outputs this portuguese string to describe the author information. Currently, it is relevant only for txt.
- CWsetchapterstring(n)
- Defines CWname as the `chapter' string, by default Chapter. E.g., after CWsetchapterstring(Hoofdstuk), YODL gains some measure of national language support for Dutch. Note that LaTeX support has its own NLS, this macro doesn't affect the way LaTeX output looks.
- CWsetdatestring(n)
- Defines CWname as the `date information' string, by default DATE INFORMATION. E.g., after CWsetdatestring(DATA), YODL outputs this portuguese string to describe the date information. Currently, it is relevant only for txt.
- CWsetfigurestring(n)
- Defines the CWname as the `figure' text, used e.g. in figure captions. E.g., after CWsetfigurestring(Figuur), YODL uses Dutch names for figures.
- CWsethtmlfigureext(ext)
- Defines the filename extension for HTML figures, defaults to CW.gif. Note that a leading dot must be included in CWext. The new extension takes effect starting with the following usage of the CWfigure macro.
- CWsethtmlfigurealign(alignment)
- Redefines the alignment for figures in HTML. The default is CWbottom. Other options depend on the client browser, but CWtop and CWcenter should be universal.
- CWsetlanguage(language)
- Sets the language to language. Currentley supported languages english and portuguese.
- CWsetlatexfigureext(ext)
- Defines the filename extension for encapsulated PostScript figures in LaTeX, defaults to CW.ps. The dot must be included in t new extension CWext. The new extension takes effect starting with a following usage of the CWfigure macro.
- CWsetpartstring(n)
- Defines CWname as the `part' string, by default Part. E.g., after CWsetpartstring(Teil), YODL identifies parts in the German way. Note that LaTeX output does its own national language support; this macro doesn't affect the way LaTeX output looks.
- CWsettitlestring(n)
- Defines CWname as the `title information' string, by default TITLE INFORMATION. E.g., after CWsettitlestring(TÍTULO), YODL outputs this portuguese string to describe the title information. Currently, it is relevant only for txt.
- CWsettocstring(n)
- Defines CWname as the `table of contents' string, by default Table of Contents. E.g., after CWsettocstring(Inhalt), YODL identifies the table of contents in the German way. Note that LaTeX output does its own national language support; this macro doesn't affect the way LaTeX output looks.
- CWsgmlcommand(cmd)
- Writes CWcmd to the output when converting to SGML. The CWcmd is not further expanded by YODL.
- CWsgmltag(tag)(onoff)
- Similar to CWhtmltag, but used in the SGML converter.
- CWstandardlayout()
- Enables the default LaTeX layout. When this macro is absent, then the first lines of paragraphs are not indented and the space between paragraphs is somewhat larger. The CWstandardlayout() directive must appear before stating the document type as CWarticle, CWreport, etc..
- CWstartcenter()
- Starts centered text. Use CWendcenter() to stop centering text.
- CWstartdit()
- Starts a descriptive list. Use CWdit(item) to set items in the list, and use CWenddit() to end the list.
- CWstarteit()
- Starts an enumerated list. Use CWeit() in the list to indicate items, and use CWendeit() to end the list.
- CWstartit()
- Starts an itemized list. Use CWit() in the list to indicate items, and use CWendit() to end the list.
- CWstartmenu()
- DEPRECATED Starts a menu. Use CWmit() in the menu to indicate menu items, and use CWendmenu() to end the menu.
- CWsups(text)
- Set superscript...
- CWsubs(text)
- Set subscript
- CWsubsect(title)
- Starts a new subsection. Other sectioning commands are CWsubsubsect and CWsubsubsubsect.
- CWlsubsect(label)(title)
- Starts a new subsection. Other sectioning commands are CWsubsubsect and CWsubsubsubsect. A label is added just before the subsection.
- CWsubsubsect(title)
- Starts a sub-subsection.
- CWlsubsubsect(label)(title)
- Starts a sub-subsection, a label is added just before the section
- CWsubsubsubsect(title)
- Starts a sub-sub-sub-subsection. This level of sectioning is not numbered, in contrast to `higher' sectionings.
- CWlsubsubsubsect(label)(title)
- Starts a sub-sub-sub-subsection. This level of sectioning is not numbered, in contrast to `higher' sectionings. A label is added just before the subsubsubection.
- CWtexinfocommand(cmd)
- Writes CWcmd to the output when converting to Texinfo. The CWcmd is not further expanded by YODL.
- CWTeX()
- The TeX symbol.
- CWtitleclearpage()
- Forces the generation of a CWclearpage() directive following the title of a document. This is already the default in CWbooks and CWreports, but can be overruled with CWnotitleclearpage(). When present, must appear in the preamble; i.e., before the document type is stated with CWarticle, CWbook or CWreport.
- CWtocclearpage()
- Forces the generation of a CWclearpage() directive following the table of contents in a document. This is already the default in all document types, but can be overruled with CWnotocclearpage(). When present, must appear in the preamble; i.e., before the document type is stated with CWarticle, CWbook or CWreport.
- CWtt(text)
- Sets CWtext in teletype font, and prevents it from being expanded. For unbalanced parameter lists, use CWCHAR(4) to get CW( and CWCHAR(4) to get CW).
- CWtxtcommand(cmd)
- Writes CWcmd to the output when converting to ASCII. The CWcmd is not further expanded by YODL.
- CWurl(description)(locator)
- In LaTeX documents the CWdescription is sent to the output. For HTML, a link is created with the descriptive text CWdescription and pointing to CWlocator. The CWlocator should be the full URL, including service; e.g, CWhttp://www.icce.rug.nl, but excluding the double quotes that are necessary in plain HTML. Use the macro CWlink to create links within the same document. For other formats, something like description [locator] will appear.
- CWlurl(locator)
- An url described by its Locator. For small urls with readable addresses.
- CWverb(text)
- Sets CWtext in verbatim mode: not subject to macro expansion or character table expansion. The text appears literally on the output, usually in a teletype font (that depends on the output format). This macro is for larger chunks, e.g., listings. For unbalanced parameter lists, use CWCHAR(4) to get CW( and CWCHAR(4) to get CW).
- CWverbinclude(filename)
- Reads filename and inserts it literally in the text, set in verbatim mode. not subject to macro expansion.The text appears literally on the output, usually in a teletype font (that depends on the output format). This macro is an alternative to CWverb(...), when the text to set in verbatim mode is better kept in a separate file.
- CWverbpipe(command)(text)
- Pipe text through command, but don't expand the output.
- CWwhenhtml(text)
- Sends CWtext to the output when in HTML conversion mode. The text is further expanded if necessary.
- CWwhenlatex(text)
- Sends CWtext to the output when in LaTeX conversion mode. The text is further expanded if necessary.
- CWwhenman(text)
- Sends CWtext to the output when in man conversion mode. The text is further expanded if necessary.
- CWwhenms(text)
- Sends CWtext to the output when in ms conversion mode. The text is further expanded if necessary.
- CWwhensgml(text)
- Sends CWtext to the output when in SGML conversion mode. The text is further expanded if necessary.
- CWwhentexinfo(text)
- Sends CWtext to the output when in Texinfo conversion mode. The text is further expanded if necessary.
- CWwhentxt(text)
- Sends CWtext to the output when in ASCII conversion mode. The text is further expanded if necessary.
- CWstarttable(n)(LaTexAllignment)
- The arguments are the number of columns in the table, and the alignment specifications for LaTeX, which should consist of CWnColumns characters (CWl, CWr, or CWc). It is used internally by CWtable()
- CWendtable()
- This macro ends the definition of a table. It is used internally by CWtable()
- CWtable(n)(LaTeXallignment)(Contents)
- The CWtable()-macro defines a table. Its first argument specifies the number of columns in the table. Its second argument specifies the LaTeX-alignment specifications: use CWl for left-alignment, CWr for right alignment, CWc for centered-alignment. The third argument defines the contents of the table which are the rows, each containing column-specifications.
- CWrow(Cells)
- The argument CWCells contains the cells of one row of the table
- CWcell(element)
- Set a table cell, i.e., one element in a row.
- CWtcell(text)
- Roff helper to set a table textcell, i.e., a paragraph. For special table formatting p{} should be used.
- CWcells(n)(element)
- Set a table cell centered over CWnColumns columns. See also CWleftcells() and CWrightcells().
- CWcolumnline(from)(to)
- Sets a horizontal line over a column in a row. See also CWrowline().
- CWrowline()
- Sets a horizontal line over the width of the table. See also CWcellsline().
OPTIONS
No options are relevant in respect to the macros.
FILES
The files in /usr/local/lib/yodl/ define the macro package of the converter. The scripts yodl2tex, yodl2html, yodl2man etc. run the conversions.
SEE ALSO
- o
- yodl: the main Yodl converter
- o
- yodlmanpage: more detailed description of the CWmanpage format
- o
- yodlconverters: divers converters for divers output formats
DIAGNOSTICS
Error messages and warnings are printed to stderr. There are too many warnings or error messages to enumerate, but they should be self-explanatory.
BUGS
The macro package may contain bugs, but I'm working on it. Furthermore, the macro package may not be complete.
AUTHOR
Karel Kubat (karel@icce.rug.nl)