betty.html package

Submodules

• betty.html.attributes module
  • Attributes
    • Attributes.__init__()
    • Attributes.format()
    • Attributes.get_data()
    • Attributes.html_accept
    • Attributes.html_accept_charset
    • Attributes.html_accesskey
    • Attributes.html_action
    • Attributes.html_allow
    • Attributes.html_alt
    • Attributes.html_aria_controls
    • Attributes.html_aria_expanded
    • Attributes.html_as
    • Attributes.html_async
    • Attributes.html_autocapitalize
    • Attributes.html_autocomplete
    • Attributes.html_autoplay
    • Attributes.html_capture
    • Attributes.html_charset
    • Attributes.html_checked
    • Attributes.html_cite
    • Attributes.html_class
    • Attributes.html_cols
    • Attributes.html_colspan
    • Attributes.html_content
    • Attributes.html_contenteditable
    • Attributes.html_controls
    • Attributes.html_coords
    • Attributes.html_crossorigin
    • Attributes.html_data
    • Attributes.html_datetime
    • Attributes.html_decoding
    • Attributes.html_default
    • Attributes.html_defer
    • Attributes.html_dir
    • Attributes.html_dirname
    • Attributes.html_disabled
    • Attributes.html_download
    • Attributes.html_draggable
    • Attributes.html_enctype
    • Attributes.html_enterkeyhint
    • Attributes.html_for
    • Attributes.html_formaction
    • Attributes.html_formenctype
    • Attributes.html_formmethod
    • Attributes.html_formnovalidate
    • Attributes.html_formtarget
    • Attributes.html_headers
    • Attributes.html_height
    • Attributes.html_hidden
    • Attributes.html_high
    • Attributes.html_href
    • Attributes.html_hreflang
    • Attributes.html_http_equiv
    • Attributes.html_id
    • Attributes.html_inputmode
    • Attributes.html_integrity
    • Attributes.html_ismap
    • Attributes.html_itemprop
    • Attributes.html_kind
    • Attributes.html_label
    • Attributes.html_lang
    • Attributes.html_list
    • Attributes.html_loading
    • Attributes.html_loop
    • Attributes.html_low
    • Attributes.html_max
    • Attributes.html_maxlength
    • Attributes.html_media
    • Attributes.html_method
    • Attributes.html_min
    • Attributes.html_minlength
    • Attributes.html_multiple
    • Attributes.html_muted
    • Attributes.html_name
    • Attributes.html_novalidate
    • Attributes.html_open
    • Attributes.html_optimum
    • Attributes.html_pattern
    • Attributes.html_ping
    • Attributes.html_placeholder
    • Attributes.html_playsinline
    • Attributes.html_poster
    • Attributes.html_preload
    • Attributes.html_readonly
    • Attributes.html_referrerpolicy
    • Attributes.html_rel
    • Attributes.html_required
    • Attributes.html_reversed
    • Attributes.html_role
    • Attributes.html_rows
    • Attributes.html_rowspan
    • Attributes.html_sandbox
    • Attributes.html_scope
    • Attributes.html_selected
    • Attributes.html_shape
    • Attributes.html_size
    • Attributes.html_sizes
    • Attributes.html_slot
    • Attributes.html_span
    • Attributes.html_spellcheck
    • Attributes.html_src
    • Attributes.html_srcdoc
    • Attributes.html_srclang
    • Attributes.html_srcset
    • Attributes.html_start
    • Attributes.html_step
    • Attributes.html_style
    • Attributes.html_tabindex
    • Attributes.html_target
    • Attributes.html_title
    • Attributes.html_translate
    • Attributes.html_type
    • Attributes.html_usemap
    • Attributes.html_value
    • Attributes.html_width
    • Attributes.html_wrap
    • Attributes.set()
    • Attributes.set_data()
    • Attributes.setdefault()

Module contents

Provide the HTML API, for generating HTML pages.

class betty.html.Breadcrumbs

Bases: Dumpable

A trail of navigational breadcrumbs.

__init__()

append(label: str, url: str) → None

Append a breadcrumb to the trail.

dump() → bool | int | float | str | None | MutableSequence[Dump] | MutableMapping[str, Dump]

Produce a serialized data dump of self.

class betty.html.Citer

Bases: object

Track citations when they are first used.

__init__()

cite(citation: Citation) → int

Reference a citation.

Returns:

The citation’s sequential reference number.

class betty.html.CssProvider

Bases: ABC

Provide CSS for HTML pages.

abstract property public_css_paths: Sequence[str]

The public URL paths to the CSS files to include in each HTML page.

class betty.html.JsProvider

Bases: ABC

Provide JavaScript for HTML pages.

abstract property public_js_paths: Sequence[str]

The public URL paths to the JavaScript files to include in each HTML page.

final class betty.html.NavigationLink

Bases: Link

A navigation link.

__init__(url: str, label: Localizable)

property label: Localizable

The human-readable short link label.

property url: str

The absolute URL the link points to.

class betty.html.NavigationLinkProvider

Bases: object

Provide navigation links for HTML pages.

primary_navigation_links() → Sequence[NavigationLink]

The primary navigation links.

secondary_navigation_links() → Sequence[NavigationLink]

The secondary navigation links.