Add more documentation

This commit is contained in:
Robert Curry 2013-03-08 14:28:33 +13:00
parent 0353f72e5e
commit 67fc92c361
4 changed files with 50 additions and 7 deletions

View File

@ -20,10 +20,4 @@ Or just clone/download the git repository into a subfolder (usually called "vers
## Usage ## Usage
### Accessing RSS feeds For usage instructions see [user manual](docs/en/user.md).
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.

0
docs/_manifest_exclude Normal file
View File

23
docs/en/developer.md Normal file
View File

@ -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`.

26
docs/en/user.md Normal file
View File

@ -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.