Link Variables
By Paul
4.75/5 based on 4 votes. The median rating is 5.
By Paul
Main variables
{ARTICLEID} - The id number of the link.
{ARTICLETITLE} - The title of the link.
{ARTICLEBOOKMARKTITLE} - A bookmarkable title (removes all characters like ' that mess up the bookmarking javascript). May also be of use for alt tags on images.
{ARTICLEURL} - The URL of the link.
{ARTICLEBASEURL} - The base of the URL to the end of the domain, like http://www.site.com.
{ARTICLEDOMAIN} - The domain name of the URL, by itself, no http:// and no www.
{ARTICLEDETAILSURL} - The URL of the link's details page.
{ARTICLETHREADURL} - The URL of the associated comment thread.
{ARTICLETAGS} - A linked list of tags associated with the link.
{ARTICLETAGSSTRIPPED} - A plain text list of tags (added in 5.0.1).
{ARTICLEDESCRIPTION} - Description of the link.
-- Optional paramater: {LINKDESCRIPTION[x]} will trim the description to x characters.
{LINKDESCRIPTIONSTRIPPED} - Description of the link with all WSN/HTML code removed.
-- Optional paramater: {LINKDESCRIPTIONSTRIPPED[x]} will trim the description to x characters.
{ARTICLEDESCRIPTIONSENTENCE} - The first sentence of the desciption.
{ARTICLECATID} - The id number of the category which this link is in.
{ARTICLECATPARENTID} - The id number of the category's parent.
{ARTICLECATNAME} - The name of the category this link is in.
{ARTICLEORIGINALCATNAME} - The name of the original category of an aliased link (or just regular category name otherwise).
{ARTICLEORIGINALCATURL} - The URL of the original category of an aliased link (or just regular category url otherwise).
{ARTICLEEMAIL} - The email address provided when the link was submitted.
{ARTICLEHITS} - Number of hits out to this link.
{ARTICLEHITSIN} - Number of hits in from this link.
{ARTICLEOWNERID} - Member id number of the person who submitted the link.
{ARTICLETYPE} - The official type of this link (regular, recip, etc)
{ARTICLETYPELANG} - The friendly language name of the link's type (reciprocal instead of recip for example)
{ARTICLERECIPURL} - The url of the reciprocal link for this link.
{ARTICLERECIPWITH} - The URL which the link uses to reciprocate.
{ARTICLEFUNDS} - Funds remaining for this link from member purchasing link group promotion.
{ARTICLEFUNDSPROJECTION} - The projected date on which the funds will run out.
{ARTICLEDATE} - The date on which this link was first submitted.
{ARTICLELASTEDITDATE} - The date on which this link was last edited.
{ARTICLENEW} - Contains the html to display the "new" image if the link is new, otherwise it's empty.
{ARTICLEUPDATED} - Contains the html to display the "updated" image if the link is updated, otherwise it's empty.
{ARTICLEHITSOUTTEMP} - Number of hits out over last admin-defined number of days.
{ARTICLEHITSINTEMP} - Number of hits in over last admin-defined number of days.
{ARTICLEHITSOUTPERDAY} - Number of hits out per day.
{ARTICLEHITSINPERDAY} - Number of hits in per day.
{ARTICLEHITSOUTPERMONTH} - Number of hits out per month.
{ARTICLEHITSINPERMONTH} - Number of hits in per month.
{ARTICLEDAYSOLD} - The number of days ago the link was submitted.
{ARTICLEEXPIREDAYS} - Days until link expires, if it is set to expire.
{ARTICLEEXPIREDATE} - The date the link will expire (accepts format parameter like all dates).
{ARTICLEISEXPIRED| - Returns true if expired, false if not.
{ARTICLENUMALIASES} - The number of aliases the link has.
{ARTICLEALIASEDIN} - A list of the categories the link is aliased to.
--- Optional paramater: separator (defaults to a comma)
{ARTICLEVIEWERS} - List of people who've viewed the link [if activated]
{ARTICLEADMIN} - If the viewer has permission to edit the link, contains the edit image/link... otherwise empty.
{ARTICLEIMPORTANCE} - The importance of the link based on the formula defined in your admin panel.
{ARTICLEIMPORTANCENUMBER} - The ranking of the link ordered by importance.
{ARTICLEFILTERLINK[field <,> filtertype]} - Creates a filter link.
{ARTICLECANEDIT} - True if viewer has permission to edit, otherwise false.
Voting variables
{ARTICLERATING} - The rating, as a decimal, of the link.
-- Optional parameter: number of decimal places.
{ARTICLEVOTES} - Number of votes cast for the link.
{ARTICLESUMOFVOTES} - The sum of all vote values cast for this link.
{ARTICLESTARS} - displays a number of stars equivilant to the link's rating.
{ARTICLEOLDSTARS} - the old 4.1-style non-AJAX stars
{ARTICLEVOTERIPS} - List of IP addresses of the people who have voted for the link.
{ARTICLEVOTERIDS} - Currently N/A, should be list of member ids numbers of people who've voted for the link.
{ARTICLEMEDIANRATING} - The median rating of the link.
-- Optional parameter: field, to get median for custom rating fields. {ARTICLEMEDIANRATING[stylerating]} gets the average style rating.
Comment-related variables
{ARTICLENUMCOMMENTS} - Number of comments posted about this article.
-- Optional parameter: comment type name, to get the number of comments of that type. For example, {ARTICLENUMCOMMENTS[regular]} to get the number of regular articles.
{ARTICLETHREADVIWERS} - List of people who've viewed the associated comments thread [if activated]
Attachment variables
These vars here will just pick one of the link's attachkments. Use a distinct attachments area to handle each attachment if you want to handle each attached file.
As of 4.2.0, all of these template variables accept an optional parameter with which you can specify a file extension to look for. This way, instead of using a random attachment, you can use one of a particular file type. Examples: {ARTICLENUMBEROFATTACHMENTS[jpg]} will check only for files with that extension. {ARTICLEFILENAME[jpg]} will give the name of an attached jpg file.
{ARTICLENUMBEROFATTACHMENTS} - The number of attached files. Use it in conditionals, will evaluate to false when there are none.
{ARTICLEFILENAME} - The filename on disk of the attached file -- this will be a long randomized string.
{ARTICLEFILETITLE} - The readable submitted file name of the attachment, suitable for display.
{ARTICLEDOWNLOADURL} - The download URL for the attachment.
{ARTICLEDOWNLOADS} - The number of times the attached file has been downloaded.
{ARTICLEKB} - Size of attachment in KB.
{ARTICLEXWIDTH} - The width of image attachments in pixels.
{ARTICLEYHEIGHT} - The height of image attachements in pixels.
{ARTICLEISIMAGE} - For custom attachment fields, a boolean to see if we can make a thumbnail.
{ARTICLETHUMBURL} - The location of the thumbnail for an attached image.
Note: For custom attachment variables, insert the field name after LINK. For example, {ARTICLEMYATTACHFIELDKB} would give the size in KB of a custom attachment field named myattach.
Misc.
{ARTICLENAV} - Contains the navigation path of the categories to get to the link.
{ARTICLETYPESELECTOR} - The <option value...> content of the link type selector.
{ARTICLEHIDESELECTOR} - Contains <option value...> content of the yes/no selector for hiding a link.
{ARTICLESUSPENDED} - 0 if the link is normal, 1 if the link is suspended.
{ARTICLEVALIDATED} - 0 if link is unvalidated, 1 if it is validated.
{ARTICLEHIDE} - 0 if link is hidden, 1 is visible.
{ARTICLENOTIFY} - 0 if submitter does not want to be notified of comments on the link, 1 if they do.
{ARTICLESUSPECT} - 0 if the link is normal, 1 if the link is suspect.
{ARTICLEISREAD} - 0 (false) if the link has not been visitied by the user, 1 (true) if it has.
{ARTICLECOMMENTSREAD} - 0 (false) if the most recent comment in the associated comments thread has not been read by the user, 1 (true) if it has.
{ARTICLEISNEW} - 0 if link is old, 1 if new.
{ARTICLEISUPDATEDBOOL} - 0 if link hasn't been recently updated, 1 if it has been.
{ARTICLECHECKED[field <,> value]} - checks if field is set for value
{ARTICLEID} - The id number of the link.
{ARTICLETITLE} - The title of the link.
{ARTICLEBOOKMARKTITLE} - A bookmarkable title (removes all characters like ' that mess up the bookmarking javascript). May also be of use for alt tags on images.
{ARTICLEURL} - The URL of the link.
{ARTICLEBASEURL} - The base of the URL to the end of the domain, like http://www.site.com.
{ARTICLEDOMAIN} - The domain name of the URL, by itself, no http:// and no www.
{ARTICLEDETAILSURL} - The URL of the link's details page.
{ARTICLETHREADURL} - The URL of the associated comment thread.
{ARTICLETAGS} - A linked list of tags associated with the link.
{ARTICLETAGSSTRIPPED} - A plain text list of tags (added in 5.0.1).
{ARTICLEDESCRIPTION} - Description of the link.
-- Optional paramater: {LINKDESCRIPTION[x]} will trim the description to x characters.
{LINKDESCRIPTIONSTRIPPED} - Description of the link with all WSN/HTML code removed.
-- Optional paramater: {LINKDESCRIPTIONSTRIPPED[x]} will trim the description to x characters.
{ARTICLEDESCRIPTIONSENTENCE} - The first sentence of the desciption.
{ARTICLECATID} - The id number of the category which this link is in.
{ARTICLECATPARENTID} - The id number of the category's parent.
{ARTICLECATNAME} - The name of the category this link is in.
{ARTICLEORIGINALCATNAME} - The name of the original category of an aliased link (or just regular category name otherwise).
{ARTICLEORIGINALCATURL} - The URL of the original category of an aliased link (or just regular category url otherwise).
{ARTICLEEMAIL} - The email address provided when the link was submitted.
{ARTICLEHITS} - Number of hits out to this link.
{ARTICLEHITSIN} - Number of hits in from this link.
{ARTICLEOWNERID} - Member id number of the person who submitted the link.
{ARTICLETYPE} - The official type of this link (regular, recip, etc)
{ARTICLETYPELANG} - The friendly language name of the link's type (reciprocal instead of recip for example)
{ARTICLERECIPURL} - The url of the reciprocal link for this link.
{ARTICLERECIPWITH} - The URL which the link uses to reciprocate.
{ARTICLEFUNDS} - Funds remaining for this link from member purchasing link group promotion.
{ARTICLEFUNDSPROJECTION} - The projected date on which the funds will run out.
{ARTICLEDATE} - The date on which this link was first submitted.
{ARTICLELASTEDITDATE} - The date on which this link was last edited.
{ARTICLENEW} - Contains the html to display the "new" image if the link is new, otherwise it's empty.
{ARTICLEUPDATED} - Contains the html to display the "updated" image if the link is updated, otherwise it's empty.
{ARTICLEHITSOUTTEMP} - Number of hits out over last admin-defined number of days.
{ARTICLEHITSINTEMP} - Number of hits in over last admin-defined number of days.
{ARTICLEHITSOUTPERDAY} - Number of hits out per day.
{ARTICLEHITSINPERDAY} - Number of hits in per day.
{ARTICLEHITSOUTPERMONTH} - Number of hits out per month.
{ARTICLEHITSINPERMONTH} - Number of hits in per month.
{ARTICLEDAYSOLD} - The number of days ago the link was submitted.
{ARTICLEEXPIREDAYS} - Days until link expires, if it is set to expire.
{ARTICLEEXPIREDATE} - The date the link will expire (accepts format parameter like all dates).
{ARTICLEISEXPIRED| - Returns true if expired, false if not.
{ARTICLENUMALIASES} - The number of aliases the link has.
{ARTICLEALIASEDIN} - A list of the categories the link is aliased to.
--- Optional paramater: separator (defaults to a comma)
{ARTICLEVIEWERS} - List of people who've viewed the link [if activated]
{ARTICLEADMIN} - If the viewer has permission to edit the link, contains the edit image/link... otherwise empty.
{ARTICLEIMPORTANCE} - The importance of the link based on the formula defined in your admin panel.
{ARTICLEIMPORTANCENUMBER} - The ranking of the link ordered by importance.
{ARTICLEFILTERLINK[field <,> filtertype]} - Creates a filter link.
{ARTICLECANEDIT} - True if viewer has permission to edit, otherwise false.
Voting variables
{ARTICLERATING} - The rating, as a decimal, of the link.
-- Optional parameter: number of decimal places.
{ARTICLEVOTES} - Number of votes cast for the link.
{ARTICLESUMOFVOTES} - The sum of all vote values cast for this link.
{ARTICLESTARS} - displays a number of stars equivilant to the link's rating.
{ARTICLEOLDSTARS} - the old 4.1-style non-AJAX stars
{ARTICLEVOTERIPS} - List of IP addresses of the people who have voted for the link.
{ARTICLEVOTERIDS} - Currently N/A, should be list of member ids numbers of people who've voted for the link.
{ARTICLEMEDIANRATING} - The median rating of the link.
-- Optional parameter: field, to get median for custom rating fields. {ARTICLEMEDIANRATING[stylerating]} gets the average style rating.
Comment-related variables
{ARTICLENUMCOMMENTS} - Number of comments posted about this article.
-- Optional parameter: comment type name, to get the number of comments of that type. For example, {ARTICLENUMCOMMENTS[regular]} to get the number of regular articles.
{ARTICLETHREADVIWERS} - List of people who've viewed the associated comments thread [if activated]
Attachment variables
These vars here will just pick one of the link's attachkments. Use a distinct attachments area to handle each attachment if you want to handle each attached file.
As of 4.2.0, all of these template variables accept an optional parameter with which you can specify a file extension to look for. This way, instead of using a random attachment, you can use one of a particular file type. Examples: {ARTICLENUMBEROFATTACHMENTS[jpg]} will check only for files with that extension. {ARTICLEFILENAME[jpg]} will give the name of an attached jpg file.
{ARTICLENUMBEROFATTACHMENTS} - The number of attached files. Use it in conditionals, will evaluate to false when there are none.
{ARTICLEFILENAME} - The filename on disk of the attached file -- this will be a long randomized string.
{ARTICLEFILETITLE} - The readable submitted file name of the attachment, suitable for display.
{ARTICLEDOWNLOADURL} - The download URL for the attachment.
{ARTICLEDOWNLOADS} - The number of times the attached file has been downloaded.
{ARTICLEKB} - Size of attachment in KB.
{ARTICLEXWIDTH} - The width of image attachments in pixels.
{ARTICLEYHEIGHT} - The height of image attachements in pixels.
{ARTICLEISIMAGE} - For custom attachment fields, a boolean to see if we can make a thumbnail.
{ARTICLETHUMBURL} - The location of the thumbnail for an attached image.
Note: For custom attachment variables, insert the field name after LINK. For example, {ARTICLEMYATTACHFIELDKB} would give the size in KB of a custom attachment field named myattach.
Misc.
{ARTICLENAV} - Contains the navigation path of the categories to get to the link.
{ARTICLETYPESELECTOR} - The <option value...> content of the link type selector.
{ARTICLEHIDESELECTOR} - Contains <option value...> content of the yes/no selector for hiding a link.
{ARTICLESUSPENDED} - 0 if the link is normal, 1 if the link is suspended.
{ARTICLEVALIDATED} - 0 if link is unvalidated, 1 if it is validated.
{ARTICLEHIDE} - 0 if link is hidden, 1 is visible.
{ARTICLENOTIFY} - 0 if submitter does not want to be notified of comments on the link, 1 if they do.
{ARTICLESUSPECT} - 0 if the link is normal, 1 if the link is suspect.
{ARTICLEISREAD} - 0 (false) if the link has not been visitied by the user, 1 (true) if it has.
{ARTICLECOMMENTSREAD} - 0 (false) if the most recent comment in the associated comments thread has not been read by the user, 1 (true) if it has.
{ARTICLEISNEW} - 0 if link is old, 1 if new.
{ARTICLEISUPDATEDBOOL} - 0 if link hasn't been recently updated, 1 if it has been.
{ARTICLECHECKED[field <,> value]} - checks if field is set for value
Rating:
4.75/5 based on 4 votes. The median rating is 5.
Submitted: 09/25/03 (Edited 12/13/08)
Description: Summary of what each link template variable does when used in a template.
Views:
5538 views. Averaging 3 per day.
In the most recent 30 day period, there've been 5 views.

Print
E-Mail