Article¶

The article template consists of a title page, an optional table of contents and the body text. By default, it uses a single numbering style for all pages and the same template for even and odd pages.

class rinoh.templates.article.Article(document_tree, configuration=None, backend=None)¶

stylesheet¶

The stylesheet to use for styling document elements (inherited from DocumentTemplate)

Accepts StyleSheet: the name of an installed style sheet or the filename of a stylesheet file (with the .rts extension)

Default: sphinx_article (= rinoh.stylesheets.sphinx_article) (overrides DocumentTemplate default)

table_of_contents¶

Show or hide the table of contents

Accepts Bool: true or false

Default: true

abstract_location¶

Where to place the abstract

Accepts AbstractLocation: title, front matter

Default: front matter

parts¶

The parts making up this document (inherited from DocumentTemplate)

Accepts PartsList: a space-separated list of document part template names

Default: title front_matter contents (overrides DocumentTemplate default)

language¶

The main language of the document (inherited from DocumentTemplate)

Accepts Language: the code of one of the supported languages

Default: EN (English)

strings¶

Strings to override standard element names (inherited from DocumentTemplate)

Accepts Strings: strings need to be entered in INI sections named after the StringCollection subclasses

Default: none

title¶

base: None

Type: TitlePartTemplate

front_matter¶

base: None

Overrides these defaults:

page_number_format = continue

Type: ArticleFrontMatter

contents¶

base: None

Overrides these defaults:

page_number_format = continue

Type: ContentsPartTemplate

page¶

base: None

Overrides these defaults:

page_size = $(paper_size)

Type: BodyPageTemplate

title_page¶

base: page

Overrides these defaults:

top_margin = 8cm

Type: TitlePageTemplate

front_matter_page¶

base: page

Type: BodyPageTemplate

contents_page¶

base: page

Type: BodyPageTemplate

Configuration¶: alias of ArticleConfiguration

ConfigurationFile¶: alias of ArticleConfigurationFile

class rinoh.templates.article.AbstractLocation¶

Where to place the article’s abstract

Accepts: title, front matter