HyperWorks Desktop

Contents and Content Definition

Contents and Content Definition

Previous topic Next topic Expand/collapse all hidden text  

Contents and Content Definition

Previous topic Next topic JavaScript is required for expanding text JavaScript is required for the print function  
hmtoggle_plus1greyContent

Content refers to any information stored in a library.

Contents hold information such as:

Metadata (like content name)
Zero or more documents
References to other contents

Anything that can be described using the HyperWorks content definition XML format can be managed as content.

hmtoggle_plus1greyContent Definition

Content Definitions encapsulate information about the types of information managed by the HyperWorks libraries. The information is captured as:

Metadata that is associated with the content
Dependencies between the metadata, if any
Relationships that can be achieved between this content type and others

The Organize browser has three special content types that are reserved. They are:

ContentType
Category
FolderType

Out-of-the-box content definitions are provided for CAE content types, which are used when creating a managed CAE library.

hmtoggle_plus1greyContent Definition XML Schema

Content definitions can be created using XML schema. HyperWorks does not have a schema validating XML parser, hence it is the responsibility of the publisher to make sure the content type XML description is validated externally.

At the root of the document is the element ContentType, with name as a mandatory attribute. It contains a list of Metadata.
Each metadata has name and type as required attributes.
If “mandatory” attribute is true then “defaultvalue” should be specified.
In addition a metadata might have a set of valid values.
hmtoggle_plus1greyMetadata Attributes
name (mandatory - string): name of metadata.
type (mandatory - string): metadata value type. Should be one of string, int, float, boolean.
dname (boolean): if it is true then the metadata is used as name for the related content.
editable (boolean): if it is true then the metadata is editable by you.
displayable (boolean): if it is true then the metadata is displayed to you.
mandatory (boolean): if it is true then the metadata should be filled by you.
displayName (string): metadata display name.
defaultvalue (string): metadata default value.
category (string): metadata category.
Note:It is mandatory to set dname to true on one and only one attribute.
hmtoggle_plus1greyContent Definition Example

In this example a Macro Content Definition is shown below. The content definition has three metadata:

name
description
actiontype

The last metadata has a list of valid values. All metadata are of type string and mandatory.

content_def_example

hmtoggle_plus1greyParser

A parser automatically extracts information from files when they are added to a library. The extracted information is stored as content metadata, or as indexed metadata, and can be used when searching for contents in a library. Searches can be metadata or full-text based.