Template Tags

This is a list of all the standard template tags that can be used in your templates. Template tags are also called snippets. This list is included as a reference, and not necessarily as a means to writing your own templates. Inspecting the default templates will give you a much better idea of how it all fits together. Please also read Working with snippets.

Use this to include files into your templates or entries.

[[include:header.html]]

Use this to place an image in your page or your entries. Parameters used are the 'name' of the image, the 'alt' attribute, the 'alignment' and the width of the 'border'.

[[image:image.gif:Some image:center:1]]

Ideally, you should not use the alignment and width parametres. An entry in your style sheet is quicker, and cleaner. So if you choose to use a style sheet to position/style the images, use the following syntax

[[image:image.gif:Some image:class:myclass]]

or

[[image:image.gif:Some image:id:myid]]

to set the class or id for the image. (Then you add entries for 'myclass' or 'myid' to your style sheet.)

Use this to place an image or text-link in your entries, which will open an image in its own window. Parameters used are: 'filename', 'name' of the thumbnail image or text or '(thumbnail)' to insert the thumbnail that Pivot generated, 'alt' attribute, 'alignment' and width of the 'border'.

[[popup:christina.jpg:(thumbnail):x-tina!:center:1]]
[[popup:image.jpg:an image::right:0]]

The best way to control the layout of the image link (thumbnail) is using your stylesheet with the CSS class pivot-popupimage. There is also the CSS class pivot-popuptext used if there is no thumbnail (text link) for the popup image.

Use this to convert a bit of text to uppercase or lowercase. Not very useful.

[[lower:NO uPPERcaSE]]

Use this to insert the weblog's title as defined in Administration » Weblogs.

Use this to insert the weblog's subtitle or tagline, as defined in Administration » Weblogs.

Use this to insert the weblog's name, as used by Pivot to identify it, as defined in Administration » Weblogs.

See: Working with tags

See: Working with tags

See: Working with tags

See: Working with tags

[1.20] Use this to insert the name you defined in Administration » Configuration, field 'Site Name'.

Used to insert localized text fragments. Mostly used in templates/_sub_commentform.html. See langs/pvl_eng.php for examples, under $lang['weblog_text'].

[[label:disclaimer]]

Use this to place a small button with a link to the Pivot site. You can replace the image located at pivot/pics/pivotbutton.png, and this tag will still output the correct HTML, and adjust automatically for any change in size.

Use this to display a button with a link to the weblogs RSS file. You can replace the image located at pivot/pics/rssbutton.png, and this tag will still output the correct HTML, and adjust automatically for any change in size.

Use this to display a button with a link to the weblogs Atom file.You can replace the image located at pivot/pics/atombutton.png, and this tag will still output the correct HTML, and adjust automatically for any change in size.

Use this to insert the URL of the weblogs homepage.

[1.20] A formatted copyright string that creates a floating copyright date. If no year is passed then the copyright date will be the current year. If a year in the past is passed, then a string indicating a copyright that spans the period from that date to now will be returned. Sanity checks block dates before 1999 and after the current year.

[[copyyear:2001]] will print '© 2001-2004'
[[copyyear:2004]] will print '© 2004'

NOTE: this is only available as an extension.. find it here

(wording could be improved)

[1.20] Use this to insert a link to a previously uploaded file that you wish to make available for download to your visitors. The parametres are:

• 'filename' → the name of the file that was uploaded (this is essential);
• 'icon' → takes one of two parametres, 'gif' or 'png'. If one of these is present, the code will attempt to display an image from the pics/ directory that has the same name as the file extension. For example, icon_pdf.gif for a .pdf file. If 'png' is used the function will look for a 'png'-format image file, then, failing that, a 'gif'-format image file. Failing that, it will display a generic 'icon_file.gif' image before giving an error message. The code will include the size attributes automatically and the displayed icon will have a class of:
• 'icon', so that you can act on it in the style sheet;
• 'text' → this will be displayed with the link;
• 'title' → the title text to be displayed inside the tag.

[[download:filename:icon:text:title]]

[1.40] Creates a link to the “self registration” / “create account” page. Optional argument is the link text.

[1.40] Creates a link to the “comment user” / “registered visitor” page. Optional argument is the link text.

[1.20] Link to a file of the following types, doc, .pdf, .txt, .ppt, .pot, .xls, or .mdb , to open in a new window.

• 'filename' is the name of the file;
• 'text' is the information that will be displayed for the link.

[[link:filename:text]]

Creates the URL to an entry. It takes three optional parameters - entry code, query string and weblog ID. If code is not given, the link will be to the currently active entry. To link to entry 11 in the weblog with ID my_weblog use:

<a href="[[entrylink:11::my_weblog]]">...</a>

Always gives the path to the [[pivot_dir]], like /var/www/html/pivot/

Always gives the URL to the [[pivot_dir]], like http://www.example.com/pivot/

[1.30] Always gives the URL to the [[log_dir]], like http://www.example.com/weblog/

[1.20] If you have activated the option Encode Email Addresses in Administration » Create / Edit Weblog, step 3 of 3, then this tag will also encrypt any e-mail that you give it.

• 'email' - a valid e-mail address [required]
• 'display' - the text that will be displayed on the page [required]
• 'title' - complementary information for the link [optional]

[[encrypt_mail:email:display:title]]

These template tags are used to designate special directories on your site, independently of where they are called in your pages/site.

Use this to insert the URL of the template directory. Useful for when you want to include files that are in the templates/ directory.

<link rel="stylesheet" type="text/css" href="[[template_dir]]pivot_template.css" />

Use this to insert the URL of the Pivot dir. Useful for when you want to include files that are in the pivot/ directory.

<script src="[[pivot_dir]]includes/js/dyna_content.js" type="text/javascript"></script>

Use this to link to files in the root directory of your weblog.

<link rel="stylesheet" type="text/css" href="[[log_dir]]mkt_v7.css" />

[1.20] Use this to link to files in the user-defined directory of your Pivot installation. See the doc “Extenstions HowTo” for more information

<script src="[[extensions_dir]]/my_javascript.js" type="text/javascript"></script>

[1.30] Use this to link to files in the user-defined upload/images directory of your Pivot installation. You should consider using [[image]], [[popup]] and [[download]] in stead.

These template tags are usually only used inside the <head> section of your page.

Use this to insert the current charset, like ISO-8859-1.

Use this to insert a <link rel=“alternate” /> tag in the '<head> section of the page, which is used by RSS aggregator software to detect the URL of the RSS feed.

Use this to insert a <link rel=“alternate” /> tag in the <head> section of the page, which is used by Atom aggregator software to detect the URL of the Atom feed.

[1.30] Use it in the frontpage template so blog authoring tools (like Flock) autodetects the metaweblog interface.

Use this to insert the <style> tags for the calendar. Place this in the <head> section of your document.

• See also: [[calendar]]

Use this to insert the URL of the template directory. Useful for when you want to include files that are in the templates/ directory.

[1.40 beta 2] This tag was added with the addition of the Thickbox effect to Pivot popups. All full Pivot distributions since 1.40 beta 2 will have this tag in the <head> section of the frontpage, entrypage and archivepage templates.

If you're upgrading or writing your own templates, just add this tag in the head section of your frontpage, entrypage and archivepage templates, like so:

<head>
  (other stuff goes here..)
  [[thickbox:head]]
</head>

If you were using the lightbox extension before, you should remove any [[lightbox:head]] tags that are present in your templates.

Thickbox requires the jquery javascript library, which means that it isn't compatible with prototype or script.aculo.us. We're sorry, but you can't use thickbox if you're also using one of these. you can use [[popup_old]] instead, which mimics the old behviour.

Note that there is no [[thickbox]] tag. Just use pivot's built in [[popup]] tag.

[1.20] Use this to insert the language as defined in Administration » Configuration » Default language:. Adding the alternate tag 'html' will generate a 'lang=“xx”' where 'xx' is the two-letter language code as defined in the langs/pvl_xx.php for your language - langs/pvl_eng.php for english, for example.

[[lang]]

or

[[lang:html]]

[1.30] Since we are using XHTML in our templates we also need the correct XML syntax for language (in the opening html tag) - use

[[lang:xml]]

These template tags are generally for use in a page template and are not to be used in an entry; the result could be unpredicatable.

Use this to insert the file templates/_aux_link_list.html. Normally this is used to keep an updated list of links to friends or other sites you read.

Use this to insert a list of links to the archives for the current weblog. Option for this can be set in Administration » Weblogs.

Use this to insert a small form that leads to the search output screen. It takes six optional parameters:

1. To display just the input field without a submit button, set to “nobutton”.
2. Button name.
3. Place holder/default value for the input field.
4. Field name/label for the search form.
5. Which weblog to search. Default value is the current weblog. The special value “_all_” will search all weblogs. ([1.30])
6. Which template to use for the search results page. The default is to use the extra template (for the selected weblog). ([1.40])

Examples:

[[search:nobutton]]

which gives just the input field without a button,

[[search::go!]]

which gives a button with “go!” as text, or

[[search::search:::_all_]]

which will search all weblogs (and a button with “search” as text).

In your CSS-file you can use the following rules to style the output:

/* these styles are for the search boxes */
.searchbox, .result-searchbox { 
	width: 10em; 
	font-size: 10px;
}	
.searchbutton, .result-searchbutton {
	border: 1px solid #000;
	font-size: 10px;
}

Use this to define subweblogs in the templates for the frontpage or archivepage. It take three parameters:

• name of the subweblog (mandatory).
• number of entries displayed in the subweblog (optional) - currently ignored.
• order of entries (optional). The default values is 'lasttofirst'. If you need the reverse order (if you are writing in narrative form), use 'firsttolast'.

The first parameter (name) is used in Administration » Weblogs to determine which categories are published in this subweblog.

[[subweblog:linkdump]]
[[subweblog:standard]]
[[subweblog:somename::firsttolast]]

Use this to display a list of the last comments left by visitors. The format is defined under 'Settings for last comments' in Administration » Weblogs.

For the formatting you can use %name%, %title%, %comment% and the regular Date Formatting options.

Use this to display a list of the last referrers. The format is defined under 'Settings for last Referrers' in Administration » Weblogs.

For the formatting you can use %url%, %title% and the regular Date Formatting options.

Put this in the page somewhere. It doesn't produce any output, but it is required to keep track of referers.

livepage Use this to insert the calendar with links to your entries.

Use this to insert an iframe with your blogroll. The format is defined in Administration » Weblogs. You can set the width and height with parameters:

[[blogroll_iframe: 150:400]]

Use this to insert an RSS feed into your file. With parameters you can specify the URL of the feed, the maximum number of elements, the format, the maximum length (of the text for each entry) and the cache age (in seconds). Only the URL is mandatory.

[[rss:http://slashdot.org/slashdot.rss:10:::600]]

will display the 10 latest entries from slashdot, updated every 10 minutes. Another example is

[[rss:http://blogdex.net/xml/index.asp:6:<b><a href="%link%">%title%</a></b><br /> 
 <small>%description%</small><br />]]

[1.20] Use this to insert a (live) list of archives per category - generated on demand according to the parameters that you pass. Normal usage is just

[[livearchive_list]] or [[livearchive_list:::current]]

but the snippet takes four optional parameters as follows

[[livearchive_list:filename:format:weblog:template]]

The default filename is path_to_pivot_directory/archive.php, the default format is

<a href='%file%?c=%cat%&amp;w=%weblogid%&amp;t=%template%'>%cat%</a><br />

the default weblog and default template is empty strings. The snippet produces one line for each category according to the format.

The supported tags in the format is

• %file% - the file/script used to display the category (as set by the filename parameter).
• %catid% - the ID (internal name) of the category to be display, use in the URL (href value).
• %cat% - the name of the category to be display, use in link text.
• %weblogid% - the ID (internal name) of the selected weblog, use in the URL (href value).
• %weblog% - the name of the selected weblog (if any), use in link text.
• %template% - the template (as set by the template parameter).

The weblog parameter can be either “current”, which means to make a list of the categories in the current weblog, or a weblog (internal) name, which means to make a list of all categories in that weblog. An empty weblog parameter, the default, means make a list of all categories registered in Pivot.

This inserts your link to your BBClone web counter.

[[bbclone_counter:reference]]

The value passed in reference can be used to identify the pages, sections or categories that are visited, in order to keep separate totals.

Note: As of Pivot 1.30 this tag has been deprecated. Use [[hardened_bbclone]] instead.

These template tags need to be used in an entry template, or need an entry to refer to, for obvious reasons.

Use this to insert the internal unique number each entry has.

Use this to insert the title of an entry.

Use this to insert the subtitle of an entry.

Use this to insert the introduction of an entry.

Use this to insert the body text of an entry.

Use this to insert a date. Without parameter, this uses the format as specified under 'Entry Date' in Administration » Weblogs, on the third page. With a parameter you can override this format:

[[date:%day% %monthname%]]

For formatting options, see the Date Formatting page.

Use this to insert a date. This uses the format as specified under 'Full Date' in Administration » Weblogs, on the third page. For formatting options, see the Date Formatting page.

Use this to insert a date, but only if the date is different from the date of the previous entry. This uses the format as specified under 'Diff. Date' in Administration » Weblogs, on the third page. For formatting options, see the Date Formatting page.

Use this to insert the category or categories of the entry. An optional parameter can be used to only output the categories that are published in the current weblog.

[[category:onlythisweblog]]

Use this to insert a link to the body text of an entry. If the entry has only an introduction, nothing will be output.

Use this to insert the comments for an entry. The format of the output is defined under 'Format of Comments' in Administration » Weblogs.

[1.30] The snippet takes an optional argument setting the order of the comments, oldest (which is the default) or newest first.

[[comments:descending]]

will output the comments with the newest first. (No argument or ascending will output the oldest first.)

Use this to insert a comment form. Optional argument: The name of the comment form template. The default argument/template is _sub_commentform.html.

[[commentform]]

or

[[commentform:yourcommentform.html]]

Use this to insert links that will allow the visitor to rate an entry, by adding or decreasing the karma score.

[[karma:good:+]] [[karma:bad:-]]

Use this to make a link to this entry on its own page. The snippet takes two arguments

1. Link text
2. Title attribute text

The default value (as of Piovt 1.40) is ”%title%” for both arguments.

Use this to make a link to this entry in the archives. The snippet takes two arguments

1. Link text
2. Title attribute text

The default value (as of Piovt 1.40) is ”%title%” for both arguments.

Use this to make a link to the comments on this entry.

Use this to display the number of comments. The format of this is defined in Administration » Weblogs.

Use this to insert a list of the names of people who left a comment on a particular entry.

Use this to insert a bit of javascript to show the comments on this entry, without leaving the current page. To make this work, you need to do the following:

• Somewhere in the <head> section of your document, you need to include a javascript file (most likely in your frontage.html template):

<script src="[[pivot_dir]]includes/js/dyna_content.js" type="text/javascript"></script>

• Then, where you want the link to appear, insert [[inlinecommentlink]] and where you want the comments themselves, insert [[inlinecomments]] (these go into templates/_sub_entry_standard.html if you're changing the default files):

<div class="entryfooter"> ....  [[inlinecommentlink]] </div>
[[inlinecomments]]

Use this to display information about the author of the entry. Use like this:

[[user]]
[[user:email]]
[[user:emailtonick]]
[[user:nick]]

If you defined more userfields under Administration » Users, you can use these in the templates by simply using [[user:myuserfieldname]], where 'myuserfieldname' is the name you gave the userfield, of course.

Use this to link to the next entry. With parameters you can format the output, and cut off text that is too long:

[[nextentry:<a href='%link%'>to the entry called '%title%'</a>:50]]

Use this to link to the previous entry. With parameters you can format the output, and cut off text that is too long:

[[previousentry:<a href='%link%'>to the entry called '%title%'</a>:50]]

Use this to link to the next entry that is published in the same category (or, if either of them are published in more than one category, the sets should have at least one overlapping category). With parameters you can format the output, and cut off text that is too long:

[[nextentryincategory:<a href='%link%'>to the entry called '%title%'</a>:50]]

Use this to link to the previous entry that is published in the same category (or, if either of them are published in more than one category, the sets should have at least one overlapping category). With parameters you can format the output, and cut off text that is too long:

[[previousentryincategory:<a href='%link%'>to the entry called '%title%'</a>:50]]

Use this to insert a bit of javascript to show the body text of an entry, without leaving the current page. To make this work, you need to do the following:

<script src="[[pivot_dir]]includes/js/dyna_content.js" type="text/javascript"></script>

Then, where you want the link to appear, insert [[inlinemorelink]] and where you want the body text itself, insert [[inlinemore]] (these go into templates/_sub_entry_standard.html if you're changing the default files):

[[introduction]]
[[inlinemorelink]]
[[inlinemore]]

Use this to display a list of the last referers for a single live entry.

Use this to make simple polls.

[[vote:sucks:Polls suck::(%num% votes)]]
[[vote:rocks:Polls rock::(%num% votes)]]
[[vote:pancakes:I like pancakes::(%num% votes)]]

[1.20] Displays the 'via' information from the extended entry form as a title with a link.

Optional parameter which defines the output - [[via:text]]. The default value of “text” is:

<a href='%link%' title='%title%'>via</a>

[1.20] Displays the 'keywords' information from the extended entry form. It takes two optional parameters, the text (containing the %keywords% formatting tag) and the separator between the keywords. Example usage in the entry introduction, body or entry related templates:

[[keywords:This entry covers <em>%keywords%</em>:-]]

Example usage in the HTML head of the entry page template:

<meta name="keywords" content="[[keywords]]" />

Default output corresponds to

[[keywords:%keywords%:, ]]

[1.20] Uses [[code]] to create an anchor/id for this entry in the archives.

[1.20] returns odd, or even. By feeding this into a style tag, you can colour alternating lines in a list of Pivot entries.

This is a link to the entry itself.. like the Pivot equivalent of PHP_SELF.

[1.20] Inserts counts into an entry.

[[entry_data:words:images:downloads]]

word:image:document can be:

• nothing: in this case this information will not be displayed.
• * : in this case, 'word[s]', 'image[s]' and 'document[s]' from the chosen language file will be displayed, and will take the single, or plural form depending on the number.
• anything else: this will pass through and be displayed.

[1.30] Adds a link to the category/categories of the current entry.

[1.30] The edit date of the current entry. Optional argument: Date format - the default is the fulldate format.

[1.30] Link to the editing page for the current entry.

Optional argument: the text to display - the default text is “Edit” translated to the language of the weblog.

[1.30] Count the page with BBclone protected against referer spam. Use it in the body, not the head, of your templates.

Optional argument: Text to be used in the BBclone stats - the default value is 'Pivot page 2006-03', where the last part reflects the current month.

The following format tags are reconginzed in the optional argument:

• %title%,
• %date% (in a monthly format),
• %weblogtitle%,
• %archivetitle% and %tagtitle%.

The last two fall back to %weblogtitle% if not on an archive or tag page respectively.

Note: When you have a large number of entries(1000 or more), do not use a page-specific bbclone counter, since bbclone is not very efficient in dealing with a great number of tracked pages. This will result in a very large access.php file, and an increased chance of corrupting the file.

One way to set up the bbclone tags would be like this:

• Frontpage: [[hardened_bbclone:%weblogtitle%]]
• Archive pages: [[hardened_bbclone:Archive of %weblogtitle%]]
• Entry pages: [[hardened_bbclone:Entry of %weblogtitle% - %date%]]
• In your template for Tags: [[hardened_bbclone:%tagtitle%]]

[1.30] Use it in the frontpage template, if you can't set up checking of the moblog account using a cron job.

[1.30] BBClone stats, hits.

[1.40] BBClone stats, hits for one entry identified by it's title. Typically used on an entry page. It takes two optional parameters

1. Text to be displayed. Formatting tag ”%n%” is replaced with the number of hits. Default value is ”%n visits.”
2. Title of entry. Must match the format you are using for [[hardened_bbclone]]. Default value is ”%title”.

[1.30] BBClone stats, referers.

[1.30] Allows for commentform texarea's to be resizeable on the fly. Used with the Textareatools extension.

[1.30] Use this to insert a bit of javascript to show the trackbacks on this entry, without leaving the current page. To make this work, you need to do the following:

• Somewhere in the section of your document, you need to include a javascript file (most likely in your frontpage template):

<script src="[[pivot_dir]]includes/js/dyna_content.js" type="text/javascript"></script>

• Then, where you want the link to appear, insert [[inlinetrackbacklink]] and where you want the trackbacks themselves, insert [[inlinetrackbacks]] (these go into templates/_sub_entry_standard.html if you're changing the default files):

<div class="entryfooter"> ....  [[inlinetrackbacklink]] </div>
[[inlinetrackbacks]]

[1.30] Use this to insert RDF-code on entrypages (in the entrypage template), which is used by blog authoring software to detect the trackback URL for the entry.

[1.30] Alias for trackautodiscovery

[1.30] Use this to make a link to the trackbacks on this entry.

[1.30] Use this to display the trackbacks for an entry.

[1.30] Use this to display the amount of trackbacks for an entry

[1.30] Use this to insert the trackback URL for the current entry.

[1.30] Use this to insert a list of the names of people who left a trackback to a particular entry.

These template tags are generally used in the comment form.

[1.30] To protect your comments against spam, you can configure Pivot to ask a (silly/easy) question that has to be answered to accept a comment. Use this tag to place the question in the comment form.

The spamquiz tag takes two optional arguments:

[[spamquiz:IntroFormat:QuestionFormat]]

The default values are:

<p><small>%intro%</small><br />

and

<label for="spamquiz_answer"><b>%question%</b></label> &nbsp;
<input type="text" class="commentinput" name="spamquiz_answer" id="spamquiz_answer" %name_value% /></p>

Use this to display remembered information in commentforms. See the file templates/_sub_commentform.html for examples of how to use.

Use this to insert a link to the small emoticons reference. Only displayed if emoticons are enabled.

Use this to insert a link to the small textile reference. Only displayed if Textile is enabled.

This is used to display messages to the visitors when they post or preview a comment. For example: ”Your comment has been stored successfully”.

[1.20] Returns 'registered' if the visitor is a registered user. To be exact, returns 'registered' if the registration information is found in a cookie that was previously set.

Inserts the javascript cookie code to 'remember' information for comments. This is a fallback for [[cookie]].

Use this to make a link to the next archive. With 'next' we mean the first one that's older. With a parameter you can define the output:

[[archivenext:To the next archive!]]

Use this to make a link to the previous archive. With 'previous' we mean the first one that's newer. With a parameter you can define the output:

[[archiveprevious:To the previous archive!]]

This is used to insert a short snippet of javascript, that will allow visitors to close popup windows by pressing the escape key.

These appear in the Pivot source code - however their role is in keeping things sane there, you do not even need to know they exist, but if we don't document them someone will ask questions. Do not use. Consider yourselves warned.

Internal check on page update.

One of the most essential parts of Pivot. Be careful, your site will fail if you even so much as look at this snippet!

Internal alias for weblogtitle.

Internal alias for subweblogtitle.