--- <%= localization_name %>: desc: author: Renders the name of the author of the current page. breadcrumb: Renders the @breadcrumb@ attribute of the current page. breadcrumbs: Renders a trail of breadcrumbs to the current page. The separator attribute specifies the HTML fragment that is inserted between each of the breadcrumbs. By default it is set to @>@. The boolean nolinks attribute can be specified to render breadcrumbs in plain text, without any links (useful when generating title tag). *Usage:*
children-count:
Renders the total number of children.
children-each-child:
Page attribute tags inside of this tag refer to the current child. This is occasionally
useful if you are inside of another tag (like <r:find>) and need to refer back to the
current child.
*Usage:*
...
children-each-header:
Renders the tag contents only if the contents do not match the previous header. This
is extremely useful for rendering date headers for a list of child pages.
If you would like to use several header blocks you may use the @name@ attribute to
name the header. When a header is named it will not restart until another header of
the same name is different.
Using the @restart@ attribute you can cause other named headers to restart when the
present header changes. Simply specify the names of the other headers in a semicolon
separated list.
*Usage:*
...
children-each-if_first:
Renders the tag contents only if the current page is the first child in the context of
a children:each tag
*Usage:*
...
children-each-if_last:
Renders the tag contents only if the current page is the last child in the context of
a children:each tag
*Usage:*
...
children-each-unless_first:
Renders the tag contents unless the current page is the first child in the context of
a children:each tag
*Usage:*
...
children-each-unless_last:
Renders the tag contents unless the current page is the last child in the context of
a children:each tag
*Usage:*
...
children-each:
Cycles through each of the children. Inside this tag all page attribute tags
are mapped to the current child page.
*Usage:*
...
children-first:
Returns the first child. Inside this tag all page attribute tags are mapped to
the first child. Takes the same ordering options as @...
children-last:
Returns the last child. Inside this tag all page attribute tags are mapped to
the last child. Takes the same ordering options as @...
children:
Gives access to a page's children.
*Usage:*
...
comment:
Nothing inside a set of comment tags is rendered.
*Usage:*
...
content:
Renders the main content of a page. Use the @part@ attribute to select a specific
page part. By default the @part@ attribute is set to body. Use the @inherit@
attribute to specify that if a page does not have a content part by that name that
the tag should render the parent's content part. By default @inherit@ is set to
@false@. Use the @contextual@ attribute to force a part inherited from a parent
part to be evaluated in the context of the child page. By default 'contextual'
is set to true.
*Usage:*
cycle:
Renders one of the passed values based on a global cycle counter. Use the @reset@
attribute to reset the cycle to the beginning. Use the @name@ attribute to track
multiple cycles; the default is @cycle@.
*Usage:*
date:
Renders the date based on the current page (by default when it was published or created).
The format attribute uses the same formating codes used by the Ruby @strftime@ function. By
default it's set to @%A, %B %d, %Y@. The @for@ attribute selects which date to render. Valid
options are @published_at@, @created_at@, @updated_at@, and @now@. @now@ will render the
current date/time, regardless of the page.
*Usage:*
escape_html:
Escapes angle brackets, etc. for rendering in an HTML document.
*Usage:*
...
find:
Inside this tag all page related tags refer to the page found at the @url@ attribute.
@url@s may be relative or absolute paths.
*Usage:*
...
if_ancestor_or_self:
Renders the contained elements if the current contextual page is either the actual page or one of its parents.
This is typically used inside another tag (like <r:children:each>) to add conditional mark-up if the child element is or descends from the current page.
*Usage:*
...
if_children:
Renders the contained elements only if the current contextual page has one or
more child pages. The @status@ attribute limits the status of found child pages
to the given status, the default is @"published"@. @status="all"@ includes all
non-virtual pages regardless of status.
*Usage:*
...
if_content:
Renders the containing elements if all of the listed parts exist on a page.
By default the @part@ attribute is set to @body@, but you may list more than one
part by separating them with a comma. Setting the optional @inherit@ to true will
search ancestors independently for each part. By default @inherit@ is set to @false@.
When listing more than one part, you may optionally set the @find@ attribute to @any@
so that it will render the containing elements if any of the listed parts are found.
By default the @find@ attribute is set to @all@.
*Usage:*
...
if_dev:
Renders the containing elements only if Radiant in is development mode.
*Usage:*
...
if_parent:
Renders the contained elements only if the current contextual page has a parent, i.e.
is not the root page.
*Usage:*
...
if_self:
Renders the contained elements if the current contextual page is also the actual page.
This is typically used inside another tag (like <r:children:each>) to add conditional mark-up if the child element is the current page.
*Usage:*
...
if_url:
Renders the containing elements only if the page's url matches the regular expression
given in the @matches@ attribute. If the @ignore_case@ attribute is set to false, the
match is case sensitive. By default, @ignore_case@ is set to true.
*Usage:*
...
link:
Renders a link to the page. When used as a single tag it uses the page's title
for the link name. When used as a double tag the part in between both tags will
be used as the link text. The link tag passes all attributes over to the HTML
@a@ tag. This is very useful for passing attributes like the @class@ attribute
or @id@ attribute. If the @anchor@ attribute is passed to the tag it will
append a pound sign (#
) followed by the value of the attribute to
the @href@ attribute of the HTML @a@ tag--effectively making an HTML anchor.
*Usage:*
or
link text here
markdown:
Filters its contents with the Markdown filter.
*Usage:*
** bold text **
produces
bold text
meta-description:
Emits the page description field in a meta tag, unless attribute
'tag' is set to 'false'.
*Usage:*
meta-keywords:
Emits the page keywords field in a meta tag, unless attribute
'tag' is set to 'false'.
*Usage:*
meta:
The namespace for 'meta' attributes. If used as a singleton tag, both the description
and keywords fields will be output as <meta /> tags unless the attribute 'tag' is set to 'false'.
*Usage:*
navigation-if_first:
Renders the containing elements if the element is the first
in the navigation list
*Usage:*
...
navigation-if_last:
Renders the containing elements if the element is the last
in the navigation list
*Usage:*
...
navigation:
Renders a list of links specified in the @urls@ attribute according to three
states:
* @normal@ specifies the normal state for the link
* @here@ specifies the state of the link when the url matches the current
page's URL
* @selected@ specifies the state of the link when the current page matches
is a child of the specified url
# @if_last@ renders its contents within a @normal@, @here@ or
@selected@ tag if the item is the last in the navigation elements
# @if_first@ renders its contents within a @normal@, @here@ or
@selected@ tag if the item is the first in the navigation elements
The @between@ tag specifies what should be inserted in between each of the links.
*Usage:*
|
page:
Causes the tags referring to a page's attributes to refer to the current page.
*Usage:*
...
parent:
Page attribute tags inside this tag refer to the parent of the current page.
*Usage:*
...
random:
Randomly renders one of the options specified by the @option@ tags.
*Usage:*
...
...
...
rfc1123_date:
Outputs the published date using the format mandated by RFC 1123. (Ideal for RSS feeds.)
*Usage:*
slug:
Renders the @slug@ attribute of the current page.
smarty_pants:
Filters its contents with the SmartyPants filter.
*Usage:*
"A revolutionary quotation."
produces
“A revolutionary quotation.”
snippet:
Renders the snippet specified in the @name@ attribute within the context of a page.
*Usage:*
When used as a double tag, the part in between both tags may be used within the
snippet itself, being substituted in place of @Lorem ipsum dolor...
status:
Prints the page's status as a string. Optional attribute 'downcase'
will cause the status to be all lowercase.
*Usage:*
textile:
Filters its contents with the Textile filter.
*Usage*:
* First
* Second
produces:
- First
- Second
title:
Renders the @title@ attribute of the current page.
unless_ancestor_or_self:
Renders the contained elements unless the current contextual page is either the actual page or one of its parents.
This is typically used inside another tag (like <r:children:each>) to add conditional mark-up unless the child element is or descends from the current page.
*Usage:*
...
unless_children:
Renders the contained elements only if the current contextual page has no children.
The @status@ attribute limits the status of found child pages to the given status,
the default is @"published"@. @status="all"@ includes all non-virtual pages
regardless of status.
*Usage:*
...
unless_content:
The opposite of the @if_content@ tag. It renders the contained elements if all of the
specified parts do not exist. Setting the optional @inherit@ to true will search
ancestors independently for each part. By default @inherit@ is set to @false@.
When listing more than one part, you may optionally set the @find@ attribute to @any@
so that it will not render the containing elements if any of the listed parts are found.
By default the @find@ attribute is set to @all@.
*Usage:*
...
unless_dev:
The opposite of the @if_dev@ tag.
*Usage:*
...
unless_parent:
Renders the contained elements only if the current contextual page has no parent, i.e.
is the root page.
*Usage:*
...
unless_self:
Renders the contained elements unless the current contextual page is also the actual page.
This is typically used inside another tag (like <r:children:each>) to add conditional mark-up unless the child element is the current page.
*Usage:*
...
unless_url:
The opposite of the @if_url@ tag.
*Usage:*
...
url:
Renders the @url@ attribute of the current page.
yield:
Used within a snippet as a placeholder for substitution of child content, when
the snippet is called as a double tag.
*Usage (within a snippet):*
before
after
If the above snippet was named "yielding", you could call it from any Page,
Layout or Snippet as follows:
Content within
Which would output the following:
before
Content within
after
When called in the context of a Page or a Layout, @