Textpattern CMS Template Tags

Textpattern template tags, the content components, the conditionals.
#anchors

a . article . b . c . category . comment . e . f . file . h . if . image . k . l . link . m . n . o . p . r . s . search . t . v . y

a

<txp:author /> Returns the name of the author of the currently displayed article. (single tag, 3 attributes, 1 e.g.)

<txp:author_email /> Returns the email address of the author of the currently displayed article. (single tag, 2 attributes, 2 e.g.)

article

<txp:article /> Outputs one or more articles depending on the attributes used. (sing/cont tag, 14 attributes, 6 e.g.)

<txp:article_custom /> Provides a variety of custom options for sorting, selecting and displaying articles. (sing/cont tag, 15 attributes, 6 e.g.)

<txp:article_id /> Returns the numeric ID of the article being displayed. (single tag, 0 attributes, 2 e.g.)

<txp:article_image /> Returns an <img src="..." /> HTML tag using the Article image field when the article was posted. (single tag, 8 attributes, 2 e.g.)

<txp:article_url_title /> Returns the dumbed-down "URL title" of the article being displayed. (single tag, 0 attributes, 0 e.g.)

b

<txp:body /> Returns the text, or content, of the article being displayed (the article itself). (single tag, 0 attributes, 1 e.g.)

<txp:breadcrumb /> Used to create breadcrumb navigation. (single tag, 4 attributes, 2 e.g.)

c

<txp:css /> Outputs the URL of the style sheet assigned in the Sections tab. (single tag, 5 attributes, 3 e.g.)

<txp:custom_field /> Used to display the contents of a custom field. (single tag, 3 attributes, 3 e.g.)

category

<txp:category /> Displays category information as defined by the name attribute, or the one currently being viewed. (sing/cont tag, 8 attributes, 4 e.g.)

<txp:category_list /> Used to produce a list of linked categories. (sing/cont tag, 10 attributes, 3 e.g.)

<txp:category1 /> Displays information of the category as defined by Cat1 of the article being displayed. (sing/cont tag, 6 attributes, 3 e.g.)

<txp:category2 /> Displays information of the category as defined by Cat2 of the article being displayed. (sing/cont tag, 6 attributes, 3 e.g.)

comment

<txp:comment_anchor /> Produces an empty anchor tag with an id attribute reflecting the comment ID. (single tag, 0 attributes, 1 e.g.)

<txp:comment_email /> Displays the commenter's email address, if entered at the time of posting. (single tag, 0 attributes, 1 e.g.)

<txp:comment_email_input /> Displays a text entry field to accept the commenter's email address. (single tag, 0 attributes, 1 e.g.)

<txp:comment_id /> Displays the comment's internal id as assigned by Textpattern at the time of posting (single tag, 0 attributes, 1 e.g.)

<txp:comment_message /> Displays the message text, or comment. (single tag, 0 attributes, 1 e.g.)

<txp:comment_message_input /> Displays a text entry field to accept the commenter's message text. (single tag, 0 attributes, 1 e.g.)

<txp:comment_name /> Displays a link using the commenter's name as text. (single tag, 1 attributes, 1 e.g.)

<txp:comment_name_input /> Displays a text entry field to accept the commenter's name. (single tag, 0 attributes, 1 e.g.)

<txp:comment_permlink /> Returns the permanent link of the article comment being displayed. (container tag, 1 attributes, 1 e.g.)

<txp:comment_preview /> Displays a Preview button the user can use to preview the comment text. (single tag, 0 attributes, 1 e.g.)

<txp:comment_remember /> Displays a check box input field, if checked the users details are remembered. (single tag, 0 attributes, 1 e.g.)

<txp:comment_submit /> Displays a Submit button. (single tag, 0 attributes, 1 e.g.)

<txp:comment_time /> Displays the time and date of the comment was submitted. (single tag, 1 attributes, 1 e.g.)

<txp:comment_web /> Displays (a link to) the commenter's web address. (sing/cont tag, 0 attributes, 2 e.g.)

<txp:comment_web_input /> Displays a text entry field to accept the commenter's domain name. (single tag, 0 attributes, 1 e.g.)

<txp:comments /> Displays the comments associated with a particular article. (single tag, 8 attributes, 2 e.g.)

<txp:comments_count /> Displays the number of comments associated with a particular article. (single tag, 0 attributes, 1 e.g.)

<txp:comments_error /> Produces the current comments error. (single tag, 3 attributes, 1 e.g.)

<txp:comments_form /> Used to display a comment form. (single tag, 7 attributes, 3 e.g.)

<txp:comments_help /> Displays a Textile help link (single tag, 0 attributes, 1 e.g.)

<txp:comments_invite /> Displays a link to an article comment form. (single tag, 5 attributes, 1 e.g.)

<txp:comments_preview /> Displays a preview of a visitor's comment. (single tag, 3 attributes, 0 e.g.)

e

<txp:else /> Used within a conditional tag to provide the means to assign default, or alternative behavior. (single tag, 0 attributes, 1 e.g.)

<txp:email /> Returns a mailto: email link, according to the attributes set. (sing/cont tag, 3 attributes, 3 e.g.)

<txp:error_message /> Prints the error message text for the error status as set by the server. (single tag, 0 attributes, 1 e.g.)

<txp:error_status /> Prints the error status as returned by the server. (single tag, 0 attributes, 1 e.g.)

<txp:excerpt /> Used to return the excerpt text. (single tag, 0 attributes, 2 e.g.)

<txp:expires /> Used to indicate when an article should no longer appear in a site. (single tag, 3 attributes, 1 e.g.)

f

<txp:feed_link /> Outputs an XHTML link to the site's articles' RSS or Atom feeds. (sing/cont tag, 6 attributes, 2 e.g.)

file

<txp:file_download /> Produces a file download form. (single tag, 3 attributes, 1 e.g.)

<txp:file_download_author /> Returns the author's name associated with the current download. (single tag, 6 attributes, 0 e.g.)

<txp:file_download_category /> Returns the category of the file to download. (single tag, 3 attributes, 1 e.g.)

<txp:file_download_created /> Returns the upload date of the file to download. (single tag, 1 attributes, 1 e.g.)

<txp:file_download_description /> Returns the description of the file to download. (single tag, 3 attributes, 1 e.g.)

<txp:file_download_downloads /> Returns the number of times the current file has been downloaded. (single tag, 0 attributes, 1 e.g.)

<txp:file_download_id /> Returns the internal ID number of the file to be downloaded. (single tag, 0 attributes, 1 e.g.)

<txp:file_download_link /> Produces a link to a download-able file. (sing/cont tag, 2 attributes, 1 e.g.)

<txp:file_download_list /> Produces a list of download links according to the given attributes. (sing/cont tag, 11 attributes, 1 e.g.)

<txp:file_download_modified /> Returns the last modified date of the file to download. (single tag, 1 attributes, 1 e.g.)

<txp:file_download_name /> Returns the name of the file to download. (single tag, 1 attributes, 1 e.g.)

<txp:file_download_size /> Returns the formated file size of the file to be downloaded. (single tag, 2 attributes, 1 e.g.)

h

<txp:hide /> Suppress the interpretation of all enclosed contents. (container tag, 0 attributes, 2 e.g.)

if

<txp:if_article_author /> Will execute the contained statement if the author name associated with a particular article matches. (container tag, 1 attributes, 1 e.g.)

<txp:if_article_category /> Will execute the contained statement if the category associated with a particular article matches. (container tag, 2 attributes, 3 e.g.)

<txp:if_article_id /> Will execute the contained statement if the article id associated with a particular article matches. (container tag, 1 attributes, 1 e.g.)

<txp:if_article_image /> Will execute the contained statements if an image is associated with the article being displayed. (container tag, 0 attributes, 1 e.g.)

<txp:if_article_list /> Will execute the contained statement if an article list is being displayed. (container tag, 0 attributes, 2 e.g.)

<txp:if_article_section /> Will execute the contained statements if the section associated with a particular article matches. (container tag, 1 attributes, 2 e.g.)

<txp:if_author /> Will execute the contained statements if the called page is the result of an article search by author. (container tag, 2 attributes, 1 e.g.)

<txp:if_category /> Will execute the contained statements if the name attribute matches a category search value. (container tag, 2 attributes, 4 e.g.)

<txp:if_comments /> Will execute the contained statements if there are comments associated with an article. (container tag, 0 attributes, 1 e.g.)

<txp:if_comments_allowed /> Will execute the contained statements if comments are allowed for a given article. (container tag, 0 attributes, 2 e.g.)

<txp:if_comments_disallowed /> Will execute the contained statements if comments are disallowed for a given article. (container tag, 0 attributes, 2 e.g.)

<txp:if_comments_error /> Will execute the contained statements when an error exists with the comments. (container tag, 0 attributes, 1 e.g.)

<txp:if_comments_preview /> Will execute the contained statements if a comment is being previewed. (container tag, 0 attributes, 1 e.g.)

<txp:if_custom_field /> Will execute the contained statements if one or more custom fields for a given article have content. (container tag, 4 attributes, 3 e.g.)

<txp:if_different /> Will execute the contained statement when the value differs from the preceding value. (container tag, 0 attributes, 2 e.g.)

<txp:if_excerpt /> Will execute the contained statements if an excerpt is associated with the article. (container tag, 0 attributes, 1 e.g.)

<txp:if_expired /> Will execute the contained statements if a particular article is expired. (container tag, 0 attributes, 1 e.g.)

<txp:if_expires /> Will execute the contained statements if a particular article has an expiry date set. (container tag, 0 attributes, 1 e.g.)

<txp:if_first_article /> Will execute the contained statements if the displayed article is the first in the currently displayed list. (container tag, 0 attributes, 1 e.g.)

<txp:if_first_category /> Will execute the contained statements if the current category is the first in the currently displayed list. (container tag, 0 attributes, 1 e.g.)

<txp:if_first_section /> Will execute the contained statements if the current section is the first in the currently displayed list. (container tag, 0 attributes, 0 e.g.)

<txp:if_individual_article /> Will execute the contained statements if an individual article is being displayed. (container tag, 0 attributes, 2 e.g.)

<txp:if_keywords /> Will execute the contained statement if the current article's keywords field has one or more entries. (container tag, 1 attributes, 1 e.g.)

<txp:if_last_article /> Will execute the contained statements if the displayed article is the last in the currently displayed list. (container tag, 0 attributes, 1 e.g.)

<txp:if_last_category /> Will execute the contained statements if the current category is the last in the currently displayed list. (container tag, 0 attributes, 0 e.g.)

<txp:if_last_section /> Will execute the contained statements if the current section is the last in the currently displayed list. (container tag, 0 attributes, 0 e.g.)

<txp:if_plugin /> Will execute the contained statements if the name matches a currently installed and enabled plugin. (container tag, 2 attributes, 1 e.g.)

<txp:if_search /> Will execute the contained statements if the called page is the result of a search. (container tag, 0 attributes, 1 e.g.)

<txp:if_search_results /> Will execute the contained statements if the article list contains entries matching the search term. (container tag, 2 attributes, 3 e.g.)

<txp:if_section /> Will execute the contained statements if the called page is part of the section specified. (container tag, 1 attributes, 2 e.g.)

<txp:if_status /> Will execute the contained statements depending on the requested page's HTTP status condition. (container tag, 1 attributes, 1 e.g.)

<txp:if_thumbnail /> Will execute the contained statements if the current image has a thumbnail assigned to it. (container tag, 0 attributes, 1 e.g.)

<txp:if_variable /> Tests the existence and/or value of a global variable set with the variable tag. (container tag, 2 attributes, 0 e.g.)

image

<txp:image /> Returns an <img src="..." /> HTML tag matching the numeric id of an uploaded image. (single tag, 9 attributes, 2 e.g.)

<txp:image_author /> Returns the author's name associated with the current image in a list. (single tag, 6 attributes, 2 e.g.)

<txp:image_date /> Returns the uploaded date of the current (or given) image. (single tag, 3 attributes, 1 e.g.)

<txp:image_display /> Displays an image specified by the page URL. (single tag, 0 attributes, 1 e.g.)

<txp:image_index /> Renders thumbnails of all images contained in an image category. (single tag, 4 attributes, 1 e.g.)

<txp:image_info /> Returns relevant image data from the current image. (single tag, 8 attributes, 3 e.g.)

<txp:image_url /> Returns the URL of the current image in an image list. (sing/cont tag, 4 attributes, 1 e.g.)

<txp:images /> Display simple image galleries from a list of images. (sing/cont tag, 19 attributes, 18 e.g.)

k

<txp:keywords /> Return the keywords associated with the article being displayed. (single tag, 0 attributes, 1 e.g.)

l

<txp:lang /> Returns the 2-letter code of the site's language. (single tag, 0 attributes, 1 e.g.)

<txp:link_feed_link /> Returns an XHTML link to the site's links RSS feed. (single tag, 4 attributes, 1 e.g.)

<txp:link_to_home /> Returns a link to the site's home page. (container tag, 1 attributes, 1 e.g.)

<txp:link_to_next /> Returns the permanent URL of the next article by posting date. (sing/cont tag, 1 attributes, 3 e.g.)

<txp:link_to_prev /> Returns the permanent URL of the previous article by posting date. (sing/cont tag, 1 attributes, 3 e.g.)

link

<txp:link /> Returns an (X)HTML hyperlink defined under the Links tab. (single tag, 1 attributes, 1 e.g.)

<txp:link_author /> Returns the author's name associated with the current link. (single tag, 6 attributes, 0 e.g.)

<txp:link_category /> Returns the link category as text. (single tag, 5 attributes, 1 e.g.)

<txp:link_date /> Returns the date the link was created as text. (single tag, 3 attributes, 1 e.g.)

<txp:link_description /> Returns the text from the Description field as defined under the "links" tab. (single tag, 5 attributes, 1 e.g.)

<txp:link_id /> Returns the numerical ID of the link. (single tag, 0 attributes, 1 e.g.)

<txp:link_name /> Returns the name of the link as assigned on the links pane as text. (single tag, 1 attributes, 1 e.g.)

<txp:link_url /> Returns the URL of the link as text. (single tag, 0 attributes, 1 e.g.)

<txp:linkdesctitle /> Returns an (X)HTML hyperlink to a link. (single tag, 1 attributes, 1 e.g.)

<txp:linklist /> Produces a list of links from the predefined list created on the Links tab. (sing/cont tag, 9 attributes, 3 e.g.)

m

<txp:meta_author /> Retruns an HTML meta tag with the Author's name. (single tag, 1 attributes, 1 e.g.)

<txp:meta_keywords /> Returns an HTML meta tag with the Article's keywords. (single tag, 0 attributes, 1 e.g.)

<txp:modified /> Returns the modfication date of the article being displayed. (single tag, 3 attributes, 2 e.g.)

n

<txp:newer /> Returns an XHTML link to the next list of articles in the sort order. (sing/cont tag, 1 attributes, 4 e.g.)

<txp:next_title /> Returns the title of the next article in the sort order. (single tag, 0 attributes, 1 e.g.)

o

<txp:older /> Returns an XHTML link to the next list of articles in the sort order. (sing/cont tag, 1 attributes, 4 e.g.)

<txp:output_form /> Replaces tag with the content resulting from the form called by the tag. (sing/cont tag, 1 attributes, 3 e.g.)

p

<txp:page_title /> Displays page title text depending on the context it is used. (single tag, 1 attributes, 1 e.g.)

<txp:page_url /> Returns a particular component of the url from the current page being displayed. (single tag, 1 attributes, 1 e.g.)

<txp:password_protect /> Protects a site or page by prompting a user for username and password. (single tag, 2 attributes, 1 e.g.)

<txp:permlink /> Returns the permanent url of the article being displayed. (sing/cont tag, 4 attributes, 3 e.g.)

<txp:php /> Insert PHP code into your pages and forms (the safe way). (container tag, 0 attributes, 2 e.g.)

<txp:popup /> Produces a popup selector for browsing by section or category. (single tag, 3 attributes, 2 e.g.)

<txp:posted /> Returns the publish date of the article being displayed. (single tag, 5 attributes, 3 e.g.)

<txp:prev_title /> Returns the title of the previous article in the sort order. (single tag, 0 attributes, 1 e.g.)

r

<txp:recent_articles /> Produces a list of permanent links to recent articles by title. (single tag, 5 attributes, 3 e.g.)

<txp:recent_comments /> Produces a list of permanent links to recent comments. (sing/cont tag, 3 attributes, 2 e.g.)

<txp:related_articles /> Produces a list of related (by category) articles. (sing/cont tag, 6 attributes, 3 e.g.)

<txp:rsd /> Inserts a Really Simple Discoverability link element. (single tag, 0 attributes, 0 e.g.)

s

<txp:section /> Displays information about the current or named section. (sing/cont tag, 6 attributes, 4 e.g.)

<txp:section_list /> Produces a list of linked sections. (sing/cont tag, 7 attributes, 3 e.g.)

<txp:site_name /> Returns the site's name as defined under the Basic Preferences tab. (single tag, 0 attributes, 1 e.g.)

<txp:site_slogan /> Displays the site's tagline (labeled as Site tagline in the Basic Preferences). (single tag, 0 attributes, 2 e.g.)

<txp:site_url /> Returns the full URL of the site. (single tag, 0 attributes, 3 e.g.)

search

<txp:search_input /> Provides a text entry field for search parameters. (single tag, 6 attributes, 2 e.g.)

<txp:search_result_count /> Returns the number of articles found by a search. (single tag, 1 attributes, 3 e.g.)

<txp:search_result_date /> Provides the article posted date as returned by the search function. (single tag, 0 attributes, 1 e.g.)

<txp:search_result_excerpt /> Shows the occurence of the search term with some surrounding context. (single tag, 3 attributes, 1 e.g.)

<txp:search_result_title /> Provides a hyperlinked title to an article as returned by the search function. (single tag, 0 attributes, 1 e.g.)

<txp:search_result_url /> Provides a hyperlinked URL to an article as returned by the search function. (single tag, 0 attributes, 1 e.g.)

<txp:search_term /> Returns the expression the user searched for through the full text search form. (single tag, 1 attributes, 1 e.g.)

t

<txp:text /> Returns localized language strings from the txp_lang database table. (single tag, 1 attributes, 1 e.g.)

<txp:thumbnail /> Returns the thumbnail of an uploaded image. (single tag, 10 attributes, 1 e.g.)

<txp:title /> Returns the title of the article being displayed. (single tag, 1 attributes, 2 e.g.)

<txp:txp_die /> Terminates normal page rendition and returns the given status to the user agent. (single tag, 2 attributes, 1 e.g.)

v

<txp:variable /> Sets or returns a user-defined global variable. (sing/cont tag, 2 attributes, 3 e.g.)

y

<txp:yield /> Returns the inner content of the enclosing <txp:output_form> tag. (single tag, 0 attributes, 1 e.g.)