Encoding of files conforming to the 'about' template

General

The about template is a customization of the general template, specifically designed for encoding introductory texts and similar content that are integral parts of the edition (e.g. pages as 'About', 'Intoduction', 'This edition', 'Help', 'Copyright', 'Background' etc.).

Editors must refer to the documentation for the general template for all aspects not covered in the text below, such as references, tables, annotations, etc.

About files start with a header:

<?xml version="1.0" encoding="UTF-8"?>
<?editem template="about"?>
<?xml-model href="https://xmlschema.huygens.knaw.nl/editem-general.rng" type="application/xml" schematypens="http://relaxng.org/ns/structure/1.0"?
<?xml-model href="https://xmlschema.huygens.knaw.nl/editem-general.rng" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?>

The first line is the so-called XML declaration, used in all editem XML files. The second line declares that the file conforms to the editem 'about' template. The third and fourth line declare that the file should conform to the editem-general.rng schema, interpreted both as a RNG schema (third line) and as a Schematron schema (fourth line).

Metadata

The teiHeader must contain a teiHeader/fileDesc/titleStmt/title element, providing the title of the file. The title element may be repeated for multiple languages.

Structure

The text/body element must consist of one or more head elements, which can carry an optional type attribute with the value subtitle, if needed. However, if the text is present in multiple languages, the body will have multiple divs, one for each language.

The head(s) are followed by div elements containing a head and several paragraphs, encoded as p elements.

Each div must carry an xml:id attribute. The value of this attribute can be chosen by the editors, using a self-explanatory value (such as 'editorial_account', 'colophon', etc.). It is also possible to use a simple hierarchical scheme as is used in the example below.

It is possible to nest div elements within a div. We recommend not going beyond four levels.

Each div must contain a head element, providing the title of the section. The head elements must carry an n attribute to number them. The value of the n attribute may be chosen by editors. We recommend using a clear hierarchy to divide the text into paragraphs and subparagraphs. The content of the head element should not contain a number. These will be added by the publication software.

Within divs, the following elements can occur: div, head, p, list, figure, quote. If further structural elements are desired, such as tables, please contact the eDITem staff.

All block elements must contain xml:id attributes in in order to facilitate hyperlinking. We recommend a simple hierarchical scheme such as in the example below. The also must have n attributes that can be used for a paragraph numbering in the publication.

If it should be desirable to have extra whitespace above a block (p, list, etc.) the element should have a rend attribute with value line-above.

Example: structure

       <body>
         <head>The Mondrian Papers:</head>
         <head type="subtitle">Edition of the Letters and Theoretical Writings of Piet
            Mondrian.</head>

         <div xml:id="div.1">
            <head xml:id="head.1" n="1">Introduction</head>
            <p  xml:id="p.1" n="1">text</p>
            <div xml:id="div.1.1">
               <head xml:id="head.1.1" n="1.1">The Mondrian Papers: Part I</head>
               <p xml:id="p.1.1.1" n="2">text</p>
               <p xml:id="p.1.1.2" n="3">text</p>
            </div>
            <div xml:id="div.1.2">
               <head xml:id="head.1.2" n="1.2">Earlier attempts</head>
               <p xml:id="p.1.2.1" n="4">text</p>
               <p xml:id="p.1.2.2" n="5">text</p>
            </div>
         </div>
         <div  xml:id="div.2">
            <head xml:id="head.2" n="2">The letters</head>
            <p xml:id="p.2.1" n="6">text</p>
            <p xml:id="p.2.2" n="7">text</p>
         </div>
      </body>

results matching ""

    No results matching ""