rss_suparchive_bycat

The rss_suparchive_bycat tag will generate an article listing in the form of an unordered list and group them by category and optionally by section within each category. The total number of articles in each category and/or section can also be displayed. This listing also solves the problem of listing related articles once the article has been displayed. This allows for a related article listing anywhere on a page as long as a single article is displayed somewhere.

Revision History

See rss_suparchive

Notes

NOTE: The archive can be filtered by day, month or year by generating URLs in the format /yourarchivesection/yyyy/mm/dd or /yourarchivesection/yyyy/mm or /yourarchivesection/yyyy, which is done by using the rss_suparchive_menu tag or the rss_posted plugin.

NOTE: If a global category is set the listing will be filtered by that category.

Plugin Attributes

section
Accepts a comma separated list of sections. NO spaces after commas.
Default: “article”
Example: section=”sectionOne,sectionTwo”

timeframe
Accepts one of 3 options “PAST”, “FUTURE” or “ALL”. By default (PAST) will display articles with a posted date before the current date/time.
Selecting FUTURE will display articles with a posted date after the current date/time. Selecting ALL will display all articles regardless of posted date.
Default: “PAST”
Example: timeframe=”FUTURE”

form
Uses the form to format the results. Paging using the newer and older tags is supported.
Default: “”
Example: form=”lofi”

formwraptag
This tag will wrap the output of each individual form used in the listing.
Default: “”
Example: formwraptag=”ul”

addbreak
Adds an HTML line break after the article link.
Default: “0”
Example: addbreak=”1”

showdate
Displays a date after the article title.
Default: “0”
Example: showdate=”1”

dateformat
Accepts PHP date format.
Default: F j, Y”
Example: dateformat=”j F Y”

datesep
Places the given text in between the date and the article title.
Default: ” » ”
Example: datesep=” » ”

showauthor
Displays the article authors name after the title (and date if applicable).
Default: “0”
Example: showauthor=”1”

authorsep
Places the given text before the author name.
Default: “by”
Example: authorsep=”by ”

showexcerpt
Displays the excerpt of the article.
Default: “0”
Example: showexcerpt=”1”

showheader
Displays the header label for the article listing.
Default: “0”
Example: showheader=”1”

headerlabel
The header text.
Default: “Articles By Category:”
Example: headerlabel=”Category Archive”

showmenu
Shows an unordered list of categories being listed with built in anchor links.
Default: “0”
Example: showmenu=”1”

showcats
Shows category name headers.
Default: “1”
Example: showcats=”0”

showcatsonly
Shows category name headers without article links below to be used as a category menu.
Default: “0”
Example: showcatsonly=”1”

linktosection
Denotes the section that the category headers will link to when the URL is built.
Default: “”
Example: linktosection=”archive”

showcatcount
Shows the article count within the category next to the category name.
Default: “1”
Example: showcatcount=”0”

showsections
Shows the section name headers
Default: “0”
Example: showsections=”1”

showsectioncount
Shows the article count within the section next to the section name.
Default: “0”
Example: showsectioncount=”1”

showjump
Displays a jump back to top link below each category grouping.
Default: “0”
Example: showjump=”1”

jumplabel
The text of the jump back to top link.
Default: ”^ back to top”
Example: jumplabel=”Back To Top”

useartcat1
If an article id is in the current page scope, the listing will be filtered by Category1 of that article. Can be used for a related articles listing.
Default: “0”
Example: useartcat1=”1”

useartcat2
If an article id is in the current page scope, the listing will be filtered by Category2 of that article. Can be used for a related articles listing.
Default: “0”
Example: useartcat2=”1”

useartcats
If an article id is in the current page scope, the listing will be filtered by Category1 or Category2 of that article. Can be used for a related articles listing.
Default: “0”
Example: useartcats=”1”

limit
Limits the number of articles displayed.
Default: “”
Example: limit=”10”