Number formats

Format numbers, such as those in a numbered list.

NumberFormatType

class creator_studio_doc_format.core.NumberFormatType(*, preset_identifier='', kind=None, upper=None, formal=None, format=None, **extra_data)[source]

A format for numbers, such as those in a numbered list.

Not every combination of kind, upper, formal, and format exists; an unsupported combination falls back to a plain number followed by a period.

field kind : NumberFormatTypeKind | None = None

The numbering system used for the label, such as Western digits, Roman numerals, Latin letters, or a Japanese, Chinese, Korean, Arabic, or Hebrew system. The default is numeric.

field upper : bool | None = None

Whether to use uppercase, which applies only to the roman and alpha kinds; every other kind requires false. The default is false.

field formal : bool | None = None

Whether to use the formal ideographic form, which applies only to the japanese, simplified_chinese, and traditional_chinese kinds; every other kind requires false. The default is false.

field format : Format | None = None

The decoration around the number: decimal for a trailing period, paren for a trailing parenthesis, double_paren for enclosing parentheses, circled (numeric kind only), or standard (hebrew_biblical kind only). The default is decimal.

NumberFormatTypeKind

class creator_studio_doc_format.core.NumberFormatTypeKind(str, Enum)[source]

A numbering system.

A field accepts a member or its value, so NumberFormatTypeKind.ALPHA and 'alpha' are the same. The member’s name as a string isn’t accepted.

ALPHA = 'alpha'

Latin letters; use upper to choose between A and a.

ARABIAN = 'arabian'

Arabic-Indic digits.

ARABIAN_ABJAD = 'arabian_abjad'

Abjad numerals, in which Arabic letters carry numeric values.

ARABIAN_ALPHA = 'arabian_alpha'

Arabic letters in alphabetical order.

HEBREW = 'hebrew'

Hebrew letters in alphabetical order.

HEBREW_BIBLICAL = 'hebrew_biblical'

Traditional Hebrew numerals, in which letters carry numeric values.

HIRAGANA = 'hiragana'

Hiragana characters in aiueo order.

HIRAGANA_IROHA = 'hiragana_iroha'

Hiragana characters in iroha order.

JAPANESE = 'japanese'

Japanese ideographic numerals; set formal for the formal form.

KATAKANA = 'katakana'

Katakana characters in aiueo order.

KATAKANA_IROHA = 'katakana_iroha'

Katakana characters in iroha order.

KOREAN = 'korean'

Korean syllables in ga, na, da order.

NUMERIC = 'numeric'

Western digits: 1, 2, 3.

ROMAN = 'roman'

Roman numerals; use upper to choose between I and i.

SIMPLIFIED_CHINESE = 'simplified_chinese'

Simplified Chinese ideographic numerals; set formal for the formal form.

TRADITIONAL_CHINESE = 'traditional_chinese'

Traditional Chinese ideographic numerals; set formal for the formal form.

Format

class creator_studio_doc_format.core.Format(str, Enum)[source]

The decoration around a number, such as a trailing period or parentheses.

A field accepts a member or its value, so Format.CIRCLED and 'circled' are the same. The member’s name as a string isn’t accepted.

CIRCLED = 'circled'

The number enclosed in a circle. Valid only with the numeric kind.

DECIMAL = 'decimal'

The number followed by a period, as in 1..

DOUBLE_PAREN = 'double_paren'

The number enclosed in parentheses, as in (1).

PAREN = 'paren'

The number followed by a closing parenthesis, as in 1).

STANDARD = 'standard'

The standard form of the number for its kind, with no added decoration. Valid only with the hebrew_biblical kind.