API Reference

domilite.dom_tag Module

Classes

dom_tag(*args, **kwargs)

Base class for any tag object.

Flags(value)

Set rendering properties of individual tags

Class Inheritance Diagram

Inheritance diagram of domilite.dom_tag.dom_tag, domilite.dom_tag.Flags

domilite.tags Module

Classes

dom_tag(*args, **kwargs)

Base class for any tag object.

html_tag(*args, **kwargs)

Any valid HTML tag

html(*args, **kwargs)

The root element of an HTML document

head(*args, **kwargs)

The <head> HTML element contains machine-readable information (metadata) about the document, like its title, scripts, and style sheets.

title(*args, **kwargs)

The <title> HTML element defines the document's title that is shown in a browser's title bar or a page's tab.

base(*args, **kwargs)

The <base> HTML element specifies the base URL to use for all relative URLs contained within a document.

link(*args, **kwargs)

The <link> HTML element specifies relationships between the current document and an external resource.

meta(*args, **kwargs)

The <meta> HTML element represents metadata that cannot be represented by other HTML meta-related elements, like base, link, script, style or title.

style(*args, **kwargs)

The <style> HTML element contains style information for a document, or part of a document.

script(*args, **kwargs)

The <script> HTML element is used to embed executable code or data; this is typically used to embed or refer to JavaScript code.

noscript(*args, **kwargs)

The <noscript> HTML element defines a section of HTML to be inserted if a script type on the page is unsupported or if scripting is currently turned off in the browser.

body(*args, **kwargs)

The <body> HTML element represents the content of an HTML document.

main(*args, **kwargs)

The <main> HTML element represents the dominant content of the body of a document.

section(*args, **kwargs)

The <section> HTML element represents a standalone section of functionality contained within an HTML document, typically with a heading, which doesn't have a more specific semantic element to represent it.

nav(*args, **kwargs)

The <nav> HTML element represents a section of a page that links to other pages or to parts within the page: a section with navigation links.

article(*args, **kwargs)

The <article> HTML element represents a self-contained composition in a document, page, application, or site, which is intended to be independently distributable or reusable (e.g., in syndication).

aside(*args, **kwargs)

The <aside> HTML element represents a section of a document with content connected tangentially to the rest, which could be considered separate from that content.

h1(*args, **kwargs)

The <h1> HTML element represents the most important heading on the page.

h2(*args, **kwargs)

The <h2> HTML element represents a second-level heading on the page.

h3(*args, **kwargs)

The <h3> HTML element represents a third-level heading on the page.

h4(*args, **kwargs)

The <h4> HTML element represents a fourth-level heading on the page.

h5(*args, **kwargs)

The <h5> HTML element represents a fifth-level heading on the page.

h6(*args, **kwargs)

The <h6> HTML element represents a sixth-level heading on the page.

hgroup(*args, **kwargs)

The <hgroup> HTML element represents a group of <h1> to <h6> elements that form a heading for a section of the document.

header(*args, **kwargs)

The <header> HTML element represents introductory content for a document or an article.

address(*args, **kwargs)

The <address> HTML element indicates that the enclosed HTML provides contact information for a person or people, or for an organization.

p(*args, **kwargs)

The <p> HTML element represents a paragraph of text.

hr(*args, **kwargs)

The <hr> HTML element represents a thematic break between paragraph-level elements.

pre(*args, **kwargs)

The <pre> HTML element represents preformatted text which is to be presented exactly as written in the HTML file.

blockquote(*args, **kwargs)

The <blockquote> HTML element indicates that the enclosed text is an extended quotation.

ol(*args, **kwargs)

The <ol> HTML element represents an ordered list of items, typically rendered with a numbered list.

ul(*args, **kwargs)

The <ul> HTML element represents an unordered list of items, typically rendered with bullet points.

li(*args, **kwargs)

The <li> HTML element represents an item in a list.

dl(*args, **kwargs)

The <dl> HTML element represents a description list.

dt(*args, **kwargs)

The <dt> HTML element specifies a term in a description or definition list, and as such must be used inside a <dl> element.

dd(*args, **kwargs)

The <dd> HTML element provides the description, definition, or value for the preceding term (dt) in a description list (dl).

figure(*args, **kwargs)

The <figure> HTML element represents self-contained content, potentially with an optional caption, which is specified using the <figcaption> element.

figcaption(*args, **kwargs)

The <figcaption> HTML element represents a caption or legend describing the rest of the contents of its parent <figure> element.

div(*args, **kwargs)

The <div> HTML element is a generic container for flow content.

a(*args, **kwargs)

The <a> HTML element (or anchor element), with its href attribute, creates a hyperlink to web pages, files, email addresses, locations in the same page, or anything else a URL can address.

em(*args, **kwargs)

The <em> HTML element marks text that has stress emphasis.

strong(*args, **kwargs)

The <strong> HTML element indicates that its contents have strong importance, seriousness, or urgency.

small(*args, **kwargs)

The <small> HTML element represents side comments such as copyright, contact information, or legal restrictions for the document or an article.

s(*args, **kwargs)

The <s> HTML element represents content that is no longer accurate or no longer relevant.

cite(*args, **kwargs)

The <cite> HTML element is used to describe a reference to a cited creative work, and must include the title of that work.

q(*args, **kwargs)

The <q> HTML element indicates that the enclosed text is a short inline quotation.

dfn(*args, **kwargs)

The <dfn> HTML element represents the defining instance of a term.

abbr(*args, **kwargs)

The <abbr> HTML element represents an abbreviation or acronym.

time(*args, **kwargs)

The <time> HTML element represents a specific period in time.

code(*args, **kwargs)

The <code> HTML element represents a fragment of computer code.

var(*args, **kwargs)

The <var> HTML element represents a variable in a mathematical expression or a programming context.

samp(*args, **kwargs)

The <samp> HTML element represents sample output from a computer program.

kbd(*args, **kwargs)

The <kbd> HTML element represents user input text.

sub(*args, **kwargs)

The <sub> HTML element represents a subscript.

sup(*args, **kwargs)

The <sup> HTML element represents a superscript.

i(*args, **kwargs)

The <i> HTML element represents a range of text that is set off from the normal text for some reason, such as idiomatic text, technical terms, taxonomical designations, among others.

b(*args, **kwargs)

The <b> HTML element represents a span of text stylistically different from normal text, without conveying any special importance or relevance.

u(*args, **kwargs)

The <u> HTML element represents a span of text with an unarticulated, though explicitly rendered, non-textual annotation, such as labeling the text as being a proper name in Chinese text (a Chinese proper name mark), or labeling the text as being misspelt.

mark(*args, **kwargs)

The <mark> HTML element represents text which is marked or highlighted for reference or notation purposes, due to the marked passage's relevance or importance in the enclosing context.

ruby(*args, **kwargs)

The <ruby> HTML element represents small annotations that are rendered above, below, or next to base text, usually used for showing the pronunciation of East Asian characters.

rt(*args, **kwargs)

The <rt> HTML element specifies the ruby text component of a ruby annotation, which is used to provide pronunciation, translation, or transliteration information for East Asian typography.

rp(*args, **kwargs)

The <rp> HTML element is used to provide fall-back parentheses for browsers that do not support display of ruby annotations using the ruby element.

bdi(*args, **kwargs)

The <bdi> HTML element tells the browser's bidirectional algorithm to treat the text it contains in isolation from its surrounding text.

bdo(*args, **kwargs)

The <bdo> HTML element overrides the current directionality of text, so that the text within is rendered in a different direction.

span(*args, **kwargs)

The <span> HTML element is a generic inline container for phrasing content, which does not inherently represent anything.

br(*args, **kwargs)

The <br> HTML element produces a line break in text (carriage-return).

wbr(*args, **kwargs)

The <wbr> HTML element represents a word break opportunity—a position within text where the browser may optionally break a line, though its line-breaking rules would not otherwise create a break at that location.

ins(*args, **kwargs)

The <ins> HTML element represents a range of text that has been added to a document.

del_(*args, **kwargs)

The <del> HTML element represents a range of text that has been deleted from a document.

img(*args, **kwargs)

The <img> HTML element embeds an image into the document.

iframe(*args, **kwargs)

The <iframe> HTML element represents a nested browsing context, embedding another HTML page into the current one.

embed(*args, **kwargs)

The <embed> HTML element embeds external content at the specified point in the document.

object(*args, **kwargs)

The <object> HTML element represents an external resource, which can be treated as an image, a nested browsing context, or a resource to be handled by a plugin.

param(*args, **kwargs)

The <param> HTML element defines parameters for an <object> element.

video(*args, **kwargs)

The <video> HTML element embeds a media player which supports video playback into the document.

audio(*args, **kwargs)

The <audio> HTML element embeds sound content in documents.

source(*args, **kwargs)

The <source> HTML element specifies multiple media resources for media elements (<video> and <audio>).

track(*args, **kwargs)

The <track> HTML element specifies text tracks for media elements (<video> and <audio>).

canvas(*args, **kwargs)

The <canvas> HTML element provides scripts with a resolution-dependent bitmap canvas, which can be used for rendering graphs, game graphics, art, or other visual images on the fly.

map(*args, **kwargs)

The <map> HTML element is used with <area> elements to define an image map (a clickable link area).

area(*args, **kwargs)

The <area> HTML element defines a hot-spot region on an image, and optionally associates it with a hypertext link.

table(*args, **kwargs)

The <table> HTML element represents tabular data — that is, information presented in a two-dimensional table comprised of rows and columns of cells containing data.

caption(*args, **kwargs)

The <caption> HTML element specifies the caption (or title) of a table.

colgroup(*args, **kwargs)

The <colgroup> HTML element defines a group of columns within a table.

col(*args, **kwargs)

The <col> HTML element defines a column within a table and is used for defining common semantics on all common cells.

tbody(*args, **kwargs)

The <tbody> HTML element encapsulates a set of table rows (<tr> elements), indicating that they comprise the body of the table.

thead(*args, **kwargs)

The <thead> HTML element defines a set of rows defining the head of the columns of the table.

tfoot(*args, **kwargs)

The <tfoot> HTML element defines a set of rows summarizing the columns of the table.

th(*args, **kwargs)

The <th> HTML element defines a cell as header of a group of table cells.

tr(*args, **kwargs)

The <tr> HTML element defines a row of cells in a table.

td(*args, **kwargs)

The <td> HTML element defines a cell of a table that contains data.

form(*args, **kwargs)

The <form> HTML element represents a document section that contains interactive controls to submit information to a web server.

fieldset(*args, **kwargs)

The <fieldset> HTML element is used to group several controls as well as labels (<label>) within a web form.

legend(*args, **kwargs)

The <legend> HTML element represents a caption for the content of its parent <fieldset>.

label(*args, **kwargs)

The <label> HTML element represents a caption for an item in a user interface.

input(*args, **kwargs)

The <input> HTML element is used to create interactive controls for web-based forms in order to accept data from the user.

button(*args, **kwargs)

The <button> HTML element is an interactive element activated by a user with a mouse, keyboard, finger, voice command, or other assistive technology.

select(*args, **kwargs)

The <select> HTML element represents a control that provides a menu of options.

datalist(*args, **kwargs)

The <datalist> HTML element contains a set of <option> elements that represent the permissible or recommended options available to choose from within other controls.

option(*args, **kwargs)

The <option> HTML element is used to define an item contained in a <select>, an <optgroup>, or a <datalist> element.

optgroup(*args, **kwargs)

The <optgroup> HTML element creates a grouping of options within a <select> element.

textarea(*args, **kwargs)

The <textarea> HTML element represents a multi-line plain-text editing control, useful when you want to allow users to enter a sizeable amount of free-form text, for example a comment on a review or feedback form.

keygen(*args, **kwargs)

The <keygen> HTML element exists to facilitate generation of key material, and submission of the public key as part of an HTML form.

output(*args, **kwargs)

The <output> HTML element is a container element into which a site or app can inject the results of a calculation or the outcome of a user action.

progress(*args, **kwargs)

The <progress> HTML element displays an indicator showing the completion progress of a task, typically displayed as a progress bar.

meter(*args, **kwargs)

The <meter> HTML element represents either a scalar value within a known range or a fractional value.

details(*args, **kwargs)

The <details> HTML element creates a disclosure widget in which information is visible only when the widget is toggled into an "open" state.

summary(*args, **kwargs)

The <summary> HTML element specifies a summary, caption, or legend for a <details> HTML element's disclosure box.

command(*args, **kwargs)

The <command> HTML element represents a command that a user can invoke.

menu(*args, **kwargs)

The <menu> HTML element is used to group a set of commands that a user can perform or activate.

font(*args, **kwargs)

The <font> HTML element is used to specify the font family, size, and weight of text.

comment(*args, **kwargs)

Adds HTML comments.

Class Inheritance Diagram

Inheritance diagram of domilite.dom_tag.dom_tag, domilite.tags.html_tag, domilite.tags.html, domilite.tags.head, domilite.tags.title, domilite.tags.base, domilite.tags.link, domilite.tags.meta, domilite.tags.style, domilite.tags.script, domilite.tags.noscript, domilite.tags.body, domilite.tags.main, domilite.tags.section, domilite.tags.nav, domilite.tags.article, domilite.tags.aside, domilite.tags.h1, domilite.tags.h2, domilite.tags.h3, domilite.tags.h4, domilite.tags.h5, domilite.tags.h6, domilite.tags.hgroup, domilite.tags.header, domilite.tags.address, domilite.tags.p, domilite.tags.hr, domilite.tags.pre, domilite.tags.blockquote, domilite.tags.ol, domilite.tags.ul, domilite.tags.li, domilite.tags.dl, domilite.tags.dt, domilite.tags.dd, domilite.tags.figure, domilite.tags.figcaption, domilite.tags.div, domilite.tags.a, domilite.tags.em, domilite.tags.strong, domilite.tags.small, domilite.tags.s, domilite.tags.cite, domilite.tags.q, domilite.tags.dfn, domilite.tags.abbr, domilite.tags.time, domilite.tags.code, domilite.tags.var, domilite.tags.samp, domilite.tags.kbd, domilite.tags.sub, domilite.tags.sup, domilite.tags.i, domilite.tags.b, domilite.tags.u, domilite.tags.mark, domilite.tags.ruby, domilite.tags.rt, domilite.tags.rp, domilite.tags.bdi, domilite.tags.bdo, domilite.tags.span, domilite.tags.br, domilite.tags.wbr, domilite.tags.ins, domilite.tags.del_, domilite.tags.img, domilite.tags.iframe, domilite.tags.embed, domilite.tags.object, domilite.tags.param, domilite.tags.video, domilite.tags.audio, domilite.tags.source, domilite.tags.track, domilite.tags.canvas, domilite.tags.map, domilite.tags.area, domilite.tags.table, domilite.tags.caption, domilite.tags.colgroup, domilite.tags.col, domilite.tags.tbody, domilite.tags.thead, domilite.tags.tfoot, domilite.tags.th, domilite.tags.tr, domilite.tags.td, domilite.tags.form, domilite.tags.fieldset, domilite.tags.legend, domilite.tags.label, domilite.tags.input, domilite.tags.button, domilite.tags.select, domilite.tags.datalist, domilite.tags.option, domilite.tags.optgroup, domilite.tags.textarea, domilite.tags.keygen, domilite.tags.output, domilite.tags.progress, domilite.tags.meter, domilite.tags.details, domilite.tags.summary, domilite.tags.command, domilite.tags.menu, domilite.tags.font, domilite.tags.comment

domilite.svg Module

Classes

svg_tag(*args, **kwargs)

svg(*args, **kwargs)

SVG tag class

animate(*args, **kwargs)

The animate tag class is used to animate an element's attributes over time.

animateMotion(*args, **kwargs)

The animateMotion tag is used to animate an element's motion over time.

animateTransform(*args, **kwargs)

The animateTransform tag is used to animate an element's transformation over time.

circle(*args, **kwargs)

The circle tag is used to draw a circle.

clipPath(*args, **kwargs)

The clipPath tag is used to define a clipping path.

defs(*args, **kwargs)

The defs tag is used to define elements that can be reused throughout the SVG document.

desc(*args, **kwargs)

The desc tag is used to provide a description of the SVG document.

ellipse(*args, **kwargs)

The ellipse tag is used to draw an ellipse.

g(*args, **kwargs)

The g tag is used to group SVG elements together.

image(*args, **kwargs)

The image tag is used to embed an image into an SVG document.

line(*args, **kwargs)

The line tag is used to draw a line.

linearGradient(*args, **kwargs)

The linearGradient tag is used to define a linear gradient.

marker(*args, **kwargs)

The <marker> element defines the graphic that is to be used for drawing arrowheads or polymarkers on a given <path>, <line>, <polyline> or <polygon> element.

mask(*args, **kwargs)

The <mask> element defines a mask.

mpath(*args, **kwargs)

The <mpath> element is used to reference a path element for use in a mask.

pattern(*args, **kwargs)

The <pattern> element is used to define a pattern that can be used to fill or stroke an element.

polygon(*args, **kwargs)

The polygon tag is used to draw a polygon.

radialGradient(*args, **kwargs)

The radialGradient tag is used to define a radial gradient.

path(*args, **kwargs)

The path tag is used to define a path.

rect(*args, **kwargs)

The rect tag is used to draw a rectangle.

stop(*args, **kwargs)

The svg tag is used to define an SVG document.

switch(*args, **kwargs)

The switch tag is used to define a group of elements that can be used to switch between different elements.

symbol(*args, **kwargs)

The symbol tag is used to define a graphics object that can be referenced by other elements.

text(*args, **kwargs)

The text tag is used to define text.

textPath(*args, **kwargs)

The textPath tag is used to define a path for text.

title(*args, **kwargs)

The title tag is used to define a title for an element.

tspan(*args, **kwargs)

The tspan tag is used to define a subregion of text.

use(*args, **kwargs)

The use tag is used to reuse an element.

view(*args, **kwargs)

The view tag is used to define a view of an SVG document.

filter(*args, **kwargs)

Class Inheritance Diagram

Inheritance diagram of domilite.svg.svg_tag, domilite.svg.svg, domilite.svg.animate, domilite.svg.animateMotion, domilite.svg.animateTransform, domilite.svg.circle, domilite.svg.clipPath, domilite.svg.defs, domilite.svg.desc, domilite.svg.ellipse, domilite.svg.g, domilite.svg.image, domilite.svg.line, domilite.svg.linearGradient, domilite.svg.marker, domilite.svg.mask, domilite.svg.mpath, domilite.svg.pattern, domilite.svg.polygon, domilite.svg.radialGradient, domilite.svg.path, domilite.svg.rect, domilite.svg.stop, domilite.svg.switch, domilite.svg.symbol, domilite.svg.text, domilite.svg.textPath, domilite.svg.title, domilite.svg.tspan, domilite.svg.use, domilite.svg.view, domilite.svg.filter

domilite.util Module

Classes

container(*args, **kwargs)

text(text[, escape])

Class Inheritance Diagram

Inheritance diagram of domilite.util.container, domilite.util.text

domilite.template Module

Classes

TagTemplate(tag[, attributes, classes])

A helper for creating tags.

Class Inheritance Diagram

Inheritance diagram of domilite.template.TagTemplate