Page Comparison

...

Notebook, Bali and C[hinese] Theatre Notes, 1932. Harold Acton papers, GEN MSS 663. Series III. Yale University Library Special Collections. http://pui.hudmol.com/repositories/3/archival_objects/1280 Accessed July 09, 2017.

In this example:

• “Notebook, Bali and C[hinese] Theatre Notes, 1932” is the Display String, which is constructed from the title of the archival object, concatenated with a comma and the first (but only the first!) date subrecord, if there is a date subrecord, as per the rules in place in the ArchivesSpace staff interface.

• “Harold Acton papers” is the Resource title.

• “GEN MSS 663. Series III.” is the composite identifier for the Archival Object, which is a configurable inheritance option for the new public interface.

• “Yale University Library Special Collections” is the Repository name.

• “http://pui.hudmol.com/repositories/3/archival_objects/1280” is the URI of the Archival Object for which the user has clicked the Citation action button.

• “July 09, 2017” is the date when the Citation action button was clicked.

...

The language code translation value from the staff interface displays in the single-scroll view of a resource record (i.e. the finding-aid overview , that's provided when you click on the second tab of a resource page).  The language code translation value is also added to the new PDF output.  Last, even though this language code is set up to be inherited by default, since it does not display on any pages in the PUI currently, you will not see any evidence of that inheritance. In future releases, this element could be used as an additional facet.

...

The working group's suggestion to handle the language code / language note relationship was to follow the logic that the Language Note should be the element that is displayed to users, whereas the Language Code translation value could be used for facets, but if a Language Note was missing, then the translation value from the Language Code would display in its absence (e.g. if there is no language note, but a language code of "eng" is supplied, a Language Note with the value of "English" would still display to the user). This is not how the PUI works currently, however, but that behavior could be accommodated with a plugin, or in a future release of the new PUI.

...

By default, the Digital Object display badge will show up as "Digital Record." If the VRA core option of Collection, Image, or Work is selected in the Staff interface, then that will change the badge display to "Digital Collection", "Digital Image", or "Digital Work", respectively. This will only affect display in the default Public interface.  There are no facets included in the Public interface to differentiate between these four possible display options.

Series-based facets for top containers

For any collection that has top containers linked to it, there will be a new search-resutls page in the Public interface that returns all of the top containers associated with that collection. On this page, one of the two possible facets that can display here are Series titles. Please note that the Series will only appear as a facet if it has an identifier in the staff interface. This limitation could be changed in a future release, but right now it is in place due to how the Top Container information is constructed on the staff-side of the application. 

Internal linking

You can use the EAD “ref” element along with it’s @href attribute in the staff interface to provide internal links within the same finding aid in the public interface.  The advantage of using this is 1) that the link won't change regardless of your public-facing URL structure (e.g. archives.myinstiution.com vs. archives.library.myinstituion.com) and 2) these links will also work in your EAD files outside of the ArchivesSpace Public Interface.

If you want to link to a specific component from the context of the resource record's scope and content note, for example, then all you need to do is grab the reference ID of that archival component and use that as the value of the href attribute in your EAD ref element.

...add example once i have wifi...

Digital object links / thumbnails

Add some examples of how two can be used in tandem.  

Please note that the “make representative” feature that’s in the staff interface is not yet used in the Public interface.  The following user story in JIRA might eventually be implemented so that a staff user can determine which digital object link to highlight: AR-XXXX.

Links between digital object records and accessions, resources, and archival objects

...just a place to note how the full hierarchy is displayed on the digital object pages, where the actual linkable occurs at the level that's bolded.  Should actually move this to the other PUI documentation page.

...

Digital Object Buttons / Thumbnails

If you publish a digital object in the new PUI without any published File URIs, then it will not include the new Digital Object Button.

If you include a published File URI sub record, then there are two different ways that the Digital Object Button can display to a user, and everything else will depend on whether or not use the "embed" option for the Xlink Show Attribute field:

1. The button will display with a generic icon when a single File URI is associated with that digital object and the File URI does not use the "embed" option for the Xlink Show Attribute field.  The digital object name will also display as the title of the button, and in the case that a type has been added in the staff interface (e.g. cartographic), then that type will display as part of the title in parentheses (e.g. digital object title (cartographic)).  No other elements have any affect right now in the PUI, including the caption field.
2. The button will include an embedded image that also functions as a link.  To achieve this, there need to be two File URI sub records, and only one of those will need to have the "embed" option selected for the Xlink Show Attribute field. The other File URI will function as the destination of the link.  But what if you have more than two File URI sub records?  In that case, only the last two that are listed in the staff interface are utilized in the PUI. Because of that, you will need to be careful with the order of File URIs if you ever publish more than two File URI sub records in the same digital object record.

You can also embed an image directly in the interface without creating a Digital Object Button by having a single File URI with the "embed" option selected.  If you have multiple File URIs that are published, all with the "embed" option selected, then you will still only have a single embedded image in the PUI for that digital object. The image that is embedded with be the last File URI in the staff interface.  If at least one of those published File URIs does not have the "embed" option selected, then you will wind up with a Digital Object Button, as described previously.

If this digital object is linked to an archival object, then the same Digital Object Button that displays on the digital object page will display on the archival object page.  Additionally, the digital dbject will show up as a link in the Digital Material accordion section from the context of the archival object page. At this time, the Digital Object Button does not display on Resource or Accession pages, but linked digital objects will still be listed in the Digital Material accordion section. Since you can attach multiple digital objects to any archival component, please be careful with publishing multiple File URIs at the same time, since the current PUI will add a Digital Object button for each one, and the page would just get longer and longer.  Remember, it is only the archival object pages in the current PUI that include the Digital Object buttons in the same way that the Digital Object pages do.

Please also note that the “make representative” feature that’s in the staff interface is not yet used in the Public interface. 

Image Added

Links from Digital Object records to Archival Objects, Accessions, and Resources

When a Digital Object record is linked to an Archival Object record, then the full, ancestor hierarchy or that archival object is displayed on the digital object page. Each ancestor is included as a link, and the last link for that archival object appears in bold to indicate that is where the Digital Object is linked in the context of the overall Resource record.  

Because of this, the links from a Digital Object record to an Accession and/or Resource record are also in bold when on the linked Digital Object page.

Series-based facets for top containers

For any collection that has top containers linked to it, there will be a new search-results page in the Public interface that returns all of the top containers associated with that collection. On this page, one of the two possible facets that can display here are Series titles. Please note that the Series will only appear as a facet if it has an identifier in the staff interface. This limitation could be changed in a future release, but right now it is in place due to how the Top Container information is constructed on the staff-side of the application. 

Internal linking

You can use the EAD “ref” element along with it’s @target attribute in the staff interface to provide internal links within the same finding aid in the public interface.  The advantage of using this is 1) that the link won't change regardless of your public-facing URL structure (e.g. archives.myinstiution.com vs. archives.library.myinstituion.com) and 2) these links will also work in your EAD files outside of the ArchivesSpace Public Interface.

If you want to link to a specific component from the context of the resource record's scope and content note, for example, then all you need to do is grab the reference ID of that archival component and use that as the value of the target attribute in your EAD ref element (see https://www.loc.gov/ead/tglib/elements/ref.html for more information).

Example: Check out the <ref target="b5eb603c1f21d605311e2c0b5b25a796">photographs</ref>!

Agent to Agent links

Please note that if you provide a description of a relationship between two agents, the same description will appear on both agent landing pages. This behavior is the same in the staff interface as it is now in the public interface.  You will need to keep this in mind when authoring any descriptive notes for agent relationships, since you cannot have two different descriptions written from different perspectives associated with the same relationship in ArchivesSpace 2.1.  For example, if you were to link an agent record for Vincent Price and his mother, Marguerite Cobb Price, in the staff interface, it would be best to have the note reference both names since the same note will appear on both Vincent’s landing page as well as Marguerite’s, assuming that both agent records are published in the staff interface.

...

See this JIRA ticket for the mappings used in ArchivesSpace 2.1 (but note that the Repository mappings have not yet been put into place): https://archivesspace.atlassian.net/browse/AR-1484

You can test out these new features by going to Google’s Structured Data Testing Tool, https://search.google.com/structured-data/testing-tool, and pasting in a URI from the public interface for a resource or person/corporate body agent record.

...

• Title (direct inheritance)

• Identifier (indirect inheritance, but by default the identifier inherits from ancestor archival objects only; it does NOT include the resource identifier.

  also it is advised to inherit this element in a composite fashion once it is determined whether the level of description should or should not display as part of the identifier, which will depend upon local data-entry practices)

• Language code (direct inheritance, but it does NOT display anywhere in the interface currently; eventually, this could be used for faceting)

• Dates (direct inheritance)

• Extents (indirect inheritance)

• Creator (indirect inheritance)

• Access restrictions note (direct inheritance)

• Scope and contents note (indirect inheritance)

• Language of Materials note (indirect inheritance, but there seems to be a bug right now so that the Language notes always show up as being directly inherited. See AR-XXXX)

See https://github.com/archivesspace/archivesspace/blob/master/common/config/config-defaults.rb#L296-L396 for more information and examples.

Also, a video overview of this feature, which was recorded before development was finished, is available online: https://vimeo.com/195457286

Composite Identifier Inheritance

...

When you set include_level to true, that means that the archival object level will be included in identifier so that you don't have to repeat that data.  For example, if the level of description is "Series" and the archival object identifier is "1", and the parent resource identifier is "MSS 1", then the composite identifier would display as "MSS 1. Series 1" at the series 1 level, and any descendant record.  If you set include_eve level to false, then the display would be "MSS 1. 1"

...

By default, this action button is turned off.  This feature has been configured in the Test Corpus, however, so that a Gmail email account is used to 1) email users with information about their request, and 2) to email staff detailed information about the user’s request.  The information that is included in a request is detailed in the following JIRA ticket:  https://archivesspace.atlassian.net/browse/AR-1660

See https://github.com/archivesspace/archivesspace/blob/master/common/config/config-defaults.rb#L493-L524 for more information about how to configure this option.

...

Search the configuration file, , https://github.com/archivesspace/archivesspace/blob/master/common/config/config-defaults.rb, for “pui” and “public” for other options that can be configured easily.

The labels used in the PUI may also be configured in whichever YML file is used: https://github.com/archivesspace/archivesspace/blobtree/master/commonpublic/config/config-defaults.rb, for “pui” and “public” for other options that can be configured easily.The labels used in the PUI may also be configured in whichever YML file is used: https://github.com/archivesspace/archivesspace/tree/master/public/config/locales

Known Bugs

...hopefully none to report, but will likely have a few

(e.g. locales

Known Bugs

(links to JIRA still need to be added for each bug)

issues with the proxy_pui_uri (home links and citations)... but I think that these have already been addressed in the master branch.

finding aid status does not use the YML file (instead, the database value is shown).  need to verify if this is a template issue, or an issue with the default YML file.

"Language of descripti..." is truncated in the Finding Aid & Administrative Information accordion section.  Updating the pixel-based width from 160 to 170 should fix that with the current theme (or just removing the width declaration altogether).

when container type is missing, the text "Container " plus the container indicator are displayed in the badge on the landing page of an Accession record, but the text Container is missing from the badge on a search-result page).

and the fact that if you suppress some archival objects that have top containers attached, then you need to edit those top containers, as well, in order for those top containers not to show up in the container inventory view of the PUI. 

...

...

Appendices

Appendix A

...