Reference an article attached file by name.
filen name will display a link to the file.
<filen name field > will display the given field from the file
record. A field of url will be a URL to the file.
If the file identifier given doesn't exist for the current article the empty string is returned, allowing use as ifFilen.
The result is unspecified if the field specified isn't one of the
image record field names and isn't url.
Iterate over files attached to the current article.
<:file field:> can only access simple attributes.
<:filen - field:> can also access any inline representations.
Iterators over the ancestor tree from the article parent to the root.
Parameters include:
showtop - the top level article is included even if unlisted
listedonly - only listed articles in the tree are included
The default depends on the value of $Constants::UNLISTED_LEVEL1_IN_CRUMBS.
Generate::Article - generates articles.
In your HTML each tag will be preceded by <: and followed by :>
Tags marked as conditional will require a little more. Conditional tags can be used in two ways:
<:ifName args:>true text<:or:>false text<:eif:>
or:
<:if Name args:>true text<:or Name:>false text<:eif Name:>
Tags starting iterator ... are used as iterators, like:
<:iterator begin name:> repeated text <:iterator separator name:> separator text <:iterator end name:>
In general, a parameter which can be any one of 'article', 'parent' or 'section'. In a child iterator it can also be 'child'. In a crumbs iterator it can also be 'crumbs'. If which is missing it means the current article.
Access to fields of the article. See Article attributes.
Access to fields of the parent article. See Article attributes.
Conditional tag, true if there is a parent.
Access to the fields of the section containing the article. See Article attributes.
The title of the article presented as an image if there is a titleImage or as text. See Tag notes for values for which.
Conditional tag, true if the given article has a titleImage,
The thumbnail image as an <img> tag for object which where which is one of the article objects defined. The optional class adds a class attribute to the tag with that class.
Conditional tag, true if the article specified by which has a thumbnail.
Conditional tag, true if the number of children/stepkids/allkids is less or equal to the article's threshold.
The formatted body of the article.
Ignore this one.
Iterates over the ancestors of the article. See the item crumbs.
option can be empty, "listedonly" or "showtop". If empty the display of an unlisted level1 ancestor is controlled by $UNLISTED_LEVEL1_IN_CRUMBS, if "listedonly" then an unlisted level1 article isn't shown in the crumbs, and it is if "showtop" is the option. This can be used in <: ifCrumbs :> too.
Access to the fields of the specific ancestor. name can be any of the Article attributes.
Conditional tag, true if there are any crumbs.
See iterator ... crumbs [option] for information on option.
Conditional tag, true if the article has any children.
Iterates over the children of the article. See the item child.
Access to the fields of the current child.
Produces a processed summary of the current child's body.
Conditional tag, true if there is a previous child. Originally used for generating a move up link, but you can use the moveUp tag for that now.
Conditional tag, true if there is a next child. Originally used to generating a move down link, but you can use the moveDown tag for that now.
Conditional tag, true if the given which is the page currently
being generated. This can be used to apply special formatting if a
level1 or level2 article is the current page.
Iterates over the unnamed images for the given article.
Iterates over all images for the article.
Iterates over the named images for the article.
Iterates over images with names matching the given regular expression. Note that if the expression matches an empty string then unnamed images will be included.
Extracts the given field from the specified image.
which in this can be either an image index to access a specific image, or "-" to access the current image in the images iterator.
The image fields are:
The identifier of the article the image belongs to.
A partial url of the image, relative to /images/.
Alternative text of the image.
dimensions of the image.
the url if any associated with the image
Produces HTML to render the given image.
which can be an image index (1, 2, 3...) to select one of the
images from the current article, or '-' or omitted to select the
current image from the images iterator. If align is present then the
align attribute of the image is set.
If the image has a URL that <a href="...">...</a> will also be generated.
Condition tag, true if an image exists at the given index.
Conditional tag, true if the article has any images.
Conditional tag, true if the article has any named images.
Conditional tag, true if the article has any named images, where the name matches the regular expression.
Conditional tag, true if the article has any unnamed images.
This has been made more general and been moved, see embed child in the Generate manpage.
Tests if the article is dynamically generated.
Toplevel article being generated. This is the page that any articles are being embedded in.
Iterates over the files attached to the article, setting the file tag.
Information from the current file in the files iterator.
The file fields are:
id - identifier for this file
articleId - article this file belongs to
displayName - the filename of the file as displayed
filename - filename of the file as stored on disk,
sizeInBytes - size of the file in bytes.
description - the entered description of the file
contentType - the MIME content type of the file
displayOrder - number used to control the listing order.
forSale - non-zero if the file needs to be paid for to be downloaded.
download - if this is non-zero BSE will attempt to make the browser download the file rather than display it.
whenUploaded - date/time when the file was uploaded.
requireUser - if non-zero the user must be logged on to download this file.
notes - longer descriptive text.
name - identifier for the file for filelink[]
hide_from_list - if non-zero the file won't be listed by the files iterator, but will still be available to filelink[].
Identifies the article.
The identifier of the parent article.
The title of the article. See the title tag
The name of the title image for the article, if any. See the title and ifTitleImage tags.
The body of the article. See the body tag.
The thumbnail image for the article, if any. See the thumbnail tag.
The release and expiry dates of the article.
Any keywords for the article. Indexed by the search engine.
Links to the normal and adminstrative versions of the article. The url tag defined by Generate.pm will select the appropriate tag for the current mode.
The maximum number of articles that should be embeded into the current article for display. See the ifUnderThreshold tag.
The maximum amount of text displayed in the summary of an article. See the summary tag.
The class used to generate the article. Should be one of Generate::Article, Generate::Catalog or Generate::Product.
The level of the article. Sections are level1, etc
How the article is listed. If zero then the article can only be found in a search. If 1 then the article is listed in menus and article contents, if 2 then the article is only listed in article contents.
When the article was last modified. Currently only used for display in search results.
Set the the current admin user logon if access_control is enabled in the cfg.
Set to the current date time when a new article is created.
Set to the current admin user logon if access_control is enabled in the cfg.
A user definable field for attributing the article author.
An alternate article title which can be used to make search engine baited oage titles.
Article metadata description, used as metadata in the generated HTML output.
Article metadata keywords, used as metadata in the generated HTML output.
The following attributes are unlikely to be used in a page:
Used internally to control the ordering of articles within a section.
The position of the first image in the body. The body tag will format images into the body as specified by this tag.
The template used to format the article.
Flags which can be checked by code or template tags to control behaviours specific the the article.
Forces a page to be displayed dynamically with page.pl regardless of access control.
Controls whether the article inherits its parents access controls.
The following tags produce output only in admin mode.
Produces buttons and links used for administering the article.
Generates a move up link if there is a previous child for the current child.
Generates a move down link if there is a next child for the current child.
Produces buttons and links used for administering the article.
This tag can use a specialized template if it's available. If you
call it with a parameter, <:admin template:> then it will use
template admin/adminmenu/template.tmpl. When used in an
article template <:admin:> behaves like <:admin article:>, when used in a catalog template <:admin:> behaves like <
<:admin catalog: >>, when used in a product template <:admin:>
behaves like <:admin product:>. See Admin Menu Templates
for the tags available in admin menu templates.
If the template doesn't exist then the old behaviour applies.
These tags can be used in the templates included by the <:admin:> tag.
The basic template tags and ifUserCan tag can be used in admin menu templates.
Retrieves a field from the current article.
Retrieves a field from the parent of the current article.
Conditional tag, true if the current article has a parent.
Conditional tag, true if the current article is embedded in another article, in this context.