Child pages
  • The Get Structured Text Action Group

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Returns a logical table of contents for a text as well-formed XML (based on a generic <div> structure).  The table of contents contains actionable URLs for each unit of content of a text.  These URLs could be fully formed calls to getChunk

The strucure of the well-formed XML is as follows:

<div type="toc" id="optional local text identifier">
    <head>The label or title of the text</head>
    <div xlink="actionable URL to a chunk">
        <head>The label or title of the chunk</head>
    <div>
</div>

Some notes about the XML structure:

  1. <div> tags can be nested as appropriate
  2. The value of the 'type' attribute is always "toc"
  3. The 'id' attribute is optional

getHeader

Returns the well-formed native markup language header (for example, TEI, EAD, DOCBOOK) for an entire text as a whole.  It is assumed that this header will provide information about the text as a whole.

The well-formed native markup language header is contained in the following wrapper:

<div type="header" n="format of the native XML" id="optional local text identifier">
... native markup ...
</div>

Some notes about the wrapper:

  1. the header is wrapped in the same top level <div> + attributes structure as the TOC example; this <div> is followed by the actual document header markup.
  2. the value of the 'type' attribute is always "header"

 getChunk 

Returns a logical chunk of a text, such as a chapter, as native XML in a generic <div> wrapper.  This assumes that a request parameter is passed (the chunkID).

Format:
The well-formed XML in native markup language is contained the following wrapper:

<div type="chunk" n="optional title or label of the chunk" id="optional local text identifier">
    <head>The label or title of the chunk</head>
        ... native markup ...
    <div>
</div>

Some notes about the wrapper:

  1. the chunk is wrapped in the same top level <div> + attributes structure as the TOC example; this <div> is followed by the actual chunk markup.
  2. the value of the 'type' attribute is always "chunk"