Last updated: 2006-01-09 22:01

chh_article special attributes

chh_article accepts the same attributes as chh_article_custom, with some additions and distinctions:

form="article-form"
Sets the form to use on an article page. If no form attribute is supplied, the default article form will be used.
searchall="0"
By default, when the txp:article tag returns a search query, it returns results from all searchable sections. The setting of searchall="0" restricts the search to the current section. If you need no further refinement, stop reading.

Because the chh_article tag allows you to restrict article lists with the same attributes as chh_article_custom, search results may be limited to not only articles in the current (or specified) section(s), but also articles with the specified category, keywords, author, time, month, day, and/or excerpted status. To restrict the search results by all of these attributes, if they exist, set searchall="none".

You may also specify a list of attributes to ignore. searchall="section,category" will return results from all searchable sections and categories (mnemonic: "search all sections and categories") but if the keywords, author, time, month, or excerpted tag attributes are set, the search results will be only from articles that match the values specified for those attributes. In other words, the default action of searchall="y" is equivalent to saying searchall="section,category,keywords,author,time,month,excerpted".
searchmode="mode"
Specify the type of search to perform. By default, the tag returns the standard Txp exact-phrase search. Additionally, you may specify natural or boolean.

natural is a weighted search (the same search that determines an article's score in the default Txp search), ranking articles higher the more search terms they contain. boolean is the most powerful. It allows the user to specify which terms must be or must not be in an article and allows term grouping and exact phrase searching. Your mySQL server must be version 4.0.2 or higher to perform boolean searches.

Note: The nature of natural and boolean searches means that in many instances the txp:search_result_excerpt tag will not function.
pgonly="integer"
Do the article count, but do no display anything. Used when you want to show a search result count, or article navigation tags before the list of articles. Available values: 1 or 0.