American Social History Online
Child pages
  • The Get Structured Text Action Group

Versions Compared

Old Version 9

changes.mady.by.user Unknown User (rchave01)

Saved on

compared with

New Version 10

changes.mady.by.user Unknown User (rchave01)

Saved on

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 structure 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>

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>

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

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.

...