SF Patch #1591871 Docs for google and html sitemaps

git-svn-id: http://scm.dspace.org/svn/repo/trunk@2170 9c30dcfa-912a-0410-8fc2-9e0234be79fd

dspace-api/src/main/java/org/dspace/app/sitemap/GenerateSitemaps.java

@@ -188,7 +188,10 @@ public class GenerateSitemaps
 
         File outputDir = new File(ConfigurationManager
                 .getProperty("dspace.dir"), "sitemaps");
-
+        if (!outputDir.exists()) {
+        	outputDir.mkdir();
+        }
+        
         AbstractGenerator html = null;
         AbstractGenerator sitemapsOrg = null;
 

dspace/CHANGES

@@ -58,10 +58,14 @@
 (Stuart Lewis)
 - SF Patch #1737792 Patch for bug 1552760 - Submit interface looks bad in Safari
 - Removal of message for Netscape users in choose-file.jsp + removal of supporting text and images in the help file
+- SF Patch #1591871 Docs for google and html sitemaps
 
 (Chris yates)
 - SF Patch #1724330 Removes "null" being displayed in community-home.jsp
 
+(Robert Tansley / Stuart Lewis)
+- SF Patch #1587225 Google and html sitemap generator
+
 1.4.2 beta
 ===========
 
@@ -111,7 +115,6 @@
 (Stuart Lewis)
 - SF Patch #1670110 for SF Bug #1670106 Onebox and textarea fail when visibility set to workflow
 - SF Patch #1628889 Improve file size descriptions in ItemTag
-- SF Patch #1587225 Google and html sitemap generator
 - SF Patch #1641678 [dspace]/bin scripts for import and export
 - SF Patch #1642336 Restrict domains of self-registered users
 

dspace/bin/generate-sitemaps

@@ -47,5 +47,5 @@
 # Get the DSPACE/bin directory
 BINDIR=`dirname $0`
 
-echo "Generating HTML sitemaps"
+echo "Generating sitemaps"
 $BINDIR/dsrun org.dspace.app.sitemap.GenerateSitemaps $@

dspace/docs/install.html

@@ -528,6 +528,39 @@ $JAVA_HOME/bin/keytool -genkey -alias tomcat -keyalg RSA -keysize 1024 \
 
 	<p>will change any handles currently assigned prefix 123456789 to prefix 1303, so for example handle 123456789/23 will be updated to 1303/23 in the database.</p>
 
+	<h3><a NAME="sitemaps">Google and HTML sitemaps</a></h3>
+
+    <p>To aid web crawlers index the content within your repository, you can make use of sitemaps. There are currently two forms of sitemaps included in DSpace; Google sitemaps and HTML sitemaps.</p>
+
+    <p>Sitemaps allow DSpace to expose it's content without the crawlers having to index every page. HTML sitemaps provide a list of all items, collections and communities in HTML format, whilst Google sitemaps provide the same information in gzipped XML format.</p>
+
+    <p>To generate the sitemaps, you need to run <code>[dspace]/bin/generate-sitemaps</code> This creates the sitemaps in <code>[dspace]/sitemaps/</code></p>
+
+    <p>The sitemaps can be accessed from the following URLs:
+
+    <ul>
+    	<li>http://dspace.example.com/dspace/sitemap - Index sitemap</li>
+    	<li>http://dspace.example.com/dspace/sitemap?map=0 - First list of items (up to 50,000)</li>
+    	<li>http://dspace.example.com/dspace/sitemap?map=n - Subsequent lists of items (e.g. 50,0001 to 100,000) etc...</li>
+    </ul>
+
+    HTML sitemaps follow the same procedure:
+
+    <ul>
+    	<li>http://dspace.example.com/dspace/htmlmap - Index sitemap</li>
+    	<li>etc...</li>
+    </ul>
+
+    </p>
+
+    <p>When running <code>[dspace]/bin/generate-sitemaps</code> the script informs Google that the sitemaps have been updated. For this update to register correctly, you must first register your Google sitemap index page (<code>/dspace/sitemap</code>) with Google at <a href="http://www.google.com/webmasters/sitemaps/">http://www.google.com/webmasters/sitemaps/</a>. If your DSpace server requires the use of a HTTP proxy to connect to the Internet, ensure that you have set <code>http.proxy.host</code> and <code>http.proxy.port</code> in <code>[dspace]/config/dspace.cfg</code></p>
+	
+	<p>The URL for pinging Google, and in future, other search engines, is configured in <code>[dspace]/config/dspace.cfg</code> using the <code>sitemap.engineurls</code> setting where you can provide a comma-separated list of URLs to 'ping'.
+
+    <p>You can generate the sitemaps automatically every day using an additional cron job:</p>
+
+    <pre># Generate sitemaps<br />0 6 * * * [dspace]/bin/generate-sitemaps
+	</pre>
 
 	<h2><a name="windows">Windows Installation</a></h2>