Skip to main content

 Element reference

PSML elements from <author> to <xref>

<toc-part>

Summary

The <toc-part> element is a table of content reference in processed PSML.

When <toc-part> is generated, the first <toc> element contains a reference for all <heading> elements in the publication.

Usage context

Element category
PSML levelprocessed
Permitted content<toc-part>
Permitted parent<toc-tree>
HTML equivalent
OpenXML equivalent

Attributes

This element includes the following attributes:

NameTypeRequiredDescription
levelxs:positiveIntegeryesThe level in the table of contents
idrefxs:stringnoReference to a heading
canonicalxs:stringnoCanonical prefix (e.g. 1.0.3, 1.1.4)
prefixxs:stringnoActual prefix (e.g. 1.3 or 1.a.iv)
titlexs:stringnoText of referenced heading

@level

The level in the table of contents.

@idref

The reference to a heading.

@canonical

The canonical prefix is computed from the position of the heading and its position in the heading hierarchy.

It is always a sequence of numbers separated by ‘.’ and is unique to the heading.

@prefix

The actual prefix when the formatting rules are applied to the canonical prefix.

@title

The text of the referenced heading.

Examples

<toc>
  <toc-tree title="Specification">

    <toc-part level="1" title="Introduction" idref="123-1-1-1">

      <toc-part level="2"
                title="Overview"
                idref="123-1-2-1"
                prefix="1."
                canonical="0.1." />
    </toc-part>
  </toc-tree>
</toc>

Schema

XML Schema

Compatibility

Introduced in v0.12 of the PSML schema, in PageSeeder v5.96, as a replacement for <tocref>.

Created on , last edited on