Skip to main content

 Element reference

PSML elements from <author> to <xref>

<xref-fragment>

Summary

The <xref-fragment> element is a specialized fragment which only contains block-level cross-references.

It is used to create a collection or hierarchy of documents.

Other kinds of fragment elements are the following:

Usage context

Element categorystructure
PSML levelportable
Permitted content<blockxref>
Permitted parent<section>
HTML equivalentno direct equivalent but akin to <nav>
OpenXML equivalent

Attributes

This element includes the following attributes:

NameTypeRequiredDescription
idfragment-idyesThe fragment ID
typefragment-typenoThe template type
labelslabel-listnoA list of fragment labels

@id

A identifier for this fragment that is unique within the document.

@type

The type of fragment

Examples

Following is an example that can be uploaded. Once uploaded, PageSeeder adds all the generated attributes and content.

<xref-fragment id="5">
  <blockxref href="chapter1.psml" frag="default">
     Chapter 1: Down the Rabbit-Hole
  </blockxref>
  <blockxref href="chapter2.psml" frag="default">
     Chapter 2: The Pool of Tears
  </blockxref>
</xref-fragment>

Schema

XML Schema

<xs:element name="xref-fragment">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="blockxref"
                  minOccurs="0"
                  maxOccurs="unbounded"/>
    </xs:sequence>
    <xs:attribute name="id" type="fragment-id" use="required"/>
    <xs:attribute name="type" type="fragment-type"/>
    <xs:attribute name="labels" type="label-list"/>
  </xs:complexType>
</xs:element>

Relax Schema

element xref-fragment {
   attribute id { fragment-id },
   attribute type { fragment-type }?,
   attribute labels { label-list }?, 
   element blockxref*
}

Compatibility

This element was introduced in the first draft of PSML and is well-supported from PageSeeder 5.1.

Created on , last edited on