This is an old revision of the document!
This plugin lets you manage a database of links from your admin area and maintains a count of how many times each link has been clicked on by reader. When used as a skin variable, it displays a redirector URL in the form of /nucleus/plugins/blogroll/?n=id, or a group of such URLs.
| General Plugin info | |
|---|---|
| Current Version: | 0.23 |
| Download: | Download this plugin |
| Forum Thread: | Discuss on the forum |
| Author: | Joel Pan (ketsugi) (http://www.ketsugi.com) |
Parameters: Type, ID, Sort field, Sort order, GroupDesc, NumOfLinks
‘group’ | ‘link’
Tells plugin whether to display an individual link or a group of links as defined in the admin area.
If Type is ‘group’, this should be the name of the group to display. Use the pipe character (’|’) to separate multiple group names. If Type is ‘link’, this should be the numeric ID of the link to display.
‘order’ | ‘url’ | ‘text’ | ‘desc’ | ‘created’ | ‘clicked’ | ‘counter’
If Type is ‘group’, tells plugin in what order to display links. Defaults to ‘order’, which displays links according to the order defined in admin area. If Type is ‘link’, this field is ignored.
‘asc’ | ‘desc’
If Type is group, tells plugin whether to display links in ascending or descending order according to the field defined in Sort field. Defaults to ‘asc’.
If ID defines multiple groups to display links from, the GroupDesc value will determine what will replace the <%groupdesc%> variable in the blogroll template. If no GroupDesc is specified, the description of the first group will be used.
If Type is group, tells plugin to display only a specified number of links. Must be a positive integer value; if not, plugin will display all links.
<%Blogroll(group,blogs)%>: displays the group of links named ‘blogs’<%Blogroll(group,mac,clicked,desc)%>: display the group of links named ‘mac’, from the most clicked to the least clicked<%Blogroll(group,blogs|news|mac,text,desc,Blogroll)%>: displays all links from ‘blogs’, ‘news’ and ‘mac, sorted by text in descending order, and using ‘Blogroll’ as a collective group description<%Blogroll(group,news|mac,random,,News,10)%>: displays 10 random links from ‘news’ and ‘mac’. <%Blogroll(link,5)%>: displays the link for link #5In the plugin options page, you can specify how links will appear on your page. The variables available for use in all fields except ‘Item’ are:
<%groupid%>: the group’s internal id number<%groupname%>: the group name<%groupdesc%>: the group’s descriptionVariables available for use in the item template are:
<%linkid%>: the link’s id number<%linkurl%>: the link’s redirector URL as generated by the plugin<%linktext%>: the link text<%linktitle%>: the link’s description<%linkcounter%>: number of times the link has been clicked (not available if redirection is off) <%linkclicked%>: date and time the link was last clicked (not available if redirection is off)<%linkcreated%>: when the link was created
If the <%Blogroll%> skinvar is used to call a single link, the item template will be used to display the link.