Release notes cleanup
[working/Evergreen.git] / docs / admin_initial_setup / designing_your_catalog.txt
index 0769551..a691bcc 100644 (file)
@@ -363,8 +363,8 @@ You may also change the default number of facets appearing under each category
 by editing the _facet.default_display_count_ value in _config.tt2_. The default 
 value is 5.
 
-Including external content to you public interface
---------------------------------------------------
+Including external content in your public interface
+---------------------------------------------------
 
 The public interface allows you to include external services and content in your
 public interface. These can include book cover images, user reviews, table of
@@ -421,7 +421,7 @@ social interaction of patrons to appear in your catalog. To activate ChiliFresh,
 you will need to open the Apache configuration file _/etc/apache2/eg_vhost.conf_
 and edit several lines:
 
-. Uncoment (remove the "#" at the beginning of the line) and add your chilifresh
+. Uncomment (remove the "#" at the beginning of the line) and add your ChiliFresh
 account number:
 
 ----
@@ -434,14 +434,14 @@ account number:
 #SetEnv OILS_CHILIFRESH_PROFILE
 ----
 
-Uncomment the line indicating the location of the Evergreen javaScript for
+Uncomment the line indicating the location of the Evergreen JavaScript for
 ChiliFresh:
 
 ----
 #SetEnv OILS_CHILIFRESH_URL http://chilifresh.com/on-site /js/evergreen.js
 ----
 
-. Uncomment the line indicating the secure URL for the Evergreen javaScript :
+. Uncomment the line indicating the secure URL for the Evergreen JavaScript :
 
 ----
 #SetEnv OILS_CHILIFRESH_HTTPS_URL https://secure.chilifresh.com/on-site/js/evergreen.js
@@ -476,7 +476,7 @@ place of a book cover.
 Google Analytics
 ~~~~~~~~~~~~~~~~
 
-Google Analytics is a free service to collect statisitics for your Evergreen
+Google Analytics is a free service to collect statistics for your Evergreen
 site.  In order to use Google Analytics you will first need to set up the
 service from the Google Analytics website at http://www.google.com/analytics/.
 To activate Google Analytics you will need to edit _config.tt2_ in your
@@ -511,10 +511,10 @@ SFX OpenURL resolver
 
 An OpenURL resolver allows you to find electronic resources and pull them into
 your catalog based on the ISBN or ISSN of the item. In order to use the SFX
-OpenURL resolver, you will need to subscribe to the Ex Libirs SFX service.  To
+OpenURL resolver, you will need to subscribe to the Ex Libris SFX service.  To
 activate the service in Evergreen edit the _config.tt2_ file in your template.
 Enable the resolver by changing the value of _openurl.enabled_ to _true_ and
-change the _openurl.baseurl_ setting to point to the URL of your openURL
+change the _openurl.baseurl_ setting to point to the URL of your OpenURL
 resolver. 
 
 Syndetic Solutions
@@ -542,6 +542,58 @@ points to the Syndetic service:
 For changes to be activated for your public interface you will need to restart
 Evergreen and Apache.
 
+Sitemap generator
+-----------------
+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
+your site. In the case of Evergreen, the primary pages of interest are the
+bibliographic record detail pages.
+
+The sitemap generator script creates sitemaps that adhere to the
+http://sitemaps.org specification, including:
+
+* limiting the number of URLs per sitemap file to no more than 50,000 URLs;
+* providing the date that the bibliographic record was last edited, so
+  that once a search engine has crawled all of your sites' record detail pages,
+  it only has to reindex those pages that are new or have changed since the last
+  crawl;
+* generating a sitemap index file that points to each of the sitemap files.
+
+Running the sitemap generator
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The `sitemap_generator` script must be invoked with the following argument:
+
+* `--lib-hostname`: specifies the hostname for the catalog (for example,
+  `--lib-hostname https://catalog.example.com`); all URLs will be generated
+  appended to this hostname
+
+Therefore, the following arguments are useful for generating multiple sitemaps
+per Evergreen instance:
+
+* `--lib-shortname`: limit the list of record URLs to those which have copies
+  owned by the designated library or any of its children;
+* `--prefix`: provides a prefix for the sitemap index file names
+
+Other options enable you to override the OpenSRF configuration file and the
+database connection credentials, but the default settings are generally fine.
+
+Note that on very large Evergreen instances, sitemaps can consume hundreds of
+megabytes of disk space, so ensure that your Evergreen instance has enough room
+before running the script.
+
+Scheduling
+~~~~~~~~~~
+To enable search engines to maintain a fresh index of your bibliographic
+records, you may want to include the script in your cron jobs on a nightly or
+weekly basis.
+
+Sitemap files are generated in the same directory from which the script is
+invoked, so a cron entry will look something like:
+
+------------------------------------------------------------------------
+12 2 * * * cd /openils/var/web && /openils/bin/sitemap_generator
+------------------------------------------------------------------------
+
 Troubleshooting TPAC errors
 ---------------------------