Last updated: 2006-01-21 22:01

<txp:chh_keywords_list />

This tag, which should be used in an article form, outputs a lists of keywords for the article.

field="field name"
Sets the article field to use as the keywords field. The value should be either keywords, or the assigned name of any custom field. The default is field="keywords".
section="section name"
Sets the section for keyword links. The page template for this section should have a corresponding chh_keywords_articles tag. By default, links are directed to the default section (home page). The value of section="?" will set the section to the current section.
sortby="keyword"
Enables keyword list sorting. By default, words are listed in the order in which they are entered. The only allowed value is "keyword", which sorts alphabetically.
sortdir="direction"
Sets the sort order. Default is sortdir="asc". Allowed values are "asc" and "desc".
wraptag="tag"
break="tag or text"
class="text label"
breakclass="text label"
label="text label"
labeltag="tag"
This tag outputs a standard link list and accepts the standard wraptag/break attributes. By default break=", ". All other values are empty.
rel="link-type"
Specifies the relationship attribute of keyword links. Default is unset.

<txp:chh_keywords_list_all />

Lists all keywords in the database.

field="field name"
Sets the article field to use as the keywords field. The value should be keywords, the assigned name of any custom field, or the "?" wildcard to indicate the field name of the current keyword query (if any). The default is field="keywords".
section="section1,section2"
Restricts the listing to a comma-separated list of section names. The special wildcard "?" will be replaced with the currently browsed section name, if any. The first section in the list will be used as the section for keyword links, the same as the section attribute for chh_keywords_list.
wraptag="tag"
break="tag or text"
class="text label"
breakclass="text label"
label="text label"
labeltag="tag"
This tag outputs a standard link list and accepts the standard wraptag/break attributes. By default break=", ". All other values are empty.
weightclass="class name"
Keywords are given a weight from 1 to 10. The keyword(s) assigned to the most articles will have a weight of 10, and keywords assigned to only one article will have a weight of 1. When weightclass is set, the keyword's weight will be appended to it and assigned to the keyword link's CSS class attribute.
sortby="keyword"
Enables keyword list sorting. By default, words are listed in the order in which they are found in the database, with words from the most recently posted articles first. Allowed values are "keyword", which sorts alphabetically, and "weight", which sorts by the words weight, with more often used words being "heavier" than less used words.
sortdir="direction"
Sets the sort order for "keyword" or "weight"-sorted. Default is sortdir="asc". Allowed values are "asc" and "desc".

<txp:chh_keywords_articles />

This tag should be used on a page template. When a keyword query is made, the tag outputs a list of all articles with the specified keyword, much like Txp's default browse-by-category feature works.

form="article-form"
Sets the form to use when displaying an article list. If no form attribute is supplied, the tag will return a standard link list based on the label, break, and wraptag attributes.
label="label text"
This string will be prepended to the link list. Default is empty. (Applies only when form is unset)
labeltag="labeltag text"
Independent wraptag for label for the top of the list. Default is empty. (Applies only when form is unset)
break="tag text"
HTML tag to be used for line breaks, without brackets. Default is <br />. (Applies only when form is unset)
wraptag="wraptag text"
HTML tag to be used as the wraptag, without brackets. Default is empty. (Applies only when form is unset)
class="class name"
CSS class attribute for the wraptag, default is empty. (Applies only when form is unset)
breakclass="class name"
CSS class attribute for the break tag, default is empty. (Applies only when form is unset)
section="section1,section2"
Restricts the article listing to a comma-separated list of section names. The special wildcard "?" will be replaced with the currently browsed section name, if any.
category="Dog,Chicken&Egg,Cat"
Restricts the article listing to a comma-separated list of category names. When two categories are joined by an ampersand (&), an article must be assigned to both categories to match. For example, the above attribute means the tag should look for articles categorised as either Dog, or Cat, or both Chicken and Egg. An article with category1 set to Chicken and category2 set to Duck would not be matched. The special wildcard "?" will be replaced with the currently browsed category name, if any.
children="y"
Enables recursive descent into subcategories. Will match all subcategories of those specified by the category attribute (or by the currently browsed category, if category="?"). Note, however, that paired categories (like "Chicken&Egg") must still match exactly; their subcategories are never searched.
strict="n"
Disables strict keyword matching. When strict="n", keywords are matched within a field the same as when using article_custom's keywords attribute; that is, a loose substring match. With the default, strict="n", keywords must match exactly, and no spaces are allowed before or after the commas.
limit="integer"
The number of articles to display. Default is 10.
offset="integer"
The number of articles to skip. Default is 0.

<txp:chh_if_keywords> </txp:chh_if_keywords>

This is a conditional tag which will display the enclosed text whenever the current page is a keyword query.

field="field names"
Restrict the keyword query check to a comma-separated list of field names.

<txp:chh_keywords_name />

Outputs the field name of the current keyword query. Returns nothing if the current page is not a keyword query.

<txp:chh_keywords_value />

Outputs the keyword value of the current keyword query. Returns nothing if the current page is not a keyword query.