XML Sitemap Creation Script
---------------------------

Contents
--------

1. Overview
2. System Requirements
3. Installation
4. Developers
5. Copyright


1. Overview
-----------

Creates sitemaps.org compliant sitemap XML files, sitemap.xml and
sitemap-abstracts.xml.gz, in the static file configuration directory
of an archive.

The abstracts file contains an entry for every eprint in the live
archive. The loc element contains the path of the abstract page and
the last modified date reflects the actual date modified of the
eprints. The changefreq is hardcoded as 'yearly' and priority as
'1.0'.

Implementing this automatic sitemap will prevent access to EPrints'
in-built sitemap, which conforms to Semantic Web Crawling: A Sitemap
Extension http://sw.deri.org/2007/07/sitemapextension/.


2. System Requirements
----------------------

This was developed for EPrints 3.2. It looks like it should work in
EPrints 3.3 but it hasn't been tested.


3. Installation
---------------

1. Copy create_sitemap to eprints/bin

2. Run $ eprints/bin/create_sitemap <repository_id>

Optional Step 1. Add step 2 to crontab such that the sitemap is
updated on a nightly or weekly basis.

Optional Step 2. Patch EPrints::Apache::SiteMap using SiteMap.patch so
that the in-built semantic web crawling sitemap can still be accessed.


4. Developers
-------------

Created by Dr Nicholas Sheppard, 2011.
Revisions by Mark Gregson, 2011, 2012.


5. Copyright
------------

Copyright (c) 2011 Queensland University of Technology, Queensland, Australia

The plug-ins are free software; you can redistribute them and/or modify
them under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

The plug-ins are distributed in the hope that they will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.