Embed Size (px)
Citation preview
OhioLINK DRCInput Forms Workshop
Linda NewmanDigital Projects CoordinatorUniversity of Cincinnati Librarieshttp://[email protected]
OhioLINK DRC Input Forms Workshop 3-15-2011
Catalina OylerDigital Initiatives CoordinatorThe Five Colleges of Ohio [email protected]
Don’t forget about Templates:You can use templates to control fields. Edit Collection Edit Item Template
(found after ‘Current logo’)
Templates in Use:This is how the input form looks:
Structure of input-forms.xmlHeader: <?xml version="1.0"?>
<!DOCTYPE input-forms SYSTEM "input-forms.dtd">
Form Map:
<form-map> <name-map collection-handle="default" form-name="traditional" /> <name-map collection-handle="2374.UC/862" form-name="uc_news_record" /></form-map>
Form Definitions:
<form-definitions> <form name="uc_news_record"> <page number="1"> <!-- A form may contain 1-6 pages.--> <field></field> </page> </form></form-definitions>
Value Pairs: <form-value-pairs> <value-pairs value-pairs-name="common_identifiers" dc-term="identifier"> <pair></pair> </value-pairs></form-value-pairs>
Footer: </input-forms>
Documentation:
Chapter 14.4 of the “DSpace Manual” for release 1.6.0:
http://www.dspace.org/1_6_0Documentation/ch14.html#N183C7
For the entire manual see: http://www.dspace.org/1_6_0Documentation/index.htmlPDF:http://www.dspace.org/1_6_0Documentation/DSpace-Manual.pdf
Field definitions <field> <!-- contributor.author -->
<dc-schema>dc</dc-schema>
<dc-element>contributor</dc-element>
<dc-qualifier>author</dc-qualifier>
<repeatable>true</repeatable>
<label>Author</label>
<input-type>name</input-type>
<hint>Enter the name of the author of this item.</hint>
<required>You must enter an author.</required>
</field>
It’s good to label each field with a comment : <!– comment -->
Elements for each field: •dc-schema•dc-element •dc-qualifier repeatable •label •input-type •hint•required
If a field is not required, omit any content between the tags <required></required>.
It’s good to label each field with a comment : <!– comment -->
Elements for each field: •dc-schema•dc-element •dc-qualifier repeatable •label •input-type •hint•required
If a field is not required, omit any content between the tags <required></required>.
Other elements (consult online documentation: •visibility•vocabulary
Input Types• onebox -- A single text-entry box.
• textarea -- Large block of text that can be entered on multiple lines.
• name -- Personal name, with separate fields for surname and first name. When saved they are appended in the format ’LastName, FirstName‘.
• date -- Calendar date. If required at least the year must be entered.
• series -- Series/Report name and number. Separate fields are provided for series name and series number, but they are appended (with a semicolon between) when saved.
• dropdown -- Choose value(s) from a "drop-down" menu list. *
• qualdrop_value -- Enter a "qualified value", which includes both a qualifier from a drop-down menu and a free-text value.*
• list -- Choose value(s) from a checkbox or radio button list. If the repeatable attribute is set to true, a list of checkboxes is displayed. If the repeatable attribute is set to false, a list of radio buttons is displayed.*
*These input types require the value-pairs-name attribute.
onebox• onebox -- A single text-entry box.
<field> <!-- title -->
<dc-schema>dc</dc-schema>
<dc-element>title</dc-element>
<dc-qualifier></dc-qualifier>
<repeatable>false</repeatable>
<label>Title</label>
<input-type>onebox</input-type>
<hint>Enter the main title of the item.</hint>
<required>You must enter a main title for this item.</required>
</field>
textarea• textarea -- Large block of text that can be entered on multiple lines.
<field> <!-- description -->
<dc-schema>dc</dc-schema>
<dc-element>description</dc-element>
<dc-qualifier></dc-qualifier>
<repeatable>true</repeatable>
<label>Description</label>
<input-type>textarea</input-type>
<hint> Enter any descriptive notes in this box. HTML is allowed. This field appears on brief record.</hint>
<required></required>
</field>
name• name -- Personal name, with separate fields for surname and first name. When
saved they are appended in the format ’LastName, FirstName‘.
<field> <!– contributor.author -->
<dc-schema>dc</dc-schema>
<dc-element>contributor</dc-element>
<dc-qualifier>author</dc-qualifier>
<repeatable>true</repeatable>
<label>Author</label>
<input-type>name</input-type>
<hint>Enter the name of the author of this item.</hint>
<required>You must enter at least one author.</required>
</field>
date• date -- Calendar date. If required at least the year must be entered.
<!-- **** date.issued is toggled on/off by "Published before?" checkbox on INITIAL QUESTIONS page **** -->
<field> <!-- date.issued -->
<dc-schema>dc</dc-schema>
<dc-element>date</dc-element>
<dc-qualifier>issued</dc-qualifier>
<repeatable>false</repeatable>
<label>Date of Issue</label>
<input-type>date</input-type>
<hint>Please give the date of previous publication or public distribution below. You can leave out the day and/or month if they aren't applicable.</hint>
<required>Date Issued will usually match Date Created for this collection.</required>
</field>
dropdown• dropdown -- Choose value(s) from a "drop-down" menu list<field> <!-- language.iso set to en_us -->
<dc-schema>dc</dc-schema>
<dc-element>language</dc-element>
<dc-qualifier>iso</dc-qualifier>
<repeatable>false</repeatable>
<label>Language</label>
<input-type value-pairs-name="us_english_language">dropdown</input-type>
<hint>Language defaults to English (United States) but this can be changed by editing the metadata after record submission.</hint>
<required>choose English (United States)</required>
</field>
Later in value pairs section:
<value-pairs value-pairs-name="us_english_language" dc-term="language">
<pair>
<displayed-value>English (United States)</displayed-value>
<stored-value>en_US</stored-value>
</pair>
</value-pairs>
Dropdown (in use)
qualdrop• qualdrop_value -- Enter a "qualified value", which includes both a qualifier from
a drop-down menu and a free-text value.
<field>
<dc-schema>dc</dc-schema>
<dc-element>contributor</dc-element>
<dc-qualifier></dc-qualifier>
<repeatable>true</repeatable>
<label>Contributors</label>
<input-type value-pairs-name="uc_CCM_contributors">qualdrop_value</input-type>
<hint>Enter any prominently named authors, performers, composers, conductors, or other. Enter in the format of lastname, firstname.</hint>
<required></required>
</field>
Qualdrop (value-pairs)<value-pairs value-pairs-name="uc_CCM_contributors" dc-term="contributor">
<pair>
<displayed-value>author</displayed-value>
<stored-value>author</stored-value>
</pair>
<pair>
<displayed-value>performer</displayed-value>
<stored-value>performer</stored-value>
</pair>
<pair>
<displayed-value>composer</displayed-value>
<stored-value>composer</stored-value>
</pair>
<pair>
<displayed-value>conductor</displayed-value>
<stored-value>conductor</stored-value>
</pair>
<pair>
<displayed-value>other</displayed-value>
<stored-value>other</stored-value>
</pair>
</value-pairs>
Qualdrop (in use)
Limitations of input-forms.xml
• A form-definition must exist for each collection if the default input-form is not sufficient. (No method for defining input forms for all collections within a community.)
• Input-types cannot be combined, such as ‘name’ and ‘qualdrop’.
• Fields of the same element and qualifier cannot be repeated with different value-pairs within the same form.
Exercise1. Login through the OARnet VPN client. Use FileZilla to
login to your test instance and download the following two files to your laptop. Both are found in /local/local/dspace/config
input-forms.xmlinput-forms.dtd
2. Copy input-forms.xml. Good practice – name the copy for the date of last modification, for example: input-forms_bkup_20110311.xml
3. Create a new collection in your test instance named ‘Test Input Forms’. Make a note of the collection handle.
Exercise4. Open input-forms.xml in Oxygen (or your xml
editor of choice). Make an entry for the new collection in the form-map section:
<name-map collection-handle="2374.UC/222240" form-name= "test_inputforms" />
5. Copy the form-definition for “traditional” to a new form-definition above this form-definition. Select beginning with this line: <form name="traditional"> and copy through </form>
6. Change the first line of the new form-definition to <form name= "test_inputforms ">
Exercise7. Alter the input-type in the field definition for ‘Identifier’:<input-type value-pairs-
name="workshop_common_identifiers"> qualdrop_value</input-type>8. Alter the input-type in the field definition for ‘subject’:<input-type
value-pairs-name="workshop_subjects">list</input-type>
9. Alter the input-type in the field definition for ‘language’:<input-type value-pairs-
name="workshop_languages">dropdown</input-type>
Exercise10. Go to the end of the file. Before the line that closes the
value-pairs section -- </form-value-pairs> -- add 3 new value-pair definitions:
<value-pairs value-pairs-name="workshop_common_identifiers" dc-term="identifier"> <pair> <displayed-value>ISSN</displayed-value> <stored-value>issn</stored-value> </pair> <pair> <displayed-value>ISBN</displayed-value> <stored-value>isbn</stored-value> </pair></value-pairs>
(Continued next slide)
Exercise<value-pairs value-pairs-name="workshop_subjects" dc-term="subject"> <pair> <displayed-value>Apples</displayed-value> <stored-value>Apples</stored-value> </pair> <pair> <displayed-value>Oranges</displayed-value> <stored-value>Oranges</stored-value> </pair> <pair> <displayed-value>Grapefruit</displayed-value> <stored-value>Grapefruit</stored-value> </pair></value-pairs>
<value-pairs value-pairs-name="workshop_languages" dc-term="language"> <pair> <displayed-value>English (United States)</displayed-value> <stored-value>en_US</stored-value> </pair> <pair> <displayed-value>French</displayed-value> <stored-value>fr</stored-value> </pair></value-pairs>
Exercise11.Validate the input-forms.xml file using
Oxygen.12.Save input-forms.xml13.Using FileZilla, upload both input-forms.xml
and your backup copy, to your test instance, to /local/local/dspace/config
14.Login to your test instance using PuTTY, including ‘sudo -i’, and issue this command: tomcat restart
15.Test your new input form!
Exercise16.The exercise is complete. You may wish to
restore your original input-forms.xml. You can do this in FileZilla, on the right hand pane – in /local/local/dspace/config. Rename or delete the new file, and then rename your backup copy to ‘input-forms.xml’. Then in PuTTY, restart tomcat again. This is one way to back-out of any changes that don’t work.
OhioLINK DRCInput Forms Workshop
Linda NewmanDigital Projects CoordinatorUniversity of Cincinnati Librarieshttp://[email protected]
OhioLINK DRC Input Forms Workshop 3-15-2011
Catalina OylerDigital Initiatives CoordinatorThe Five Colleges of Ohio [email protected]
