Yodl 2.xx.yy
Frank B. Brokken (f.b.brokken@rug.nl)
initially by Karel Kubat
Computing Center, University of Groningen
1996-NOW
Yodl is a package implementing a pre-document language and tools to
process it. The idea of Yodl is that you write up a document in a
pre-language, then use the tools (e.g. yodl2html) to convert it to some final
document language. Current converters are for HTML, man, LaTeX, a poor-man's
text converter and an experimental XML converter. Main document types are
`article', `report', `book', `letter' and `manpage'. The Yodl document
language is designed to be easy to use and extensible.
Table of Contents
- 2.2.1: Language elements
- 2.2.1.1: Identifiers and Names
- 2.2.1.2: Numbers
- 2.2.1.3: Parameter lists
- 2.2.1.4: Builtin functions
- 2.2.1.5: Character translation tables
- 2.2.1.6: Counters
- 2.2.1.7: Macros
- 2.2.1.8: Nousermacros
- 2.2.1.9: Symbols
- 2.2.2: Line continuation
- 2.2.3: The +identifier sequence
- 2.2.4: Preventing macros from being expanded
- 2.3.1: Defining a translation table
- 2.3.2: Using a translation table
- 2.3.3: Pushing and popping character tables
- 2.5.1: Creating a counter
- 2.5.2: Using counters
- 3.1.1: ADDTOCOUNTER
- 3.1.2: ADDTOSYMBOL
- 3.1.3: ATEXIT
- 3.1.4: CHAR
- 3.1.5: CHDIR
- 3.1.6: COMMENT
- 3.1.7: COUNTERVALUE
- 3.1.8: DECWSLEVEL
- 3.1.9: DEFINECHARTABLE
- 3.1.10: DEFINECOUNTER
- 3.1.11: DEFINEMACRO
- 3.1.12: DEFINESYMBOL
- 3.1.13: DELETECHARTABLE
- 3.1.14: DELETECOUNTER
- 3.1.15: DELETEMACRO
- 3.1.16: DELETENOUSERMACRO
- 3.1.17: DELETESYMBOL
- 3.1.18: DUMMY
- 3.1.19: ENDDEF
- 3.1.20: ERROR
- 3.1.21: EVAL
- 3.1.22: FILENAME
- 3.1.23: FPUTS
- 3.1.24: IFBUILTIN
- 3.1.25: IFCHARTABLE
- 3.1.26: IFDEF
- 3.1.27: IFEMPTY
- 3.1.28: IFEQUAL
- 3.1.29: IFGREATER
- 3.1.30: IFMACRO
- 3.1.31: IFSMALLER
- 3.1.32: IFSTREQUAL
- 3.1.33: IFSTRSUB
- 3.1.34: IFSYMBOL
- 3.1.35: IFZERO
- 3.1.36: INCLUDEFILE
- 3.1.37: INCLUDELIT, INCLUDELITERAL
- 3.1.38: INCWSLEVEL
- 3.1.39: INTERNALINDEX
- 3.1.40: NEWCOUNTER
- 3.1.41: NOEXPAND
- 3.1.42: NOEXPANDINCLUDE
- 3.1.43: NOEXPANDPATHINCLUDE
- 3.1.44: NOTRANS
- 3.1.45: NOUSERMACRO
- 3.1.46: OUTBASE
- 3.1.47: OUTDIR
- 3.1.48: OUTFILENAME
- 3.1.49: PARAGRAPH
- 3.1.50: PIPETHROUGH
- 3.1.51: POPCHARTABLE
- 3.1.52: POPCOUNTER
- 3.1.53: POPMACRO
- 3.1.54: POPSYMBOL
- 3.1.55: POPWSLEVEL
- 3.1.56: PUSHCHARTABLE
- 3.1.57: PUSHCOUNTER
- 3.1.58: PUSHMACRO
- 3.1.59: PUSHSYMBOL
- 3.1.60: PUSHWSLEVEL
- 3.1.61: RENAMEMACRO
- 3.1.62: SETCOUNTER
- 3.1.63: SETSYMBOL
- 3.1.64: STARTDEF
- 3.1.65: SUBST
- 3.1.66: SYMBOLVALUE
- 3.1.67: SYSTEM
- 3.1.68: TYPEOUT
- 3.1.69: UNDEFINEMACRO
- 3.1.70: UPPERCASE
- 3.1.71: USECHARTABLE
- 3.1.72: USECOUNTER
- 3.1.73: VERBOSITY
- 3.1.74: WARNING
- 3.1.75: WRITEOUT
- 4.1.1: Document types
- 4.1.2: The manpage document type
- 4.2.1: abstract(text)
- 4.2.2: addntosymbol(symbol)(n)(text)
- 4.2.3: affiliation(site)
- 4.2.4: AfourEnlarged()
- 4.2.5: appendix()
- 4.2.6: article(title)(author)(date)
- 4.2.7: bf(text)
- 4.2.8: bind(text)
- 4.2.9: book(title)(author)(date)
- 4.2.10: cell(contents)
- 4.2.11: cells(nColumns)(contents)
- 4.2.12: center(text)
- 4.2.13: chapter(title)
- 4.2.14: cindex()
- 4.2.15: cite(1)
- 4.2.16: clearpage()
- 4.2.17: code(text)
- 4.2.18: columnline(from)(to)
- 4.2.19: def(macroname)(nrofargs)(redefinition)
- 4.2.20: description(list)
- 4.2.21: dit(itemname)
- 4.2.22: eit()
- 4.2.23: ellipsis()
- 4.2.24: em(text)
- 4.2.25: email(address)
- 4.2.26: endcenter()
- 4.2.27: enddit()
- 4.2.28: endeit()
- 4.2.29: endit()
- 4.2.30: endmenu()
- 4.2.31: endtable()
- 4.2.32: enumerate(list)
- 4.2.33: enumeration(list)
- 4.2.34: fig(label)
- 4.2.35: figure(file)(caption)(label)
- 4.2.36: file(text)
- 4.2.37: findex()
- 4.2.38: footnote(text)
- 4.2.39: gagmacrowarning(name name ...)
- 4.2.40: getaffilstring()
- 4.2.41: getauthorstring()
- 4.2.42: getchapterstring()
- 4.2.43: getdatestring()
- 4.2.44: getfigurestring()
- 4.2.45: getpartstring()
- 4.2.46: gettitlestring()
- 4.2.47: gettocstring()
- 4.2.48: htmlbodyopt(option)(value)
- 4.2.49: htmlcommand(cmd)
- 4.2.50: htmlheadopt(option)
- 4.2.51: htmlnewfile()
- 4.2.52: htmlstylesheet(url)
- 4.2.53: htmltag(tagname)(start)
- 4.2.54: ifnewparagraph(truelist)(falselist)
- 4.2.55: includefile(file)
- 4.2.56: includeverbatim(file)
- 4.2.57: it()
- 4.2.58: itemization(list)
- 4.2.59: itemize(list)
- 4.2.60: kindex()
- 4.2.61: label(labelname)
- 4.2.62: langle()
- 4.2.63: languagedutch()
- 4.2.64: languageenglish()
- 4.2.65: languageportugese()
- 4.2.66: LaTeX()
- 4.2.67: latexaddlayout(arg)
- 4.2.68: latexcommand(cmd)
- 4.2.69: latexdocumentclass(class)
- 4.2.70: latexlayoutcmds(NOTRANSs)
- 4.2.71: latexoptions(options)
- 4.2.72: latexpackage(options)(name)
- 4.2.73: lchapter(label)(title)
- 4.2.74: letter(language)(date)(subject)(opening)(salutation)(author)
- 4.2.75: letteraddenda(type)(value)
- 4.2.76: letteradmin(yourdate)(yourref)
- 4.2.77: letterfootitem(name)(value)
- 4.2.78: letterreplyto(name)(address)(zip city)
- 4.2.79: letterto(element)
- 4.2.80: link(description)(labelname)
- 4.2.81: lref(description)(labelname)
- 4.2.82: lsect(label)(title)
- 4.2.83: lsubsect(label)(title)
- 4.2.84: lsubsubsect(label)(title)
- 4.2.85: lsubsubsubsect(label)(title)
- 4.2.86: lurl(locator)
- 4.2.87: mailto(address)
- 4.2.88: makeindex()
- 4.2.89: mancommand(cmd)
- 4.2.90: manpage(title)(section)(date)(source)(manual)
- 4.2.91: manpageauthor()
- 4.2.92: manpagebugs()
- 4.2.93: manpagedescription()
- 4.2.94: manpagediagnostics()
- 4.2.95: manpagefiles()
- 4.2.96: manpagename(name)(short description)
- 4.2.97: manpageoptions()
- 4.2.98: manpagesection(SECTIONNAME)
- 4.2.99: manpageseealso()
- 4.2.100: manpagesynopsis()
- 4.2.101: mbox()
- 4.2.102: menu(list)
- 4.2.103: metaC(text)
- 4.2.104: metaCOMMENT(text)
- 4.2.105: mit()
- 4.2.106: mscommand(cmd)
- 4.2.107: nchapter(title)
- 4.2.108: nemail(name)(address)
- 4.2.109: nl()
- 4.2.110: node(previous)(this)(next)(up)
- 4.2.111: nodeprefix(text)
- 4.2.112: nodeprefix(text)
- 4.2.113: nodetext(text)
- 4.2.114: nop(text)
- 4.2.115: nosloppyhfuzz()
- 4.2.116: notableofcontents()
- 4.2.117: notitleclearpage()
- 4.2.118: notocclearpage()
- 4.2.119: notransinclude(filename)
- 4.2.120: noxlatin()
- 4.2.121: nparagraph(title)
- 4.2.122: npart(title)
- 4.2.123: nsect(title)
- 4.2.124: nsubsect(title)
- 4.2.125: nsubsubsect(title)
- 4.2.126: nsubsubsect(title)
- 4.2.127: paragraph(title)
- 4.2.128: part(title)
- 4.2.129: pindex()
- 4.2.130: plainhtml(title)
- 4.2.131: printindex()
- 4.2.132: quote(text)
- 4.2.133: rangle()
- 4.2.134: redef(nrofargs)(redefinition)
- 4.2.135: redefinemacro(nrofargs)(redefinition)
- 4.2.136: ref(labelname)
- 4.2.137: report(title)(author)(date)
- 4.2.138: roffcmd(dotcmd)(sameline)(secondline)(thirdline)
- 4.2.139: row(contents)
- 4.2.140: rowline()
- 4.2.141: sc(text)
- 4.2.142: sect(title)
- 4.2.143: setaffilstring(name)
- 4.2.144: setauthorstring(name)
- 4.2.145: setchapterstring(name)
- 4.2.146: setdatestring(name)
- 4.2.147: setfigureext(name)
- 4.2.148: setfigurestring(name)
- 4.2.149: sethtmlfigureext(ext)
- 4.2.150: setincludepath(name)
- 4.2.151: setlanguage(name)
- 4.2.152: setlatexalign(alignment)
- 4.2.153: setlatexfigureext(ext)
- 4.2.154: setlatexverbchar(char)
- 4.2.155: setmanalign(alignment)
- 4.2.156: setpartstring(name)
- 4.2.157: setrofftab(x)
- 4.2.158: setrofftableoptions(optionlist)
- 4.2.159: settitlestring(name)
- 4.2.160: settocstring(name)
- 4.2.161: sgmlcommand(cmd)
- 4.2.162: sgmltag(tag)(onoff)
- 4.2.163: sloppyhfuzz(points)
- 4.2.164: standardlayout()
- 4.2.165: startcenter()
- 4.2.166: startdit()
- 4.2.167: starteit()
- 4.2.168: startit()
- 4.2.169: startmenu()
- 4.2.170: starttable()
- 4.2.171: sups(text)
- 4.2.172: subsect(title)
- 4.2.173: subsubsect(title)
- 4.2.174: subsubsubsect(title)
- 4.2.175: sups(text)
- 4.2.176: table(nColumns)(alignment)(Contents)
- 4.2.177: tcell(text)
- 4.2.178: telycommand(cmd)
- 4.2.179: TeX()
- 4.2.180: texinfocommand(cmd)
- 4.2.181: tindex()
- 4.2.182: titleclearpage()
- 4.2.183: tocclearpage()
- 4.2.184: tt(text)
- 4.2.185: txtcommand(cmd)
- 4.2.186: url(description)(locator)
- 4.2.187: verb(text)
- 4.2.188: verbinclude(filename)
- 4.2.189: verbpipe(command)(text)
- 4.2.190: vindex()
- 4.2.191: whenhtml(text)
- 4.2.192: whenlatex(text)
- 4.2.193: whenman(text)
- 4.2.194: whenms(text)
- 4.2.195: whensgml(text)
- 4.2.196: whentely(text)
- 4.2.197: whentexinfo(text)
- 4.2.198: whentxt(text)
- 4.2.199: whenxml(text)
- 4.2.200: xit(itemname)
- 4.2.201: xmlcommand(cmd)
- 4.2.202: xmlmenu(order)(title)(menulist)
- 4.2.203: xmlnewfile()
- 4.2.204: xmlsetdocumentbase(name)
- 4.2.205: xmltag(tag)(onoff)
- 4.3.1: Accents
- 4.3.2: Conversion-type specific literal commands
- 4.3.3: Figures
- 4.3.4: Fonts and sizes
- 4.3.5: Labels, links, references and URLs
- 4.3.6: Lists and environments
- 4.3.6.1: National language support
- 4.3.6.2: Pagebreaks after the title and table of contents
- 4.3.7: Sectioning
- 4.3.8: Typesetting modifiers
- 4.3.9: Miscellaneous commands
- 5.2.0.1: Direct commands to HTML
- 5.2.0.2: Section numbering
- 5.3.0.1: Direct commands to LaTeX
- 5.3.0.2: Verbatim text
- 5.4.0.1: Direct commands to man
- 5.5.0.1: Direct commands to txt
- 5.8.1: Example
- 6.1.1: Installing Yodl
- 6.2.1: Subdirectories and their meanings