cbe_keywords

Developed with a tagcloud in mind.

Idea inspired by tru_tags and chh_keywords, pieces of code grabbed almost everywhere, borrowed from many plugins developers, you know who you are ... thank you !

Table of contents

• Features
• Download, installation, support
• Tags and attributes
• Examples
• Changelog

Features

• get a simple list of all keywords used (example)
• get a list with number of occurences for each keyword (example)
• build a tag cloud (example)
• build a formatted list ready to pass as a parameter to a script (example)
• get articles that share same keywords with the current one (example)
• turn article keywords into hashtags (example)

Download, installation, support

Download from the plugin page.

Copy/paste in the Admin > Plugins tab to install or uninstall, activate or desactivate.

Visit the forum thread for support.

Tags and attributes

All tags share the common presentational attributes wraptag, break, class, breakclass. Default values are unset. See Attributes Cross-reference for further information.

• <txp:cbe_all_keywords />
• <txp:cbe_keyword />
• <txp:cbe_keyword_count />
• <txp:cbe_keyword_ratio />
• <txp:cbe_keywords_related />
• <txp:cbe_keywords_hashtags />

<txp:cbe_all_keywords />

Get a list of all keywords.

Can be used in a page or form template, either as a single or container tag.

<txp:cbe_keyword />

Value of the current keyword.

Used as a single tag.

Attribute:
escape: convert characters to HTML entities - values:

• unset: use UTF8 character set
• html: use ISO-8859-1 character set only
• htmlspecial: convert only special characters (&, ", ', <, >)

<txp:cbe_keyword_count />

How many times the current keyword is being used.

Attributes: no other than the common presentational attributes.

<txp:cbe_keyword_ratio />

How many times the current keyword is being used amongst all the other keywords.

Attributes: no other than the common presentational attributes.

<txp:cbe_keywords_related />

Works as <txp:related_articles />, but on a keywords basis.

<txp:cbe_keywords_hashtags />

keyword1, keyword2, keyword3 become #keyword1 #keyword2 #keyword3

Attributes: the common presentational attributes, plus
limit: limits the output to the specified number, can be a negative value to return the n last keywords.

Examples

Basic usage

<txp:cbe_all_keywords break=" " />

outputs a single line containing all keywords.

Text tagcloud

<txp:cbe_all_keywords minfontsize="12" maxfontsize="24" sortby="alpha" sortdir="asc" label="Tagcloud" labeltag="h2" wraptag="div" class="tagcloud">
  <span style="font-size: <txp:cbe_keyword_ratio />px;"><txp:cbe_keyword /></span>
</txp:cbe_all_keywords>

Try with minfontsize="100" maxfontsize="200" and style="font-size: <txp:cbe_keyword_ratio />%;"

Flash tagcloud

This is how to construct the parameter to pass to WP-Cumulus, using the internal textpattern search engine, and assuming you have the flash file available:

1. Create a form, name it for example param_cumulus and put the following code (in one single line):
   

   <txp:cbe_all_keywords minfontsize="8" maxfontsize="22"><a href='<txp:site_url />?q=<txp:cbe_keyword escape="html" />' style='font-size:<txp:cbe_keyword_ratio />px;'><txp:cbe_keyword /></a></txp:cbe_all_keywords>

2. In the script, pass the paramaters this way:

   <script type="text/javascript">
   ...
       so.addVariable("tagcloud", "<tags><txp:output_form form="param_cumulus" /></tags>");
   ...
   </script>

Top 10 keywords

<txp:cbe_all_keywords limit="10" sortby="weight" sortdir="desc" wraptag="table" class="allkw">
<tr>
  <txp:cbe_keyword wraptag="td" class="kw" />
  <txp:cbe_keyword_count wraptag="td" class="count" />
  <txp:cbe_keyword_ratio wraptag="td" class="ratio" />
</tr>
</txp:cbe_all_keywords>

Related articles

Titles of the (at most) five latest related articles :

<txp:cbe_keywords_related limit="5" break="br" wraptag="div">
  <txp:title />
</txp:cbe_keywords_related>

Links to the (at most) ten related articles older than the current one, and published far in the past :

<txp:cbe_keywords_related time="older" sort="Posted asc" />

Links to the (at most) ten related articles that were immediately published after the current one :

<txp:cbe_keywords_related time="newer" sort="Posted asc" />

Hashtags

<txp:cbe_keywords_hashtags wraptag="p" break="span" class="hashtags" breakclass="tag" />

will generate something like this :

<p class="hashtags">
	<span class="tag">#textpattern</span>
	<span class="tag">#javascript</span>
	<span class="tag">#jquery</span>
</p>

Changelog

• 04 Apr 13 - v0.2 - Added values time='newer | older' (than displayed article) for <txp:cbe_keywords_related />
• 11 Jul 11 - v0.1 - Initial release