|
| 1 | +CommentPress Core |
| 2 | +================= |
| 3 | + |
| 4 | +**Please note:** this is the development repository for *CommentPress Core*. It can be found in [the WordPress Plugin Directory](http://wordpress.org/plugins/commentpress-core/), which is the best place to get it from if you're not a developer. |
| 5 | + |
| 6 | +*CommentPress Core* is an open source theme and plugin for WordPress that allows readers to comment in the margins of a text. Readers may comment paragraph-by-paragraph, line-by-line, block-by-block or by selecting text. |
| 7 | + |
| 8 | +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 *BuddyPress Groupblog* to create communities around your documents. |
| 9 | + |
| 10 | +**Please note:** this plugin comes bundled with three official themes, one of which must be active for *CommentPress Core* to function. The *CommentPress Modern Theme* will be auto-activated when the plugin is first activated. The old *CommentPress Default Theme* is still included for those who wish to stay with it or have built their own child themes for it. Since version 3.9 a new "CommentPress Flat Theme" is included for those who want an alternative layout. If you are upgrading from a previous version of *CommentPress* (3.0.x - 3.3.x), please follow the instructions in the Installation section before doing so. |
| 11 | + |
| 12 | +**For sites hosted in the European Union, please note:** the *CommentPress Default Theme* makes use of cookies, but for presentational purposes only. If you intend to use the *CommentPress Default Theme* on a public site, you may need to inform visitors of this. |
| 13 | + |
| 14 | +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]) |
| 15 | + |
| 16 | +Many thanks to the following for translations: |
| 17 | + |
| 18 | +* French - [Pouhiou](http://wordpress.org/support/profile/pouhiou) |
| 19 | +* Spanish - Andrew Kurtis from [WebHostingHub](http://www.webhostinghub.com/) |
| 20 | +* Dutch - Gerrit Jan Dijkgraaf |
| 21 | +* German - Chris Witte |
| 22 | + |
| 23 | + |
| 24 | +--- |
| 25 | + |
| 26 | +## Installation ## |
| 27 | + |
| 28 | +### GitHub ### |
| 29 | + |
| 30 | +There are two ways to install from GitHub: |
| 31 | + |
| 32 | +#### ZIP Download #### |
| 33 | + |
| 34 | +If you have downloaded *CommentPress Core* as a ZIP file from the GitHub repository, do the following to install and activate the plugin and theme: |
| 35 | + |
| 36 | +1. Unzip the .zip file and, if needed, rename the enclosing folder so that the plugin's files are located directly inside `/wp-content/plugins/commentpress-core` |
| 37 | +2. Activate the plugin |
| 38 | +3. Follow the setup instructions for your context below |
| 39 | +4. You are done! |
| 40 | + |
| 41 | +#### git clone #### |
| 42 | + |
| 43 | +If you have cloned the code from GitHub, it is assumed that you know what you're doing. |
| 44 | + |
| 45 | +### WordPress Plugin Repository ### |
| 46 | + |
| 47 | +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 so that the plugin directory is `/wp-content/plugins/commentpress-core`. |
| 48 | + |
| 49 | +The following are full instructions for setting up *CommentPress Core* in the contexts in which it works: |
| 50 | + |
| 51 | + |
| 52 | +#### Install *CommentPress Core* in WordPress Standalone #### |
| 53 | + |
| 54 | +Base Install: |
| 55 | + |
| 56 | +1. Install WordPress |
| 57 | +2. Install *CommentPress Core* |
| 58 | +3. Activate *CommentPress Core* |
| 59 | + |
| 60 | +Your basic *CommentPress Core* setup is complete. At this point you can: |
| 61 | + |
| 62 | +1. Create a custom menu for the main site |
| 63 | +2. Use the Theme Customizer to modify the look |
| 64 | +3. Change Background and Header |
| 65 | +4. Customise *CommentPress Core* via its Settings Page |
| 66 | + |
| 67 | + |
| 68 | +#### Install *CommentPress Core* in WordPress Multisite #### |
| 69 | + |
| 70 | +Base Install: |
| 71 | + |
| 72 | +1. Install WordPress |
| 73 | +2. Create Network |
| 74 | + |
| 75 | +Okay, we're ready to install *CommentPress Core*: |
| 76 | + |
| 77 | +1. Install and Network Activate *CommentPress Core* |
| 78 | +2. If you want to, you can enable *CommentPress Core* on your main blog |
| 79 | +3. Network Enable the *CommentPress Modern Theme* and/or the *CommentPress Default Theme* UNLESS |
| 80 | +4. You have *CommentPress Core*-compatible child themes you want to use instead: |
| 81 | +5. Network Enable any *CommentPress Core*-compatible child themes you want to use |
| 82 | + |
| 83 | +Go to the "CommentPress" network settings page under "Network Admin" -> "Settings": |
| 84 | + |
| 85 | +1. Configure your options as desired |
| 86 | +2. Click "Save Changes" |
| 87 | + |
| 88 | +Your basic *CommentPress Core* setup is complete. At this point you can: |
| 89 | + |
| 90 | +1. Create a custom menu for the main site |
| 91 | +2. Use the Theme Customizer to modify the look |
| 92 | +3. Change Background and Header |
| 93 | +4. Customise *CommentPress Core* via its Settings Page |
| 94 | + |
| 95 | + |
| 96 | +#### Install *CommentPress Core* with *BuddyPress Groupblogs* #### |
| 97 | + |
| 98 | +Base Install: |
| 99 | + |
| 100 | +1. Install WordPress |
| 101 | +2. Create Network |
| 102 | + |
| 103 | +Essential Plugins: |
| 104 | + |
| 105 | +1. Install, Network Activate and configure *BuddyPress* (**Please note:** *CommentPress Core* has not been tested with the Forums component) |
| 106 | +2. Download and Network Activate the latest version of *BuddyPress Groupblog* greater than 1.8.3 |
| 107 | + |
| 108 | +Optional Plugins: |
| 109 | + |
| 110 | +1. Network Install *BuddyPress Group Email Subscription* |
| 111 | +2. Network Install *Invite Anyone* |
| 112 | +3. Network Install *My Page Order* |
| 113 | +4. Network Install *Co-Authors Plus* |
| 114 | +5. Network Install *Simple Footnotes* (recommended), *FD Footnotes* or *WP-Footnotes* |
| 115 | + |
| 116 | +Okay, we're ready to install *CommentPress Core*: |
| 117 | + |
| 118 | +1. Install and Network Activate *CommentPress Core* |
| 119 | +2. If you want to, you can enable *CommentPress Core* on your main blog |
| 120 | +3. Network Enable the *CommentPress Modern Theme* and/or the *CommentPress Default Theme* UNLESS |
| 121 | +4. You have *CommentPress Core*-compatible child themes you want to use instead: |
| 122 | +5. Network Enable any *CommentPress Core*-compatible child themes you want to use |
| 123 | +6. Optionally, activate your chosen *CommentPress Core*-compatible child theme |
| 124 | + |
| 125 | +Go to your "Groupblog Setup" page under "Network Admin" -> "Settings": |
| 126 | + |
| 127 | +1. Select your desired "BuddyPress Groupblog" theme as your default "BuddyPress Groupblog" theme |
| 128 | +2. Click "Save Changes" |
| 129 | +3. Click the "Redirect" header |
| 130 | +4. Set "Redirect Enabled to:" to "Home Page" |
| 131 | +5. Click "Save Changes" |
| 132 | + |
| 133 | +Go to the "CommentPress" network settings page under "Network Admin" -> "Settings": |
| 134 | + |
| 135 | +1. Select your desired "CommentPress Groupblog" theme. This will be applied to group blogs that are *CommentPress Core*-enabled |
| 136 | +2. Configure other options as desired |
| 137 | +3. Click "Save Changes" |
| 138 | + |
| 139 | +Your basic "CommentPress Groupblogs" setup is complete. At this point you can: |
| 140 | + |
| 141 | +1. Create a custom menu for the main site |
| 142 | +2. Use the Theme Customizer to modify the look |
| 143 | +3. Change Background and Header |
| 144 | +4. Customise *CommentPress Core* via its Settings Page |
| 145 | + |
| 146 | +To create a *CommentPress Core*-enabled Groupblog: |
| 147 | + |
| 148 | +1. Begin to create a group as usual |
| 149 | +2. At the "Groupblog" screen, click "Enable CommentPress" |
| 150 | +3. Choose any further options |
| 151 | +4. Check the box for "Enable member blog posting" and use the default settings unless you have reason not to |
| 152 | +5. Continue and finish creating the group |
| 153 | +6. To go to the groupblog, click "Blog" (or if you have chosen to alter the naming scheme, then whatever name you have chosen) |
| 154 | +7. Start your group blogging! |
| 155 | + |
| 156 | +--- |
| 157 | + |
| 158 | +## Upgrades ## |
| 159 | + |
| 160 | +Upgrades from previous versions of *CommentPress* are possible. Please follow the following procedures for your context. |
| 161 | + |
| 162 | +**The name has been changed from *CommentPress* to *CommentPress Core* for two reasons:** (a) because it serves as the basis for extending it for your purposes and (b) to safeguard historical installations, which could break if they upgrade. Newer *CommentPress* installations (versions 3.0.x - 3.3.x) can upgrade to the current version. |
| 163 | + |
| 164 | + |
| 165 | +### Upgrade to *CommentPress Core* ### |
| 166 | + |
| 167 | +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 all be found on Github: |
| 168 | + |
| 169 | +1. Get the latest [CommentPress Plugin](https://github.com/IFBook/CommentPressPlugin) |
| 170 | +2. Get the latest [CommentPress for Multisite](https://github.com/IFBook/CommentPressMultisite) |
| 171 | +3. Get the latest [CommentPress Ajaxified](https://github.com/IFBook/CommentPressAjaxified) |
| 172 | +4. Get the latest [CommentPress Theme](https://github.com/IFBook/CommentPressTheme) |
| 173 | + |
| 174 | + |
| 175 | +### Upgrade to *CommentPress Core* in WordPress Standalone ### |
| 176 | + |
| 177 | +1. Activate *CommentPress Core* plugin |
| 178 | +2. *CommentPress Core* will try and deactivate the *CommentPress Ajaxified* plugin. Deactivate it if it is still active. |
| 179 | +3. *CommentPress Core* will try and deactivate the *CommentPress* plugin. Deactivate it if it is still active. |
| 180 | +4. Delete *CommentPress Ajaxified* plugin |
| 181 | +5. Delete *CommentPress* plugin |
| 182 | + |
| 183 | + |
| 184 | +### Upgrade to *CommentPress Core* in WordPress Multisite (NOT network-activated) ### |
| 185 | + |
| 186 | +On each site: |
| 187 | + |
| 188 | +1. Activate *CommentPress Core* plugin |
| 189 | +2. *CommentPress Core* will try and deactivate the *CommentPress Ajaxified* plugin. Deactivate it if it is still active. |
| 190 | +3. *CommentPress Core* will try and deactivate the *CommentPress* plugin. Deactivate it if it is still active. |
| 191 | + |
| 192 | +When EVERY site has done this, go to "Network Admin" -> "Plugins": |
| 193 | + |
| 194 | +1. Delete *CommentPress Ajaxified* plugin |
| 195 | +2. Delete *CommentPress* plugin |
| 196 | + |
| 197 | + |
| 198 | +### Upgrade to *CommentPress Core* (network-activated OR with *BuddyPress Groupblogs*) ### |
| 199 | + |
| 200 | +To upgrade to *CommentPress Core*. |
| 201 | + |
| 202 | +1. Install, but DO NOT activate OR network-activate *CommentPress Core*. |
| 203 | +2. Network Deactivate *CommentPress for Multisite Extras*, if present |
| 204 | +3. Network Deactivate *CommentPress for Multisite* |
| 205 | +4. Network Disable all old *CommentPress* child themes |
| 206 | +5. Now Network Activate *CommentPress Core* |
| 207 | + |
| 208 | +*CommentPress Core* will now be active on your main site. |
| 209 | + |
| 210 | +On each site: |
| 211 | + |
| 212 | +1. Activate *CommentPress Core* plugin |
| 213 | +2. *CommentPress Core* will try and deactivate the *CommentPress Ajaxified* plugin. Deactivate it if it is still active. |
| 214 | +3. *CommentPress Core* will try and deactivate the *CommentPress* plugin. Deactivate it if it is still active. |
| 215 | + |
| 216 | +When EVERY site has done this, go to "Network Admin" -> "Plugins": |
| 217 | + |
| 218 | +1. Delete *CommentPress Ajaxified* plugin |
| 219 | +2. Delete *CommentPress* plugin (NOT *CommentPress Core*!) |
| 220 | +3. Delete *CommentPress for Multisite Extras*, if present |
| 221 | +4. Delete *CommentPress for Multisite* |
| 222 | + |
| 223 | +--- |
| 224 | + |
| 225 | +## Changelogs ## |
| 226 | + |
| 227 | +### 3.4 onwards ### |
| 228 | + |
| 229 | +The merged plugins and theme. |
| 230 | + |
| 231 | +* See the [commits on GitHub](https://github.com/IFBook/commentpress-core/commits/master) |
| 232 | + |
| 233 | +### Merging 3.3.6 to 3.4 ### |
| 234 | + |
| 235 | +The merging process for the plugins and theme. |
| 236 | + |
| 237 | +* See the [commits on GitHub](https://github.com/IFBook/commentpress/commits/master) |
| 238 | + |
| 239 | + |
| 240 | +### Up to 3.3.6 ### |
| 241 | + |
| 242 | +Up to this version, *CommentPress* was a collection of separate plugins and a theme. |
| 243 | + |
| 244 | +* See the [plugin commits on GitHub](https://github.com/IFBook/CommentPressPlugin/commits/master) |
| 245 | +* See the [theme commits on GitHub](https://github.com/IFBook/CommentPressTheme/commits/master) |
| 246 | +* See the [ajax plugin commits on GitHub](https://github.com/IFBook/CommentPressAjaxified/commits/master) |
| 247 | +* See the [multisite plugin commits on GitHub](https://github.com/IFBook/CommentPressMultisite/commits/master) |
| 248 | + |
0 commit comments