From a6b46cb301203355a2687c2edd650af4e9eeabd6 Mon Sep 17 00:00:00 2001
From: Holger Schurig <holgerschurig@gmx.de>
Date: Fri, 26 Jun 2009 12:12:05 +0200
Subject: [PATCH] doc: more documentation about plugin/google_sitemap.py

---
 in/pageformat.md             | 32 ++++++++++++++++++++++++++++++++
 in/plugins/google_sitemap.md | 22 +++++++++++++++++++++-
 2 files changed, 53 insertions(+), 1 deletion(-)

diff --git a/in/pageformat.md b/in/pageformat.md
index c244f89..67ada75 100644
--- a/in/pageformat.md
+++ b/in/pageformat.md
@@ -129,3 +129,35 @@ Anything you specify here will be accessible in the template as ${keywords}.
 You can use this for HTML meta information, see [[template_make]].
 
 If you don't specify a description, then ${keywords} will be the empty string.
+
+
+== main_url ==
+
+Used by [[google_sitemap]]:
+
+Internally, [[Webber]] works with relative URLs and is quite agonistic about
+the final website. However, the [[google_sitemap]] plugin needs absolute URLs,
+complete with host name. So we need this configuration ...
+
+Used by [[google_sitemap]]:
+
+
+== sitemap_priority ==
+
+Used by [[google_sitemap]] to specify a relative important-ness of a page.
+Should be between "`0.0`" and "`1.0`" (including).
+
+
+== sitemap_changefreq ==
+
+Used by [[google_sitemap]] as an estimate about how often a page might change.
+
+Should be one of the following values:
+
+* always
+* hourly
+* daily
+* weekly
+* monthly
+* yearly
+* never
diff --git a/in/plugins/google_sitemap.md b/in/plugins/google_sitemap.md
index 913ec2e..6d49b86 100644
--- a/in/plugins/google_sitemap.md
+++ b/in/plugins/google_sitemap.md
@@ -5,7 +5,7 @@ keywords: Google, XML, Sitemap generator
 ctime: 2009-06-26
 
 This plugins write an XML "`sitemap.xml`" file into the out-directory. The
-format is documented at [[http://www.sitemaps.org|http://www.sitemaps.org]].
+format is documented at [[http://www.sitemaps.org]].
 
 
 = Configuration =
@@ -36,3 +36,23 @@ You can define an relative page importance on each page by specifying
 this keyword at the header of each [[page|Page format]]. However, the
 "`sitemap_priority`" from the configuration file will be used as a
 default.
+
+
+= robots.txt =
+
+Please note that you'll also specify the sitemap in your "`robots.txt`" file,
+e.g.:
+
+	User-agent: *
+	Disallow: /logs/
+	Sitemap: http://www.holgerschurig.de/sitemap.xml
+
+Also make sure that your "`robots.txt`" file get's copied, by adding
+
+	copy_files: [
+		...
+		"robots.txt",
+		...
+	]
+
+to "`webber.conf`".
-- 
2.39.2