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