From 67fc92c361017e2c418c28918458d6ae40cc2b36 Mon Sep 17 00:00:00 2001
From: Robert Curry <robert@silverstripe.com>
Date: Fri, 8 Mar 2013 14:28:33 +1300
Subject: [PATCH] Add more documentation

---
 README.md              |  8 +-------
 docs/_manifest_exclude |  0
 docs/en/developer.md   | 23 +++++++++++++++++++++++
 docs/en/user.md        | 26 ++++++++++++++++++++++++++
 4 files changed, 50 insertions(+), 7 deletions(-)
 create mode 100644 docs/_manifest_exclude
 create mode 100644 docs/en/developer.md
 create mode 100644 docs/en/user.md

diff --git a/README.md b/README.md
index c5f0de5..2c146d3 100644
--- a/README.md
+++ b/README.md
@@ -20,10 +20,4 @@ Or just clone/download the git repository into a subfolder (usually called "vers
 
 ## Usage
 
-### Accessing RSS feeds
-
-The extensions will automatically add links to the RSS feeds, accessible by the actions 'changes' and 'allchanges'. You will encounter problems if you have functions called the same name on any controller.
-
-### Enabling / disabling
-
-You can enable or disable the feed on a per-page basis by interacting with the checkbox on the Settings tab of each page.
\ No newline at end of file
+For usage instructions see [user manual](docs/en/user.md).
\ No newline at end of file
diff --git a/docs/_manifest_exclude b/docs/_manifest_exclude
new file mode 100644
index 0000000..e69de29
diff --git a/docs/en/developer.md b/docs/en/developer.md
new file mode 100644
index 0000000..f046ea1
--- /dev/null
+++ b/docs/en/developer.md
@@ -0,0 +1,23 @@
+# Version Feed
+
+## Development
+
+### Feed actions
+
+Creating functions called `changes` or `allchanges` on any of your page types or controllers will cause confusion with
+the extensions defined on the extension.
+
+### Default RSS action
+
+Templates can offer a "Subscribe" link with a link to the most relevant RSS feed. This will default to the changes feed
+for the current page. You can override this behaviour by defining the `getDefaultRSSLink` function in your page type
+and returning the URL of your desired RSS feed:
+
+	:::php
+	class MyPage extends Page {
+		function getDefaultRSSLink() {
+			return $this->Link('myrssfeed');
+		}
+	}
+
+This can be used in templates as `$DefaultRSSLink`.
diff --git a/docs/en/user.md b/docs/en/user.md
new file mode 100644
index 0000000..2331f4d
--- /dev/null
+++ b/docs/en/user.md
@@ -0,0 +1,26 @@
+# Version Feed
+
+## Usage
+
+### Accessing RSS feeds
+
+There are two feeds that are automatically created for each page:
+
+ - Page changes: This feed will display all published versions of the page, highlighting any additions or deletions
+ with underscores or strikethroughs. It is accessible with the `changes` action - so `http://mysite.com/mypage/changes`
+ - Site changes: This will aggregate all the per-page change feeds into one feed and display the most recent 20. It is
+ accessible from any page with the `allchanges` action - so `http://mysite.com/home/allchanges`
+
+### Enabling / disabling
+
+You can enable or disable the feed on a per-page basis by checking or unchecking the *Public History* checkbox in the
+Settings tab of each page. If a page has the Public History option, unchecked, it will not appear in the allchanges
+feed.
+
+#### Privacy
+
+A page's history will be completely visible when it has public history enabled, even if some updates were made when it
+was restricted to only being viewed by authenticated users. So if a page has ever had confidential data on it, it is
+best to not enable this feature unless the data has entered the public domain.
+
+There is a warning explaining this fact next to the *Public History* checkbox.