Child pages
  • The Get Structured Text Action Group

Versions Compared

Key

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

...

<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 are unnumbered and can be nested as appropriate
  2. The value of the 'type' attribute for a getTOC response is always "toc"
  3. The 'id' attribute is optional
  4. The <head> element nested in the <response> element contains the title/lable of the object
  5. The <head> element nested in <div> elements contains the title/label of the chunk
Panel
bgColor#FFFFCE
titleBGColor#F7D6C1
titleProposal to change well-formed XML structure wrapper

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

...

  1. <div> tags are unnumbered and can be nested as appropriate
  2. The value of the 'type' attribute for a getTOC response is always "toc"
  3. The 'id' attribute is optional
  4. The <head> element nested in the <response> element contains the title/lable of the object
  5. The <head> element nested in <div> elements contains the title/label of the chunk

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.

...

<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"
Panel
bgColor#FFFFCE
titleBGColor#F7D6C1
titleProposal to change well-formed XML structure wrapper

<response type="header" id="optional local text identifier">
<head>The label or title of the object</head>
... native markup ...
</reponse>

*The wrapper becomes a <response> element that contains the document header markup
*The @n attribute has been removed
*A <head> element has been added; it contains the label/title of the object

Some notes about the wrapper:

...

...

 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).

...

<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"
Panel
bgColor#FFFFCE
titleBGColor#F7D6C1
titleProposal to change well-formed XML structure wrapper

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

*The wrapper becomes a <response> element that contains the document header markup
*The @n attribute has been removed

Some notes about the wrapper:

...