Note: This 'manual' is copied from http://pdml.sourceforge.net/manual.php as a quick reference for myself.

Documentation

Tags

a author b body br cell column div font footer head header i img keywords line multicell page pdml rect rotate script subject title u

Entities

pagenumber pagecount title author subject creator A word about size and dimension parameters:

By default, all lengths and sizes are in points. You can override this by specifying a unit after the number. Currently recognized units are:

  • mm: millimeters
  • cm: centimeters
  • in: inches
  • pt: points. equivalent to not specifying a unit.
  • %: percentage. For length, this is the percentage of the appropriate page dimension. For font size, this is relative to the current font size.

    a

    Define a local anchor, and/or define a link.<br> This element can be used anywhere within a body element, except inside a multicell element.
  • name: define a local anchor
  • href: define a link Example:
    <a href="http://pdml.sf.net/">This is a URL link</a>
<a href="#blah">This is a local link</a>
<a name="blah" />This is a local anchor.
    See also:

    author

    Set an author for the document.<br> This element can be used directly under a head element.Example:
    <pdml>
<head>
<author>John Q. Author</author>
</head>
...
    See also:     subject, keywords,

    b

    Renders text in bold.<br> This element can be used anywhere within a body element, except inside a multicell element.Example:
    Normal text, <b>Bold text, </b> More normal text.
    See also:     u, i, font,

    body

    Indicates the beginning of the actual document rendering tags.<br> This element must be used once under the pdml element.Example:
    <pdml>
<body>
Text to render goes here.
</body>
</pdml>
    See also:     head,

    br

    Insert a line break in the document.<br> This element can be used anywhere within a body element, except inside a multicell element.
  • height: the length of the line break. By default, the size of the current font. Example:
    Some text.<br />
More text on the next line.
<br height="3cm" />
Some more text, 3 centimeters below.
    See also:     page,

    cell

    Define a single line of text that can have a border, background, position and alignment.<br> This is primarily used to build tables, by using the next parameter.<br> This element can be used anywhere within a body element, except insider a cell or a multicell element.
  • left: the distance between the container and the left border of the page. By default, use the current position in the document.
  • top: the distance between the container and the top border of the page. By default, use the current position in the document.
  • width: the width of the container. By default, use the remainder of the space on the page.
  • height: the height of the container. By default, use the remainder of the space on the page.
  • color: indicates a border is needed and specify the color. Colors are encoded as 6 digits hexadecimal numbers such as "FC80C0" or "#A03E8F"
  • fillcolor: specify a background color. By default, the background is transparent.
  • border: indicates the thickness of the border.
  • next: right|bottom|break: define where the flow continues after the cell.
  • align: left|center|right Example:
    hm. write me. See 3d example in the "examples" section.
    See also:     div, multicell,

    column

    Starts a multi-column layout.<br> This element can be used anywhere within a body element, except insider a cell or a multicell element.
  • left: the distance between the container and the left border of the page. By default, use the current position in the document.
  • top: the distance between the container and the top border of the page. By default, use the current position in the document.
  • count: how many columns should show. By default, use 2 columns.
  • width: the width of one column. By default, use the remainder of the space on the page, divided by the number of columns
  • height: the height of each column. By default, use the remainder of the space on the page.
  • spacing: the vertical distance between 2 rows of columns. Only meaningful if break is set to 'line'.
  • break: page|line. if set to 'page', a new page starts everytime all columns are filled. if set to 'line', start a new row under the current one. Example:
    yes, an example would be nice. See 3d example in the "examples" section.
    See also:

    div

    Define a text container that can have a border, a background, a position and a size.<br> This element can be used anywhere within a body element, except inside a multicell element.
  • left: the distance between the container and the left border of the page. By default, use the current position in the document.
  • top: the distance between the container and the top border of the page. By default, use the current position in the document.
  • width: the width of the container. By default, use the remainder of the space on the page.
  • height: the height of the container. By default, use the remainder of the space on the page.
  • color: indicates a border is needed and specify the color. Colors are encoded as 6 digits hexadecimal numbers such as "FC80C0" or "#A03E8F"
  • fillcolor: specify a background color. By default, the background is transparent.
  • border: indicates the thickness of the border. Example:
    <div top=30% left=30% width=40% height=40% color=#00FF00 border=2mm>
This is <b>right</b> in the <u>middle</u> of the page.<br>
Neat.
</div>
    See also:     multicell,

    font

    Specify a change of font family, color and/or size.<br> This element can be used anywhere within a body element, except inside a multicell element.
  • color: set the color of the font, using a 6 digit hexadecimal number.
  • face: set the family of the font [XXX: This needs more details.]
  • size: set the font size. Example:
    default size. <font size=%200>This is twice as big.</font>
<font size=8pt>This is 8pt. <font size=4cm>This is a 4cm-tall font.
</font>This is a 8pt font again.</font>
<font face=Courier>This is courier<font face=Arial>
This is arial</font> courier again</font>
<font color="#ff0000">red, </font>
<font color="#00ff00">green, </font>
<font color="#0000ff">blue.</font>
    See also:     b, u, i,

    footer

    This element, like <a href=#header>header</a>, is processed unusually. Instead of being rendered directly, the content of this element is kept until the bottom of a page is reached. At this point, anything within the footer element gets rendered.Example:
    <body>
<footer>
<multicell top=98% align=right>
Page &pagenumber;/&pagecount;</multicell>
</footer>
<page />
<page />
<page />
<footer>
<div top=98% left=40%>I am the last footer.</div>
</footer>
</body>
    See also:     header, page,

    head

    Indicates a section of the document that doesn't directly impact its rendering.<br> This element can be used once under the pdml element.Example:
    <pdml>
<head>
<author>John Q. T. Author.</author>
<title>PDML Considered Harmful</title>
</head>
<body>
...
</body>
</pdml>
    See also:     body,

    header

    This element, like <a href=#footer>footer</a>, is processed unusually. Instead of being rendered directly, the content of this element is kept until a new page starts. At this point, anything within the header element gets rendered.Example:
    <body>
<header>
<font face=Courier size=25pt color="#00ff5c">
<multicell align=center>Header Thingy.</multicell>
</font>
</header>
<page />
<page />
<page />
</body>
    See also:     footer, page,

    i

    Renders text in italic.<br> This element can be used anywhere within a body element, except inside a multicell element.Example:
    Normal text ,<i>Italic text, </b>More normal text.
    See also:     b, u,

    img

    write meExample:
    See also: 
    keywords
    
write meExample:
    See also: 
    line
    
write meExample:
    See also: 
    multicell
    
write meExample:
    See also: 
    page
    
write meExample:
    See also: 
    pdml
    
write meExample:
    See also: 
    rect
    
write meExample:
    See also: 
    rotate
    
write meExample:
    See also: 
    script
    
write meExample:
    See also: 
    subject
    
write meExample:
    See also: 
    title
    
write meExample:
    See also: 
    u
    
Renders text with an underline.<br>
This element can be used anywhere within a body element, except inside a multicell element.Example:
    Normal text ,<u>Underlined text, </u>More normal text.
    See also:     b, i, 
    pagenumber
    
write meExample:
    See also: 
    pagecount
    
write meExample:
    See also: 
    title
    
Expands into the document title as specified in the <TITLE> tag.
This element can be used anywhere within a body element.Example:
    <header><multicell align="center">&title;</multicell></header>
    See also:     title, 
    author
    
Expands into the document author as specified in the <AUTHOR> tag.
This element can be used anywhere within a body element.Example:
    <header><multicell align="center">&author;</multicell></header>
    See also:     author, 
    subject
    
Expands into the document subject as specified in the <SUBJECT> tag.
This element can be used anywhere within a body element.Example:
    <header><multicell align="center">&subject;</multicell></header>
    See also:     subject, 
    creator
    
Expands into the document creator as specified in the <CREATOR> tag.
This element can be used anywhere within a body element.Example:
    <header><multicell align="center">&creator;</multicell></header>
    See also:     creator, 
    


    Site design and content copyright (c) 2004 Henri T.