OrderedListBuilder
(start, format)¶Constructor:
__init__
(start, format)¶Create an ordered list with sequentially numbered mark text.
The format is composed of an optional prefix text, a numbering scheme character followed by suffix text. Valid numbering schemes are:
1
a
A
i
I
Prefix text may typically be (
or [
and suffix text is
typically .
, )
or empty, but either can be any string.
Parameters: |
|
---|
Methods:
begin
(decoder, style)Begin a list. get_mark
(value)item
(decoder, style[, value])Begin a list item.
Attributes:
Methods
OrderedListBuilder.
begin
(decoder, style)Begin a list.
Parameters:
- decoder (StructuredTextDecoder) – Decoder.
- style (dict) – Style dictionary that applies over the entire list.
OrderedListBuilder.
item
(decoder, style, value=None)Begin a list item.
Parameters:
- decoder (StructuredTextDecoder) – Decoder.
- style (dict) – Style dictionary that applies over the list item.
- value (str) – Optional value of the list item. The meaning is list-type dependent.