MaisonBisson.com

redirect: http://maisonbisson.com/blog/bsuite/tokens

bSuite Core adds some useful but hard to describe features that make it easier to use WordPress as a CMS and application platform. Some of these features stand on their own, some are there to be used by other plugins. NOTE: this plugin does not include the stats or tag management features of previous version of bSuite.

Features

• Adds support for “tokens” in post content that are dynamically replaced on page load. Some default tokens are included, other WP plugins can add their own tokens to insert dynamic content in a post.
• incorporates the features of bsuite_innerindex.
• Improves searching by implementing MySQL’s full-text index; search results include pages and posts.
• Adds some caching features so that dynamic content doesn’t have to be regenerated for every page load.
• Adds an experimental hook to allow other plugins to attach actions to page or sub-post URLs (i.e. site.com/permalink/sub_thing invokes an action and content specified by another plugin).

Installation

• Download and untar bsuite_core.tar.gz
• Place the bsuite_core folder into your wp-content/plugins/ directory
• Log in to your WordPress admin panel and activate the plugin, then visit the new bsuite submenu of the options tab. This will allow bSuite Core to create its database tables.

Commands

The bsuite submenu of the options has a few command buttons:

• Rebuild bsuite search index
  The bSuite search index is implemented on a separate table which is updated as you write or edit content. Use this command to bring old-content into the index or if you?ve edited the content in way WP doesn?t know about.

Using Tokens

Tokens are written into the post content as regular text in double square brackets like this [[token name]]. Some tokens accept options like this [[token name|option string]]. bSuite Core includes a few default tokens:

date

Inserts the date, uses the same options as PHP’s date function.
Examples:

• [[date]]
• [[date|F j, Y, g:i a]]

pagemenu

Inserts a list of Pages. Wrap it with ol or ul tags to make it valid.
The options are the same as those supported by wp_list_pages, the default (when called without any options) will output a list of child pages of the current page (child_of=$id&depth=1) sorted by menu order (sort_column=menu_order).
Examples:

• [

  Contents
  ]
• [

  Contents
  ]

innerindex

Inserts a div with a linked list of anchors in the current page. Anchors are automatically added to any H-tagged text. See it in action at the top of this page.
Example:

• [

  Contents

  1. Features
  2. Installation
  3. Commands
  4. Using Tokens
     1. date
     2. pagemenu
     3. innerindex
     4. feed
     5. redirect
  5. Extending Tokens
  6. License
  7. Road Map
  8. Bugs
  ]

feed

Inserts the content of an RSS/Atom feed into the body of the post. The template can include any valid HTML, %%link%% , %%title%% , and %%content%% will be replaced with elements from the feed.
Examples:

• []
• []

redirect

If headers haven’t already been sent to the browser, this will send a redirect to the location specified, otherwise it just inserts a link in the content.
Examples:

• [[redirect|http://maisonbisson.com/]]

Extending Tokens

Other WordPress plugins can add their own tokens using the bsuite_tokens filter. Take a look at the plugin code for examples.

License

This software is released as-is and without warranty under the terms of the GPL.

Road Map

Once WP 2.3 is released with tag support, the useful features of bSuite Tags will be incorporated here.

The search enhancements are rudimentary at the moment. Later versions will add more features, including searching of comments and integration of external search engines.

Search word highlighting, a feature of previous versions of bSuite will return in cache-friendly javascript form.

Bugs

Please report bugs in the comments below.

bsuite, bsuite_core, software, download, content management system, wordpress extras, plugin