Versions Compared

Key

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

...

Popular schemas such as XHTML suffer from the problem of not relating elements together explicitly. For example, if a heading precedes a paragraph, the heading is related to the paragraph not because it is encoded as such but because it happens to precede it. When these structures are attempted to be translated into formats where these types of relationships are explicit, the translation becomes tedious, and potentially problematic. More structured schemas, like TEI or DocbookDocBook, are domain specific (much like DRI itself) and therefore not suitable for our purposes.

...

A Theme is a collection of XSL stylesheets and supporting files like images, CSS styles, translations, and help documents. The XSL stylesheets are applied to the DRI Document to covert it into a readable format and give it structure and basic visual formatting in that format. The supporting files are used to provide the page with a specific look and feel, insert images and other media, translate the content, and perform other tasks. The currently used output format is XHTML and the supporting files are generally limited to CSS, images, and JavaScript. More output formats, like PDF or SVG, may be added in the future.unmigrated-wiki-markup

A DSpace installation running Manakin may have several Themes associated with it. When applied to a page, a Theme determines most of the page's look and feel. Different themes can be applied to different sets of DSpace pages allowing for both variety of styles between sets of pages and consistency within those sets. The xmlui.xconf configuration file determines which Themes are applied to which DSpace pages (see the Chapter 7. Manakin \ [XMLUI\] Configuration and Customization for more information on installing and configuring themes). Themes may be configured to apply to all pages of specific type, like browse-by-title, to all pages of a one particular community or collection or sets of communities and collections, and to any mix of the two. They can also be configured to apply to a singe arbitrary page or handle.

Aspect Chains

Manakin Aspects are arrangements of Cocoon components (transformers, actions, matchers, etc) that implement a new set of coupled features for the system. These Aspects are chained together to form all the features of Manakin. Five Aspects exist in the default installation of Manakin, each handling a particular set of features of DSpace, and more can be added to implement extra features. All Aspects take a DRI Document as input and generate one as output. This allows Aspects to be linked together to form an Aspect chain. Each Aspect in the chain takes a DRI Document as input, adds its own functionality, and passes the modified Document to the next Aspect in the chain.

...

There were major structural changes between these two version numbers. Several elements were removed from the schema:includeSet, include, objectMeta, and object. Originally all metadata for objects were included in-line with the DRI document, this proved to have several problems and has been removed in version 1.1 of the DRI schema. Instead of including metadata in-line, external references to the metadata is included. Thus, a reference element has been added along with referenceSet. These new elements operate like their counterparts in the previous version except refrencing metadata contained on the objectMeta element they reference metadata in external files. The repository and repositoryMeta elements were alse modified in a similar mannor manner removing in-line metadata and refrencing external metadata documents.

...

Code Block
<meta>

    <userMeta> ... </userMeta>

     <pageMeta>

        <metadata element="title">Examlpe>Example DRI
	page</metadata>

        <metadata
	element="contextPath">/xmlui/</metadata>

        <metadata ...> ... </metadata>

        ...

        <trail source="123456789/6"> A bread crumb item
	</trail>

        <trail ...> ... </trail>

        ...

     </pageMeta>

</meta>

...

reference is a reference element used to access information stored in an extarnal external metadata file. The url attribute is used to locate the external metadata file. The type attribute provides a short limited description of the referenced object's type.

...

  • repositoryID: requiredA unique identifier assigned to a repository. It is referenced by the object element to signify the repository that assigned its identifier.
  • url: requiredA url to the external METS metadata file for the repository.
Code Block

<repositoryMeta>

     <repository repositoryID="123456789"
	url="/metadata/handle/1234/4/mets.xml" />

</repositoryMeta>

repositoryMeta

Metadata Element

The repositoryMeta element contains metadata refernces references about the repositories used in the used or referenced in the document. It can contain any number of repository elements.

See the repository tag entry for more information on the structure of repository elements.

Parent

  • Meta

Children

  • repository

...

  • (any)

Attributes

  • None
Code Block
<meta>

  <userMeta> ... </usermeta>

  <pageMeta> ... </pageMeta>

     <repositoryMeta>

        <repository repositoryIID="..." url="..."
	/>

     </repositoryMeta>

</meta>

...

The row element is contained inside a table and serves as a container of cell elements. A required role attribute determines how the row and its cells are rendered.

Parent

  • table

Children

  • cell

...

  • (any)

Attributes

  • id: optionalA (optional) A unique identifier of the element
  • n: optionalA (optional) A local identifier used to differentiate the element from its siblings
  • rend: optionalA (optional) A rendering hint used to override the default display of the element.
  • role: requiredIndicates (required) Indicates what kind of information the row carries. Possible values include "header" and "data".
Code Block

<table n="table-example" id="XMLExample.table.table-example" rows="2"
	cols="3">

     <row
	role="head">

      <cell cols="2">Data Label One and
	Two</cell>

        <cell>Data Label Three</cell>

        ...

     </row> <row>

      <cell> Value One </cell>

      <cell> Value Two </cell>

      <cell> Value Three </cell>

      ...

     </row>

    ...

</table>

table

Structural Element

The table element is a container for information presented in tabular format. It consists of a set of row elements and an optional header.

Parent

  • div

Children

  • head

...

  • (zero or one)
  • row

...

  • (any)

Attributes

  • cols: requiredThe (required) The number of columns in the table.
  • id: requiredA (required) A unique identifier of the element
  • n: requiredA (required) A local identifier used to differentiate the element from its siblings
  • rend: optionalA (optional) A rendering hint used to override the default display of the element.
  • rows: requiredThe (required) The number of rows in the table.
Code Block

<div n="division-example"
	id="XMLExample.div.division-example">

     <table n="table1" id="XMLExample.table.table1" rows="2"
	cols="3">

        <row role="head">

          <cell cols="2">Data Label One and
	Two</cell>

            <cell>Data Label Three</cell>

            ...

        </row>

        <row>

          <cell> Value One </cell>

          <cell> Value Two </cell>

          <cell> Value Three </cell>

          ...

        </row>

        ...

     </table>
    ...
</div>

trail

Text Container

Metadata Element

The trail element carries information about the user's current location in the system relative of the repository's root page. Each instance of the element serves as one link in the path from the root to the current page.

Parent

  • pageMeta

Children

  • none

Attributes

  • rend: optionalA (optional) A rendering hint used to override the default display of the element.
  • target: optionalAn (optional) An optional attribute to specify a target URL for a trail element serving as a hyperlink. The text inside the element will be used as the text of the link.
Code Block

<pageMeta>

    <metadata element="title"

...

>Example DRI
	page</metadata>

    <metadata
	element="contextPath">/xmlui/</metadata>

    <metadata ...> ... </metadata>

    ...

     <trail target="/myDSpace"> A bread crumb item pointing to a
	page. </trail> <trail ...> ... </trail>

    ...

</pageMeta>

userMeta

Metadata Element

The userMeta element contains metadata associated with the user that requested the document. It contains generic metadata elements, which in turn carry the information. Required and suggested values for metadata elements contained in userMeta include but not limited to:

  • identifier (suggested): A unique identifier associated with the user.
  • identifier.email (suggested): The requesting user's email address.
  • identifier.firstName (suggested): The requesting user's first name.
  • identifier.lastName (suggested): The requesting user's last name.
  • identifier.logoutURL (suggested): The URL that a user will be taken to when logging out.
  • identifier.url (suggested): A url reference to the user's page within the repository.
  • language.RFC3066 (suggested): The requesting user's preferred language selection code as describe by RFC3066
  • rights.accessRights (required): Determines the scope of actions that a user can perform in the system. Accepted values are:
    • none: The user is either not authenticated or does not have a valid account on the system
    • user: The user is authenticated and has a valid account on the system
    • admin: The user is authenticated and belongs to the system's administrative group

See the metadata tag entry for more information on the structure of metadata elements.

...

Parent

  • meta

Children

  • metadata

...

  • (any)

Attributes

  • authenticated: requiredAccepted (required) Accepted values are "yes", "no". Determines whether the user has been authenticated by the system.
Code Block

<meta>

     <userMeta>

        <metadata element="identifier" qualifier="email"

...

>bobJones@tamu.edu</metadata>

        <metadata element="identifier" qualifier="firstName"

...

>Bob</metadata>

        <metadata element="identifier" qualifier="lastName"

...

>Jones</metadata>

        <metadata element="rights"

...

 qualifier="accessRights">user</metadata>

        <metadata ...> ... </metadata>

        ...

        <trail source="123456789/6"

...

>A bread crumb 

...

item</trail>

        <trail ...> ... </trail>

        ...

     </userMeta>

    <pageMeta> ... </pageMeta>

</meta>

value

Rich Text Container

Structural Element

The value element contains the value associated with a form field and can serve a different purpose for various field types. The value element is comprised of two subelements: the raw element which stores the unprocessed value directly from the user of other source, and the interpreted element which stores the value in a format appropriate for display to the user, possibly including rich text markup.

Parent

  • field

Children

  • hi

...

  • (any)
  • xref

...

  • (any)
  • figure

...

  • (any)

Attributes

  • optionSelected: optionalAn (optional) An optional attribute for select, checkbox, and radio fields to determine if the value is to be selected or not.
  • optionValue: optionalAn (optional) An optional attribute for select, checkbox, and radio fields to determine the value that should be returned when this value is selected.
  • type: requiredA (required) A required attribute to specify the type of value. Accepted types are:
    • raw: The raw type stores the unprocessed value directly from the user of other source.
    • interpreted: The interpreted type stores the value in a format appropriate for display to the user, possibly including rich text markup.
    • default: The default type stores a value supplied by the system, used when no other values are provided.
Code Block

<p>
  <hi> ... </hi>
  <xref> ... </xref>
  <figure> ... </figure>
  <field id="XMLExample.field.name" n="name" type="text"
	required="yes">
    <params size="16" maxlength="32"/>
    <help>Some help text with <i18n>localized
	content</i18n>.</help>
     <value type="default">Author,
	John</value>
  </field>
</p>

xref

Text Container

Structural Element

The xref element is a reference to an external document. It can be mixed freely with text, and any text within the tag itself will be used as part of the link's visual body.

Parent

  • cell
  • p
  • item
  • hi

Children

  • none

Attributes

  • target: requiredA (required) A target for the reference, using either a URL or an id of an existing element as a destination for the xref.
Code Block

<p>

...


     <xref target="/url/link/target">This text is shown as a

...

 link.</xref>

...


</p>