Skip to content
This repository has been archived by the owner on Nov 28, 2022. It is now read-only.

Commit

Permalink
Merge pull request #2 from christianwach/master
Browse files Browse the repository at this point in the history 
plugins merged
  • Loading branch information
@christianwach
christianwach committed Nov 11, 2012
2 parents 89bfbfc + 0a45c60 commit 476fa3f
Show file tree
Hide file tree
Showing 226 changed files with 23,950 additions and 9,410 deletions.
239 changes: 231 additions & 8 deletions README.md
View file
@@ -1,17 +1,240 @@
Commentpress
============
CommentPress Plugin
===================

Commentpress is an open source theme and plugin for WordPress that allows readers to comment paragraph by paragraph in the margins of a text.
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 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.
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.

For Wordpress Multisite: do not network activate this plugin. Consider using [Commentpress for Multisite](https://github.com/IFBook/CommentPressMultisite), which will handle the setup of sub-blogs for you.
**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 further information and instructions please see the [Commentpress site](http://www.futureofthebook.org/commentpress/)
**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 [cpdev@futureofthebook.org](mailto:cpdev@futureofthebook.org)

---

## Installation ##

1. Unzip the .zip file into `/wp-content/plugins/commentpress`
### GitHub ###

There are two ways to install from GitHub:

#### ZIP Download ####

If you have downloaded this as a ZIP file from the GitHub repository, do the following to install and activate the plugin and theme:

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`
2. Activate the plugin
3. Visit settings page and configure plugin
3. Visit settings pages and configure plugin and theme
4. You are done!

#### git clone ####

If you have cloned the code from GitHub, it is assumed that you know what you're doing.

### WordPress Plugin Repository ###

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/".


#### Install CommentPress Core in WordPress Standalone ####

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


#### Install CommentPress Core in WordPress Multisite ####

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


#### Install CommentPress Core with BuddyPress Groupblogs ####

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!

---

## Upgrades ##

Upgrades from previous versions of CommentPress are possible. Please follow the following procedures for your context.


### Upgrade to CommentPress Core ###

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:

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)


### Upgrade to CommentPress Core in WordPress Standalone ###

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


### Upgrade to CommentPress Core in WordPress Multisite (NOT network-activated) ###

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


### Upgrade to CommentPress Core (network-activated OR with BuddyPress Groupblogs) ###

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"

---

## Changelogs ##

### Merging 3.3.6 to 3.4 ###

The merging process for the plugins and theme.

* See the [commits on GitHub](https://github.com/IFBook/commentpress/commits/master)


### Up to 3.3.6 ###

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)

0 comments on commit 476fa3f

Please sign in to comment.