### HTMLgen 2.2.2 Online Documentation

## Lists

### FEATURES

The List class and it's children have been structured to allow full nesting of either regular Python data types, (e.g., lists of lists of strings) or HTMLgen objects. For example, an OrderedList class can contain an instance of the List class, ImageBulletList class and DefinitionList class. Added in version 2.0.6 is the capability to render the list into multiple columns. Just set the `columns` attribute to a number greater than one and it will use that many columns. Also added is the ability to assign a background color through the use of the `bgcolor` attribute.

- List class uses the UL markup and is the base class for:
  - OrderedList, which uses the OL markup.
  - DefinitionList, which uses the DL markup.
  - ImageBulletList, which uses the UL markup and just provides a simple object object BR style for each list item.
  - NonBulletList, which uses the UL markup and just provides a simple indented list without prepending a bullet (or anything else).

The Netscape Navigator extension `type` tag is supported as an attribute of the List and OrderedList classes and can be set as keyword parameters (although they have different meanings). In List instances you can set the `type='disk' | 'circle' | 'square'` to hardwire the style of bullet used. In OrderedList instances you can set `type='A' | 'a' | 'I' | 'i'` to alter the numbering from Arabic to respectively: capital letters, small letters, Roman numerals, small Roman numerals.

Normal list operations apply to all the classes in this family as the base class inherits from the UserList class provided in the core distribution.

The rendered HTML output should also exhibit indentation proportional to the level of list nesting.

Below is some example output. See the HTMLtest.py script for the source code which generated it.

The following section just exercises most of the markup classes.

### List class

First item in the OrderedList (ImageBulletList) Purple Orange Red Blue Green Yellow | Second item in the OrderedList Items First Item Second Item SubitemA SubitemB Third Item More

This should be initial upper caps
  INITIAL UPPER CAPITAL LETTERS
This is normal Text with >< & escaped.
  <&>"Don't play dumb. You're not as good at it as I am.": Colonel Flagg - M*A*S*H
This is Blockquote markup.

  > "Don't play dumb. You're not as good at it as I am.": Colonel Flagg - M*A*S*H

This is red text.
  "Don't play dumb. You're not as good at it as I am.": Colonel Flagg - M*A*S*H
This is Address markup.
This is Emphasis markup.
  "Don't play dumb. You're not as good at it as I am.": Colonel Flagg - M*A*S*H
This is Cite markup.
  "Don't play dumb. You're not as good at it as I am.": Colonel Flagg - M*A*S*H
This is KBD markup.
  `"Don't play dumb. You're not as good at it as I am.": Colonel Flagg - M*A*S*H`
This is Sample markup.
  `"Don't play dumb. You're not as good at it as I am.": Colonel Flagg - M*A*S*H`
This is Code markup.
  `"Don't play dumb. You're not as good at it as I am.": Colonel Flagg - M*A*S*H`
This is Define markup.
  "Don't play dumb. You're not as good at it as I am.": Colonel Flagg - M*A*S*H
This is Var markup.
  "Don't play dumb. You're not as good at it as I am.": Colonel Flagg - M*A*S*H

Copyright © 1996-7 Robin Friedrich
All Rights Reserved
Comments to author: friedrich@pythonpros.com
Generated: Tue Apr 20, 1999