13. XHTML Edit Module

Contents

This section is normative.

This module defines elements and attributes for use in editing-related markup:

Element Attributes Minimal Content Model
del Common, cite (URI), datetime (Datetime) (PCDATA | Flow)*
ins Common, cite (URI), datetime (Datetime) (PCDATA | Flow)*

When this module is used, the del and ins elements are added to the Inline content set of the Text Module.

Implementation: DTD

13.1. The del element

The del element is used to indicate that a section of a document has been deleted with respect to a different version of the document (e.g., in draft legislation where lawmakers need to view the changes).

Attributes

The Common collection
A collection of other attribute collections, including: Core, Events, I18N, and Hypertext
cite = URI
The value of this attribute is a URI that designates a source document or message. This attribute is intended to give further information about the element's contents (e.g., the source from which a quotation was borrowed, or the reason text was inserted or deleted). User Agents should provide a means for the user to access the further information.
datetime = Datetime
The value of this attribute specifies the date and time when a change was made.

This element is unusual for XHTML in that they may serve as either block-level or inline elements (but not both). It may contain one or more words within a paragraph or contain one or more block-level elements such as paragraphs, lists and tables.

This example could be from a bill to change the legislation for how many deputies a County Sheriff can employ from 3 to 5.

<p>
  A Sheriff can employ <del>3</del><ins>5</ins> deputies.
</p>

The del element must not contain block-level content when it is behaving as an inline element.

ILLEGAL EXAMPLE:
The following is not legal HTML.

<p>
<ins><div>...block-level content...</div></ins>
</p>

User agents should render deleted text in ways that make the change obvious. For instance, inserted text may appear in a special font, deleted text may not be shown at all or be shown as struck-through or with special markings, etc.

Both of the following examples correspond to November 5, 2001, 8:15:30 am, US Eastern Standard Time.

     2001-11-05T13:15:30Z
     2001-11-05T08:15:30-05:00

Used with ins, this gives:

<ins datetime="2001-11-05T08:15:30-05:00"
        cite="http://www.example.org/mydoc/comments.html">
Furthermore, the latest figures from the marketing department
suggest that such practice is on the rise.
</ins>

The document "http://www.example.org/mydoc/comments.html" would contain comments about why information was inserted into the document.

Authors may also make comments about deleted text by means of the title attribute for the del element. User agents may present this information to the user (e.g., as a popup note). For example:

<del datetime="2001-11-05T08:15:30-05:00"
        title="Changed as a result of Steve G's comments in meeting.">
Furthermore, the latest figures from the marketing department
suggest that such practice is on the rise.
</del>

13.2. The ins element

The ins element is used to indicate that a section of a document has been inserted with respect to a different version of the document (e.g., in draft legislation where lawmakers need to view the changes).

Attributes

The Common collection
A collection of other attribute collections, including: Core, Events, I18N, and Hypertext
cite = URI
The value of this attribute is a URI that designates a source document or message. This attribute is intended to give further information about the element's contents (e.g., the source from which a quotation was borrowed, or the reason text was inserted or deleted). User Agents should provide a means for the user to access the further information.
datetime = Datetime
The value of this attribute specifies the date and time when a change was made.

This element is unusual for XHTML in that they may serve as either block-level or inline elements (but not both). It may contain one or more words within a paragraph or contain one or more block-level elements such as paragraphs, lists and tables.

The ins element must not contain block-level content when it is behaving as an inline element.

ILLEGAL EXAMPLE:
The following is not legal HTML.

<p>
<ins><div>...block-level content...</div></ins>
</p>

User agents should render inserted text in ways that make the change obvious. For instance, inserted text may appear in a special font.

Both of the following examples correspond to November 5, 2001, 8:15:30 am, US Eastern Standard Time.

     2001-11-05T13:15:30Z
     2001-11-05T08:15:30-05:00

Used with ins, this gives:

<ins datetime="2001-11-05T08:15:30-05:00"
        cite="http://www.foo.org/mydoc/comments.html">
Furthermore, the latest figures from the marketing department
suggest that such practice is on the rise.
</ins>

The document "http://www.foo.org/mydoc/comments.html" would contain comments about why information was inserted into the document.

Authors may also make comments about inserted text by means of the title attribute for the ins element. User agents may present this information to the user (e.g., as a popup note). For example:

<ins datetime="2001-11-05T08:15:30-05:00"
        title="Changed as a result of Steve B's comments in meeting.">
Furthermore, the latest figures from the marketing department
suggest that such practice is on the rise.
</ins>