3.8 Skribe User Manual -- Enumeration

These functions implements three various style of enumerations.

prototype
(itemize :symbol [:ident] [:class "itemize"] item...)
(enumerate :symbol [:ident] [:class "enumerate"] item...)
(description :symbol [:ident] [:class "description"] item...)
optionenginesdescription
identhtml latex xml The node identifier.
classhtml latex xml The node class.
symbolhtml latex The symbol that prefixes the items.
argumentdescription
item...The items of the enumeration.

Items are introduce by the means of the item markup:

prototype
(item :key [:ident] [:class])
optionenginesdescription
identhtml latex xml The node identifier.
classhtml latex xml The node class.
keyhtml latex The item key.
Example:
(itemize (item [A first item.])
         (item [A ,(bold "second") one:
             ,(itemize (item "One.")
                       (item "Two.")
                       (item "Three."))])
         (item [Lists can be nested. For instance that item contains a
           ,(tt "description"):
           ,(description (item :key (bold "foo")
                               [is a usual Lisp dummy identifier.])
                         (item :key (bold "bar")
                               [is another one.])
                         (item :key (list (bold "foo") (bold "bar"))
                               [A description entry may contain more than
                                one keyword.]))])
         (item [The last ,(tt "itemize") entry contains an ,(tt "enumerate"):
           ,(enumerate (item "One.") (item "Two.") (item "Three."))]))

(itemize :symbol "-"
         (item "One.")
         (item "Two.")
         (item "Three.")
         (item "Four."))
Ex. 10: The enumeration markups

Produces:

  • A first item.
  • A second one:
    • One.
    • Two.
    • Three.
  • Lists can be nested. For instance that item contains a description:
    foo
    is a usual Lisp dummy identifier.
    bar
    is another one.
    foo
    bar
    A description entry may contain more than one keyword.
  • The last itemize entry contains an enumerate:
    1. One.
    2. Two.
    3. Three.
  • One.
  • Two.
  • Three.
  • Four.

This Html page has been produced by Skribe.
Last update Tue Jun 29 09:37:13 2010.