Collection Information Menu. Navigation, pages, and related-links quickstart guide

Transcription

1 Collection Information Menu Navigation, pages, and related-links quickstart guide

2 FL-Islandora users can now extend the Collection theming functionality provided by the BANNER and DESC-TEXT datastreams with the addition of RELATED-LINKS. The RELATED-LINKS datastream allows users to create a menu as part of their collection object display. The menu can contain internal and external links as well as links to generate collection-specific user-created pages.

3 internal-link page external-link

4 RELATED-LINKS DOWNLOAD TEMPLATE The RELATED-LINKS datastream is a simple XML file and requires only a basic text editor to create. Each link in the menu corresponds to an element in the file. The value of the title attribute assigns the link label. The text enclosed within each tag defines the target of the link. The type of tag determines the type of link (external-link, internal-link, or page). The XML file should begin with the prolog below. Use <related-links> as the root element.

5 Adding External Links Adding an external link requires the FULL URI of the link destination. Useful for linking to library and institution websites or other locations outside of your FL-Islandora domain.

6 Adding Internal Links An internal link must point to a location within your FL-Islandora site. Using a forward slash, the link will be appended to the end of your FL-Islandora domain. /node/1 => /islandora/object/fgcu:25619 => These links are relative and without a forward slash will be inserted at the level of a user s path when they access the link. islandora/object/fgcu:25619 => (accessed from Therefore it is advisable to begin your internal links with a forward slash and include the full path to your target location.

7 Building Pages DOWNLOAD PAGE TEMPLATE Before adding pages to your related-links XML file you will need to create them. Like Related-Links, modal pages are stored as datastreams as part of collection objects. Also like Related-Links, the page files must be created locally. Use a text or HTML editor to create each page file with the desired content. HTML, CSS, And JQuery can be used to structure and style the content. HTML tags are not required for the content to be rendered but you will not be able to structure or style the content without it. Save the file as HTML to preview it in a browser. NOTE: Styles applied to your Islandora site will affect the content of your modal pages. Use inline styles or create new selectors to override existing CSS. Tip: Enclose your page in a <div class= modal-inner > tag for finer control of your content and to correct overflow problems.

8 Adding Pages Add finished page files to the collection object in the same manner as adding a BANNER or DESC-TEXT datastream. Select + Add a datastream For the Datastream ID enter the corresponding value in the RELATED-LINKS file. The value given to this ID and the value given to the intended page element must be identical. If the Datastream ID doesn t match the value in your RELATED-LINKS file the page link will not work! You can enter anything you d like for Datastream Label but it is best to enter something that describes the page so that you are able to reference it later (this is especially important if you are creating many modal pages for the same collection).

9 Building Pages cont... If you need to reference files, such as images, in your pages that are not hosted elsewhere (or files loaded as islandora objects) you may load them as supplementary datastreams in the Collection. When adding the datastream be sure to give the DSID a unique name and provide a descriptive label. After loading the file use the URL of the datastream itself as the location of the resource in your page.

10 Building Pages cont... Supplemental datastreams for use in pages is not limited to images. You may host any type of file as long as it does not exceed the upload limit of 2GB. Other examples from the PALMM Collection pages include PDF, Excel documents, and audio files. You may also add an HTML file that is not linked from your related-links menu (see next slide).

11 Building Pages cont... If you d like to link to other modal pages from within a modal page, add it as an anchor link. Note: Only use an anchor link if the datastream designated in the link is included in the menu. If the page datastream is not included in the related-links file, link to it with either the full URL or a relative path. These pages will not open as a modal page. They will open as a separate HTML page and are not subject to any CSS that is not present or referenced within the page itself.

12 Adding the menu Once the related-links file is populated, and any Pages and desired supplemental files are loaded to the collection, it may be loaded to the target collection as a datastream. Run through the following list to be certain the file is ready. Every element* has a title attribute with the name of it s link. The type of tag corresponds to the enclosed text. The file starts with <?xml version="1.0" encoding="utf-8"?> and is saved with an.xml extension. The XML is valid. You can find many utilities online to validate your XML. Please do this. -this one only needs you to cut and paste. Creating the menu and associated collection content first on a test site is recommended. *title attribute in <related-links> is optional.

13 Adding the menu Add the XML file as you would any other datastream. Be sure the the ID is RELATED-LINKS. The label value can be anything but does require input.

14 Maintaining the menu & pages There is currently no utility in place to make edits to the collection information datastreams. If changes are needed the datastreams must be downloaded to your local machine. After editing, the collection datastreams may be replaced with the updated files in the datastream management tab.

15 Usage Easy to locate links remove the need for inline linking or list creation in DESC-TEXT. Reduce clutter of heavy DESC-TEXT by offering alternative display opportunities, allowing more objects into users view. Provide in-depth collection information without user leaving page. Highlight items from the collection. Display collection pathfinders. Build collection exhibits. Provide collection specific contact and provenance info at the collection level. Integrate college and faculty with the display of departmental links and information. Inclusion of files not part of formal collection. Increases interactivity, opportunity to engage users. Collection information datastreams stored in Fedora repository as part of collection Fedora Object. Use extra area to sell ad space. Pay down gambling debts. See PALMM for inspiration.