Editing PDS object structure
On this page:
Overview
This section describes how to edit the structure of a PDS object and how to control other aspects of the PDS public interface.
To edit structure, open the PDS object's metadata summary and select File Structure from the left-hand menu. The object's structure will display in an expandable/collapsible hierarchical tree. The structure and nearby editing options are referred to as the structure editor in this document.
The DRS2 structure editor lets you make the same types of structural changes as DRS1 PDS Maintenance, but with an updated user interface that delivers many editing options using a right-click context menu and lets you use drag and drop to move page and section nodes around the structure tree.
Some important tips related to editing PDS objects:
- Merges not available. Merging of PDS objects is not supported in the first production release of DRS2, but will be available in a future release.
- PDS public interfaceoptions are controlled by fields in an object's admin and descriptive metadata. See the section Controlling PDS public interface options for more information.
About the Structure Editor
Adding Page Numbers and Labels
You can select a single page node and apply number and label using the Node Attributes panel. Or you can number and label a range of page nodes using the "Number Pages" button. It is also possible to Rename a page label by right-clicking a page node, but this option changes the label only and not the page number.
Using the Node Attributes panel to label a single page node
- Select a page node and view the Node Attributes panel on the right.
- Enter a value in Page Number. This is the physical number printed on the page. Values in this field power the "Go to page" option in the PDS user interface.
- Enter a value in Page Label. This will normally be a label plus page number, but can be any type of label. The page label displays in the table of contents panel in the PDS user interface.
Note: There is no automatic page labeling (enter page number "1" and get a "page 1" label by default). If you leave this field blank, there will be no page label. - Click Update Attributes to apply the change.
Click Save Structmap to commit the change.
Using "Number Pages" to label a range of page nodes
- Click the Number Pages button. A Sequential Numbering panel will open on the right.
- Enter the sequence range to be numbered.
- Select a number format and starting page number.
- Enter a label format. Insert a label before or after the curly braces (representing the page number). Do not delete the braces or insert data between them.
- Click Update Numbering to apply these changes.
- Click Save Structmap to commit these changes.
Inserting a Section Node and Attaching Page Nodes
To group pages into chapters, sections etc. you can insert a section node into the structure tree using a right-click contextual menu and then drag and drop page nodes onto the section. Lines connect the parent section node with its child page nodes to form a branch. Nested sections (subsections) are also supported.
- To insert a section before or after an adjacent page node, right-click the page node and select Create > Create Section Before (or After).
- Click into the new section node and type a label. Or at any point, you can change the label by right click > Rename or by using the Node Attributes panel on the right.
- Click and drag a page node onto the section node. Use shift+click to select a group of page nodes and drag the group onto the section node.
- When dragging page nodes, you should drop them (unclick) when the target section node is highlighted.
- To insert a subsection, right-click over the parent section and select Create > Create Subsection. Or right-click over a page node in the section and select Create > Create Section.
- Click into the subsection node and type a label.
- Click Save Structmap to commit these changes.
Inserting a Section Break in the Middle of a Page
This topic describes how to depict a chapter or section that starts in the middle of a page. The procedure involves splitting a page node into two copies and inserting a section node between them.
Note: Split page nodes must stay paired and can be separated only by a section node. The structure editor will prevent you from saving a structure in which split nodes are more widely separated.
- Create a split page node. Right-click over the page node where the new section starts and select Split. A duplicate page node will be inserted. Both nodes will be marked with a link icon.
- Give the split nodes labels. The easiest way is to use Number Pages to number and label all pages including the split nodes. Or, select each node and add a number and label in the Node Attributes panel.
Note: Right-click menu options are limited on the first split node and aren't available on the second split node. - Insert a section node between the split nodes. Right-click over the first split node and select Create Section After. In a later step, you will attach the second split node to this section.
- Insert a new section node that is positioned somewhere above the first split node. In a later step, you will attach the first split node to this section.
- Drag and drop page nodes (including the first split node) onto the first section.
- Drag and drop page nodes (including the second split node) onto the second section.
- Give each section a label. Select a section and right-click to Rename or enter a label in the Node Attributes panell.
- Click Save Structmap to commit these changes.
If you need to undo a split node, right click over the first node in the pair and select Unsplit. The result will be a single page node.
Inserting a Page Node and Linking to Page Files
This topic describes how to insert a new page node into a structure and how to associate page files (images, OCR/plain text, or layout files) with it. Use techniques described here to add a new page to a document or to replace files associated with an existing page node (e.g., replacing a poor quality page image).
The page files that you associate with a page node must already be part of the object. They may have been orphaned when deleting another page node in the structure, or were uploaded to the object using the Add a File option available on the object summary page.
- Insert a new page node. Right-click over an adjacent node and select Create > Create Page Before (or After)
' - [Optional] Give the new page node a page number and label. Select the node and input a page number and label in the Node Attributes panel on the right.
- Link page files to the new node. Files available to link are listed under the Add Files area at bottom of the Node Attributes panel. With the page node selected, choose a file and click the Add File button. Repeat this step if there are additional files to be linked.
- Click Save Structmap to commit these changes.
Deleting Nodes and Unlinking Files
This topic describes options for unlinking/deleting associated page files (page images, OCR plain text, layout files) and deleting section or page nodes.
It is also possible to bulk delete multiple files or objects using the main Web Admin search interface, which also unlinks the deleted files/objects from any relationships. This process is described in the Bulk Deletion section of Managing Content.
Unlinking and deleting page files
The structure editor lets you remove a file from a page node by unlinking or deleting.
- Unlinking a file removes it from the page node but retains the file in the object. Unlinked files will be listed under Add Files at the bottom of the Node Attributes panel and will also be listed in file inventory on the object summary page.
- Deleting a file will unlink it from the page node and delete the file from DRS. Delete from the structure editor has the same effect as deleting a file from the file summary page.
- Select the page node.
- Under Page Attributes in the right panel, select the file to be removed.
- Click the Unlink button to unlink the file from the node but keep it in the object. Or click the Delete button to unlink the file and delete it from DRS.
- Click Save Structmap to commit this change.
Deleting section nodes
You can delete a section node only or delete a section plus its child page nodes. If you delete a section only, any child page nodes will be outdented to the next level up in the hierarchy. If you delete a section and its page nodes, any files associated with the deleted page nodes will be unlinked and listed in the Add Files area at bottom of the Node Attributes panel.
- Right-click the section node to be deleted and select Delete section (to delete just the section) or Delete section & its content (to delete the section and any child page nodes).
Click Save Structmap to commit this change.
Deleting a page node
You can delete a page node using the right-click menu. When you delete a page node, any linked page files will be unlinked and listed in the Add Files area at bottom of the Node Attributes panel.
- Right-click the page node to be deleted and select Delete from the menu.
- Click Save Structmap to commit this change.
Assigning a URN
At batch deposit, a PDS object is automatically assigned a citation (title-level) persistent identifier (URN). In the structure editor, you can see this citation URN associated with the first page node.
This topic describes structure editor options for assigning additional PDS URNs to an object after deposit. (A "PDS URN" resolves to a PDS URL.) You can assign a URN to individual page nodes or use the Auto Name option to assign URNs to all pages or to the first page node in all sections down to a specified depth.
If you need to assign more than one URN to the citation level (first page node) of a document, use the DRS delivery URNs field on the object's Admin metadata page.
When is a new URN actionable? About 10 minutes after you create a URN, you can use it in a browser.
Assigning a URN to a selected page
In this method, you select a page node and assign a URN using options in the Naming portion of the Node Attributes panel.
- Select a page node and view the Naming portion of the Node Attributes panel on the right.
- Select an Authority Path. The drop-down list will include authority paths that are compatible with the tub-level of the DRS owner code for the document.
- Enter a Resource Name. You can assign a specific resource name (such as a local accession number), use a URN mask to request that the resource name be generated by NRS, or a combination of these. The result must be a resource name that is unique within the selected authority path. For more about URN mask options, see Using a URN mask.
- Click Add URN to apply the change.
- Click Save Structmap to commit the change.
- The newly created URN is now associated with that page node
The URN will be actionable about 10 minutes after creation. To use it in a browser, prepend http://nrs.harvard.edu/ (in production) or http://nrstest.harvard.edu:9031/ (in beta). Using the URN created in this example, the production form would be:
http://nrs.harvard.edu/urn-3:hul.ois:269033
Assigning many URNs using Auto Naming
Use the Auto Naming option to assign URNs to all pages in the document, or to all intermediate section nodes down to a specified depth from the citation node.
Use this feature only when there is a need for URNs to all pages or to all sections in a document. If access to the citation (top) level of PDS document is sufficient, use the citation level URN that was assigned to the document at DRS deposit. If access to selected individual parts of the document is needed, assign individual URNs using the Naming option in the Node Attributes panel.
- Click the Auto Naming button and an Auto Naming panel will display on the right.
- Select an Authority Path. The drop-down list will include authority paths that are compatible with the tub-level of the DRS owner code for the document.
- Enter a Resource Name. You can assign a specific resource name (such as a local accession number), use a URN mask to request that the resource name be generated by NRS, or a combination of these. The result must be a resource name that is unique within the selected authority path. For more about URN mask options, see Using a URN mask.
- Select Name All Pages if you want to name all pages in the document.
- Select Name Sections if you want to name sections in a document. Then specify a Depth value. A depth of 1 will assign a URN to all sections one level below the citation node. Entering no depth value will assign a URN to all sections at every level of the document. Remember that naming sections involves naming the first sequential page under the section. Notice in the screenshot below that the first sequential page node below Chapter 1 is the first node under the subsection Part A.
- Click Add Names to apply this change. The URN icon will appear next to every page node that has been named.
- Click Save Structmap to commit the change.
- The newly created URNs are now associated with page nodes.
Each URN will be actionable about 10 minutes after creation. To use it in a browser, prepend http://nrs.harvard.edu/ (in production) or http://nrstest.harvard.edu:9031/ (in beta).
Using a URN mask
This topic describes the URN mask – a method for composing the resource name portion of a URN by inserting values that will be auto-generated by NRS.
A URN mask is a placeholder that will be replaced with actual values by NRS. Mask components include a unique integer generator as well as various date and time stamps.
URN mask components may be added anywhere in the resource name string, and may be repeated, if desired. They are enclosed in braces ('{' , '}') to distinguish them from other parts of the resource name string. This means that brace characters may not be part of a name (brace characters are not part of the valid NRS name character set in any event). The components are:
URN mask component | Replacement values | Meaning |
{dd} | 01 – 31 | Current day of the month |
{hh24} | 01 – 24 | Current hour, 24 hour clock |
{mo} | 01 – 12 | Current month |
{n} | 0 – 1027 | Unique integer value |
{ss} | 00 – 59 | Current second |
{yyyy} | 1999 – 9999 | Current year |
Note that using a URN mask does not guarantee that the string created will be unique. Submitting URN masks that generate non-unique values will result in an error, and the rejection of the request to generate a name. Best practice to guarantee generation of a unique name would be to include the unique integer value component, '{n}', in the mask.
Examples:
URN mask |
| Created value (resource name is highlighted) |
| urn-3:RAD.SCHL:28732 | |
| urn-3:RAD.SCHL:HOD:28733 ("HOD" is a literal string combined with the URN mask {n}) | |
| urn-3:HMS.Count:2005-28734 | |
| urn-3:FHCL:20051201 (unique only for one object on any given day) | |
| urn-3:FHCL:20051201_28735 (always unique) |
Deleting/deactivating a URN
When in the structure editor, page nodes assigned a URN are marked. To delete a URN, select the page node and in the right panel, click the Remove button to mark the URN for deletion. Then click the Save Structmap button to commit the change.
Removing a URN deactivates the URN in the NRS database but does not actually delete it. This change takes effect the next day, when the NRS resolver is updated.
Controlling PDS Public Interface Options
While the current DRS (DRS1) and new DRS (DRS2) systems operate in parallel, the existing PDS public interface will deliver PDS objects stored in either system. For DRS2 objects, this topic describes how options in the PDS public interface can be controlled by making changes to a PDS object's metadata in DRS2 Web Admin.
In the PDS public interface screenshot that follows, options circled in yellow are controlled by PDS object metadata.
- METS label: This label is controlled by fields in an object's descriptive metadata. See Updating the METS label for details.
- Search: This option lets the user keyword search text of the document. The Search button is activated automatically if the PDS Object includes OCR text for some or all pages. If OCR files are not present, this option is grayed out.
- View Text: This option lets the user view the OCR text version of the page. This option is controlled by the View Text field in PDS object admin metadata. A View Text value (on/off) can be set in Batch Builder or after deposit in Web Admin. If this field is not set in Batch Builder, the default value is OFF and the View Text button will be grayed out.
- Related Links: This option displays links and metadata associated with the PDS object. In DRS2, both the Harvard Metadata and Related Links fields in object descriptive metadata contribute to the Related Links display. If neither of these Link fields contains data, the Related Links button will be grayed out.
- Go to Page navigation: This option lets the user navigate to a specified physical page number. It's powered by the presence of page numbers associated with some or all page nodes in the document. If page numbers are not assigned to any page node, this option will be grayed out.
- Image size: The maximum size of a JPEG200-based page image can be controlled in file-level metadata. See How to limit still image delivery size for more information.
- Page image caption: The ability to display a default or custom caption below each page image is controlled by caption fields in object admin metadata.