Yodl 3.08.02

Frank B. Brokken (f.b.brokken@rug.nl)
initially by Karel Kubat

Center for Information Technology, 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

Chapter 1: Introduction

1.1: From 1.xx to 2.00: what's new?

1.2: Why use Yodl?

1.3: Copying Yodl

Chapter 2: Yodl User Guide

2.1: Using the yodl program

2.2: The Yodl grammar

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: Character tables

2.3.1: Defining a translation table
2.3.2: Using a translation table
2.3.3: Pushing and popping character tables

2.4: Sending literal text to the output

2.5: Counters

2.5.1: Creating a counter
2.5.2: Using counters

Chapter 3: All builtin functions

3.1: Yodl's builtin commands

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

Chapter 4: Macros and Document types

4.1: General structure of a Yodl document

4.1.1: Document types
4.1.2: The manpage document type

4.2: Predefined macros

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: attrib(text)
4.2.8: attribclear()
4.2.9: attribinsert()
4.2.10: bf(text)
4.2.11: bind(text)
4.2.12: book(title)(author)(date)
4.2.13: cell(contents)
4.2.14: cells(nColumns)(contents)
4.2.15: cellsline(from)(count)
4.2.16: center(text)
4.2.17: chapter(title)
4.2.18: cindex()
4.2.19: cite(1)
4.2.20: clearpage()
4.2.21: code(text)
4.2.22: columnline(from)(to)
4.2.23: def(macroname)(nrofargs)(redefinition)
4.2.24: description(list)
4.2.25: dit(itemname)
4.2.26: eit()
4.2.27: ellipsis()
4.2.28: em(text)
4.2.29: email(address)
4.2.30: enumeration(list)
4.2.31: euro()
4.2.32: fig(label)
4.2.33: figure(file)(caption)(label)
4.2.34: file(text)
4.2.35: findex()
4.2.36: footnote(text)
4.2.37: gagmacrowarning(name name ...)
4.2.38: getaffilstring()
4.2.39: getauthorstring()
4.2.40: getchapterstring()
4.2.41: getdatestring()
4.2.42: getfigurestring()
4.2.43: getpartstring()
4.2.44: gettitlestring()
4.2.45: gettocstring()
4.2.46: htmlcommand(cmd)
4.2.47: htmlheadfile(file)
4.2.48: htmlheadopt(option)
4.2.49: htmlnewfile()
4.2.50: htmlstyle(tag)(definition)
4.2.51: htmlstylesheet(url)
4.2.52: htmltag(tagname)(start)
4.2.53: ifnewparagraph(truelist)(falselist)
4.2.54: includefile(file)
4.2.55: includeverbatim(file)
4.2.56: it()
4.2.57: itdesc(itemname)(contents)
4.2.58: itemization(list)
4.2.59: kindex()
4.2.60: label(labelname)
4.2.61: langle()
4.2.62: languagedutch()
4.2.63: languageenglish()
4.2.64: languageportugese()
4.2.65: LaTeX()
4.2.66: latexaddlayout(arg)
4.2.67: latexcommand(cmd)
4.2.68: latexdocumentclass(class)
4.2.69: latexlayoutcmds(NOTRANSs)
4.2.70: latexoptions(options)
4.2.71: latexpackage(options)(name)
4.2.72: lchapter(label)(title)
4.2.73: letter(language)(date)(subject)(opening)(salutation)(author)
4.2.74: letteraddenda(type)(value)
4.2.75: letteradmin(yourdate)(yourref)
4.2.76: letterfootitem(name)(value)
4.2.77: letterreplyto(name)(address)(zip city)
4.2.78: letterto(element)
4.2.79: link(description)(labelname)
4.2.80: lref(description)(labelname)
4.2.81: lsect(label)(title)
4.2.82: lsubsect(label)(title)
4.2.83: lsubsubsect(label)(title)
4.2.84: lsubsubsubsect(label)(title)
4.2.85: lurl(locator)
4.2.86: mailto(address)
4.2.87: makeindex()
4.2.88: mancommand(cmd)
4.2.89: manpage(title)(section)(date)(source)(manual)
4.2.90: manpageauthor()
4.2.91: manpagebugs()
4.2.92: manpagedescription()
4.2.93: manpagediagnostics()
4.2.94: manpagefiles()
4.2.95: manpagename(name)(short description)
4.2.96: manpageoptions()
4.2.97: manpagesection(SECTIONNAME)
4.2.98: manpageseealso()
4.2.99: manpagesynopsis()
4.2.100: mbox()
4.2.101: metaC(text)
4.2.102: metaCOMMENT(text)
4.2.103: mscommand(cmd)
4.2.104: nchapter(title)
4.2.105: nemail(name)(address)
4.2.106: nl()
4.2.107: nodeprefix(text)
4.2.108: nodeprefix(text)
4.2.109: nodetext(text)
4.2.110: nohtmlfive()
4.2.111: nohtmlimgstyle()
4.2.112: nop(text)
4.2.113: nosloppyhfuzz()
4.2.114: notableofcontents()
4.2.115: notitleclearpage()
4.2.116: notocclearpage()
4.2.117: notransinclude(filename)
4.2.118: noxlatin()
4.2.119: nparagraph(title)
4.2.120: npart(title)
4.2.121: nsect(title)
4.2.122: nsubsect(title)
4.2.123: nsubsubsect(title)
4.2.124: nsubsubsect(title)
4.2.125: paragraph(title)
4.2.126: part(title)
4.2.127: pindex()
4.2.128: plainhtml(title)
4.2.129: printindex()
4.2.130: quote(text)
4.2.131: rangle()
4.2.132: redef(macro)(nrofargs)(redefinition)
4.2.133: redefinemacro(macro)(nrofargs)(redefinition)
4.2.134: ref(labelname)
4.2.135: report(title)(author)(date)
4.2.136: roffcmd(dotcmd)(sameline)(secondline)(thirdline)
4.2.137: row(contents)
4.2.138: rowline()
4.2.139: sc(text)
4.2.140: sect(title)
4.2.141: setaffilstring(name)
4.2.142: setauthorstring(name)
4.2.143: setchapterstring(name)
4.2.144: setdatestring(name)
4.2.145: setfigureext(name)
4.2.146: setfigurestring(name)
4.2.147: sethtmlfigureext(ext)
4.2.148: htmlmetacharset(meta-charset)
4.2.149: setincludepath(name)
4.2.150: setlanguage(name)
4.2.151: setlatexalign(alignment)
4.2.152: setlatexfigureext(ext)
4.2.153: setlatexverbchar(char)
4.2.154: setmanalign(alignment)
4.2.155: setpartstring(name)
4.2.156: setrofftab(x)
4.2.157: setrofftableoptions(optionlist)
4.2.158: settitlestring(name)
4.2.159: settocstring(name)
4.2.160: sgmlcommand(cmd)
4.2.161: sgmltag(tag)(onoff)
4.2.162: sloppyhfuzz(points)
4.2.163: standardlayout()
4.2.164: strong(contents)
4.2.165: subs(text)
4.2.166: subsect(title)
4.2.167: subsubsect(title)
4.2.168: subsubsubsect(title)
4.2.169: sups(text)
4.2.170: table(nColumns)(alignment)(Contents)
4.2.171: tcell(text)
4.2.172: telycommand(cmd)
4.2.173: TeX()
4.2.174: texinfocommand(cmd)
4.2.175: tindex()
4.2.176: titleclearpage()
4.2.177: tocclearpage()
4.2.178: tt(text)
4.2.179: txtcommand(cmd)
4.2.180: url(description)(locator)
4.2.181: verb(text)
4.2.182: verbinclude(filename)
4.2.183: verbinsert(args)
4.2.184: verbpipe(command)(text)
4.2.185: vindex()
4.2.186: whenhtml(text)
4.2.187: whenlatex(text)
4.2.188: whenman(text)
4.2.189: whenms(text)
4.2.190: whensgml(text)
4.2.191: whentely(text)
4.2.192: whentexinfo(text)
4.2.193: whentxt(text)
4.2.194: whenxml(text)
4.2.195: xit(itemname)
4.2.196: xmlcommand(cmd)
4.2.197: xmlmenu(order)(title)(menulist)
4.2.198: xmlnewfile()
4.2.199: xmlsetdocumentbase(name)
4.2.200: xmltag(tag)(onoff)

4.3: Conversion-related topics

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

4.4: Locations of the macros

Chapter 5: Conversions and converters

5.1: Conversion script invocations

5.2: The HTML converter

5.2.0.1: Direct commands to HTML
5.2.0.2: Section numbering

5.3: The LaTeX converter

5.3.0.1: Direct commands to LaTeX
5.3.0.2: Verbatim text

5.4: The man converter

5.4.0.1: Direct commands to man

5.5: The txt converter

5.5.0.1: Direct commands to txt

5.6: The experimental XML converter

5.7: The Yodl Post-processor `yodlpost'

5.8: The support program `yodlverbinsert'

5.8.1: Example

Chapter 6: Technical information

6.1: Obtaining Yodl

6.1.1: Installing Yodl

6.2: Organization of the software

6.2.1: Subdirectories and their meanings

6.3: Yodl's component interrelations and component setup

6.4: The token-producer `lexer_lex()'

6.5: The Parser's Finite State Automaton

6.6: Adding a new macro

6.7: The Yodl post-processor