|
1
|
Diff module - http://drupal.org/project/diff
|
|
2
|
============================================
|
|
3
|
|
|
4
|
Diff enhances usage of node revisions by adding the following features:
|
|
5
|
|
|
6
|
- Diff between node revisions on the 'Revisions' tab to view all the changes
|
|
7
|
between any two revisions of a node.
|
|
8
|
- Highlight changes inline while viewing a node to quickly see color-coded
|
|
9
|
additions, changes, and deletions.
|
|
10
|
- Preview changes as a diff before updating a node.
|
|
11
|
|
|
12
|
It is also an API to compare any entities although this functionality is not
|
|
13
|
exposed by the core Diff module.
|
|
14
|
|
|
15
|
REQUIREMENTS
|
|
16
|
------------
|
|
17
|
Drupal 7.x
|
|
18
|
|
|
19
|
INSTALLATION
|
|
20
|
------------
|
|
21
|
1. Place the Diff module into your modules directory.
|
|
22
|
This is normally the "sites/all/modules" directory.
|
|
23
|
|
|
24
|
2. Go to admin/build/modules. Enable the module.
|
|
25
|
The Diff modules is found in the Other section.
|
|
26
|
|
|
27
|
Read more about installing modules at http://drupal.org/node/70151
|
|
28
|
|
|
29
|
See the configuration section below.
|
|
30
|
|
|
31
|
UPGRADING
|
|
32
|
---------
|
|
33
|
Any updates should be automatic. Just remember to run update.php!
|
|
34
|
|
|
35
|
CONFIGURATION
|
|
36
|
-------------
|
|
37
|
|
|
38
|
Unlike the earlier version, the module now has a lot of configurable settings.
|
|
39
|
|
|
40
|
Global settings can be found under Configuration > Content > Diff
|
|
41
|
|
|
42
|
i.e. http://www.example.com/admin/config/content/diff
|
|
43
|
|
|
44
|
Entity specific settings would be listed under the entities settings. This
|
|
45
|
module only handles Node revisioning functionality, and these are detailed
|
|
46
|
below.
|
|
47
|
|
|
48
|
1) Node revisioning settings
|
|
49
|
|
|
50
|
Diff needs to be configured to be used with specific node types on your site.
|
|
51
|
To enable any of Diff's options on a content type's settings page.
|
|
52
|
|
|
53
|
e.g. http://www.example.com/admin/structure/types/manage/page
|
|
54
|
|
|
55
|
a) Diff options
|
|
56
|
|
|
57
|
Under "Compare revisions", enable the settings that you want;
|
|
58
|
|
|
59
|
i) "Show View changes button on node edit form" adds a new "Preview" like
|
|
60
|
submit button to node editing pages. This shows a diff preview.
|
|
61
|
|
|
62
|
This can be conditionally restricted per role using the user permission
|
|
63
|
"Access View changes button".
|
|
64
|
|
|
65
|
ii) "Enable the Revisions page for this content type" adds the revisioning
|
|
66
|
tab to content. This allows users to compare between various revisions
|
|
67
|
that they have access to.
|
|
68
|
|
|
69
|
iii) "Standard comparison preview" option allows you to control how the most
|
|
70
|
current revision is shown on the revision comparison page.
|
|
71
|
|
|
72
|
b) Publishing options
|
|
73
|
|
|
74
|
It is strongly advised that you also enable the automatic creation of
|
|
75
|
revisions on any content types you want to use this with. If you do not do
|
|
76
|
this, chances are there will be limited revisioning information available to
|
|
77
|
compare.
|
|
78
|
|
|
79
|
Under "Publishing options", enable "Create new revision".
|
|
80
|
|
|
81
|
2) Field revisioning settings
|
|
82
|
|
|
83
|
Global settings per field type can be found here:
|
|
84
|
|
|
85
|
http://www.example.com/admin/config/content/diff/fields
|
|
86
|
|
|
87
|
"Show field title" toggles field title visibility on the comparison page.
|
|
88
|
|
|
89
|
"Markdown callback" is the callback used to render the field when viewing the
|
|
90
|
page in the "Marked down" page view.
|
|
91
|
|
|
92
|
"Line counter" is an optional. This shows the approximate line number where
|
|
93
|
the change occurred. This is an approximate counter only.
|
|
94
|
|
|
95
|
Other fields add additional settings here.
|
|
96
|
|
|
97
|
3) Entity revisioning settings
|
|
98
|
|
|
99
|
Global configurable settings limited to node entities.
|
|
100
|
|
|
101
|
a) Show entity label header
|
|
102
|
|
|
103
|
This provides a field like title for the entity label field.
|
|
104
|
|
|
105
|
i.e. For nodes, this provides a header for the node's title.
|
|
106
|
|
|
107
|
b) Treat diff pages as administrative
|
|
108
|
|
|
109
|
By default, the revisioning pages are administrative, i.e. they will use the
|
|
110
|
administration theme. You can block this by unchecking this option.
|
|
111
|
|
|
112
|
4) Global settings
|
|
113
|
|
|
114
|
A small number of new features have been added to the 7.x-3.x branch, these
|
|
115
|
include the ability to change the leading and trailing lines in the comparison,
|
|
116
|
a new CSS theme for the diff pages, new JScript options for the revisioning
|
|
117
|
selection form and options to help prevent cross operating systems in relation
|
|
118
|
to line endings.
|
|
119
|
|
|
120
|
http://www.example.com/admin/config/content/diff
|
|
121
|
|
|
122
|
Technical
|
|
123
|
---------
|
|
124
|
- Diff compares the raw data, not the filtered output, making it easier to see
|
|
125
|
changes to HTML entities, etc.
|
|
126
|
- The diff engine itself is a GPL'ed php diff engine from phpwiki.
|
|
127
|
|
|
128
|
API
|
|
129
|
---
|
|
130
|
See diff.api.php
|
|
131
|
|
|
132
|
Maintainers
|
|
133
|
-----------
|
|
134
|
- realityloop (Brian Gilbert)
|
|
135
|
- Alan D. (Alan Davison)
|
|
136
|
- dww (Derek Wright)
|
|
137
|
- moshe (Moshe Weitzman)
|
|
138
|
- rötzi (Julian)
|
|
139
|
- yhahn (Young Hahn)
|
