Child pages
  • The Get Image 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 Get Image Text Action Group

Provides a basic set of functions for simple access to bits of the underlying XML structure on the image book in its native markup language.  This would provide users or applications with the basic building blocks to begin using the text in its native markup if desirable.  The available functions mirror those of the View Structured Text Action Group and provide a means to: obtain a well-formed XML summary of the logical units of content contained within a text (a table of contents), obtain a well-formed XML  fragment of any descriptive or explanatory information contained in the document header of the text, and obtain a well-formed XML fragment of any individual logical unit of content contained within a text.

Function Type: text/xml

Action response type: text/xml 

getTOC

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 getPage (see example).

The well-formed XML is expressed in the following structure:

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

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

Some notes about the wrapper:

  1. <div> tags can be nested as appropriate
  2. The value of the 'type' attribute is always "toc"
  3. The 'id' attribute is optional
  4. The <head> element nested in the top level <div> element contains the title/label of the object
  5. The <head> element nested in <div> elements contains the title/label of a page
Proposal to change well-formed XML structure wrapper

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

*The wrapper becomes a <response> element that contains the document header markup

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.

The well-formed XML in native markup language header is contained in the following wrapper:

<div type="header" n="format of the native XML" id="optional local text identifier">
	... well-formed native markup ...
</div>

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

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"
Proposal to change well-formed XML structure wrapper

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

*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

 getPage

Returns a page, as well-formed native XML in a generic <div> wrapper; this assumes that a request parameter is passed (the pageID).

The well-formed XML in native markup language is contained in the following wrapper:

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

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

Some notes about the wrapper:

  1. the page is wrapped in the same top level <div> + attributes structure as the TOC example; this <div> is followed by the actual page markup.
  2. the value of the 'type' attribute is always "page"
Proposal to change well-formed XML structure wrapper

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

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

  • No labels