Page tree
Skip to end of metadata
Go to start of metadata

Files:

  • dspace/config/controlled-vocabularies/
  • dspace/config/dspace.cfg

Instructions:

  1. By default, the controlled vocabulary functionality is disabled since it is not compatible with WAI Guidelines. To enable it, uncomment the following line in your dspace.cfg:#webui.controlledvocabulary.enable = true
  2. DSpace only has the license to redistribute the following controlled vocabularies:
    • Norwegian Science Index (nsi.xml) - By default, this vocab is not used
    • Swedish Research Subject Categories (srsc.xml) - When enabled, this vocab is used with the Subject (
      dc.subject
      ) metadata field.
  3. Each of the above controlled vocabularies is defined (in dspace/config/controlled-vocabularies/) via an XML with structure similar to:
    <node id="acmccs98" label="ACMCCS98">

    <isComposedBy>
       <node id="A." label="General Literature">
        <isComposedBy>
         <node id="A.0" label="GENERAL"/>
         <node id="A.1" label="INTRODUCTORY AND SURVEY"/>
         ...
        </isComposedBy>
       </node>
       ...
      </isComposedBy>
    </node>
  4. The above XML structure would generate a hierarchical controlled vocabulary with the following structure:
    ACMCCS98 
            General Literature
                    GENERAL
                    INTRODUCTORY AND SURVEY
  5. Using this structure, if a submitter selected
    GENERAL
    in the above hierarchy, the item would be assigned a subject which is an aggregation of all terms above the selected term in the hierarchy, e.g.
    ACMCCS98::General Literature::GENERAL
  6. You may create your own custom controlled vocabulary by generating an XML structure for it similar to above. Once created, place your custom controlled vocabulary alongside the preexisting controlled vocabularies in dspace/config/controlled-vocabularies/
    • There is a schema provided at dspace-source/docs/controlledvocabulary.xsd. The following fields are currently available in this XML Structure (optional attributes/fields are marked)
    • <node>
      - represents a single term in the hierarchy
    • id
      (optional) - a unique identifier for this term
    • label
      - a label for this term. This is the actual controlled text displayed in DSpace and stored in the metadata for an item.
    • <isComposedBy>
      (optional)- represents the "composed by" relationship between terms. So, in the example on the previous page,
      General Literature
      is specified as being composed by
      GENERAL
      and
      INTRODUCTORY AND SURVEY
    • <isRelatedTo>
      (optional) - similar to
      <isComposedBy>
      , but represents the "is related to" relationship between terms.
    • <hasNote>
      (optional) - specifies a note related to a term. This is never displayed but is useful for your own documentation/notes.
  7. To actually use a controlled vocabulary with the submission input forms (see image on previous page), you must specify the controlled vocabulary to use for a specific metadata field. This can be achieved using the
    <vocabulary>
    tag within input-forms.xml. For more information, see the notes on the
    <vocabulary>
    tag in the section Alter submission input forms
  8. Stop and restart Tomcat (See Quick Restart in Rebuild DSpace).