Home Emphasizing text Descriptions Centered text
 The guide of UDO
 The syntax of UDO
 Emphasizing text

Lists

Like the description environment this set of commands is useful to describe words. Using this environment the description of each word is displayed beneath one another.

The xlist environment starts with !begin_xlist and finishes with !end_xlist. You have to tell UDO in brackets how wide it should indent the descriptions of each item. Usually you use the longest word in brackets. Each word that has to be described has to used inside the brackets of the !item command.

You can use the xlist environment inside other (xlist) environments, too.

This short example...

UDO offers you the following environments:
!begin_xlist [description environment:]
!item [itemize environment:]
      for itemizations
!item [enumerate environment:]
      for enumerations
!item [description environment:]
      for descriptions
!item [xlist environment:]
      for lists (discussed in this section)
!end_xlist

... will be displayed this way:

UDO offers you the following environments:

itemize environment: for itemizations
 
enumerate environment: for enumerations
 
description environment: for descriptions
 
xlist environment: for lists (discussed in this section)
 

The command !short can also be used for xlist environments. To get a compressed list just add !short at the end of the line that contains !begin_xlist. Once more a short example:

!begin_xlist [description:] !short
!item [itemize:] Itemizations
!item [enumerate:] Enumerations
!item [description:] Descriptions
!item [xlist:] Lists
!end_xlist

... will be displayed this way:

itemize: Itemizations
enumerate: Enumerations
description: Descriptions
xlist: Lists

Since Release 6 UDO offers three additional environments that are similar to the xlist environment. In contrast to the xlist environment the items will be displayed in bold, italic or typewritered text.

  1. When using the blist environment (bold list) the items will be displayed in bold text. A blist environment will be started with !begin_blist and finished with !end_blist.
     
  2. When using the ilist environment (italic list) the items will be displayed in italic text. A blist environment will be started with !begin_ilist and finished with !end_ilist.
     
  3. When using the tlist environment (typewritered list) the items will be displayed in typewritered text. A tlist environment will be started with !begin_tlist and finished with !end_tlist.
     

The following example shall demonstrate the results:

!begin_xlist [typewritered:]
!item [normal:] !..
!end_xlist

!begin_blist [typewritered:]
!item [bold:] !..
!end_blist

!begin_ilist [typewritered:]
!item [italic:] !..
!end_ilist

!begin_tlist [typewritered:]
!item [typewritered:] !..
!end_tlist

... will be displayed this way:

normal: ...
 
bold: ...
 
italic: ...
 
typewritered: ...
 

You have to notice some aspects:

  1. If the text inside the brackets contains a "]" you have to quote it with an exclamation mark so that UDO will recognize that this "]" shall be part of the item and shall be displayed on the "left side".
     
  2. Bei HTML erzeugt für diese Listen Tabellen Leider unterscheiden sich Navigator und IE bei der Ausgabe der Tabellen. Falls nicht gewünscht kann man per !html_no_xlist veranlassen, dass die Listen als description-Umgebungen ausgeben werden.
     
  3. UDO doesn't know the character widths when converting the source file to RTF and Windows Help. If the indents are too wide you can adjust the indent by using the commands !rtf_charwidth and !win_charwidth.
     
  4. A description of the !short command is part of the chapter "Itemizations".
     

Copyright © www.udo-open-source.org
Last updated on November 5, 2006

Home Emphasizing text Descriptions Centered text