Last updated: 2006-01-22 20:01

relation="field-list"
Specifies a comma separated list of fields to use in determining relatedness. Possible values are category (the default), keywords, author, or the name of a custom field.
The arrow operator ("->") may be used to map from one field type to another. For example, relation="custom_1->keywords" will return a list of articles with a keywords field that matches the value in the current article's custom_1 field (you may also specify a custom field by its assigned name).
custommode="list"
Determines how custom fields are treated. By default the tag will assume the custom field is a single string to match. When set to "list", the tag treats custom fields as comma-separated lists, as if they were additional keywords fields.
listmode="all"
When set to all, the tag will return only the articles in which every field listed in the relation attribute matches the corresponding fields of the current article. By default, the tag will return articles in which any one of the listed fields matches its corresponding field in the current article.
section="foo"
Restricts the article listing to a comma-separated list of sections. The wildcard "?" may be used to represent the current section.
excerpted="y"
Restricts the article listing to articles with excerpts, just like article_custom.
children="y"
Enables recursive descent into subcategories. When using category for relations, this will expand all subcategories of Category1 and Category2 of the current article. By default, subcategories are not checked. Note: This feature requires the chh_article_custom plugin to be installed and active.
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.
strict="y"
Enables strict keyword matching in custom and keywords fields. Keywords must match exactly, and no spaces are allowed before or after the commas. The default of strict="n" is the original matching method that performs a simple substring match.
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.
sortby="field-name"
Set the article sort field, the same as txp:article. Default is 'Posted'.
sortdir="direction"
Set the article sort direction, ascending or descending, the same as txp:article. Default is 'desc'.
limit="integer"
Maximum number of listed articles. Default is 10.
form="article-form"
Enables txp:article_custom style article lists, using the designated form. If this attribute is omitted, the plugin produces standard txp:related_articles style lists, supporting the label, labeltag, wraptag, break, and class attributes.
label="label text"
Label for the top of the list. Default is empty.
labeltag="labeltag text"
Independent wraptag for label for the top of the list. Default is empty.
break="tag text"
HTML tag to be used for line breaks, without brackets. Default is empty.
wraptag="wraptag text"
HTML tag to be used as the wraptag, without brackets. Default is empty.
class="class name"
CSS class attribute, default is chh_related_articles.