...
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:
| Code Block | ||||
|---|---|---|---|---|
| ||||
<?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"> <head> <title>Table of Contents of this text</title> </head> <body> <div id="Identifier of the parent object" title="Label/Title of the parent object"> <h1>Label/Title of the parent object: Table of Contents</h1> <a href="fully formed call to *viewChunk* with the appropriate _chunkID_">Label/Title of the chunk</a> <br /> <a href="fully formed call to *viewChunk* with the appropriate _chunkID_">Label/Title of the chunk</a> <br /> ... {panel} {panel} || [View a |
| Panel |
|---|
...
...
...
...
...
...
. |
|---|
Some notes about the structure:
- The X/HTML
...
- must
...
- be valid
- 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
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
Returns a logical chunk of a text, such as a chapter, as valid X/HTML. 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
...
.
...
A
...
complete
...
list
...
of
...
valid
...
request
...
parameters
...
for
...
a
...
given
...
text
...
is
...
available
...
via
...
the
...
viewTOC
...
action.