Installation Instructions

NOTE: As of version 2.1, Organize Series now requires WordPress 2.8 - for earlier versions of WordPress, use version 2.0.8 of Organize Series

1. MAKE SURE YOU BACKUP YOUR WORDPRESS DATABASE (that's all in caps for a reason - nothing should go wrong but it's a good precaution nevertheless!!)
2. Download the File (or use the built-in updater provided by WordPress)
3. Extract to a folder in ../wp-content/plugins/. The orgSeries folder can be named whatever you want but the default is "organize-series". The final structure would be something like this: ../wp-content/plugins/organize-series/--and all the orgSeries plugin files/folders--
4. Activate orgSeries on your WordPress plugins page.
5. NEW with Organize Series 2.1 -> the Series Icon Feature uses the built in Media Uploader/picker in WordPress. You don't have to worry about what directory you upload your series icons into anymore.
6. Visit the "Options/Settings->Series Options" page to initialize all the default settings.
7. NEW with Organize Series 2.1.5 -> there is now a bundled plugin called "Organize Series Publisher" that allows you to hold a series of posts for publishing at a future date and then publish them all at once when ready. If you wish to use this plugin it must be activated after Organize Series is activated (more on this feature in the other notes section)

You can do the above or just use the new plugin install integrated in WordPress.

Upgrading

If you are upgrading from Organize Series 2.0 or above you can follow the same steps as above however make sure you revisit the Organize Series Settings page. There are some new fields that you'll need to populate. There are two ways of going about doing this:

Fill in or modify the blank fields on the options page

Specifically:

• Display series navigation links checkbox -> make sure this is checked if you want your navigation links to be automatically inserted.
• Delete all organize series datat from database... checkbox -> You can leave it unchecked UNLESS you want to have everything in your database that is organize series related removed when you delete the organize series plugin.
• Series Meta (with excerpts) textarea -> You can now control what gets displayed with post-excerpts ( the_excerpt() ). You can add exactly what is in the "Series Meta" textarea or modify to suit.
• Latest Series (tags before), (inner tags), and (tags after) textareas. -> Latest Series used to have just one template but I've brokent it out into three separate areas so you can have more control over what the Latest Series widget (or template tag) displays.

Click the "Reset Options to Default" button

This will populate all the fields with the default settings.

IMPORTANT This will also replace any customizations you have already set - so if you choose this option make sure you copy your custom settings FIRST so you can reapply them after.

Other Notes

If you customize the included series.php file (for series archive pages) and seriestoc.php file (for Series Table of Contents Page) to fit your site theme better make sure you copy those two files over to your theme directory so future upgrades of Organize Series won't overwrite your customizations.

That's it! You might want to read through the Series Options page (in the "settings" menu of WP 2.5 or "options" in earlier WP versions) and the Manage->Series Page. You'll also notice that your "write/edit" posts page now has a handy dandy series box on it for adding your posts to a series (and creating new series on the fly).

For support please visit the support forums. You can also get support from the WordPress Help Center. This is a service I have partnered with and when you pay for support from them I receive a commission so it's a way of supporting the work I do. When contacting them let them know my affiliate code which is 14322.

FAQ

How can a create a page listing all the series I've written?

By default the page is already created for you and the url is http://yourblog.com/series/ (this url can be changed via the series options page). However, depending on your theme the layout may not be quite what you want it to be. The output of this table of contents page is controlled both by the series table of contents listing: template in the series options page and the seriestoc.php file in your organize series plugin directory. You can make necessary changes to the seriestoc.php file to match your theme (go by the layout of your index.php file) and copy it to your theme directory.

Your question not answered? Ask your usage related question on the support forums and I'll put the most common ones here.

Changelog

2.1.7

This version has been tested with WordPress 2.9 and all is in working order. Please use the new compatibility form for the Organize Series listing on WordPress/extend to indicate your results with using it.

Fixes

• Fixed a problem with having duplicate id selectors with the_series_title() outputs resulting in validation errors. See the original report here

• Fixed a bug resulting in Series Part numbering not propagating correctly through all posts in a series when editing a post that is part of a series. See original report here

• Fixed a bug where Series Meta for "the_content" was being displayed where the_excerpt was called. See here for original report.

• Fixed the seriestoc template not being displayed when permalinks are off. Important: When permalinks are not enabled ".../?seriestoc=x" points to the series table of contents for all series. "x" can be any number.

• get_series_link() has been updated to direct to the correct link depending on whether permalinks are enabled or not.

2.1.6

New Features

• Just a small change that allows users to chooses whether or not the custom seriestoc URL will have a backlash after it or not. Prior to this, Organize Series would always include the backslash even if it wasn't explicitly included via the Series Options page.

Major Fixes

• There was some typos with the roles and capabilities array used with Organize Series that resulted in new users not being able to use the plugin. If you got a "You do not have sufficient permissions" error, that is fixed now.

2.1.5

New Features

• new function: get_series_ordered() - allows users to pull a list of series_ids, slugs, and names from the database ordered by whatever criteria they want. It returns an array of the data that the user will have to display as needed. (ht to Amanda Giles for the initial code that I modified a bit). See the inline docs in the series-taxonomy.php file around line 192.

• new bundled plugin: Organize Series Publisher - allows users to set a series as "unpublished" and all posts published to that series will be held back until the author decides to publish the series all at once. Great for creating "issues". This plugin is the result of me being hired by Amanda Giles who graciously agreed to make this available to all of you! This plugin must be activated after Organize Series is activated.

• Users can now set a custom base for for series archive permalinks. For instance, you can now change: "yourblog.com/series/someseriesname" to "yourblog.com/coolitems/someseriesname". The place to add the custom base is at the Series Options page. By default it is set to /series/.

• link to wphelpcenter.com added to the Series Options Page. I've partnered with wphelpcenter.com for official support and anybody paying them for help with Organize Series will be helping to support me! It's a great service for those times where you "need help right now"! When contacting them, be sure to give my affiliate number: 14322

Major Fixes

• Fixed a validation issue reported here due to some improper js code.

• Posts saved as draft and then published will now show the correct number for "total posts in series". Reported here.

• Fixed the problem where those with the "Editor" role were unable to manage series or change series options. Reported here

• Updated the layout/looks of the Organize Series Options page to better fit in with WordPress 2.8+

Minor Fixes

• A couple of mixed localization tags

• Changed the name of some menu items to better correspond with docs. "Post Series" in the Edit posts menu has been changed to "Manage Series".

• Changed the series filter dropdown on the edit posts page to show all series (not just series that have posts). This is so if you have a series where all the posts are drafts, or pending, you can still view them filtered by series.

• Also fixed some typos and minor bugs throughout the code.

2.1.2

Major Fixes

• fixed problems that were happenening with excerpts (I'm pretty sure I squashed this bug - if you notice differently please add to this thread

• Series Feeds weren't working. Now they are.

Minor Fixes

• a couple of missed localization tags.

2.1.1

This is a recommended upgrade to fix a major bug listed below.

Major Fixes

• fixed a bug that occured when comments were added to a post that was part of a series. When a comment was made the post would lose all series information.

Minor Fixes * a typo on the Organize Series Options page.

2.1

Organize Series version 2.1 is a significant update that introduces some new features and fixes many bugs introduced with many of the more recent WordPress updates. Notice that this version requires WordPress 2.8. I decided that it's becoming too time-consuming to keep making Organize Series backwards compatible.

New Features

• Organize Series now uses the built-in media-uploader with WordPress for selecting and uploading images to use as Series Icons. What's cool about this is you don't have to worry about where your images are being uploaded now. When selecting images you click the "Insert into Post" button and this will assign the image as the icon for your series.
• There are more visual cues for what image is selected and what image is the existing image when editing series.
• Organize Series integrates fully with the "quick-edit" feature on the Manage->Posts page. Now you can Add, remove or change series information quicker and easier than ever before!!
• Made the plugin much more efficient with number of queries and code execution.
• Added an option for customizing what series information is shown when the_excerpt() is used ( as opposed to the_content() )
• Added a link to the series options page with the Organize Series listing on the WordPress plugin page.
• On new installs of Organize Series there will now be a warning at the top of all WordPress admin pages that the Series Options page needs to be loaded to initialize the Organize Series settings.
• Organize Series now provides the option for users to delete all Organize Series related data from their database when deleting Organize Series using the link on the WordPress plugins page. This option can be set via the Series Options page.
• The latest_series() widget and template tag now allows for more customization of what series information is displayed. Now users have control over: How many series are displayed and how the list is ordered. With this addition I've also changed the latest_series() templates via the series options page to allow for three settings -> latest series (tags before), latest series (inner tags), and latest series (tags after). The Latest Series widget now has more options to select what the Latest Series widget outputs. This was one of the most requested features and I'm glad to be able to implement it.
• added an 'auto_tag_nav_toggle' option to the Series Options page. Auto-insertion of Series Navigation used to be controlled by the 'auto_tag_toggle' option (which also determines whether series_meta information is outputted automatically). Now you can control the output of the series navigation strip separately from the series meta information.
• fixed the series default $plugin_url and $plugin_path so it works with symlinks (thanks to patch from Georg S. Adamsen )
• Localized Organize Series. Organize Series is now fully localized so translators can bring Organize Series to other languages. Thanks to Benjamin Lupu for his initial work on this. I welcome any other translators who'd like to contribute the translation of Organize Series into other languages!

Major Fixes

• fixed series_description() bug that didn't return a series description
• restructured some of the hooks/filters so they were called in more correct places.
• WordPress 2.8 beefed up the custom taxonomy structure making it much easier for users to create custom taxonomies. A side-effect for Organize Series is that this created an additional "Manage Series" link in the admin menu and an additional Series Meta Box on the Add/Write Posts page. Organize Series 2.1 removes these additions to eliminate confusion.
• Posts that are a part of a series will no longer lose their series related information when using the quick-edit or bulk-edit feature on the Manage->posts page.
• Fixed the link on the series widget settings so it correctly directs to the Organize Series Options page.
• fixed dropdown in series widget so it directs to proper page using new taxonomy link format AND is xhtml compliant (moved js to the head and out of body).
• Fixed Organize Series so that scheduled posts added to a series will not lose their series information when reaching published date.
• Reduced number of queries to database when the series-postlist is displayed on a post page belonging to a series. There will no longer be additional queries for each post that is part of the same series (which quickly multiplied in series with a lot of posts belonging to it).
• added more wp_nonce security to the backend. Think orgSeries is all covered now.
• fix for the_excerpt stripping series meta tag html.
• Eliminated excess code not needed for earlier versions of WordPress.

Minor Fixes

• some fixes to get_series_rss_link() in orgSeries-rss.php to autodiscover series_id for displayed post.
• minor fixes for guessing the location of plugin files (orgSeries.php)
• minor fix for wp_series_nav() (which sometimes didn't display the right series in order for "next" and "previous" links).
• corrected some typo errors.
• Some security fixes -> making sure all wp_queries use $wpdb->prepare.
• All hard-coded wp-content references are corrected to call the WP-CONTENT definition allowing for WordPress installs that renamed their wp-content directory.
• fix for series widget displaying "Other Posts that are part of this series" outside of single post pages and with posts that are not part of a series.
• The title attribute in series links now uses the series name instead of series id and I've added an id attribute to the links using the series id.

2.0.8

Significant fixes and a couple minor new features. NOTE - this version was ONLY MADE POSSIBLE thanks to the many people who tested the development betas and reported on bugs. Without their help, I wouldn't have got this version out the door. Read through the comments on the Organize Series feed to see all the people who contributed!

New features

• Added a new argument to the "wp_list_series" function - "number" which enables users to limit the number of series displayed
• Reworked the layout of Organize Series administration integration with WordPress so it "fits" with WordPress 2.7 - including showing "Series" in the Dashboard "Right Now" widget.
• Organize Series interface can be floated around and respositioned in the write/edit posts screen for WordPress 2.7
• moved the "Manage Series" menu item to the Posts submenu area for WP2.7 (previous versions stay in the same location)

Minor

• fixed an inconsistency with 'show_last_update'
• fixed some bugs with the atom feed (was an early update...not sure if it's still working correctly now)
• fixed the 'series_description' function (it wasn't working)

Major

• Organize Series will now work correctly with the post-revisions feature introduced with WordPress 2.6
• redid the plugin file locater code to allow for changes with the admin menu filters.
• redid the plugin file locater code to allow for users customizing the location of their wp-content folder
• redid all code referencing wp-config.php to allow for users customizing the location of their wp-config.php file (see http://planetozh.com/blog/2008/07/what-plugin-coders-must-know-about-wordpress-26/ for reference I used).
• Fixed posts that are a part of series but not published showing up in the series list on published posts that are part of a series-taxonomy
• Fixed a bug where custom navigation text set on the Series options page wasn't showing up correctly.

2.0.7 - Contains the following fixes:

Minor

• Removal of extraneous html from series.php and seriestoc.php template files.
• Updated readme.txt for suggestion to copy customized series.php and seriestoc.php files to theme directory.
• Added missing < /div > to seriestoc.php file to fix "98%" of the typical default installations of this plugin.
• fixed a potential bug with the get_series_toc() function/template tag.
• Fixed a few spacing, code structure errors throughout the files.
• Changed the "title" attribute for the get_series_toc() link to something a bit more friendly.

Major

• Fixed bug affecting installs of Organize Series on blogs with a subdirectory in their blog address (i.e. http://www.myblog.com/blog/). In these setups the Series Table of Contents page re-direct wouldn't work. This bug also affected custom seriestoc urls set on the Series Options pages with a multiple slash structure (i.e. the default is \series\, but if you used \series\seriestoc it wouldn't work). Many thanks to Ken Carlson for his help in getting it fixed.

2.0.6 - Fixes a pretty major bug with the custom rewrite/permalink structure for series archives. This bug only shows up if you use certain prefixes to your custom permalinks such as /archives/...rest of permalink. Hat tip to Edward for the catch and fix.

2.0.5 - Contains the following bug fixes:

• PHP error that was reported on the Manage Series page affecting certain installs.
• .rss validation warning for series archive feeds thanks to this post
• some typo fixes with readme.txt file
• updating readme.txt to reflect that Organize Series works with WordPress 2.5.1

2.0.4 - This is a pretty significant changeset that fixes some things with the Series Table of Contents page:

• Series Table of Contents page now returns the correct header ('200'). It was returning '400' before the fix. see this thread.
• NEW FEATURE: You can now indicate what the browser title bar will say on Series Table of Contents page via the Series Option settings in your admin. The default will be "Series Table of Contents Page"
• Fixed a conflict with "All In One SEO Pack" plugin affecting Series Table of Contents Page.
• Thanks to gnouros for detecting and testing my fixes of the above errors for me!
• Shortened the "official" plugin name to "Organize Series" to match the directory in the svn repository - hopefully this will fix the indicator not showing up in your plugin list for when there's a new version of Organize Series out. See this post in the WP Support Forums.

2.0.3 - Previous fix broke the ajax call for the add series on a fly (on write/edit posts pages). This fixes that.

2.0.2 - IMPORTANT FIX for where organize series broke submenu links on plugins that added their own topmenu. Won't happen anymore.

2.0.1 - some fixes so that changing the SERIES_URL definition in orgSeries.php actually works (you can use this to pick how you want the series-archive permalinks to look - important for avoiding conflicts with existing category permalinks...)