forked from astashov/page_versioning
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
70 lines (48 loc) · 2.91 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
WARNING!!! For the RadiantCMS < v0.7.0 please use 0.6.9 tag, for the RadiantCMS v0.7.x use 0.7 tag.
== Page Versioning
This extension creates versioning for pages, snippets and layouts.
== Features:
* All revisions are saved in separate tables, without affecting the 'pages',
'layouts' and 'snippets' tables.
* Pages save their state with page parts.
* You can set the fields you want to version in a config file.
(vendor/extensions/page_versioning/config/config.yml)
== Installation
(from the radiant application root)
git clone git://github.com/astashov/page_versioning.git vendor/extensions/page_versioning
rake RAILS_ENV=production db:migrate:extensions
== Configuration
When you update any of the fields on Pages, Layouts or Snippets, they will create a new
revision.
This behavior can be configured in vendor/extensions/page_versioning/config/config.yml
There are two types of settings:
1. something_attributes - if user changes this attribute, new revision will be
created
2. something_specific_attributes - these attributes will not be replaced by
revisioned attributes after initializing
== Using the extension
To enable versioning you should install the plugin. Then, when you add changes to a Page, Snippet or Layout,
there will be 3 additional controls:
1. Revision select box - you can change revision you want to see.
2. Published revision select box - you can set what revision you want to use as
published. Published revision will be shown to visitors. You can set publish
new revision by default or not in vendor/extensions/page_versioning/config/config.yml
3. Preview button - if you want to look at changes, but don't want to publish
them, you can press the Preview button. A new revision will be created, and you will
be redirected to the homepage where you can see your changes, but this revision will not
be published and visitors will not see your changes.
On the Snippet Edit Page or Layout Edit Page, you can see the Preview button with its select box. To preview a
snippet, the snippet should be inserted in a Layout or Page Part. With the select box
you can select a page or layout and preview changes of that snippet in the selected page/layout.
The same goes for layouts -- you can preview the changes by specifying the page to use for viewing.
== Screenshots
Here you can see screenshot of the plugin: http://astashov.net/images/radiant_page_versioning.png
== Additional info
Sometimes you might need to disable the after_initialize hook, which changes attributes
to attributes of published revision. You can do this by setting a flag
PageVersioning.enable_versioning = false (default is false for testing environment,
others are true).
== Bugreporting
Please, post bugs on Github Issues tracker: http://github.com/astashov/page_versioning/issues
== Authors and Credits
Written by Anton Astashov, with Brenton Cheng, for Astrology.com (a division of iVillage Inc.)