Home Text styling Enumerations Lists
The guide of UDO > The UDO syntax > Text styling Index

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.

Before:
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

Afterwards:

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 !compressed is used, too:

Before:
!begin_description !compressed
!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

Afterwards:
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

Hints:

  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. Wenn der das letzte Zeichen ein Ausrufezeichen ist, dann muß diesem ein / folgend, damit UDO nicht die obige Regel annimmt.

  3. 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.

  4. A description of the !compressed command is part of the chapter Itemizations.


Copyright © www.udo-open-source.org (Kontakt)
Last updated on May 19, 2010

Home Text styling Enumerations Lists