yodlletter(7) [debian man page]
yodlletter(7) Your Own Document Language yodlletter(7) NAME
yodlletter - Yodl's `letter' document type SYNOPSIS
letter(language)(date)(subject)(opening)(salutation)(author) The letter document type was implemented to write LaTeX letters. DESCRIPTION
The letter document type was specifically implemented to write LaTeX letters, using LaTeX's brief.cls document class. It is available only for the LaTeX (yodl2latex(1)) converter. This manual page briefly describes Yodl's letter document type. This document type is specific enough that it warrants a separate man- page. letter documents do not allow you to use the `standard' sectioning commands (e.g., sect() and subsect()). You can, however, use macros that are normally used within such sections, such as description(), itemization(), bf() or em(). Several specific macros, to be used in the preamble, are available for the letter document type. They are: o AfourEnlarged(): Enlarges the usable height of A4 paper by 2 cm.: the top margin is reduced by 2 cm. o letteraddenda(type)(value): Adds an addendum at the end of a letter. type should be bijlagen (i.e., appendices), cc or ps. Use nl() within the value section if multiple addenda of a certain type are used. o letteradmin(yourdate)(yourref): Puts yourletterfrom and yourreference elements in the letter. If left empty, two dashes are inserted. o letterfootitem(name)(value): Puts a footer at the bottom of letter-pages. Up to three will usually fit. For example, o letterreplyto(name)(address)(zip city): Defines the `reply to' address. o letterto(element): Adds element as an additional line to the address of the addressee. Use one element for each line of the addressee's address. Up to five lines will usually fit. A sixth line may be squeezed in, if necessary. The letter) macro itself requires the following arguments: o language: select english, dutch, or another language supported by the babel.sty style; o date: the letter's date. Use your own date-convention. The text specified here will be used as the letter's date; o subject: a short indication as to why you wrote the letter o opening: the letter's opening, e.g., Dear Linus,; o salutation: the letter's closing phrase, e.g., Kind regards,; o author: the name of the letter's author. nl() macros can be used here, but the brief class will also restrict the width of the author-lines by itself. SEE ALSO
latex(1), yodlstriproff(1), yodl(1), yodlbuiltins(7), yodlconverters(1), yodlletter(7), yodlmacros(7), yodlmanpage(7), yodlpost(1), yodlverbinsert(1). BUGS
- AUTHOR
Frank B. Brokken (f.b.brokken@rug.nl), yodl_3.00.0.tar.gz 1996-2010 yodlletter(7)
Check Out this Related Man Page
yodlverbinsert(1) Your Own Document Language yodlverbinsert(1) NAME
yodlverbinsert - Generate verb-sections from parts of a file SYNOPSIS
yodlverbinsert [OPTIONS] marker file DESCRIPTION
Verbinsert is a simple C support program that can be used to generate verb()-sections in Yodl files from sections of existing files. The files from which sections are included are usually C or Cpp source files, accepting either // or /*-style comment. See the EXAMPLES section for illustrations. Verbinsert offers the possibility to indent both the initial verb-statement and the inserted file contents. Furthermore, an additional empty line may be inserted before the first line that is actually inserted. o marker The argument marker must start in file's first column en must either start as a standard C or C++ comment: // or /* must be used. Following that, the remainder of the argument is used as a label, e.g., //label, /*LABEL*/. Except for the first two characters and their locations no special restrictions are imposed upon the markers. A labeled section ends at the next //= (when the label started with //) or at the next /**/ (when the label started with /*). Like the markers, the end-markers must also start in the file's first column. o file The argument file must be an existing file. Verbinsert writes its selected section to its standard output stream. NOTE: Starting with Yodl version 3.00.0 Yodl's default file inclusion behavior has changed. The current working directory no longer remains fixed at the directory in which Yodl is called, but is volatile, changing to the directory in which a yodl-file is located. This has the advantage that Yodl's file inclusion behavior now matches the way C's #include directive operates; it has the disadvantage that it may break some current documents. Conversion, however is simple but can be avoided altogether if Yodl's -L (--legacy-include) option is used. OPTIONS
The default values of options are listed with each of the options between square brackets. The defaults were chosen so that yodlverbinsert performs the behavior of an earlier version of this program, which was not distributed with Yodl. o -N Do not write a newline immediately following verb-statement's open-parenthesis. By default it is written, causing an additional line to be inserted before the first line that's actually inserted from a file. o -s spaces [0] start each line that is written into the verb-section with spaces additional blanks. o -S spaces [8] prefix the verb of the verb-section by spaces additional blanks. o -t tabs [0] start each line that is written into the verb-section with tabs additional tab characters. If both -s and -t are specified, the tabs are inserted first. o -T tabs [0] prefix the verb of the verb-section by tabs additional tab characters. If both -S and -T are specified, the tabs are inserted first. EXAMPLE
Assume the file demo contains the following text: preceding text //one one 1 //= /*two*/ two /**/ trailing text Then the following commands write the shown output to the program's standard output: o verbinclude //one demo verb( one 1 ) o verbinclude -N //one demo verb(one 1 ) o verbinclude -s4 '/*two*/' demo verb( two ) SEE ALSO
yodlstriproff(1), yodl(1), yodlbuiltins(7), yodlconverters(1), yodlletter(7), yodlmacros(7), yodlmanpage(7), yodlpost(1), yodlverbin- sert(1). BUGS
- AUTHOR
Frank B. Brokken (f.b.brokken@rug.nl), yodl_3.00.0.tar.gz 1996-2010 yodlverbinsert(1)