]> git.evergreen-ils.org Git - Evergreen.git/blob - docs-antora/modules/opac/pages/visibility_on_the_web.adoc
LP#1848524: Docs: section fixes
[Evergreen.git] / docs-antora / modules / opac / pages / visibility_on_the_web.adoc
1 = Library visibility on the Web =
2 :toc:
3
4 == Introduction ==
5
6 Evergreen follows a number of best practices to
7 make Library data integrate with the rest of the
8 Web.  Evergreen's public catalog pages are
9 designed so that search engines can easily extract
10 meaningful information about your library and
11 collections.  Evergreen is also preparing for an
12 eventual shift toward linked open bibliographic
13 data.
14
15 == Catalog data in search engines ==
16
17 Each record in the catalog is displayed to search
18 engines using http://schema.org[schema.org] microdata.
19
20 [IMPORTANT]
21 Make sure your system administrator has not added
22 a restrictive robots.txt file to your server.
23 These files restrict search engines, up to the
24 point of not allowing search engines to index your
25 site at all.
26
27 === Details of the schema.org mapping ===
28
29  * Each item is listed as a
30    http://schema.org/Offer[schema:Offer], which is
31    the same category that an online bookseller might
32    use to describe an item for sale.  These Offers
33    are always listed with a price of $0.00.
34  * Subject headings are exposed as
35    http://schema.org/about[schema:about]
36    properties.
37  * Electronic resources are assigned a
38    http://schema.org/url[schema:url]
39    property, and any notes or link text
40    are assigned a
41    http://schema.org/description[schema:description]
42    property.
43  * Given a Library of Congress relator code for
44    1xx and 7xx fields, Evergreen surfaces the URL
45    for that relator code along with the
46    http://schema.org/contributor[schema:contributor]
47    property to give machines a better chance
48    of understanding how the person or organization
49    actually contributed to this work.
50  * Linking out to related records:
51    ** Given an LCCN (010 field), Evergreen links to
52       the corresponding Library of Congress record
53       using http://schema.org/sameAs[schema:sameAs].
54    ** Given an OCLC number (035 field, subfield `a`
55       beginning with `(OCoLC)`), Evergreen links to
56       the corresponding WorldCat record using
57       http://schema.org/sameAs[schema:sameAs].
58    ** Given a URI (024 field, subfield 2 = `'uri'`),
59       Evergreen links to the corresponding OCLC
60       Work Entity record using
61       http://schema.org/exampleOfWork[schema:exampleOfWork].
62
63
64 === Viewing microdata ===
65 You can learn more about how Evergreen publicizes
66 these data by viewing them directly.  The 
67 http://linter.structured-data.org[structured data linter]
68 is a helpful tool for viewing microdata.
69
70 . Using your favorite Web browser, navigate to a
71   record in your public catalog.
72 . Copy the URL that displays in your browser's
73   address bar.
74 . Go to http://linter.structured-data.org
75 . Under the _Lint by URL_ tab, paste your URL
76   into the text box.
77 . Click _Submit_
78
79 === Other helpful features for search engines ===
80  * Titles of catalog pages follow a
81    "Page title - Library name" pattern to provide
82    specific titles in search engine results pages,
83    browser bookmarks, and browser tabs.
84  * Links that robots should not crawl, such as search
85    result links, are marked with the
86    https://support.google.com/webmasters/answer/96569?hl=en[@rel="nofollow"]
87    property.
88  * Catalog pages for record details and for library
89    descriptions express a
90    https://support.google.com/webmasters/answer/139066?hl=en[@rel="canonical"]
91    link to simplify the number of variations of page
92    URLs that could otherwise have been derived from
93    different search parameters.
94  * Catalog pages that do not exist return a proper
95    404 "HTTP_NOT_FOUND" HTTP status code, and record
96    detail pages for records that have been deleted
97    now return a proper 410 "HTTP_GONE" HTTP status code.
98  * Record detail and library pages include
99    http://ogp.me/[Open Graph Protocol] markup.
100  * Each library has its own page at
101    _http://localhost/eg/opac/library/LIBRARY_SHORTNAME_
102    that provides machine-readable hours and contact
103    information.
104
105 == SKOS support ==
106
107 Some vocabularies used (or which could be used) for
108 stock record attributes and coded value maps in Evergreen
109 are published on the web using SKOS. The record
110 attributes system can now associate Linked Data URIs
111 with specific attribute values. In particular, seed data
112 supplying URIs for the RDA Content Type, Media Type, and
113 Carrier Type has been added.
114
115 This is an experimental, "under-the-hood" feature that
116 will be built upon in subsequent releases.
117