Child pages
  • The View Structured Text Action Group

This space has moved to IU's Confluence.
It is located at https://uisapp2.iu.edu/confluence-prd/display/iulDLFAquifer/

Skip to end of metadata
Go to start of metadata

 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:

<?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 />
	</div>
</body>
</html>

AssetActionsDevelopment:View a complete stand-alone example of a viewTOC response.

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.

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

<?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 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <title>Document Header</title>
  </head>
<body>

	<div id="Identifier of the parent object" title="Label/Title of the parent object">
		<h1>Label/Title of the parent object: Document Header</h1>
	</div>

	<div>
		<h3>Document title statement:</h3>
		<p>Concise Encyclopedia of Tufts History<br/>Anne Sauer<br/>compiled by:<br/>Anne Sauer<br/>Jessica Branco<br/>John Bennett<br/>Zachary Crowley</p>
	</div>

	<div>
		<h3>Tufts DL Document ID number:</h3>
		<p>tufts:central:dca:UA069:UA069.005.DO.00001</p>
	</div>
</body>
</html>

AssetActionsDevelopment:View a complete stand-alone example of a viewHeader response.

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

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, see the example above.

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

<?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 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <title>Title/Label of the parent document:  Title/Label of the chunk</title>
  </head>
  <body>
	<div>
            <h1>Title/Label of the chunk</h1>
            <p>Text of the chunk</p>
         </div>
</body>
</html>

AssetActionsDevelopment:View a complete stand-alone example of a viewChunk response

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
  • No labels