tonyair
/
silverstripe-versionfeed
mirror of https://github.com/silverstripe/silverstripe-versionfeed
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #33 from mandrew/master 

Moved user docs into userguide folder to display on userhelp site
This commit is contained in:
Damian Mooyman 2015-12-21 14:25:00 +13:00
parent a71b15a437 0426a38412
commit 83947f03d2
3 changed files with 33 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -22,7 +22,7 @@ Or just clone/download the git repository into a subfolder (usually called "vers
## Usage
For usage instructions see [user manual](docs/en/user.md).
For usage instructions see [user manual](docs/en/userguide/index.md).
## Contributing

29
docs/en/user.md
View File

@ -1,29 +0,0 @@
# 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.
The allchanges feed can also be disabled by unchecking the "All page changes" checkbox in the "Settings"
section in the cms.
#### 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.

32
docs/en/userguide/index.md Normal file
View File

@ -0,0 +1,32 @@
title: Content change RSS
summary: Adds page or site wide RSS feeds that display content changes
# Content change RSS
## In this section:
* Accessing RSS feeds
* Enabling and disabling via the CMS
## Before we begin
Make sure that your SilverStripe installation has the [versionfeed](http://addons.silverstripe.org/add-ons/silverstripe/versionfeed) module installed.
## 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.
The allchanges feed can also be disabled by unchecking the "All page changes" checkbox in the "Settings" section in the cms.
### 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.