io7m | single-page | multi-page | xstructural 2.2.0-SNAPSHOT
1.2. Document
Previous
1. Language
Up
1.4. Section
Next

# 1.3. Metadata

- 1.3.1. Description
- 1.3.2. EPUB
  - 1.3.2.1. Package
  - 1.3.2.2. com.io7m.xstructural.epub.cover
  - 1.3.2.3. com.io7m.xstructural.epub.colophon
  - 1.3.2.4. com.io7m.xstructural.epub.resource
  - 1.3.2.5. com.io7m.xstructural.epub.resource-list
  - 1.3.2.6. Examples
- 1.3.3. Web
  - 1.3.3.1. Package
  - 1.3.3.2. com.io7m.xstructural.web.branding.header
  - 1.3.3.3. com.io7m.xstructural.web.branding.footer
  - 1.3.3.4. com.io7m.xstructural.web.cover

## 1.3.1. Description

1
The Metadata element describes the metadata of a document. The element consists of a sequence of zero or more Dublin Core elements [1], followed by a sequence of zero or more MetaProperty elements [2]. Metadata is not considered to contribute to the semantics of a document. That is, a document with all of the metadata removed is still considered to be semantically valid if the original document was valid. Metadata is typically used to influence the behaviour of any renderers that are processing the document, and are also used to communicate information to external systems that may be, for example, indexing the document for use in a document retrieval system. Metadata can appear in tables in rendered documents, although this can be controlled using the boolean visible attribute (which defaults to false).
2
Some MetaProperty names are significant to renderers and, where those renderers are known (such as by being part of the xstructural package), the significance of names is documented in the following subsections.
3
Document authors are strongly recommended to namespace their MetaProperty names using reverse domain name notation, ideally using a domain that they control. MetaProperty names must contain at least two segments consisting of characters taken from the set [a (U+0061), z (U+007A)] ∪ [0 (U+0030), 9 (U+0039)] ∪ { _ (U+005F) } ∪ { _ (U+002D) } , separated by . (U+002E).

## 1.3.2. EPUB

## 1.3.2.1. Package

1
This section documents the property names used by the EPUB renderer included with xstructural 1.3.0 and newer.

## 1.3.2.2. com.io7m.xstructural.epub.cover

1
The contents of this property denote the relative (to the input document) filename of the cover image that will be used for the book. The renderer will translate this name into the correct resource name within the EPUB during rendering.

## 1.3.2.3. com.io7m.xstructural.epub.colophon

1
The contents of this property denote the relative (to the input document) filename of an XHTML file that will be inserted into the colophon page of the generated EPUB.

## 1.3.2.4. com.io7m.xstructural.epub.resource

1
The contents of this property add an extra file to the manifest. The property can be specified multiple times to add multiple resources. The resources are resolved relative to the source directory of the document.

## 1.3.2.5. com.io7m.xstructural.epub.resource-list

1
The contents of this property denote a file that contains a list of extra resources to add to the manifest. The file name is resolved relative to the source directory of the document. The file must contain one resource file per line. For example, if a file named extra-files.txt contains the following text:

### 1.3.2.5.2. Example File List

    file0.txt
    file1.txt
    file2.txt

3
Then the following MetaProperty declarations are effectively equivalent:

### 1.3.2.5.4. Example File List

    <MetaProperty name="com.io7m.xstructural.epub.resource-list">extra-files.txt</MetaProperty>

### 1.3.2.5.5. Example Files

    <MetaProperty name="com.io7m.xstructural.epub.resource">file0.txt</MetaProperty>
    <MetaProperty name="com.io7m.xstructural.epub.resource">file1.txt</MetaProperty>
    <MetaProperty name="com.io7m.xstructural.epub.resource">file2.txt</MetaProperty>

## 1.3.2.6. Examples

### 1.3.2.6.1. EPUB Example

    <Document xmlns="urn:com.io7m.structural:8:0"
              xmlns:dc="http://purl.org/dc/elements/1.1/">
      <Metadata>
        <dc:title>Example Document</dc:title>
        <MetaProperty name="com.io7m.xstructural.epub.colophon">colophon_extra.xml</MetaProperty>
        <MetaProperty name="com.io7m.xstructural.epub.cover">cover.jpg</MetaProperty>
        <MetaProperty name="com.io7m.xstructural.epub.resource">file0.txt</MetaProperty>
        <MetaProperty name="com.io7m.xstructural.epub.resource">file1.txt</MetaProperty>
        <MetaProperty name="com.io7m.xstructural.epub.resource">file2.txt</MetaProperty>
        <MetaProperty name="com.io7m.xstructural.epub.resource-list">extra-files.txt</MetaProperty>
      </Metadata>
    ...

## 1.3.3. Web

## 1.3.3.1. Package

1
This section documents the property names used by the web renderer included with xstructural 1.3.0 and newer.

## 1.3.3.2. com.io7m.xstructural.web.branding.header

1
The contents of this property denote the relative (to the input document) filename of an XHTML file f that will be inserted verbatim as the first element of the XHTML body element.

## 1.3.3.3. com.io7m.xstructural.web.branding.footer

1
The contents of this property denote the relative (to the input document) filename of an XHTML file f that will be inserted verbatim as the last element of the XHTML body element.

## 1.3.3.4. com.io7m.xstructural.web.cover

1
The contents of this property denote the relative (to the input document) filename of the cover image that will be used for the book.

## Footnotes

1 | The Dublin Core elements are optional, but some renderers may require them in order to produce sensible output. The title of a Document is specified using the dc:title element, for example. References to this footnote: 1
2 | The MetaProperty elements were added in version 8.0 of the structural language. References to this footnote: 1

1.2. Document
Previous
1. Language
Up
1.4. Section
Next
io7m | single-page | multi-page | xstructural 2.2.0-SNAPSHOT