Child pages
  • The Get Structured Text Action Group

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Provides a basic set of functions for simple access to bits of the XML structured text in its native markup language.  There is an assumption that the markup includes at least rudimentary structural definition.  These functions 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 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 getChunk

The structure of the well-formed XML is as follows:<div

Code Block
xml
xml

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

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

Some notes about the XML structure:

...

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

Code Block
xml
xml

<div type="header" n="format of the native XML" id="optional local text identifier">

...


	... native markup ...

...


</div>

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

Some notes about the wrapper:

...

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

Code Block
xml
xml

<div type="chunk" n="optional title or label of the chunk" id="optional

...

 parent text identifier">

...


<head>The label or title of the chunk</head>

...


	... native markup ...

...


<div>

...


</div>

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

Some notes about the wrapper:

...