<blockxref>

Summary

A block level cross-reference.

This type of xref is usually used to insert content from another document using the embed or transclude type. Or, it can be used to build table of contents.

The content of this element, displayed as the link title, is generated. Although the original content is only INFORMATIONAL and is discarded by the upload process, there are two exceptions to this:

• If @display="manual" and @title is missing or empty, the content is used for the value of @title;
  OR
• If the xref cannot be resolved, some content helps users to understand or debug what went wrong with the xref.

It is the only type of link allowed inside an <xref-fragment>.

When the PSML is processed, <blockxref> might contain the content of the targeted document or fragment.

For inline level cross-references, use the <xref> element instead.

Usage context

Attributes

This element includes the following attributes:

@archived

A boolean flag indicating whether the target document is archived. INFORMATIONAL - ignored by upload.

This attribute was introduced in PSML v1.3 in PageSeeder 5.99.

@display 

Defines how the target link text of this xref is displayed (Default is document).

 The following values are allowed:

• document – [document title].
• document+manual – [document title]: [manual title].
• document+fragment – [document title]: [target fragment id].
• manual – [manual title].
• template – see Xref display.

@docid

The document ID of the target. This value overrides the @uriid on upload.

@documenttype

Refers to the xref target documenttype. INFORMATIONAL - ignored by upload.

@external

If attribute value is true, the xref target is a URL. INFORMATIONAL - ignored by upload.

@frag

Refers to the xref target fragment ID. When this value is default, it refers to the entire document. This value can also reference fragments other than PSML fragments.

@href

When uploading, this might be a path relative to the current document or an absolute path that begins with a “/” character. If it is“ #”, the current document is the target. It must always be URL encoded unless document/@level="processed".

This value overrides the @docid and @uriid on upload.

@id

The ID of the XLink that corresponds to this cross-reference. INFORMATIONAL - ignored by upload.

@labels

A comma-separated list of xref labels.

@level

The level that the heading numbering of the target document starts from.

@mediatype

Refers to the mediatype of the xref target document. INFORMATIONAL - ignored by upload.

@reverselink

A boolean attribute to indicate whether the xref is bidirectional or “reverse” link. When set to true (the default value), the xref also appears in the metadata of the target document.

@reversetitle

A manually entered title to appear on the reverse link.

@reversetype

Type for link processing of reverse link. As of version 5.97, there is only support for a value of none.

@reversefrag

The fragment ID on the source. INFORMATIONAL - ignored by upload.

@title

The manually entered title to appear on the link (only used when @display='manual' or @display='document+manual'). When @display='manual' and @title is missing or empty, then @title takes the value of the element's content text.

@type

The type defines how PageSeeder is to process the xref.

The following values are allowed:

• none – No link processing.
• alternate – An alternate representation of the current document.
• embed – Replace this element’s content with the document/fragment pointed to when publishing.
• transclude – Replace this element’s content with the document/fragment pointed to when displaying.

@unresolved

If true, the target document doesn’t exist. INFORMATIONAL - ignored by upload.

@uriid

The URI ID of the target document.

Ignored by upload if on a different PS server.

@urititle

An informational attribute providing title of the target URI. INFORMATIONAL - ignored by upload.

@urilabels

A comma-separated list of labels of the target URI. Introduced in v0.11 of the PSML schema in PageSeeder v5.95. INFORMATIONAL - ignored by upload.

Examples

When constructing <blockxref> elements, it is useful to remember that PageSeeder automatically expands a minimally-expressed link. All that is required is the address of the document and fragment and some content to make the link visible. PageSeeder sees all the following examples as valid:

<blockxref href="filename.psml"
           frag="default">link title</blockxref>

<blockxref docid="server-wide_uniqueid"
           frag="default">link title</blockxref>

<blockxref uriid="9999" frag="5">link title</blockxref>

Also, documents containing these minimal links* can be uploaded before the other end of the link is available.

After both ends of the xref are available, any user with the appropriate permission can go to the Group maintenance page under the Admin menu and select the option to Resolve references.

The PageSeeder server then resolves the <blockxref> element, adds the implied attributes and values and creates a <reversexref> element at the link destination.

* the third example is using a URIID, as this value is generated by the system, the target of this xref is already known.

Schema

XML Schema

<xs:element name="blockxref">

  <xs:complexType>
    <xs:simpleContent>
      <xs:attribute name="archived" type="xs:boolean"/>
      <xs:attribute name="id" type="xs:long" />
      <xs:attribute name="docid" type="document-id" />
      <xs:attribute name="href" type="xs:string" />
      <xs:attribute name="uriid" type="xs:long" />
      <xs:attribute name="frag" type="fragment-id" use="required" />
      <xs:attribute name="title" type="xs:string" />
      <xs:attribute name="level" type="xs:integer" />

      <xs:attribute name="display">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="document" />
            <xs:enumeration value="document+manual" />
            <xs:enumeration value="document+fragment" />
            <xs:enumeration value="manual" />
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>

      <xs:attribute name="type">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="none" />
            <xs:enumeration value="alternate" />
            <xs:enumeration value="embed" />
            <xs:enumeration value="transclude" />
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>

      <xs:attribute name="labels" type="xs:string" />
      <xs:attribute name="urititle" type="xs:string" />
      <xs:attribute name="mediatype" type="xs:string" />
      <xs:attribute name="documenttype" type="xs:string" />
      <xs:attribute name="reverselink" type="xs:boolean" />
      <xs:attribute name="reversetitle" type="xs:string" />

      <xs:attribute name="reversetype">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="none" />
          </xs:restriction>
        </xs:simpleType>
      </xs:attribute>

      <xs:attribute name="reversefrag" type="fragment-id" /> 
      <xs:attribute name="unresolved" type="xs:boolean" />
      <xs:attribute name="external" type="xs:boolean" />

    </xs:simpleContent>
  </xs:complexType>
</xs:element>

Relax Schema

element blockxref {
   attribute archived { xs:boolean }?,
   attribute id { xs:long }?,
   attribute docid { document-id }?,
   attribute href { text }?,
   attribute uriid { xs:long }?,
   attribute frag { fragment-id },
   attribute title { text },
   attribute level { xs:integer }?,
   attribute type { string "none" 
                     | string "alternate"
                     | string "embed"
                     | string "transclude"},
   attribute display { "document" 
                     | "document+manual" 
                     | "document+fragment" 
                     | "manual"},
   attribute labels { text }?,
   attribute urititle { text }?,
   attribute mediatype { text }?,
   attribute documenttype { text }?,
   attribute reverselink { xs:boolean }?,
   attribute reversetitle { text }?,
   attribute reversetype { string "none"}?,
   attribute reversefrag { fragment-id }?,
   attribute unresolved { xs:boolean }?,
   attribute external { xs:boolean }?
}

Compatibility

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