From 973a95b1befe0f9cbd1dba89d78073adbc7cd78c Mon Sep 17 00:00:00 2001 From: Remington Steed Date: Wed, 15 Jan 2020 08:47:40 -0500 Subject: [PATCH] Docs: Fix section for Antora: "System Configuration and Customization" This commit does the known tasks to prepare each main docs section for Antora: - Add chapter labels to nav file items - To match existing docs "chapter" level headings, combine adoc files as needed so that each "chapter" from the old docs structure has a single file linked from the nav - In this case, the only change was in advanced_features.adoc, where two sections had the top heading level (seems like a mistake). I bumped the second one down ("Binary MARC21 Feeds") so it is a subsection of the file. Ironically, since this commit also bumps up all headings by one level, it means that heading is the only one not changed in this commit. - Upgrade all heading levels in each adoc file so that the top-most heading is a "Level 1" heading (example: "= Chapter Name =") - Add ":toc:" below top heading of each file Signed-off-by: Remington Steed --- docs-antora/modules/opac/nav.adoc | 22 +++++----- .../modules/opac/pages/advanced_features.adoc | 13 +++--- .../opac/pages/batch_actions_from_search.adoc | 19 ++++----- docs-antora/modules/opac/pages/catalog_browse.adoc | 3 +- docs-antora/modules/opac/pages/introduction.adoc | 3 +- docs-antora/modules/opac/pages/kids_opac.adoc | 17 ++++---- .../modules/opac/pages/linked_libraries.adoc | 3 +- docs-antora/modules/opac/pages/my_account.adoc | 12 +++--- docs-antora/modules/opac/pages/my_lists.adoc | 9 +++-- .../opac/pages/new_skin_customizations.adoc | 9 +++-- docs-antora/modules/opac/pages/opensearch.adoc | 5 ++- docs-antora/modules/opac/pages/search_form.adoc | 15 +++---- docs-antora/modules/opac/pages/search_url.adoc | 8 ++-- docs-antora/modules/opac/pages/sitemap.adoc | 3 +- .../modules/opac/pages/tpac_meta_record_holds.adoc | 3 +- .../pages/using_the_public_access_catalog.adoc | 47 +++++++++++----------- .../modules/opac/pages/visibility_on_the_web.adoc | 15 +++---- 17 files changed, 111 insertions(+), 95 deletions(-) diff --git a/docs-antora/modules/opac/nav.adoc b/docs-antora/modules/opac/nav.adoc index 4790f38a2a..aa2e6a3214 100644 --- a/docs-antora/modules/opac/nav.adoc +++ b/docs-antora/modules/opac/nav.adoc @@ -1,12 +1,14 @@ * xref:opac:introduction.adoc[Using the Public Access Catalog] -** xref:opac:using_the_public_access_catalog.adoc[] -** xref:opac:my_lists.adoc[] -** xref:opac:batch_actions_from_search.adoc[] -** xref:opac:kids_opac.adoc[] -** xref:opac:catalog_browse.adoc[] -** xref:opac:advanced_features.adoc[] -** xref:opac:tpac_meta_record_holds.adoc[] -** xref:opac:linked_libraries.adoc[] -** xref:opac:opensearch.adoc[] -** xref:opac:search_form.adoc[] +** xref:opac:using_the_public_access_catalog.adoc[Using the Public Access +Catalog] +** xref:opac:my_lists.adoc[My Lists] +** xref:opac:batch_actions_from_search.adoc[Batch Actions from Search] +** xref:opac:kids_opac.adoc[Kids OPAC] +** xref:opac:catalog_browse.adoc[Catalog Browse] +** xref:opac:advanced_features.adoc[Bibliographic Search Enhancements] +** xref:opac:tpac_meta_record_holds.adoc[TPAC Metarecord Search and Metarecord +Level Holds] +** xref:opac:linked_libraries.adoc[Library Information Pages] +** xref:opac:opensearch.adoc[Adding Evergreen Search to Web Browsers] +** xref:opac:search_form.adoc[Adding an Evergreen search form to a web page] diff --git a/docs-antora/modules/opac/pages/advanced_features.adoc b/docs-antora/modules/opac/pages/advanced_features.adoc index 259c4408b9..af27cf697c 100644 --- a/docs-antora/modules/opac/pages/advanced_features.adoc +++ b/docs-antora/modules/opac/pages/advanced_features.adoc @@ -1,14 +1,15 @@ -== Bibliographic Search Enhancements == += Bibliographic Search Enhancements = +:toc: Enhancements to the bibliographic search function enable you to search for records that were created, edited, or deleted within a date range. You can use the catalog interface or the record feed to search for records with specific date ranges. Note that all dates should be formatted as YYYY-MM-DD and should be included in parentheses. -=== Use the Catalog to Retrieve Records with Specified Date Ranges: === +== Use the Catalog to Retrieve Records with Specified Date Ranges: == -==== Search by Create Date or Range ==== +=== Search by Create Date or Range === To find records that were created on or after a specific date, enter the term, create_date, and the date in the catalog search field. For example, to find records that were created on or after April 1, 2013, enter the following into the catalog search field: @@ -24,7 +25,7 @@ create_date(2013-04-01,2013-04-08) -==== Search by Edit Date or Range ==== +=== Search by Edit Date or Range === To find records that were edited on or before a specific date, enter the term, edit-date, and the date in the catalog search field. The date should be preceded by a comma. For example, to find records that were edited on or before April 1, 2013, enter the following into the catalog search field: @@ -47,7 +48,7 @@ edit_date(2013-04-01,2013-04-08) -==== Search by Deleted Status ==== +=== Search by Deleted Status === To search for deleted records, enter in your catalog search field the term, edit_date, the date that you want to search, and the term, #deleted. For example, to find records that were deleted on or after April 1, 2013, enter the following into the catalog search field: @@ -63,7 +64,7 @@ edit_date(2013-04-01,2013-04-08)#deleted -=== Use a Feed to Retrieve Records with Specified Date Ranges: === +== Use a Feed to Retrieve Records with Specified Date Ranges: == You can use a feed to retrieve records that were created, edited, or deleted within specific date ranges by adding the dates to the catalog's URL. You can do this manually, or you can write a script that would automatically retrieve this information. diff --git a/docs-antora/modules/opac/pages/batch_actions_from_search.adoc b/docs-antora/modules/opac/pages/batch_actions_from_search.adoc index bfa08a69e4..c7da7bb19e 100644 --- a/docs-antora/modules/opac/pages/batch_actions_from_search.adoc +++ b/docs-antora/modules/opac/pages/batch_actions_from_search.adoc @@ -1,12 +1,13 @@ [#batch_actions_from_search] -== Batch Actions from Search == += Batch Actions from Search = +:toc: -=== Introduction === +== Introduction == The public catalog and staff interface display checkboxes on the search results pages, both for bibliographic records and metarecord constituents. Selecting one or more titles with these checkboxes adds the titles to a basket, which is viewable on the search bar as an icon. Users can then take a variety of actions on titles within the basket: place holds, print or email title details, add the items to a permanent list (from the public catalog) or add the titles to a bucket (from the staff interface). -=== Using Batch Actions from Search in the Public Catalog === +== Using Batch Actions from Search in the Public Catalog == . Perform a search in the public catalog and retrieve a list of results. + @@ -30,7 +31,7 @@ image::media/BatchActionsSearch-02.png[Basket Actions Drop-down] image::media/BatchActionsSearch-03.png[Details of Basket Actions Drop-down] -==== Actions Initiated with the Basket Actions Drop-down ==== +=== Actions Initiated with the Basket Actions Drop-down === * *View Basket* - This opens the basket in a new screen. Checkboxes allow for the selection of one or more titles within the basket. A drop-down menu appears above the list of titles that can be used to place holds, print title details, email title details, or remove titles from the basket. This menu reads _Actions for these items_. (See the next section for more information about this menu.) * *Place Hold* - This allows for placement of holds in batch for all of the items in the basket. If not already authenticated, users will be asked to login. Once authenticated, the holds process begins for all titles within the basket. Users can set _Advanced Hold Options_ for each title, as well as set the pickup location, hold notification and suspend options. @@ -43,12 +44,12 @@ image::media/BatchActionsSearch-03.png[Details of Basket Actions Drop-down] * *Clear Basket* - This removes removes all titles from the basket -==== View Basket -> _Actions for These Items_ Drop-down Menu ==== +=== View Basket -> _Actions for These Items_ Drop-down Menu === Most actions described above can be taken on titles from within the basket with the _Actions for these items_ drop-down menu. This menu offers additional flexibility, as users can select some or all of the individual titles in the basket on which to place holds, print or email details, or remove from the basket. Users cannot add titles to permanent lists with this menu. image::media/BatchActionsSearch-04.png[Actions for These Items Drop-down Menu] -=== Using Batch Actions from Search in the Staff Interface === +== Using Batch Actions from Search in the Staff Interface == . Perform a search in the staff interface and retrieve a list of results. + @@ -70,7 +71,7 @@ image::media/BatchActionsSearch-02.png[Basket Actions Drop-down] image::media/BatchActionsSearch-03.png[Details of Basket Actions Drop-down] -==== Actions Initiated with the Basket Actions Drop-down ==== +=== Actions Initiated with the Basket Actions Drop-down === * *View Basket* - This opens the basket in a new screen. Checkboxes allow for the selection of one or more titles within the basket. A drop-down menu appears above the list of titles that can be used to place holds, print title details, email title details, or remove titles from the basket. This menu reads _Actions for these items_. (See the next section for more information about this menu.) @@ -90,11 +91,11 @@ image::media/BatchActionsSearch-06.png[Add Basket Titles to Bucket] * *Clear Basket* - removes all items from the basket -==== View Basket -> Actions for These Items Drop-down Menu ==== +=== View Basket -> Actions for These Items Drop-down Menu === Most of the basket actions can be taken on titles from within the basket with the _Actions for these items_ drop-down menu. This menu offers additional flexibility, as staff can select some or all of the individual titles within the basket on which to place holds, print or email details, or remove from the basket. Staff cannot place titles in Records Buckets from this menu. -=== Additional Information === +== Additional Information == The basket used to be called a *Temporary List* in previous versions of Evergreen. diff --git a/docs-antora/modules/opac/pages/catalog_browse.adoc b/docs-antora/modules/opac/pages/catalog_browse.adoc index 288fd43888..85b8c8178b 100644 --- a/docs-antora/modules/opac/pages/catalog_browse.adoc +++ b/docs-antora/modules/opac/pages/catalog_browse.adoc @@ -1,4 +1,5 @@ -== Catalog Browse == += Catalog Browse = +:toc: *Abstract* diff --git a/docs-antora/modules/opac/pages/introduction.adoc b/docs-antora/modules/opac/pages/introduction.adoc index 159087776c..4c2e5e7f9e 100644 --- a/docs-antora/modules/opac/pages/introduction.adoc +++ b/docs-antora/modules/opac/pages/introduction.adoc @@ -1,4 +1,5 @@ -== Introduction == += Introduction = +:toc: Evergreen has a public OPAC that meets WCAG guidelines (http://www.w3.org/WAI/intro/wcag), which helps make the OPAC accessible to diff --git a/docs-antora/modules/opac/pages/kids_opac.adoc b/docs-antora/modules/opac/pages/kids_opac.adoc index 9f4e6dbdd0..8cd50373f2 100644 --- a/docs-antora/modules/opac/pages/kids_opac.adoc +++ b/docs-antora/modules/opac/pages/kids_opac.adoc @@ -1,6 +1,7 @@ -== Kids OPAC == += Kids OPAC = +:toc: -=== Introduction === +== Introduction == The Kids OPAC (KPAC) is a public catalog search that was designed for children and teens. Colorful menu items,large buttons, and simple navigation make this @@ -11,7 +12,7 @@ as the Template Toolkit OPAC (TPAC), the adult catalog search, so you can easily extend the KPAC using the code that already exists in the TPAC. Finally, third party content, such as reader reviews, can be integrated into the KPAC. -=== Choose a Skin === +== Choose a Skin == Two skins, or design interfaces, have been created for the KPAC. The KPAC was designed to run multiple skins on a single web server. A consortium, then, could @@ -37,7 +38,7 @@ After you login, the Login button disappears. image::media/Kids_OPAC2.jpg[Kids_OPAC2] -=== Search the Catalog === +== Search the Catalog == You can search the catalog using only the search bar, the search grid, or the search bar and the collection drop down menu. @@ -112,7 +113,7 @@ image::media/Kids_OPAC7.jpg[Kids_OPAC7] -=== Place a Hold === +== Place a Hold == From the search results, click the *Get it!* link to place a hold. @@ -138,7 +139,7 @@ image::media/Kids_OPAC13.jpg[Kids_OPAC13] -=== Save Items to a List === +== Save Items to a List == You can save items to a temporary list, or, if you are logged in, you can save to a list of your own creation. To save items to a list, click the *Get it* button @@ -163,7 +164,7 @@ image::media/Kids_OPAC15.jpg[Kids_OPAC15] -=== Third Party Content === +== Third Party Content == Third party content, such as reader reviews, can be viewed in the Kids OPAC. The reviews link appears adjacent to the brief information. @@ -184,7 +185,7 @@ copy information. image::media/Kids_OPAC10.jpg[Kids_OPAC10] -=== Configuration Files === +== Configuration Files == Configuration files allow you to define labels for canned searches in the icon grid, determine how icons lead users to new pages, and define whether those icons diff --git a/docs-antora/modules/opac/pages/linked_libraries.adoc b/docs-antora/modules/opac/pages/linked_libraries.adoc index dd771638d3..0e19f15533 100644 --- a/docs-antora/modules/opac/pages/linked_libraries.adoc +++ b/docs-antora/modules/opac/pages/linked_libraries.adoc @@ -1,4 +1,5 @@ -== Library Information Pages == += Library Information Pages = +:toc: The branch name displayed in the copy details section of the search results page, the record summary page, and the kids catalog record summary page will diff --git a/docs-antora/modules/opac/pages/my_account.adoc b/docs-antora/modules/opac/pages/my_account.adoc index fdad57a63a..2cb559c712 100644 --- a/docs-antora/modules/opac/pages/my_account.adoc +++ b/docs-antora/modules/opac/pages/my_account.adoc @@ -2,7 +2,7 @@ [#my_account] -=== My Account === +== My Account == // ``First Login Password Update'' the following documentation comes from JSPAC // as of 2013-03-12 this feature did not exist in EG 2.4 TPAC, @@ -68,7 +68,7 @@ If using a public computer be sure to log out! [#password_reset] -==== Password Reset ==== +=== Password Reset === indexterm:[my account, password reset] @@ -104,7 +104,7 @@ password_ field and re-enter it in the _Re-enter new password_ field. . Login to your account with your new password. -==== Account Summary ==== +=== Account Summary === indexterm:[my account, account summary] @@ -233,7 +233,7 @@ there is no way for a patron to recover those data. After changing any of these settings, you must click _Save_ to store your preferences. -===== Authorize other people to use your account ===== +==== Authorize other people to use your account ==== indexterm:[Allow others to use my account] indexterm:[checking out,materials on another patron's account] @@ -253,7 +253,7 @@ information will also be visible to circulation staff at your library. indexterm:[holds, preferred pickup location] -==== Patron Messages ==== +=== Patron Messages === The Patron Message Center provides a way for libraries to communicate with patrons through messages that can be accessed through the patron's OPAC account. @@ -284,7 +284,7 @@ image::media/message_center12.PNG[Message Center 12] NOTE: Patron deleted messages will still appear in the patron's account in the staff client under Other -> Message Center. -==== Reservations ==== +=== Reservations === When patrons place a reservation for a particular item at a particular time, they can check on its status using the *Reservations* tab. diff --git a/docs-antora/modules/opac/pages/my_lists.adoc b/docs-antora/modules/opac/pages/my_lists.adoc index 8ee6550c37..5be9c21e41 100644 --- a/docs-antora/modules/opac/pages/my_lists.adoc +++ b/docs-antora/modules/opac/pages/my_lists.adoc @@ -1,4 +1,5 @@ -== My Lists == += My Lists = +:toc: The *My Lists* feature replaces the bookbag feature that was available in versions prior to 2.2. The *My Lists* feature is a part of the Template Toolkit OPAC that is available in version 2.2. This feature enables you to create temporary and permanent lists; create and edit notes for items in lists; place holds on items in lists; and share lists via RSS feeds and CSV files. @@ -8,7 +9,7 @@ As of version 3.2, xref:opac:batch_actions_from_search.adoc#batch_actions_from_s image::media/My_Lists.png[My Lists] -=== Create New Lists === +== Create New Lists == 1) Log in to your account in the OPAC. @@ -45,7 +46,7 @@ image::media/My_Lists7.jpg[Share, Delete, Download List] 16) When you no longer need a list, click *Delete List*. -=== Local Call Number in My Lists === +== Local Call Number in My Lists == When a title is added to a list in the TPAC, a local call number will be displayed in the list to assist patrons in locating the physical item. Evergreen will look at the following locations to identify the most relevant call number to display in the list: @@ -61,7 +62,7 @@ The local call number and associated library location will appear in the list: image::media/my_list_call_numbers.png[Local Call Number in List] -=== My Lists Preferences === +== My Lists Preferences == Patrons can adjust the number of lists or list items displayed in a page. This setting can be found under the *Account Preferences* tab, in the *My Lists Preferences* section. diff --git a/docs-antora/modules/opac/pages/new_skin_customizations.adoc b/docs-antora/modules/opac/pages/new_skin_customizations.adoc index 8bbfb58471..2e7872966e 100644 --- a/docs-antora/modules/opac/pages/new_skin_customizations.adoc +++ b/docs-antora/modules/opac/pages/new_skin_customizations.adoc @@ -1,12 +1,13 @@ -== Creating a New Skin: the Bare Minimum == += Creating a New Skin: the Bare Minimum = +:toc: -=== Introduction === +== Introduction == When you adopt the TPAC as your catalog, you must create a new skin. This involves a combination of overriding template files and setting Apache directives to control the look and feel of your customized TPAC. -=== Apache directives === +== Apache directives == There are a few Apache directives and environment variables of note for customizing TPAC behavior. These directives should generally live within a `` section of your Apache configuration. @@ -31,7 +32,7 @@ PerlAddVar OILSWebDefaultLocale "fr-CA" SetEnv physical_loc 104 ------------------------------------------------------------------------------ -=== Customizing templates === +== Customizing templates == When you install Evergreen, the TPAC templates include many placeholder images, text, and links. You should override most of these to provide your users with a custom experience that matches your library. Following is a list of templates diff --git a/docs-antora/modules/opac/pages/opensearch.adoc b/docs-antora/modules/opac/pages/opensearch.adoc index 0702324c22..18883cd1e1 100644 --- a/docs-antora/modules/opac/pages/opensearch.adoc +++ b/docs-antora/modules/opac/pages/opensearch.adoc @@ -1,6 +1,7 @@ -== Adding Evergreen Search to Web Browsers == += Adding Evergreen Search to Web Browsers = +:toc: -=== Adding OpenSearch to Firefox browser === +== Adding OpenSearch to Firefox browser == OpenSearch is a collection of simple formats for the sharing of search results. More information about OpenSearch can be found on their diff --git a/docs-antora/modules/opac/pages/search_form.adoc b/docs-antora/modules/opac/pages/search_form.adoc index b56c6d6954..6cc3997241 100644 --- a/docs-antora/modules/opac/pages/search_form.adoc +++ b/docs-antora/modules/opac/pages/search_form.adoc @@ -1,13 +1,14 @@ -== Adding an Evergreen search form to a web page == += Adding an Evergreen search form to a web page = +:toc: -=== Introduction === +== Introduction == To enable users to quickly search your Evergreen catalog, you can add a simple search form to any HTML page. The following code demonstrates how to create a quick search box suitable for the header of your web site: -=== Simple search form === +== Simple search form == [source,html] ------------------------------------------------------------------------------ @@ -29,7 +30,7 @@ site: wish to anchor your search. This is the value of the ''locg'' parameter in your normal search. -=== Advanced search form === +== Advanced search form == [source,html] -------------------------------------------------------------------------------- @@ -74,17 +75,17 @@ site: -------------------------------------------------------------------------------- -=== Encoding === +== Encoding == For non English characters it is vital to set the attribute `accept-charset="UTF-8"` in the form tag (as in the examples above). If the parameter is not set, records with non English characters will not be retrieved. -=== Setting the document type === +== Setting the document type == You can set the document types to be searched using the attribute `option value=` in the form. For the value use MARC 21 code defining the type of record (i.e. https://www.loc.gov/marc/bibliographic/bdleader.html[Leader, position 06]). For example, for musical recordings you could use `` -=== Setting the library === +== Setting the library == Instead of searching the entire consortium, you can set the Library to be searched in using the attribute `option value=` in the form. For the value use Evergreen database.organization unit ID. diff --git a/docs-antora/modules/opac/pages/search_url.adoc b/docs-antora/modules/opac/pages/search_url.adoc index 36cb3664c3..d6ea158d3c 100644 --- a/docs-antora/modules/opac/pages/search_url.adoc +++ b/docs-antora/modules/opac/pages/search_url.adoc @@ -1,4 +1,4 @@ -=== Search URL === +== Search URL == indexterm:[search, URL] @@ -12,11 +12,11 @@ Here is a basic search URL structure: +++[hostname]+++/eg/opac/results?query=[search term]&**qtype**=keyword&fi%3Aitem_type=&**locg**=[location id] -==== locg Parameter ==== +=== locg Parameter === This is the id of the search location. It is an integer and matches the id of the location the user selected in the location drop down menu. -==== qtype Parameter ==== +=== qtype Parameter === The _qtype_ parameter in the URL represents the search type values and represent one of the following search or request types: @@ -31,7 +31,7 @@ one of the following search or request types: These match the options in the search type drop-down box. -==== Sorting ==== +=== Sorting === The _sort_ parameter sorts the results on one of these criteria. diff --git a/docs-antora/modules/opac/pages/sitemap.adoc b/docs-antora/modules/opac/pages/sitemap.adoc index fdfa23cca5..d66d246b22 100644 --- a/docs-antora/modules/opac/pages/sitemap.adoc +++ b/docs-antora/modules/opac/pages/sitemap.adoc @@ -1,4 +1,5 @@ -== Sitemap generator == += Sitemap generator = +:toc: A http://www.sitemaps.org[sitemap] directs search engines to the pages of interest in a web site so that the search engines can intelligently crawl diff --git a/docs-antora/modules/opac/pages/tpac_meta_record_holds.adoc b/docs-antora/modules/opac/pages/tpac_meta_record_holds.adoc index 5d7f7c2e50..59a548009a 100644 --- a/docs-antora/modules/opac/pages/tpac_meta_record_holds.adoc +++ b/docs-antora/modules/opac/pages/tpac_meta_record_holds.adoc @@ -1,4 +1,5 @@ -== TPAC Metarecord Search and Metarecord Level Holds == += TPAC Metarecord Search and Metarecord Level Holds = +:toc: Metarecords are compilations of individual bibliographic records that represent the same work. This compilation allows for several records to be represented on diff --git a/docs-antora/modules/opac/pages/using_the_public_access_catalog.adoc b/docs-antora/modules/opac/pages/using_the_public_access_catalog.adoc index 78f97a204c..c16386c5a4 100644 --- a/docs-antora/modules/opac/pages/using_the_public_access_catalog.adoc +++ b/docs-antora/modules/opac/pages/using_the_public_access_catalog.adoc @@ -1,6 +1,7 @@ -== Using the Public Access Catalog == += Using the Public Access Catalog = +:toc: -=== Basic Search === +== Basic Search == indexterm:[OPAC] @@ -50,7 +51,7 @@ To search an item copy call number, use <> ============= -==== Formats ==== +=== Formats === You can limit your search by formats based on MARC fixed field type: @@ -86,7 +87,7 @@ indexterm:[formats, music] * *VHS* -===== Libraries ===== +==== Libraries ==== If you are using a catalogue in a library or accessing a library’s online catalogue from its homepage, the search will return items for your local @@ -94,7 +95,7 @@ library. If your library has multiple branches, the result will display items available at your branch and all branches of your library system separately. -=== Advanced Search === +== Advanced Search == Advanced searches allow users to perform more complex searches by providing more options. Many kinds of searches can be performed from the _Advanced Search_ @@ -107,7 +108,7 @@ search options, use _Add Search Row_ button to add more search input rows. Clicking the _X_ button will close the search input row. -==== Sort Results ==== +=== Sort Results === indexterm:[advanced search, sort results] @@ -116,7 +117,7 @@ By default, the search results are in order of greatest to least relevance, see to order the search results by relevance, title, author, or publication date. -==== Search Library ==== +=== Search Library === indexterm:[advanced search, search library] @@ -126,7 +127,7 @@ only. If your library system has multiple branches, use the _Search Library_ box to select different branches or the whole library system. -==== Limit to Available ==== +=== Limit to Available === indexterm:[advanced search, limit to available] @@ -135,7 +136,7 @@ This checkbox is at the bottom line of _Search Library_. Select _Limit to Available_ to limit results to those titles that have items with a circulation status of "available" (by default, either _Available_ or _Reshelving_). -==== Exclude Electronic Resources ==== +=== Exclude Electronic Resources === indexterm:[advanced search, exclude electronic resources] @@ -154,7 +155,7 @@ the 'ctx.exclude_electronic_checkbox' setting in config.tt2 to 1. =============== -==== Search Filter ==== +=== Search Filter === indexterm:[advanced search, search filters] @@ -168,7 +169,7 @@ For each filter type, you may select multiple criteria by holding down the _CTRL_ key as you click on the options. If nothing is selected for a filter, the search will return results as though all options are selected. -===== Search Filter Enhancements ===== +==== Search Filter Enhancements ==== Enhancements to the Search Filters now makes it easier to view, remove, and modify search filters while viewing search results in the Evergreen OPAC. Filters that are selected while conducting an advanced search in the Evergreen OPAC now appear below the search box in the search results interface. @@ -186,7 +187,7 @@ Each filter can be removed by clicking the X next to the filter name to modify t [#numeric_search] indexterm:[advanced search, numeric search] -==== Numeric Search ==== +=== Numeric Search === If you have details on the exact item you wish to search for, use the _Numeric Search_ tab on the advanced search page. Use the drop-down menu to select your @@ -194,7 +195,7 @@ search by _ISBN_, _ISSN_, _Bib Call Number_, _Call Number (Shelf Browse)_, _LCCN_, _TCN_, or _Item Barcode_. Enter the information and then click the _Search_ button. -==== Expert Search ==== +=== Expert Search === indexterm:[advanced search, expert search] @@ -213,7 +214,7 @@ an expert search for "245 a Gone with the wind", simply do a regular title search for "Gone with the wind". ============= -=== Boolean operators === +== Boolean operators == indexterm:[search, AND operator] indexterm:[search, OR operator] @@ -249,7 +250,7 @@ might require it, using symbolic operators as follows: | NOT | `-`_term_ | `a -b` |================================= -=== Search Tips === +== Search Tips == indexterm:[search, stop words] indexterm:[search, truncation] @@ -317,7 +318,7 @@ truncate any number of characters. (example: _environment* agency_) -=== Search Methodology === +== Search Methodology == [#stemming] @@ -351,7 +352,7 @@ _golden_. [#order_of_results] -==== Order of Results ==== +=== Order of Results === indexterm:[search, order of results] @@ -368,7 +369,7 @@ can also re-order your search results using the _Sort Results_ dropdown list on the search result screen. -=== Search Results === +== Search Results == indexterm:[search results] @@ -407,7 +408,7 @@ the _Show More Details_ link. Clicking an entry on the list will re-sort your search results accordingly. -==== Facets: Subjects, Authors, and Series ==== +=== Facets: Subjects, Authors, and Series === indexterm:[search results, facets: subjects, authors, and series] @@ -420,7 +421,7 @@ your original results before the facet was activated. image::media/catalogue-5.png[catalogue-5] -==== Availability ==== +=== Availability === indexterm:[search results, availability] @@ -441,7 +442,7 @@ next to the _Limit to available items_ check box, to view each search result's copies' individual call number, status, and shelving location. -==== Viewing a record ==== +=== Viewing a record === indexterm:[search results, viewing a record] @@ -452,7 +453,7 @@ options for placing holds, add to my list, and print/email. image::media/catalogue-8.png[catalogue-8] image::media/catalogue-8a.png[catalogue-8a] -=== Details === +== Details == indexterm:[search results, details] @@ -538,7 +539,7 @@ The record summary page offers a link to a shorter permalink that image::media/using-opac-view-permalink.png[Permalink] -==== SMS Call Number ==== +=== SMS Call Number === If configured by the library system administrator, you may send yourself the call number via SMS message by clicking on the *Text* link, which appears beside diff --git a/docs-antora/modules/opac/pages/visibility_on_the_web.adoc b/docs-antora/modules/opac/pages/visibility_on_the_web.adoc index b5f04c68b1..d1fcb6183f 100644 --- a/docs-antora/modules/opac/pages/visibility_on_the_web.adoc +++ b/docs-antora/modules/opac/pages/visibility_on_the_web.adoc @@ -1,6 +1,7 @@ -== Library visibility on the Web == += Library visibility on the Web = +:toc: -=== Introduction === +== Introduction == Evergreen follows a number of best practices to make Library data integrate with the rest of the @@ -11,7 +12,7 @@ collections. Evergreen is also preparing for an eventual shift toward linked open bibliographic data. -=== Catalog data in search engines === +== Catalog data in search engines == Each record in the catalog is displayed to search engines using http://schema.org[schema.org] microdata. @@ -23,7 +24,7 @@ These files restrict search engines, up to the point of not allowing search engines to index your site at all. -==== Details of the schema.org mapping ==== +=== Details of the schema.org mapping === * Each item is listed as a http://schema.org/Offer[schema:Offer], which is @@ -60,7 +61,7 @@ site at all. http://schema.org/exampleOfWork[schema:exampleOfWork]. -==== Viewing microdata ==== +=== Viewing microdata === You can learn more about how Evergreen publicizes these data by viewing them directly. The http://linter.structured-data.org[structured data linter] @@ -75,7 +76,7 @@ is a helpful tool for viewing microdata. into the text box. . Click _Submit_ -==== Other helpful features for search engines ==== +=== Other helpful features for search engines === * Titles of catalog pages follow a "Page title - Library name" pattern to provide specific titles in search engine results pages, @@ -101,7 +102,7 @@ is a helpful tool for viewing microdata. that provides machine-readable hours and contact information. -=== SKOS support === +== SKOS support == Some vocabularies used (or which could be used) for stock record attributes and coded value maps in Evergreen -- 2.11.0