Home Emphasizing text Enumerations Lists
 The guide of UDO
 The syntax of UDO
 Emphasizing text

Descriptions

Use the description environment for describing some words. Start the environment with !begin_description and finish it using !end_description.

A word that has to be described is used with the !item command inside brackets and will be displayed with bold text.

The description environment can be used inside other (description) environments. This example...

UDO offers you the following environments:
!begin_description
!item [the itemize environment]
      for itemized lists,
!item [the enumerate environment]
      for enumerated lists,
!item [the description environment]
      for descriptions and
!item [the xlist environment]
      for lists
!end_description

... will be displayed this way:

UDO offers you the following environments:

the itemize environment
for itemized lists,
 
the enumerate environment
for enumerated lists,
 
the description environment
for descriptions and
 
the xlist environment
for lists
 

In this example the description environment is used inside another one and the !short is used, too:

!begin_description !short
!item [Item 1] of the outer description environment
!item [Item 2] of the outer description environment
      !begin_description
      !item [Item 1] of the inner environment.
      !item [Item 2] of the inner environment.
      !end_description
!item [Item 3] of the outer description environment
!end_description

... becomes:

Item 1
of the outer description environment
Item 2
of the outer description environment
Item 1
of the inner environment.
Item 2
of the inner environment.
Item 3
of the outer description environment

Please note:

  1. If the word that shall be displayed in bold text contains a "]" you have to quote it with an exclamation mark to tell UDO that it has to be printed in bold text, too.
     
  2. The HTML version of your source file will print the descriptions in bold text, too, even if this not typical for HTML. The next versions of UDO will offer a command to disable the bold text inside descriptions for HTML.
     
  3. 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 Enumerations Lists