/organizeserieslogo.gif

Series: Organize Series Usage Tips

I developed the “Organize Series WordPress plugin” to help me manage and make it easier for readers to find various articles I’ve written as part of a series. In this series of articles I am writing about how to use this plugin effectively and in the process I’ll be working through various features of the plugin.

Introduction to Organize Series Usage Tips

When I first started off in the WordPress blogging world there are a few things I discovered fairly quickly:

  1. WordPress is a kick-butt platform for publishing on the web. It’s not only a great tool for typical blogging usage but also makes a great system for designing CMS based websites.
  2. There’s an awesome community behind WordPress. Having such a big and helpful community certainly makes learning and using WordPress all the more easier.
  3. There’s tons of plugins that extend the capabilities of what WordPress can do.
  4. I like tweaking and playing with the codebase of WordPress.
  5. There’s nothing built into the core for handling series of articles…

That last point was something that I encountered more and more as developed other websites (in particular my sermons website at UnashamedSermons.com). Out of that need and not finding a plugin to meet that need I went on to write what is now known as the Organize Series WordPress Plugin. Of course, shortly after the first release I was pointed to the “InSeries Plugin” currently being maintained by Travis Snoozy. He’s doing good work with In-Series but bleh, I decided a little competition won’t hurt (and I like my approach to series a bit better ;) ).  (UPDATE 10/22/09: InSeries is no longer maintained and does not work with the latest version of WordPress – there are now other series plugins at the WordPress plugin repository)

Series Options Page: Tokens

One of the ways that Organize Series makes it possible to easily and finely tune the various ways in which series related content is displayed on your blog is via the use of a templates combined with a token system. “Tokens” are just a way of referring to text indicators that point the plugin to what you want the token to be replaced with when it executes the code. The token format Organize Series uses is %token%. The “key” is surrounded by “%” symbols.

Here’s an example of one of the templates showing you the token system at work.

templateexample

Notice the highlighted tokens in the image: ‘%series_part%’, ‘%total_posts_in_series%’, %series_title_linked%’, and %postcontent%. The plugin uses the reference keys in each token and the positioning of each token to determine where you want the various series information displayed with this particular template.

In this particular case, the settings for Series Meta indicates that whenever the series meta information is called you want it to be in a ‘<div>’ container of the class “seriesmeta” (styled via .css) and with the text, “This entry is part [the series part] of [total parts in the series] in the series [series title linked to the series archive page]“. The %postcontent% token indicates that when the series meta information is automatically inserted by the plugin (see “Automation Settings“) you want it to appear before the rest of the post content.

Tags: , , ,

Series Options Page: Automation Settings

For the next few articles in this series I’m going to focus on the Series Options Page and go over all the different settings that are possible there.

First we’re going to look at the “Automation Settings” section:

Automation Settings

The majority of this section controls the automatic insertion of series related information in your blog. In most cases, you will want to leave everything here as is but there are cases where you may want to have more fine control over the addition of series related information in your blog theme so Organize Series makes it possible for you to do so. Here’s a run down of the different options in this section:

“Display list of series on post pages?”
Postlist Box toggle

Default PostList BoxToggling this checkbox indicates whether you want the series postlist box to be displayed on the page of a post that belongs to a series. If you leave this unchecked, the postlist box will not be displayed automatically and you will have to insert the template tag yourself (I’ll be devoting a whole section to template tags in a later post in this series). The style and “layout” of the postlist box is controlled by the `Series Post List Template` in the “Template Tags Section” on the series options page.

Series Options Page: Series Post List Template

The Series Post List Template is used to affect the presentation of all posts belonging to a series on the single page of a post belonging to a series. In other words, the series postlist box you see on this page.

By default, Organize Series inserts the contents of this template into your blog whenever a post page is displayed for a post that belongs to a series. However you can disable this by unchecking the “Display list of series on post pages” checkbox (I know, I need to change the wording – it’s misleading!).

Let’s take a look at a screenshot of the Series Post List template:

seriespostlisttemplate

In every template you include the following three things:

  • (x)html/css controlling the layout and “looks” of the box.
  • Any text you want displayed.
  • %token-tags% controlling the placement of series information (see “Series Options Page: Tokens” for more on tokens)

In this particular template we see that I’ve used div containers to control the layout of the postlist “box” (with css class “seriesbox” and “center”). I’ve also decided to make the list of posts (%post_title_list%) an unordered list (ul).

Series Options Page: Series Navigation Template

A bit late with this post today but at least I still got it out the door!

If you haven’t yet you’ll want to read about automation settings, tokens, and Templates before reading any further – it’ll save me repeating myself ;)

One of the new features added with Organize Series 2.0 is a Navigation strip that gets displayed with posts that are part of a series containing links to the next and previous posts in the series. This just provides another way for users to click through to other posts in the series besides the series table of contents.

On the Series Options page is a template for controlling how the series navigation strip is displayed:

series post navigation template

The output of the above looks like this:

series navigation strip example

Notice that like the other templates on the options page you control the output by inserting various %tokens%, text, and (x)html markup. Once again, you can automatically insert the series navigation strip into your blog by using the %postcontent% token. In this particular example the %postcontent% token is before the rest of the template telling the plugin that you want the Series Navigation Strip to show up after the post-content. If you don’t want the series navigation strip inserted automatically then simply remove %postcontent% from the template. UPDATE (JULY 23, 2009 – thanks steve!): Actually, removing the %postcontent% token would keep your post content from displaying.  What you would want to do is remove everything else BUT the %postcontent% token.  Sorry for the confusion!

Tags: , , ,

Series Options Page: Series Meta Template

Once again, if you haven’t yet, you should read about automation settings, tokens, and Templates before reading any further.

In this post I’m going to zero in on the Series Meta. What is the series meta? It’s basically an information strip you can associate with a post that belongs to a series for a quick overview of what part the post is, a total count of the posts in the series, and the name of the series the post belongs to. Of course what you actually put in the series meta is up to you!

Here’s what the template looks like:

series meta template

And here’s the output on the blog:

series meta output

Now in the case of the series-meta, it appears wherever the post that is a part of a series is displayed and the location of the output is controlled once again by the %postcontent% token.

If you want to manually insert the series-meta template into your theme then you need to remove the %postcontent% token AND make sure the Display series meta information with posts? checkbox is unchecked.

Template Tag:
Here’s the function you use to call the series-meta template (remember full documentation is found in the series-template-tags.php file):

Tags: , , , , , , ,

Series Options Page: Series Table of Contents Template

So far in the Organize Series Usage Tips Series I’ve been writing about the Series Options page and focusing on some of the things you can do there to customize the output of series related information on your blog. In this post of the series I’m going to focus on the customization of the Series Table of Contents Template.

The Series Table of Contents is a page on your blog that lists all the series you’ve written (that contain posts). The output of this page is controlled by three things.

  • “Series Table of Contents URL” in the Automation Settings Section of the Series Options Page. This setting is what you want to be the location of the series table of contents page.
  • “seriestoc.php” – this is the default file that Organize Series will load when the series table of contents page is requested. The default layout in this file should work with most theme setups but of course it won’t work with all. In some cases, this file will have to be modified to match your theme structure (i.e by looking at your themes index.php or archive.php file). I’ll be writing a post later in this series to go into more detail with this.

Tags: , , , , , ,

Series Options Page: Wrap up

We’re going to conclude our look at the Series Options page in this post by looking at the “Latest Series” Template and the Series Icon Options.

Here’s what the “Latest Series Template” option field looks like (WP2.5):

\"Latest Series Template\"

This is the one template option that is not automatically added to your blog. The contents of this template control the output of the latest_series() function or the latest series widget. You can insert the latest_series() function wherever you want it to appear in your blog (manually into your theme files) or you can simply use the built in widget if you have widgets enabled for your theme.

\"Latest Series DisplayThis is how the default Latest Series output looks on my blog (to the left):

Of course like the other template options on the series options page you can use different tokens to control the contents of the latest_series() ouput.  For instance you might want to use the %series_title% token to display the series title instead of the series icon.  In future versions of Organize Series I’ll be adding more tokens that you can use.

Tags: , , , , , ,

Showing off your series

One of the things that the Organize Series WordPress plugin does well is provide multiple ways for you to promote and “show off” the various series you’ve written. Since some of those possibilities aren’t easily visible to the new user this next few posts in the series will give you a list of all the different ways you can publicize your serial work.

Latest Series – <?php latest_series(); ?>

This template tag is one of the few features of Organize Series that is not automatically enabled right out of the box on fresh Organize Series installs. However, it is a powerful function that provides an easy way for you to promote the latest series you’ve published (or are in the midst of writing).

How to use it:

To use the latest_series() tag you need to be familiar with editing your theme files. There are some great pointers for this here, here, and here. The latest_series() template tag can be placed wherever you want – inside or outside of the WordPress loop. What will happen is that when the page is generated the latest_series template tag will be replaced by what you have included in the Latest Series Template in the Series Options Page. So you can control the output via the series options. By default, the latest_series tag will display the series icon for the latest series.

Tags: , , , , ,

Showing off Your Series: Series List

In the last post, I talked about how you can show off the latest series in your sidebar.  One of the caveats of the latest_series() function/widget is that it only shows one series.  The “latest series” function is just a way of giving readers quick insight into the most recent series you’ve published to your blog and is the easiest to customize.

However, there is another more powerful function included with Organize Series that you can use to output a list of all the series you’ve written where you want that acts very similar to the “wp_list_categories()” template tag in the WordPress core. What that means is that if you’ve already got a handle on how to use “wp-list_categories” then you’ll have no problem with “wp_list_series()”.  Let’s take a closer look:

The Widget

For those of you who are uncomfortable with editing your theme files and who are using a theme with widgets enabled there is a widget included with Organize Series that you can use to output the list of series in your sidebar.

The widget name is “Series Widget” (imaginative eh?) and when you activate it you’ll see that there are some options you can set for the widget (Click on “Edit”).  Here’s a breakdown of what the various options are:

Tags: , , , , ,

Get Adobe Flash playerPlugin by wpburn.com wordpress themes