Child pages
  • The View Structured Text Action Group

Versions Compared

Key

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

 The View Structured Text Action Group 

Provides a basic set of functions for viewing a transcription of a text that is marked up using XML, not necessarily in TEI.  There is an assumption that the markup includes at least rudimentary structural definition.  These functions provide a means to: obtain a summary view of the logical units of content contained within a text (a table of contents), obtain a view of any descriptive or explanatory information contained in the document header of the text, and obtain a view of any individual logical unit of content contained within a text.

Response Type: text/html 

viewTOC

Returns a logical table of contents for a text as valid X/HTML.  The table of contents contains actionable URLs for each unit of content of a text.  These URLs are fully formed calls to viewChunk (see below).This logical table of contents is essentially the entry point to a text as it lists all accessible units of content (chunks) and embeds the appropriate actionable URL call to viewChunk to retrieve a particular unit of content.

A suggested structure of the  x/HTML is as follows:

...

Wiki Markup
h2.  The View Structured Text Action Group 

Provides a basic set of functions for viewing a transcription of a text that is marked up using XML, not necessarily in TEI.  There is an assumption that the markup includes at least rudimentary structural definition.  These functions provide a means to: obtain a summary view of the logical units of content contained within a text (a table of contents), obtain a view of any descriptive or explanatory information contained in the document header of the text, and obtain a view of any individual logical unit of content contained within a text.

Response Type: text/html 

h4. *{_}viewTOC{_}*

Returns a logical table of contents for a text as valid X/HTML.  The table of contents contains actionable URLs for each unit of content of a text.  These URLs are fully formed calls to *{_}viewChunk{_}* (see below).This logical table of contents is essentially the entry point to a text as it lists all accessible units of content (chunks) and embeds the appropriate actionable URL call to *{_}viewChunk{_}* to retrieve a particular unit of content.

A suggested structure of the  x/HTML is as follows:

{panel | bgColor=#FFFFCE}

<?xml version="1.0" encoding="UTF-8"?>

...


<\!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">

...


<html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">

...


&nbsp;&nbsp; &nbsp;<head>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<title>Table of Contents of this text</title>
&nbsp;&nbsp; &nbsp;</head>
&nbsp;&nbsp; &nbsp;<body>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<div id="Identifier of the parent object" title="Label/Title of the parent object">

...

             ...    

Some notes about the structure:

  1. The X/HTML must be valid 
  2. There must be an X/HTML document header
  3. There must be a <head><title>
  4. The <body> markup can vary, but all hrefs should contain a fully formed URL call to getChunk

viewHeader

Returns the header information for a text as valid X/HTML; it is assumed that this header will provide information about the text as a whole.

viewChunk

...


&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<h1>Label/Title of the parent object: Table of Contents</h1>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<a href="fully formed call to *viewChunk* with the appropriate _chunkID_">Label/Title of the chunk</a>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<br />
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<a href="fully formed call to *viewChunk* with the appropriate _chunkID_">Label/Title of the chunk</a>
&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp;<br />

&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;&nbsp; &nbsp; ... &nbsp; &nbsp;

{panel}


|| [View a stand-alone example of a _getTOC_ response|^viewStructuredText_example_1.html]. \\ ||
Some notes about the structure:
# The X/HTML must be valid&nbsp;
# There must be an X/HTML document header
# There must be a <head><title>
# The <body> markup can vary, but all hrefs should contain a fully formed URL call to *getChunk*

h4. *{_}viewHeader{_}*

Returns the header information for a text as valid X/HTML; it is assumed that this header will provide information about the text as a whole.

h4. *{_}viewChunk{_}*

Returns a logical chunk of a text, such as a chapter, as valid X/HTML.&nbsp; This assumes that a request parameter (_chunkID_) is passed. For example, the actionable URL for a *{_}viewChunk{_}* call might look as follows: [http://repository01.lib.tufts.edu:8080/fedora/get/tufts:UA069.005.DO.00001/bdef:TuftsTextAssetDef/viewChunk?chunkID=num00001].

...

&nbsp; A complete list of valid request parameters for a given text is available via the *{_}viewTOC

...

{_}* action.

&nbsp;&nbsp;&nbsp; &nbsp;&nbsp; &nbsp;&nbsp;&nbsp;  &nbsp;&nbsp;  &nbsp;&nbsp;
&nbsp;