This repository has been archived by the owner on Nov 28, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
/
readme.txt
244 lines (152 loc) · 9.99 KB
/
readme.txt
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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
=== CommentPress Plugin ===
Contributors: needle, commentpress
Author URI: http://www.haystack.co.uk
Plugin URI: http://www.futureofthebook.org/commentpress
Donate link: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PZSKM8T5ZP3SC
Tags: commentpress, buddypress, groups, blogs, groupblogs, content, comments, commenting, debate, collaboration
Requires at least: 3.3
Tested up to: 3.4.2
Stable tag: 3.4
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
CommentPress Core allows fine-grained commenting in the margins of a text. Use it to annotate, workshop or debate a social text in a social context.
== Description ==
CommentPress Core is an open source theme and plugin for WordPress that allows readers to comment paragraph-by-paragraph, line-by-line or block-by-block in the margins of a text.
Annotate, gloss, workshop, debate: with CommentPress Core you can do all of these things on a finer-grained level, turning a document into a conversation. It can be applied to a fixed document (paper/essay/book etc.) or to a running blog. Use it in combination with BuddyPress and Groupblogs to create communities around your documents.
**Please note:** this plugin comes bundled with the official CommentPress Default Theme which will be auto-activated when the plugin is activated. If you are upgrading from a previous version of CommentPress, please follow the instructions in the Installation section before doing so.
**For sites hosted in the European Union, please note:** CommentPress makes use of cookies, but for presentational purposes only. If you intend to use CommentPress on a public site, you may need to inform visitors of this.
The name has been changed from CommentPress to CommentPress Core for two reasons: because it serves as the basis for extending it for your purposes and also to safeguard historical installations, which could break if they upgrade. Newer CommentPress installations (version 3.0 onwards) can upgrade to the current version.
For further information and instructions please see the [CommentPress site](http://www.futureofthebook.org/commentpress/) or contact the developers by email at [[email protected]](mailto:[email protected])
== Installation ==
You can download and install CommentPress Core using the built in WordPress plugin installer. If you download CommentPress Core manually, make sure it is uploaded to "/wp-content/plugins/commentpress-core/".
<h4>Install CommentPress Core in WordPress Standalone</h4>
Base Install:
1. Install WordPress
2. Install "CommentPress Core"
3. Activate "CommentPress Core"
Your basic "CommentPress Core" setup is complete. At this point you can:
1. Create a custom menu for the main site
2. Use the Theme Customizer to modify the look
3. Change Background and Header
4. Customise "CommentPress Core" via its Settings Page
<h4>Install CommentPress Core in WordPress Multisite</h4>
Base Install:
1. Install WordPress
2. Create Network
Okay, we're ready to install "CommentPress Core":
1. Install and Network Activate "CommentPress Core"
2. This should have enabled "CommentPress Core" on your main blog
3. Network Enable the "CommentPress Default Theme" UNLESS
4. You have "CommentPress Core"-compatible child themes you want to use instead:
5. Network Enable any "CommentPress Core"-compatible child themes you want to use
Go to the "CommentPress" network settings page under "Settings" in "Network Admin":
1. Configure your options as desired
2. Click "Save Changes"
Your basic "CommentPress Core" setup is complete. At this point you can:
1. Create a custom menu for the main site
2. Use the Theme Customizer to modify the look
3. Change Background and Header
4. Customise "CommentPress Core" via its Settings Page
<h4>Install CommentPress Core with BuddyPress Groupblogs</h4>
Base Install:
1. Install WordPress
2. Create Network
Essential Plugins:
1. Install, Network Activate and configure "BuddyPress"
2. Download and Network Activate my fork of "BuddyPress Groupblog" on GitHub (which fixes a number of bugs) from https://github.com/christianwach/bp-groupblog
3. If you can't do this, Install and Network Activate "BuddyPress Groupblog" 1.8+
4. Install and DO NOT Network Activate "BuddyPress Template Pack"
Optional Plugins:
1. Network Install "BuddyPress Group Email Subscription"
2. Network Install "Invite Anyone"
3. Network Install "My Page Order"
4. Network Install "Co-Authors Plus"
5. Network Install "Simple Footnotes" (recommended), "FD Footnotes" or "WP-Footnotes"
Okay, we're ready to install "CommentPress Core":
1. Install and Network Activate "CommentPress Core"
2. This should have enabled "CommentPress Core" on your main blog
3. Network Enable the "CommentPress Default Theme" UNLESS
4. You have "CommentPress Core"-compatible child themes you want to use instead:
5. Network Enable any "CommentPress Core"-compatible child themes you want to use
Go to your main blog's Dashboard:
1. Activate "BuddyPress Template Pack"
2. Go to the "BP Compatibility" page
3. Click "Finish"
4. Tick "Disable BP Template Pack CSS"
5. Click "Save Settings"
6. Optionally, activate your chosen "CommentPress Core"-compatible child theme
Go to your "Groupblog Setup" page under "Settings" in "Network Admin":
1. Select your desired "BuddyPress Groupblog" theme as your default "BuddyPress Groupblog" theme
2. Click "Save Changes"
3. Click the "Redirect" header
4. Set "Redirect Enabled to:" to "Home Page"
5. Click "Save Changes"
Go to the "CommentPress" network settings page under "Settings" in "Network Admin":
1. Select your desired "CommentPress Groupblog" theme. This will be applied to group blogs that are "CommentPress Core"-enabled
2. Configure other options as desired
3. Click "Save Changes"
Your basic "CommentPress Groupblogs" setup is complete. At this point you can:
1. Create a custom menu for the main site
2. Use the Theme Customizer to modify the look
3. Change Background and Header
4. Customise "CommentPress Core" via its Settings Page
To create a "CommentPress Core"-enabled Groupblog:
1. Begin to create a group as usual
2. At the "Groupblog" screen, click "Enable CommentPress"
3. Choose any further options
4. It is recommended that you "Enable member blog posting" with the default settings
5. Continue and finish creating the group
6. To go to the groupblog, click "Blog" (or "Workshop" if you have chosen that naming scheme)
7. Start your group blogging!
== Other Notes ==
Upgrades from previous versions of CommentPress are possible. Please follow the following procedures for your context.
<h4>Upgrade to CommentPress Core</h4>
It is recommended that you upgrade to the latest versions of WordPress as well as the latest versions of the old "Commentpress" plugins and theme before upgrading to "CommentPress Core", but "CommentPress Core" will do its best if this is not possible. A minimum of WordPress 3.3 is required, but upgrades under WordPress 3.4+ work much better. The old "Commentpress" plugins and theme can be found on Github:
1. Get the latest [Commentpress Plugin](https://github.com/IFBook/CommentPressPlugin)
2. Get the latest [Commentpress for Multisite](https://github.com/IFBook/CommentPressMultisite)
3. Get the latest [Commentpress Ajaxified](https://github.com/IFBook/CommentPressAjaxified)
4. Get the latest [Commentpress Theme](https://github.com/IFBook/CommentPressTheme)
<h4>Upgrade to CommentPress Core in WordPress Standalone</h4>
1. Activate "CommentPress Core" plugin
2. "CommentPress Core" will try and deactivate the "Commentpress Ajaxified" plugin. Deactivate it if it is still active.
3. "CommentPress Core" will try and deactivate the "Commentpress" plugin. Deactivate it if it is still active.
4. Delete "Commentpress Ajaxified" plugin
5. Delete "Commentpress" plugin
<h4>Upgrade to CommentPress Core in WordPress Multisite (NOT network-activated)</h4>
On each site:
1. Activate "CommentPress Core" plugin
2. "CommentPress Core" will try and deactivate the "Commentpress Ajaxified" plugin. Deactivate it if it is still active.
3. "CommentPress Core" will try and deactivate the "Commentpress" plugin. Deactivate it if it is still active.
When EVERY site has done this, go to Network Admin -> Plugins:
1. Delete "Commentpress Ajaxified" plugin
2. Delete "Commentpress" plugin
<h4>Upgrade to CommentPress Core (network-activated OR with BuddyPress Groupblogs)</h4>
To upgrade to CommentPress Core.
1. Install, but DO NOT activate OR network-activate CommentPress Core.
2. Network Deactivate "Commentpress for Multisite Extras", if present
3. Network Deactivate "Commentpress for Multisite"
4. Network Disable all old "Commentpress" child themes
5. Now Network Activate "CommentPress Core"
"CommentPress Core" will now be active on your main site.
On each site:
1. Activate "CommentPress Core" plugin
2. "CommentPress Core" will try and deactivate the "Commentpress Ajaxified" plugin. Deactivate it if it is still active.
3. "CommentPress Core" will try and deactivate the "Commentpress" plugin. Deactivate it if it is still active.
When EVERY site has done this, go to "Network Admin" -> "Plugins":
1. Delete "Commentpress Ajaxified" plugin
2. Delete "Commentpress" plugin (NOT "CommentPress Core"!)
3. Delete "Commentpress for Multisite Extras", if present
4. Delete "Commentpress for Multisite"
== Changelog ==
<h4>3.4</h4>
The plugins and theme have been merged.
* See the [commits on GitHub](https://github.com/IFBook/commentpress-core/commits/master)
<h4>Merging 3.3.6 to 3.4</h4>
The merging process for the plugins and theme.
* See the [commits on GitHub](https://github.com/IFBook/commentpress/commits/master)
<h4>Up to 3.3.6</h4>
Up to this version, CommentPress was a separate plugin and theme.
* See the [plugin commits on GitHub](https://github.com/IFBook/CommentPressPlugin/commits/master)
* See the [theme commits on GitHub](https://github.com/IFBook/CommentPressTheme/commits/master)
* See the [ajax plugin commits on GitHub](https://github.com/IFBook/CommentPressAjaxified/commits/master)
* See the [multisite plugin commits on GitHub](https://github.com/IFBook/CommentPressMultisite/commits/master)