-
Notifications
You must be signed in to change notification settings - Fork 1
User Interface Features
The Openbibl project currently presents a TEI-encoded descriptive bibliography as a continuous (scrolled, rather than paged) series of bibliographic entries, preceded by the bibliography's given title and a generated, linked table of contents. The bibliographic entries are presented in a condensed form to facilitate review of the descriptive elements of the bibliography, with notes and annotations collapsed until requested by the user.
The page displaying a rendered bibliography supports a number of user interface features meant to enable user interaction with the bibliography as a hypertext document, including text search and browsing of editorial information encoded in the TEI XML bibliography but not rendered alongside the descriptive and annotative content. The items below list and detail the current set of interactive features provided by the Openbibl framework.
In large viewports -- approximately 750px or greater -- the Openbibl navigation menu is displayed beside the single-column textual region of the rendered bibliography. For smaller viewports, for example, those in a narrow browser window or in a browser on a tablet device, the navigation menu is moved offscreen until the user requests its display by clicking the menu button.
The table of contents presented above the bibliography entries is generated using the tei:title and tei:author values found in each entry and facilitates both review of the bibliography contents and navigation.
Until requested by the user, only the tei:biblStruct and tei:physDesc elements are rendered on screen.
The hyperlinks found in the body of bibliography entries are tooltips that respond to a mouse hover action. The text of a tooltip is taken from the editorial note provided in the TEI XML file.
The TEI XML file rendered in a browser is not an optimized version, since the content of the page is generated dynamically by the browser using the XML file and a number of XSLT stylesheets each time the page is loaded. In order to avoid the load time required for generating HTML from the XML bibliography, as well as index information for the browse and search functionality, a Download function is available to have the rendered HTML saved to file through the browser. This optimized HTML version of a bibliography will not differ from the XML version except for (a) the removal of the "Download" function, and (b) the inclusion of browse/search index data, which is not visible to the user directly.
A number of stylistic themes are distributed with the Openbibl framework. The fonts and style attributes of these themes may be modified by a bibliography author, and new themes may be developed.
On page load, the bibliography entries are displayed in the order in which they occur in the TEI XML file. Sorting using author name and bibliography date, when that data is available in the XML file, is enabled by the options under the Sort item on the menu.
The currently displayed bibliography entries can be filtered according to the occurrence of search terms and/or editorially identified entities, for example, people or places. The filter options are used with filter modes, "all" or "any", that determine whether to filter bibliography entries exclusively or inclusively.
Search terms may be words, abbreviations, years, terms, and other single, whole-word (i.e., bounded by whitespace or punctuation) strings of characters within the body of a bibliography entry. The search terms pre-populated in the search input field are taken from the bibliographies themselves, so any term displayed as an option will match one or more entries.
The items populating browse menus, for example, those in the "People" or "Places" lists in the example bibliography distributed with Openbibl, are pulled from the editorial lists in the TEI XML backmatter. If these editorial items are linked to their occurrences in the bibliography entries, only relevant entries will be displayed.