Adding or Removing Schemes and Qualifiers for a DC(2) Template

Main -> Documentation -> Open SiteSearch Record Builder -> Customizing DC Templates -> Adding or Removing Schemes and Qualifiers for a DC(2) Template

Adding or Removing Schemes and Qualifiers for a DC(2) Template

Contents

Introduction
Document Conventions
Adding Schemes and/or Qualifiers
Removing Schemes and/or Qualifiers

Introduction

You can add or remove schemes and/or qualifiers for any element in a DC(2) template, including locally-defined elements that you add to the default DC(2) template shipped with SiteSearch 4.1.1 or 4.1.2. An element's schemes and qualifiers appear in the drop-down list to the left of the element's text entry field or drop-down list on Record Builder's Edit Record screen. Click here for a list of the schemes and qualifiers used in the DC(2) template shipped with SiteSearch 4.1.1 or 4.1.2.

You may wish to add schemes or qualifiers recommended by a Dublin Core Working Group or database-specific schemes or qualifiers unique to your site. If you know that certain schemes or qualifiers delivered with the default DC(2) template do not apply to a local database, you can remove them as well.

Adding or removing schemes and/or qualifiers are two of the supported customizations to DC templates. Ideally, you should add or remove schemes and/or qualifiers for a database before you add any records to the database.

Note:

In SiteSearch 4.1.1, modifiers are equivalent to qualifiers in SiteSearch 4.1.2.

Document Conventions

<WebZ_root> is the location of the WebZ environment that includes Record Builder.
db_name is the top-level directory of the database for which you want to add or remove qualifiers.
namespace is an element's XML namespace. namespace is DC for an element included in the DC(2) template.xml file shipped with SiteSearch 4.1.1 and is a unique identifier other than DC, MANTIS, RDF, or RB for other elements added to a template.
element_name is an element's name, as defined in template.xml.

Adding Schemes and/or Qualifiers

Note:

You add a scheme or qualifier for a database at any time. However, metadata specialists must edit records individually to apply new scheme or qualifier values to existing records.

Follow this procedure to add schemes and/or qualifiers (modifiers in SiteSearch 4.1.1) to a database's field.xml file.

1. Does the element's specification in <WebZ_root>/dbbuilder/dbs/db_name/template.xml have statements indicating that the element should have schemes and/or qualifiers? See Items and , respectively, in the template.xml file example for these statements. (Note: The file example opens in a second browser window.)

Yes. Go to step 2.

No.

Open <WebZ_root>/dbbuilder/dbs/db_name/template.xml with a text editor.
Add these statements to the end of the element's definition, as shown in the template.xml file example:

SiteSearch 4.1.2:
<DC:Scheme>
     <MANTIS:display>invisible</MANTIS:display>
     <MANTIS:label>Scheme</MANTIS:label>
</DC:Scheme>
<DC:Qualifier>
     <MANTIS:display>invisible</MANTIS:display>
     <MANTIS:label>Qualifier</MANTIS:label>
</DC:Qualifier>

SiteSearch 4.1.1:

<RB:Scheme>
     <MANTIS:display>invisible</MANTIS:display>
     <MANTIS:label>Scheme</MANTIS:label>
</RB:Scheme>
<RB:Qualifier>
     <MANTIS:display>invisible</MANTIS:display>
     <MANTIS:label>Qualifier</MANTIS:label>
</RB:Qualifier>

Note:

If you only want to provide scheme values for the element, add only the first four lines above..

Save and close the template.xml file.
Go to step 2.

2. Open <WebZ_root>/dbbuilder/dbs/db_name/field.xml with a text editor. Click here for an example of the field.xml file in a second browser window.

3. Does the element for which you are adding schemes and/or qualifiers already have a section in field.xml?

Yes. Find the opening tag for the element for which you want to add a scheme or qualifier (such as <DC:Creator>). Review the existing values and determine where you want to insert the new value. You can add the new value anywhere in the list except for making it the first value.
- If you are adding additional scheme or qualifier value(s), go to step 7.
- If you are adding qualifier value(s) where no qualifier values currently exist for the element, go to step 6.
No. Review the general layout of an element's section in field.xml. Then go to step 4.

4. Begin a new section for the element, beginning with an opening tag:

<namespace:element_name>

and ending with a closing tag:

</namespace:element_name>

Note:

The element's opening and closing tags need to match its opening and closing tags in template.xml.

5. To start a list of scheme values, add these lines right after the opening tag:

SiteSearch 4.1.2:
<entry>
<DC:scheme>Scheme</DC:scheme>
<DC:default>true</DC:default>
</entry>

SiteSearch 4.1.1:
<entry>
<RB:scheme>Scheme</RB:scheme>
<RB:default>true</RB:default>
</entry>

6. To start a list of qualifier values, add these lines after the end of the list of scheme values:

SiteSearch 4.1.2:

<entry>
<DC:qualifier>Qualifier</DC:qualifier>
<DC:default>true</DC:default>
</entry>

SiteSearch 4.1.1:

<entry>
<RB:modifier>Modifier</RB:modifier>
<RB:default>true</RB:default>
</entry>

7. Add the new scheme or qualifier value anywhere in the list except for making it the first value (as shown in steps 5 and 6), with a section like this:

For a new scheme value:

SiteSearch 4.1.2:

<entry>
    <DC:scheme>scheme_value</DC:scheme>
</entry>

SiteSearch 4.1.1:

<entry>
    <RB:scheme>scheme_value</RB:scheme>
</entry>

For a new qualifier value:

SiteSearch 4.1.2:

<entry>
    <DC:qualifier>qualifier_value</DC:qualifier> </entry>

SiteSearch 4.1.1:

<entry>
    <RB:modifier>qualifier_value</RB:modifier>
</entry>

where scheme_value or qualifier_value represent the scheme or qualifier to appear in the drop-down list.

8. Repeat step 7 for each additional scheme or qualifier value you want to add for the element.

9. Repeat steps 3-8 to add schemes or qualifiers for another element.

10. Do you want to remove any schemes or qualifiers?

Yes. Go to step 2 of the procedure Removing Schemes and Qualifiers.
No. Go to step 11.

11. Save and close <WebZ_root>/dbbuilder/dbs/db_name/field.xml

12. Did you add schemes and/or qualifiers for new element(s) or existing element(s)?

New element(s). Return to the procedure Adding Elements to a DC Template.
Existing element(s). Go to step 13.

13. Open Record Builder with a Web browser. Then click the database's workform as if you are creating a new record. When you see the Edit Record screen appears, verify that the new scheme(s) and qualifier(s) appear in the drop-down list. If you removed any schemes or qualifiers, make sure that they show up in the appropriate drop-down list.

14. Before you or your metadata specialists add or modify records in the database, stop and then restart Record Builder. Click here for more information for UNIX; click here for more information for Windows NT.

Return to Contents

Removing Schemes and/or Qualifiers

Note:

You can remove a scheme or qualifier for a database that contains records with the scheme or qualifier you want to delete. However, metadata specialists cannot select a scheme or qualifier value for an element if it does not exist in field.xml.

1. Open <WebZ_root>/dbbuilder/dbs/db_name/field.xml with a text editor. Click here for an example of the field.xml file in a second browser window.

2. Find the opening tag for the element for which you want to remove a scheme or qualifier (such as <DC:Creator>).

3. Find the <entry> </entry> section for the scheme or qualifier, as follows, and delete it.

For a scheme value:

SiteSearch 4.1.2:
<entry>
    <DC:scheme>scheme_value</DC:scheme>
</entry>

SiteSearch 4.1.1:

<entry>
    <RB:scheme>scheme_value</RB:scheme>
</entry>

For a qualifier value:

SiteSearch 4.1.2:
<entry>
    <DC:qualifier>qualifier_value</DC:qualifier> </entry>
SiteSearch 4.1.1:
<entry>
    <RB:modifier>qualifier_value</RB:modifier>
</entry>

where scheme_value or qualifier_value represent the scheme or qualifier you want to remove.

Note:

Do not remove the first <entry> section for either a scheme or a qualifier. You must keep this section intact for Record Builder to function properly.

4. Repeat steps 2-3 for each additional scheme or qualifier value you want to remove.

5. Do you want to add any schemes or qualifiers for this element or any other elements?

Yes. Go to step 3 of the procedure Adding Schemes and Qualifiers.
No. Go to step 6.

6. Save and close <WebZ_root>/dbbuilder/dbs/db_name/field.xml.

7. Open Record Builder with a Web browser. From the New Record screen, click the link for creating a new record for the database. When the Edit Record screen appears, verify that the scheme(s) and qualifier(s) you removed no longer appear in the appropriate drop-down list. If you added any schemes or qualifiers, make sure that they show up in the appropriate drop-down list as well.

8. Before you or your metadata specialists add or modify records in the database, stop and then restart Record Builder. Click here for more information for UNIX; click here for more information for Windows NT.

Return to Contents

[Main][Documentation][Support][Technical Reference][Community][Glossary][Search]

Last Modified: