Xport Interface: document overview

Xport's document type alias, (and other aliases typed from xhtml_document), is one of the most important types in the toolkit. It's operations will will not be used as frequently as other's like element, but is the main object that you'll be concened with. A document object encompasses an xhtml document. The document object forms the document tree which consists of the document's content.

The type alias that you use for your document depends on two factors. The document type you wish to use, and the character type you wish to use. The table in the interface overview lists the available type aliases for Xport's document.

When you create a document object, you have the option of creating it without any contained elements, or with the root elements present in the document object. To create a root document, one with root elements, you supply the document's constructor with the argument root_doc. To create an empty document object, don't supply any argument in the document's constructor. This is detailed further in document::document().

All of document's public operations are listed below, categorized by their behavior. It will be benifitial for you to learn all these operations well, as all operations of document are very important.

Constructor

• document()

Root element retrieval

• html()
• head()
• title()
• body()
• frameset()

Insertion/deletion operations

• insert()
• insertion operator (<<)
• clear()

Iterator retrieval

• begin()
• end()
• descendant_begin()
• descendant_end()

Input/Output

• write()
• parse()

miscellaneous operations

• document_type()