Last updated: 2006-01-09 22:01

chh_article_custom special attributes

chh_article_custom works like and accepts the same attributes as the built-in txp:article_custom, with the following differences and enhancements:

listform="article-form"
Sets the form to use when displaying an article list. If no listform 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 listform is unset)
labeltag="labeltag text"
Independent wraptag for label for the top of the list. Default is empty. (Applies only when listform is unset)
break="tag text"
HTML tag to be used for line breaks, without brackets. Default is <br />. (Applies only when listform is unset)
wraptag="wraptag text"
HTML tag to be used as the wraptag, without brackets. Default is empty. (Applies only when listform is unset)
class="class name"
CSS class attribute for the wraptag, default is empty. (Applies only when listform is unset)
breakclass="class name"
CSS class attribute for the break tag, default is empty. (Applies only when listform is unset)
form="article-form"
Sets the form to use on an article page. Setting this attribute makes the tag context-sensitive, so that it displays a single article on article pages and an article list on all other pages. If this attribute is not set, the tag will always return an article list, just like txp:article_custom.
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.
time="time"
Restrict by time and date posted. Available values: past, future, any, or a pair of interval values in the form time="start-interval,end-interval". Default is past. Some examples of valid intervals: time="-2 months" (articles published in the last two months), time="-2 days,-1 day" (articles published yesterday) time="-0 days,+1 day" (articles that will be published tomorrow). Valid interval names are second, hour, day, month, and year. Intervals are figured from the current time, plus or minus the specified value. The start-interval is required and must contain all three elements: +/-, a number value, and an interval name. The end-interval is optional, with the default being the current date and time. Articles are matched beginning with and including the start date up to be not including the end date.
month="month descriptor"
Restrict to articles from the specified month(s). month="-1" lists articles published last month. That is, if this is January, it will list all articles from December. month="+1" would list articles to be published in February.
day="day descriptor"
Restrict to articles from the specified day(s). day="-1" lists articles published from midnight to 11:59pm yesterday. day="+1" lists articles to be published tomorrow.
sortby="SmartTitle"
Enables smarter alphabetical title sorting, ignoring leading articles like a, an, and the. The words to ignore can be set with the titlearticles attribute.
titlearticles="wordlist"
Sets a comma-separated list of words to ignore at the beginning of titles for sorting purposes. The default is titlearticles="A,An,The". Note: The word list is case-sensitive.
CustomFieldName="keyword(s)"
Restricts to articles with specified keyword(s) in the custom field named "CustomFieldName". If the custom field name contains spaces, replace them with underscores in the tag attribute. To find articles where the custom field named "My Keywords" contains "textpattern", use My_Keywords="textpattern".
strict_keywords="y"
Enables strict searching of keywords and custom fields. The Txp default is a substring match. strict_keywords="y" forces the keywords to match exactly.

chh_article_custom inherited attributes

All of the following txp:article_custom attributes are also available.

id="integer"
The id# of any live article.
sortby="sort by"
Sort retrieved articles. Available values: ID (article id#), AuthorID (author), LastMod (date last modified), LastModID (author of last modification), Posted (date posted), Title, Category1, Category2, comments_count, Status, Section, Keywords, Image (article image id#), and custom_1 through custom_10. Please note that multiple attributes can be used, separated with a comma.
sortdir="sort direction"
Sort direction of retrieved articles. Available values: asc (first to last), or desc (last to first).
limit="integer"
The number of articles to display. Default is 10.
offset="integer"
The number of articles to skip. Default is 0
excerpted="excerpt value"
Restrict by excerpt value. Available values: y (containing an excerpt) or n (not containing an excerpt).
author="author's name"
Restrict to a specified author.
month="yyyy-mm"
Restrict to articles from the specified month.
keywords="keyword(s)"
Restrict to articles with specified keyword(s). Put multiple keywords in a comma-separated list.
status="status"
Restrict by status. Available values: draft, hidden, pending, live, sticky.
allowoverride="integer"
When set to 0, disables override forms for the generated article list(does not effect individual articles). Available values: 1 or 0.