4481 lines
290 KiB
HTML
4481 lines
290 KiB
HTML
<!DOCTYPE html
|
||
SYSTEM "about:legacy-compat">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" id="site">
|
||
<head xmlns:nav="http://ccm.redhat.com/navigation">
|
||
<meta name="generator" content=" "></meta>
|
||
<meta http-equiv="content-language" content="en"></meta>
|
||
<title>
|
||
Foundry Documentation
|
||
|
||
</title>
|
||
<meta http-equiv="content-type" content="text/html;charset=utf-8"></meta>
|
||
<link rel="stylesheet" type="text/css" href="styles/foundry-doc.css"></link>
|
||
<link href="/home/jensp/pwi/libreccm/ccm/trunk/ccm-core/web/themes/foundry/images/favicon.png" type="image/png" rel="shortcut icon"></link>
|
||
</head>
|
||
<body xmlns:nav="http://ccm.redhat.com/navigation" id="site-body">
|
||
<header>
|
||
<div class="border-wrapper">
|
||
The Foundry Theming Engine for LibreCCM
|
||
|
||
</div>
|
||
</header>
|
||
<div id="title-page">
|
||
<h1>The Foundry Theme Engine for LibreCCM</h1>
|
||
</div>
|
||
<nav>
|
||
<ul class="chapter-list">
|
||
<li class="chapter-entry"><a href="#overview">Overview</a><ul class="section-list">
|
||
<li class="section-entry"><a href="#overview">About Foundry</a></li>
|
||
<li class="section-entry"><a href="#this-manual">This manual</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="chapter-entry"><a href="#user-manual">User Manual</a><ul class="section-list">
|
||
<li class="section-entry"><a href="#about-foundry">General structure</a></li>
|
||
<li class="section-entry"><a href="#layout-templates">Layout templates</a></li>
|
||
<li class="section-entry"><a href="#css-files">CSS files</a></li>
|
||
<li class="section-entry"><a href="#template-tags-reference">Templates Tags Reference</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="chapter-entry"><a href="#developer-manual">Developer Manual</a><ul class="section-list">
|
||
<li class="section-entry"><a href="#foundry-structure">The structure of Foundry</a></li>
|
||
<li class="section-entry"><a href="#coding-style">Coding style</a></li>
|
||
<li class="section-entry"><a href="#tutorial-content-types">Adding support for content types</a></li>
|
||
<li class="section-entry"><a href="#doc-system">The documentation system of Foundry</a></li>
|
||
<li class="section-entry"><a href="#function-reference">XSL Templates and Function references</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</nav>
|
||
<main id="startcontent">
|
||
<article id="overview">
|
||
<h1>Overview</h1>
|
||
<section id="overview">
|
||
<h1>About Foundry</h1>
|
||
<main xmlns="">
|
||
<p>
|
||
Foundry is a theme engine for the LibreCCM family of Content Management systems, for
|
||
example ScientificCMS and APLAWS+. Some parts of based on the Mandalay theme engine
|
||
developed by Sören Bernstein for ScientificCMS.
|
||
|
||
</p>
|
||
<p>
|
||
With Foundry the designer has full control of the HTML created from the content managed
|
||
by CCM. The templates for defining the HTML are almost plain HTML (in XML syntax) with
|
||
some additional elements which provide the data to display.
|
||
|
||
</p>
|
||
</main>
|
||
</section>
|
||
<section id="this-manual">
|
||
<h1>This manual</h1>
|
||
<main xmlns="">
|
||
<p>
|
||
This manual is separated into two parts. The <a href="#user-manual">first part</a> is
|
||
for designers and administrators (called users in the context of this manual). It
|
||
describes the structure of the templates in Foundry, how CSS files are implemented
|
||
and how Frameworks like <a href="http://getbootstrap.com">Bootstrap</a>,
|
||
<a href="http://www.yaml.de">YAML</a> or <a href="http://jquery.com">jQuery</a>
|
||
can be integrated into a Foundry theme. The first part also contains a reference
|
||
part which describes all elements/tags which can be used in the templates.
|
||
If you are viewing this documentation using an URL like
|
||
<code>/themes/foundry/doc/</code> this reference is created on the fly from the
|
||
XSL files.
|
||
|
||
</p>
|
||
<p>
|
||
The <a href="#developer-manual">second part</a> is for developers which want to
|
||
extend Foundry. It describes the
|
||
structure of Foundry, how support for content types (the most common task) can be
|
||
added, how the documentation system works and which XPath functions and XSL helper
|
||
templates are available. Developers should also read the first part because the
|
||
first part includes informations about the general structure of Foundry.
|
||
|
||
</p>
|
||
<p>
|
||
In the manual the following terms a used quite often:
|
||
|
||
</p>
|
||
<dl>
|
||
<dt>context prefix</dt>
|
||
<dd>
|
||
The context in which CCM is installed in the Servlet container. If CCM is
|
||
installed in the root context the context prefix is empty.
|
||
|
||
</dd>
|
||
<dt>theme prefix</dt>
|
||
<dd>
|
||
The URL part of accessing resources inside the theme. For example for theme
|
||
called <code>foo</code> the theme prefix is
|
||
<code>/themes/published-themedir/foo</code> is published theme is used an if
|
||
CCM is installed in the root context.
|
||
|
||
</dd>
|
||
<dt>dispatcher prefix</dt>
|
||
<dd>
|
||
The URL for creating links to other CCM resources like content items. Depends
|
||
on the context in which CCM is installed and if development theme or the
|
||
published theme is used.
|
||
|
||
</dd>
|
||
<dt>data tree</dt>
|
||
<dd>The XML created by CCM containing all data of the current page.</dd>
|
||
<dt>Layout tree</dt>
|
||
<dd>The XML of layout template in processing.</dd>
|
||
</dl>
|
||
</main>
|
||
</section>
|
||
</article>
|
||
<article id="user-manual">
|
||
<h1>User Manual</h1>
|
||
<section id="about-foundry">
|
||
<h1>General structure</h1>
|
||
<main xmlns="">
|
||
<p>
|
||
There some options for using Foundry. The easiest way is to use a version/package of
|
||
LibreCCM which includes Foundry. In this case Foundry is installed in the
|
||
<code>/themes/foundry</code> folder. There should also be a second folder named
|
||
<code>/themes/foundry-base</code> which includes a basic child theme.
|
||
|
||
</p>
|
||
<p>
|
||
Foundry supports a an parent/child theme approach. This means that the logic
|
||
part of Foundry (the XSL part) is only installed in <code>/themes/foundry</code> and
|
||
is updated together with the normal upgrades of CCM. A child only contains
|
||
the templates, CSS files, static texts and configurations files for a theme. Custom
|
||
extensions are not supported yet.
|
||
|
||
</p>
|
||
<p>
|
||
A complete Foundry theme consists of the following top level folders and files:
|
||
|
||
</p>
|
||
<dl id="foundry-structure-folders">
|
||
<dt>conf</dt>
|
||
<dd>Contains configuration files for the theme</dd>
|
||
<dt>doc</dt>
|
||
<dd>Static parts of the documentation of Foundry, for example this text</dd>
|
||
<dt>fonts</dt>
|
||
<dd>Web fonts for the theme</dd>
|
||
<dt>foundry</dt>
|
||
<dd>
|
||
This folder contains the logic parts (the XSL) of Foundry. The internal
|
||
structure is described in the <a href="#developer-manual">Developer Manual</a>.
|
||
|
||
</dd>
|
||
<dt>images</dt>
|
||
<dd>Static images for the theme</dd>
|
||
<dt>libs</dt>
|
||
<dd>
|
||
Additional JavaScript libraries. jQuery and some other JavaScript libraries are
|
||
provided by CCM itself, and can be
|
||
included using special elements like the
|
||
<a href="#load-jquery"><code>load-jquery</code></a> element.
|
||
|
||
</dd>
|
||
<dt>scripts</dt>
|
||
<dd>JavaScripts needed in the theme. </dd>
|
||
<dt>styles</dt>
|
||
<dd>
|
||
The CSS styles for the theme. More information about them can be found in the
|
||
<a href="#css-files">CSS files</a> section.
|
||
|
||
</dd>
|
||
<dt>templates</dt>
|
||
<dd>
|
||
The layout templates for the theme. A detailed description can be found in the
|
||
<a href="#layout-templates">Layout templates</a> section.
|
||
|
||
</dd>
|
||
<dt>texts</dt>
|
||
<dd>Static texts for the theme</dd>
|
||
<dt>user</dt>
|
||
<dd>Custom extensions (XSL) for theme. Not supported yet.</dd>
|
||
</dl>
|
||
<p>
|
||
Foundry also supports a parent – child – grandchild structure. This is
|
||
maybe useful
|
||
when you have themes which only differ in details like logos but use the same
|
||
general structure. Most tags which are used to include resources like images,
|
||
CSS files etc. support the attribute <code>origin</code> which can have three
|
||
values:
|
||
|
||
</p>
|
||
<dl>
|
||
<dt>Not set</dt>
|
||
<dd>The resource is loaded from the current theme</dd>
|
||
<dt><code>master</code></dt>
|
||
<dd>
|
||
If the current theme is a master/parent theme the resource is loaded from the
|
||
current theme. If the current theme is a child theme the resource is loaded
|
||
from the master theme.
|
||
|
||
</dd>
|
||
<dt><code>internal</code></dt>
|
||
<dd>
|
||
The file is loaded from the <code>foundry</code>. If the theme is a child
|
||
theme is file is loaded from the Foundry master in <code>/themes/foundry</code>.
|
||
|
||
</dd>
|
||
</dl>
|
||
<p>
|
||
The recommend way for creating a team using Foundry is to create a new child theme:
|
||
|
||
</p>
|
||
<ol>
|
||
<li>To do so create a new theme using the CCM Theme director.</li>
|
||
<li>
|
||
Copy the contents of the <code>themes/foundry-base</code> folder to the folder
|
||
created by the new theme
|
||
in <code>themes/devel-themedir/</code>.
|
||
|
||
</li>
|
||
<li>
|
||
Customise the theme
|
||
|
||
</li>
|
||
</ol>
|
||
</main>
|
||
</section>
|
||
<section id="layout-templates">
|
||
<h1>Layout templates</h1>
|
||
<main xmlns="">
|
||
<p>
|
||
The layout templates are used by the web designer to create the HTML of the web
|
||
page. With Foundry the designer has almost complete control over the HTML. Despite
|
||
the elements which correspond to HTML 5 elements most other elements which can
|
||
be used in the templates do not create HTML. A complete list of the elements which
|
||
can be used in the layout templates can be found in the
|
||
<a href="#template-tags-reference">Template Tags Reference</a>.
|
||
|
||
</p>
|
||
<p>
|
||
Which template is used is decided by Foundry using the definitions in the
|
||
<code>conf/templates</code> file. The top layer of templates which are parsed first
|
||
are the application layouts. Which layout is used for a application is decided by
|
||
Foundry using the <code>application</code> and <code>class</code> attributes of
|
||
of <code>bebop:page</code> element in the data tree. The values of these attributes
|
||
a set in the Java code or in the JSP templates used.
|
||
|
||
|
||
</p>
|
||
<h2>Application layout templates</h2>
|
||
<h3>How Foundry determines which application layout template to use</h3>
|
||
<p>
|
||
Which template is used for which application is determined using the
|
||
<code>applications</code> section in the <code>conf/templates.xml</code> file.
|
||
The <code>applications</code> element may contain any number of
|
||
<code>application</code> elements. Each application element can have three
|
||
attributes:
|
||
|
||
</p>
|
||
<dl>
|
||
<dt><code>name</code> (mandatatory)
|
||
</dt>
|
||
<dd>
|
||
The name of the application which is the value of the <code>application</code>
|
||
attribute from the data tree. To associate applications which do not set the
|
||
<code>application</code> attribute in the data tree the value <code>none</code>
|
||
can be used.
|
||
|
||
</dd>
|
||
<dt><code>class</code> (optional)
|
||
</dt>
|
||
<dd>
|
||
The class of the application page shown. This is the value of the
|
||
<code>class</code> attribute from the data tree.
|
||
|
||
</dd>
|
||
<dt><code>origin</code> (optional)
|
||
</dt>
|
||
<dd>
|
||
The origin of the template. In the default theme this is used to associate
|
||
the backend applications which like the content center with the
|
||
internal <code>admin-layout.xml</code> template provided by Foundry. It can also
|
||
be used to associate an application with an layout template from the parent
|
||
theme.
|
||
|
||
</dd>
|
||
</dl>
|
||
<p>
|
||
The <code>applications</code> element in the <code>conf/templates.xml</code> file
|
||
should also contain a <em>single</em> single default element which defines which
|
||
layout template should be used when no other matches.
|
||
|
||
</p>
|
||
<p>
|
||
Foundry tries to find the layout template to use as follows:
|
||
|
||
</p>
|
||
<ul>
|
||
<li>
|
||
If there an <code>application</code> element where both <code>name</code> and
|
||
<code>class</code> match the values from the data tree this template is used.
|
||
|
||
</li>
|
||
<li>
|
||
Otherwise Foundry checks if there is an <code>application</code> element
|
||
without a <code>class</code> attribute where value of the <code>name</code>
|
||
attribute matches the value from the data tree.
|
||
|
||
</li>
|
||
<li>
|
||
If this also fails and there is a <code>default</code> element the template
|
||
from the <code>default</code> element is used.
|
||
|
||
</li>
|
||
<li>
|
||
If there is no <code>default</code> element the internal default layout template
|
||
is used.
|
||
|
||
</li>
|
||
</ul>
|
||
<h3>The structure of a application layout template</h3>
|
||
<p>
|
||
An layout template is a normal XML file. The root element is the
|
||
<a href="#page-layout"><code>page-layout</code></a> element.
|
||
The first child should be a <a href="#head">head</a> element. The <code>head</code>
|
||
element is equivalent of the HTML head element. Inside the <code>head</code>
|
||
element the title of (the string shown as title of the browser window) can
|
||
be determined using the <a href="#title"><code>title</code></a> element. Also
|
||
the <code>head</code> is the place to load the CSS and JavaScript files and where
|
||
to put meta informations.
|
||
|
||
</p>
|
||
<p>
|
||
After the <code>head</code> there should be a <a href="#body"><code>body</code></a>
|
||
element. Inside the <code>body</code> element the HTML structure is defined.
|
||
At some point you may want to insert the content of a content item or of a Portlet.
|
||
This is done using elements like <a href="#content-item"><code>content-item</code></a> element
|
||
or
|
||
<a href="#portal-grid-workspace-column-portlets"><code>portal-grid-workspace-column-portlets</code></a>.
|
||
The layout of the individual content item or Portlet is defined in separate
|
||
templates.
|
||
|
||
</p>
|
||
<h2>Content Item layout templates</h2>
|
||
<p>
|
||
The content layout templates which are found in the
|
||
<code>templates/content-items</code> folder are used to create the HTML for
|
||
content items in the list, link and detail views. Which template is used for which
|
||
content item is determined using the <code>content-items</code> section in the
|
||
<code>conf/templates.xml</code> file.
|
||
|
||
</p>
|
||
<h3>Selecting the Content Item layout template to use</h3>
|
||
<p>
|
||
The <code>content-items</code> element in the <code>conf/templates.xml</code> file
|
||
has three sub elements: <code>detail</code>, <code>link</code> and
|
||
<code>list</code>. The <code>content-item</code> elements in these elements are
|
||
determining which template is used for which content type. There are several
|
||
attributes for selecting the template. For a description of the available attributes
|
||
please refer to the documentation of the
|
||
<a href="#content-item"><code>content-item</code></a> tag.
|
||
|
||
</p>
|
||
<h3>Structure of a Content Item layout template</h3>
|
||
<p>
|
||
Like the application layout templates a content item layout template is a XML file.
|
||
The root element is the <code>content-item-layout</code> element. Inside this
|
||
element all HTML producing elements can be used. For some content types there are
|
||
special elements for outputting special properties. For example the for news item
|
||
there is an elements <a href="#news-date"><code>news-date</code></a> which outputs
|
||
the date of a news. This element also provides an interface for designer to
|
||
customise the format in which the date is shown. There is is also an general tag
|
||
<a href="#show-property"><code>show-property</code></a> which can be used to
|
||
create a basic template for an unsupported content type.
|
||
|
||
</p>
|
||
<h2>Portlet templates</h2>
|
||
<p>
|
||
For Portlets the system is similar to the system for content items. Which template
|
||
is used for a specific Portlet is determined using the child elements of the
|
||
<code>portlets</code> element in the <code>conf/templates.xml</code> file. The
|
||
<code>portlet</code> elements which contain the path of the template to use can have
|
||
two child elements:
|
||
|
||
</p>
|
||
<dl>
|
||
<dt>class</dt>
|
||
<dd>
|
||
The class name of the Portlet.
|
||
|
||
</dd>
|
||
<dt>workspace</dt>
|
||
<dd>
|
||
The name of the workspace in which the Portlet is shown.
|
||
|
||
</dd>
|
||
</dl>
|
||
<p>
|
||
Foundry first tries to find a match for both <code>class</code> and
|
||
<code>workspace</code>. If there is no matching <code>portlet</code> element in
|
||
<code>conf/templates.xml</code> Foundry tries to find a match for the class name
|
||
only. If this also fails it used the templates defined in
|
||
<code>portlets/default</code> in the <code>conf/templates.xml</code> file.
|
||
|
||
</p>
|
||
<p>
|
||
The root element of a Portlet layout template is the <code>portlet-layout</code>
|
||
element. Inside this element all HTML elements can be used. For each Portlet type
|
||
there will be least on specific element which outputs the content of the Portlet.
|
||
|
||
</p>
|
||
</main>
|
||
</section>
|
||
<section id="css-files">
|
||
<h1>CSS files</h1>
|
||
<main xmlns="">
|
||
<p>
|
||
The system for loading CSS files is similar to the system for finding layout
|
||
templates. Which CSS files are loaded for a page is determined by the
|
||
<code>conf/css-files.xml</code>. The root element of this file is an
|
||
<code>css-files</code> element. This element has multiple <code>application</code>
|
||
child elements. Each <code>application</code> has an mandatory attribute
|
||
<code>name</code> which contains the name of the application for which the CSS files
|
||
named in the element are loaded. To further distinguish between pages provided by the
|
||
same application the optional attribute <code>class</code> can be used.
|
||
There should be also an <code>default</code>
|
||
element which determines the CSS files to load when no matching
|
||
<code>application</code> element is found.
|
||
|
||
</p>
|
||
<p>
|
||
Some pages have no application name in the data tree XML. In this cases to name of
|
||
the application is set to <code>none</code>.
|
||
|
||
</p>
|
||
<p>
|
||
Each <code>application</code> element and the <code>default</code> element
|
||
in <code>css-files.xml</code> can contain multiple <code>css-file</code> element.
|
||
Each of the <code>css-file</code> elements defines a single XML to load.
|
||
|
||
</p>
|
||
<p>
|
||
The <code>css-file</code> element has two optional attributes:
|
||
|
||
</p>
|
||
<dl>
|
||
<dt>media</dt>
|
||
<dd>
|
||
The media type, for example <code>screen</code> or <code>print</code> for
|
||
which the CSS file is used. The value of this attribute will appear in the
|
||
media attribute of the <code>link</code> element which is generated in the HTML
|
||
to load the CSS file.
|
||
|
||
</dd>
|
||
<dt>origin</dt>
|
||
<dd>
|
||
The origin of the CSS file. If not set the file is loaded from the current
|
||
theme. If set to <code>master</code> the file is loaded from the master theme
|
||
if the current theme is a child theme. If set to <code>internal</code> the
|
||
file is loaded from the internal directory for CSS files, either from the
|
||
current theme (if the current theme is a master theme) or from the Foundry
|
||
master theme installed at <code>/themes/foundry</code>.
|
||
|
||
</dd>
|
||
</dl>
|
||
</main>
|
||
</section>
|
||
<section id="template-tags-reference">
|
||
<h1>Templates Tags Reference</h1>
|
||
<section id="user-lib-template-parser.xsl">
|
||
<h1>Root template tags</h1>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
These tags are the root elements of a layout template.
|
||
|
||
</p>
|
||
<section id="fragment-layout" class="template-tag">
|
||
<h1>fragment-layout</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Root element for generating a HTML fragment instead of a complete HTML document.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="include" class="template-tag">
|
||
<h1>include</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
This element allows it to include template fragments into a template. The element
|
||
has two attributes. The <code>file</code> attribute is mandatory and contains
|
||
the path the fragment to include, relative to the <code>template</code> directory.
|
||
The <code>internal</code> attribute is optional. If set to <code>true</code> the
|
||
fragment is loaded from the internal template directory.
|
||
|
||
</p>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
For example <code><include file="fragments/footer.xml"<</code> will include
|
||
the file <code>templates/fragments/footer.xml</code>. If the <code>internal</code>
|
||
attribute is set to <code>true</code> the file
|
||
<code>foundry/templates/fragments/footer.xml</code> would be included.
|
||
|
||
</p>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
An fragment template file included using this element using this element must
|
||
contain a <code>fragment-layout</code> element as root.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>file</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Path of the file to include, relative to the <code>templates</code> directory.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>internal</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
If set to <code>true</code> the template fragment file is loaded from the
|
||
internal template directory.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</section>
|
||
<section id="insert-block" class="template-tag">
|
||
<h1>insert-block</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The element is used in a master layout to insert a block
|
||
from an extending template.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="page-layout[./@extends]" class="template-tag">
|
||
<h1>page-layout[./@extends]</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Root element of an extending template. The <code>extends</code>
|
||
attribute is required and points to the template which is
|
||
extended by the layout. Only the <code>block</code> elements
|
||
in the layout are processed. The master layout must contain
|
||
matching <code>insert-block</code> elements.
|
||
|
||
</p>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Technically the master template is processed first and the
|
||
extending layout is passed as parameter. The master layout
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul></ul>
|
||
</div>
|
||
</section>
|
||
<section id="page-layout[not(./@extends)]" class="template-tag">
|
||
<h1>page-layout[not(./@extends)]</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Root element of a template. Generates the
|
||
<code><html></code> root element.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-template-tags-content-items.xsl">
|
||
<h1>Tags for displaying Content Items</h1>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
These tags are common tags for displaying Content Items. For most Content Types
|
||
there are special tags provided by other files.
|
||
|
||
</p>
|
||
<section id="user-content-items-article.xsl">
|
||
<h1>Tags for ccm-cms-types-article</h1>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The tags in these file are used to display the content
|
||
elements of ccm-cms-types-article.
|
||
|
||
</p>
|
||
<section id="/content-item-layout//lead-text" class="template-tag">
|
||
<h1>/content-item-layout//lead-text</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the lead text of a article.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//main-text" class="template-tag">
|
||
<h1>/content-item-layout//main-text</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the main text of a article.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-content-items-assets-related-links.xsl">
|
||
<h1></h1>
|
||
<section id="related-link//internal//target-item-title" class="template-tag">
|
||
<h1>related-link//internal//target-item-title</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the title of the target item of an internal related
|
||
link.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="related-link//related-link-desc" class="template-tag">
|
||
<h1>related-link//related-link-desc</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the description of a related link.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="related-link//related-link-title" class="template-tag">
|
||
<h1>related-link//related-link-title</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the title of a related link.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="related-links" class="template-tag">
|
||
<h1>related-links</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Root element to create the list of related links assigned to an
|
||
content item
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="related-links//related-link" class="template-tag">
|
||
<h1>related-links//related-link</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
This tag wraps the HTML to display a single related link. The
|
||
tag also adds the parameters required to create the link into
|
||
the environment, for example the URL (href) of the related link.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-content-items-decisiontree.xsl">
|
||
<h1>Tags for displaying a Decisiontree item</h1>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The tags are used to configure the output of the decisiontree item. For technical
|
||
reasons it is not yet possible to customise the HTML for the decisiontree
|
||
completely.
|
||
|
||
</p>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
For title and description of the decisiontree the standard tags can be used.
|
||
|
||
</p>
|
||
<section id="/content-item-layout//decisiontree-current-section" class="template-tag">
|
||
<h1>/content-item-layout//decisiontree-current-section</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Root element for outputting the current section of a decisiontree.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
Outputs the options for the current section of a decisiontree. This tag outputs
|
||
a complete HTML form because the current implementation of the decisiontree does not
|
||
provide enough information in the XML to support a fully customisable HTML.
|
||
|
||
Nevertheless this it is possible to customise the classes set on various of the HTML
|
||
in the created form using subelements:
|
||
class-form
|
||
Classes for the form itself.
|
||
class-formgroup
|
||
Classes to set on the div surrouding each pair of a label and an
|
||
input element.
|
||
class-label
|
||
Classes to set on each label.
|
||
class-input
|
||
Classes to set on each input element.
|
||
class-buttons
|
||
Classes to set on the div surrounding the submit and cancel button.
|
||
class-cancel
|
||
Classes to set on the cancel button.
|
||
class-submit
|
||
Classes to set on the submit button.
|
||
|
||
<section id="decisiontree-current-section//section-instructions" class="template-tag">
|
||
<h1>decisiontree-current-section//section-instructions</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the instructions for the current section of a decisiontree.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="decisiontree-current-section//section-title" class="template-tag">
|
||
<h1>decisiontree-current-section//section-title</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the title of the current section of a decisiontree.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-content-items-image.xsl">
|
||
<h1>
|
||
Tags for displaying the properties of ccm-cms-types-image
|
||
|
||
</h1>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The file provides tags for displaying the special properties
|
||
of ccm-cms-types-image.
|
||
|
||
</p>
|
||
<section id="/content-item-layout//image-artist" class="template-tag">
|
||
<h1>/content-item-layout//image-artist</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>artist</code> property.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-copyright" class="template-tag">
|
||
<h1>/content-item-layout//image-copyright</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>copyright</code> property.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-description" class="template-tag">
|
||
<h1>/content-item-layout//image-description</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>description</code> property.
|
||
This is equivalent to the lead text of an article.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-height" class="template-tag">
|
||
<h1>/content-item-layout//image-height</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the height in pixel of the image.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-license" class="template-tag">
|
||
<h1>/content-item-layout//image-license</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>license</code> property.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-maintext" class="template-tag">
|
||
<h1>/content-item-layout//image-maintext</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the long description (the main text) of the image.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-material" class="template-tag">
|
||
<h1>/content-item-layout//image-material</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>material</code> property.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-origin" class="template-tag">
|
||
<h1>/content-item-layout//image-origin</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>origin</code> property.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-originalsize" class="template-tag">
|
||
<h1>/content-item-layout//image-originalsize</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>origSize</code> property.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-publishdate" class="template-tag">
|
||
<h1>/content-item-layout//image-publishdate</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>publishdate</code> property.
|
||
The date can be formatted using the date format tags.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-site" class="template-tag">
|
||
<h1>/content-item-layout//image-site</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>site</code> property.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-source" class="template-tag">
|
||
<h1>/content-item-layout//image-source</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>source</code> property.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-technique" class="template-tag">
|
||
<h1>/content-item-layout//image-technique</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the value of the <code>technique</code> property.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//image-width" class="template-tag">
|
||
<h1>/content-item-layout//image-width</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the width in pixels of the image.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//show-image" class="template-tag">
|
||
<h1>/content-item-layout//show-image</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Puts the necessary informations for showing the image on into
|
||
the environment.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//show-thumbnail" class="template-tag">
|
||
<h1>/content-item-layout//show-thumbnail</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Puts the necessary informations for showing the thumbnail on into
|
||
the environment.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-content-items-mpa.xsl">
|
||
<h1></h1>
|
||
<section id="/content-item-layout//mpa-all-sections-link" class="template-tag">
|
||
<h1>/content-item-layout//mpa-all-sections-link</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Provides the parameters (URL via the <code>href</code> parameter) for the link
|
||
to show all section of a MPA on one page.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//mpa-current-sections" class="template-tag">
|
||
<h1>/content-item-layout//mpa-current-sections</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Root element for outputting the current sections of a MPA.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//mpa-current-sections//mpa-current-section" class="template-tag">
|
||
<h1>/content-item-layout//mpa-current-sections//mpa-current-section</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Root element for outputting a current section of a MPA.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//mpa-current-sections//mpa-current-section//mpa-current-section-content" class="template-tag">
|
||
<h1>/content-item-layout//mpa-current-sections//mpa-current-section//mpa-current-section-content</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the content of a current section of a MPA.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//mpa-current-sections//mpa-current-section//mpa-current-section-title" class="template-tag">
|
||
<h1>/content-item-layout//mpa-current-sections//mpa-current-section//mpa-current-section-title</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the title of a current section of a MPA.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//mpa-next-page-link" class="template-tag">
|
||
<h1>/content-item-layout//mpa-next-page-link</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Provides the parameters (URL via the <code>href</code> parameter) for the link
|
||
to the next page of a MPA if there is a next page.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//mpa-prev-page-link" class="template-tag">
|
||
<h1>/content-item-layout//mpa-prev-page-link</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Provides the parameters (URL via the <code>href</code> parameter) for the link
|
||
to the previous page of a MPA if there is a previous page.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//mpa-sections" class="template-tag">
|
||
<h1>/content-item-layout//mpa-sections</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Root element for outputting the list of sections of a MPA.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//mpa-sections//mpa-section" class="template-tag">
|
||
<h1>/content-item-layout//mpa-sections//mpa-section</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Root for rendering a link to a section of a MPA in the list of sections.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//mpa-sections//mpa-section//mpa-section-title" class="template-tag">
|
||
<h1>/content-item-layout//mpa-sections//mpa-section//mpa-section-title</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Output the name a section of MPA in the list of sections.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="/content-item-layout//mpa-summary" class="template-tag">
|
||
<h1>/content-item-layout//mpa-summary</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the summary of the multi part article.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-content-items-news.xsl">
|
||
<h1></h1>
|
||
<section id="/content-item-layout//news-date" class="template-tag">
|
||
<h1>/content-item-layout//news-date</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Outputs the the date of a news. The <code>news-date</code> must contain at least
|
||
one <code>format</code> element. The <code>format</code> element encloses the
|
||
format definition for the specific language or the default format. The language
|
||
for which a format is used is provided using the <code>lang</code> attribute at the
|
||
<code>format</code> element. The default format has a <code>default</code> attribute
|
||
with the value <code>true</code>. An example:
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
<news-date>
|
||
<format default="true">
|
||
<iso-date/>
|
||
</format>
|
||
<format lang="de">
|
||
<day zero="true"/>.<month zero="true"/>.<year/>
|
||
</format>
|
||
</news-date>
|
||
</pre><p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
In this example a visitor with a browser using <em>German</em> as default locale
|
||
will see the news date in the date format that common in Germany
|
||
(<code>dd.mm.yyyy</code>). For all other languages, the default format is used.
|
||
In this case the <code>iso-format</code> is used.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-content-items-siteproxy.xsl">
|
||
<h1></h1>
|
||
<section id="/content-item-layout//siteproxy-content" class="template-tag">
|
||
<h1>/content-item-layout//siteproxy-content</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Processes the proxied XML of a SiteProxy using <code>xsl:apply-templates</code>.
|
||
Your theme must provide XSL to transform the proxied XML into HTML.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="content-item-layout//content-item-link" class="template-tag">
|
||
<h1>content-item-layout//content-item-link</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Provides a link to content item itself. Useful if a content item is shown using a
|
||
portlet and you want to create a link to the normal detail view of the item.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="content-item-layout//edit-link | fragment-layout//edit-link" class="template-tag">
|
||
<h1>content-item-layout//edit-link | fragment-layout//edit-link</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Provides the <code>href</code> for creating a link to edit the current item in the
|
||
content centre if the current user is logged in and has the permission to edit the
|
||
item.
|
||
|
||
</p>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
To use this feature put the following snippet like the following into the
|
||
templates for the content items in your theme:
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
<edit-link>
|
||
<div class="edit-link">
|
||
<a>
|
||
<a>
|
||
&#x270e;
|
||
</a>
|
||
</a>
|
||
</div>
|
||
</edit-link>
|
||
</pre><p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The example uses an UTF-8 character from the <em>Dingbats</em> block (a pencil).
|
||
You can of course use another character, text or an image. To
|
||
reduce the amount of code needed you may add a fragment template and include this
|
||
template using the <code>include</code> tag.
|
||
|
||
</p>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
You also have to include styles for the edit link into your theme.
|
||
The <em>foundry-base</em> theme, for example, puts the edit link the top right
|
||
corner of the area which shows the content item. This is done by the following
|
||
styles:
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
/* Sets the reference point for position: absolute
|
||
to the main element block */
|
||
main {
|
||
position: relative;
|
||
}
|
||
|
||
/* Don't show the edit link on a first glance */
|
||
main .edit-link {
|
||
display: none;
|
||
}
|
||
|
||
/* Display the edit link in the top right corner
|
||
of the content item area if the cursor is in
|
||
the content item area */
|
||
main:hover .edit-link {
|
||
display: block;
|
||
position: absolute;
|
||
right: 0;
|
||
top: 0;
|
||
font-size: 30px;
|
||
color: #0776a0;
|
||
/* Blue border around the link */
|
||
border: 1px solid #0776a0;
|
||
/* Make the link 32px in width and height */
|
||
width: 32px;
|
||
height: 32px;
|
||
text-align: center;
|
||
}
|
||
|
||
/* Remove default decoration for links */
|
||
main:hover .edit-link a:link,
|
||
main:hover .edit-link a:hover,
|
||
main:hover .edit-link a:active,
|
||
main:hover .edit-link a:visited {
|
||
color: #0776a0;
|
||
text-decoration: none;
|
||
}
|
||
|
||
</pre></div>
|
||
</section>
|
||
<section id="content-item[@mode = 'detail' or not(@mode)]" class="template-tag">
|
||
<h1>content-item[@mode = 'detail' or not(@mode)]</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The <code>content-item</code> element with the attribute <code>mode</code> set to
|
||
<code>detail</code> or without the attribute inserts the HTML representation of the
|
||
detail view of the current content item. The content item can either be the greeting
|
||
item or normal item.
|
||
|
||
</p>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The HTML representation of a content item is defined using special templates
|
||
with the <code>contentitem-layout</code> element as root. Usually these templates
|
||
are located in the <code>templates/content-items</code> folder. Which template is
|
||
used for a particular content item is defined by the <code>conf/templates.xml</code>
|
||
file. In this file there is a <code>content-items</code> element below the
|
||
<code>templates</code> element. The association between templates and
|
||
content items is described by the <code>content-item</code> elements in the
|
||
<code>content-items</code> element. The <code>content-item</code> has four
|
||
optional attributes (at least on must be present) which are used to limit the
|
||
content items for which a template is used. The four attributes are:
|
||
|
||
</p>
|
||
<dl xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
<dt><code>oid</code></dt>
|
||
<dd>
|
||
Limit the use of the template to a specific content item, identified by its
|
||
OID (the OID of the master version). Can't be used in combination with the other
|
||
attributes.
|
||
|
||
</dd>
|
||
<dt><code>content-section</code></dt>
|
||
<dd>
|
||
The name of the content section to which the item belongs. Can be used
|
||
in combination with the <code>category</code> and <code>content-type</code>
|
||
attributes.
|
||
|
||
</dd>
|
||
<dt><code>category</code></dt>
|
||
<dd>
|
||
The template is only used for the content item if the item is viewed as
|
||
item of the category. The category is set as a path containing the names
|
||
the categories.
|
||
|
||
</dd>
|
||
<dt><code>content-type</code></dt>
|
||
<dd>
|
||
The content-type of the item.
|
||
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="#layout-templates" title="The template system">The template system</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="content-item[@mode = 'link']" class="template-tag">
|
||
<h1>content-item[@mode = 'link']</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The <code>content-item</code> with the <code>mode</code> attribute set to
|
||
<code>link</code> insert the HTML representation of a content item. In this case
|
||
the content item to show is provided using by a XSL parameter which has to be
|
||
provided by a surrounding tag like <code>related-link</code>.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="content-item[@mode = 'list']" class="template-tag">
|
||
<h1>content-item[@mode = 'list']</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The <code>content-item</code> element with the <code>mode</code> attribute set to
|
||
<code>list</code> inserts the HTML representation of the the list view of a content
|
||
item. The list view is primarily used in object lists.
|
||
|
||
</p>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
As for the detail view, the HTML representation of the list view of a conten item is
|
||
defined using special templates with the <code>contentitem-layout</code> element as
|
||
root. Usually these templates are located in the
|
||
<code>templates/content-items</code> folder. Which is used for a particular content
|
||
item is defined in the <code>conf/templates.xml</code> file. In this file there is
|
||
a <code>content-items</code> element below the <code>templates</code> element.
|
||
|
||
</p>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
There three attributes which can be used to define in which cases a specific
|
||
template is used:
|
||
|
||
</p>
|
||
<dl xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
<dt>style</dt>
|
||
<dd>
|
||
Used to select a specific style for the list view of the item. To select a style
|
||
add a <code>style</code> attribute to the <code>content-item</code> attribute
|
||
in the application layout file.
|
||
|
||
</dd>
|
||
<dt>content-type</dt>
|
||
<dd>The content-type of the item.</dd>
|
||
<dt><code>category</code></dt>
|
||
<dd>
|
||
The template is only used for the content item if the item is viewed as item of
|
||
the category. The category is set as a path contains the names the categories.
|
||
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="#layout-templates" title="The template system">The template system</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-template-tags-data-tags.xsl">
|
||
<h1>Data tags</h1>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">
|
||
These tags can be used to display several informations from the XML provided by CCM.
|
||
|
||
</p>
|
||
<section id="show-page-title" class="template-tag">
|
||
<h1>show-page-title</h1>
|
||
<div><code xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">foundry:title</code></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="#foundry:title" title="foundry:title">foundry:title</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="show-text" class="template-tag">
|
||
<h1>show-text</h1>
|
||
<div><code xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">texts</code><code xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">module</code><code xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">texts/global.xml</code><code xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">id</code><code xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">class</code><code xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">with-colorset</code><code xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">span</code></div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>id</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">An unique id for the text.</p>
|
||
</dd>
|
||
<dt>class</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">One or more classes to format the text per CSS.</p>
|
||
</dd>
|
||
<dt>module</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">
|
||
The module (file) from the text is retrieved. The name of the file should be
|
||
provided without file extension.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>with-colorset</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:foundry="http://foundry.libreccm.org">
|
||
Add the classes for using the Colorset feature to the <code>span</code> element
|
||
the text is wrapped in.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-template-tags-html-tags.xsl">
|
||
<h1>HTML tags</h1>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
These tags are generating the equivalent HTML tags. In most cases the tags have
|
||
the same name and same attributes as their HTML counterparts, but some work
|
||
in a slightly different way, for example by using values provided by other
|
||
surrounding tags which are passed to them as XSL parameters.
|
||
|
||
</p>
|
||
<section id="a" class="template-tag">
|
||
<h1>a</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a HTML <code>a</code> element. There are some differences to the
|
||
<code>a</code> element in HTML. First, there two attribute for the URL:
|
||
|
||
</p>
|
||
<dl xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
<dt><code>href-property</code></dt>
|
||
<dd>
|
||
The name of a property of the current object which contains the URL for the
|
||
link.
|
||
|
||
</dd>
|
||
<dt>
|
||
<dt><code>href-static</code></dt>
|
||
<dd>
|
||
A static URL.
|
||
|
||
</dd>
|
||
</dt>
|
||
</dl>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
The third variant for providing an URL is to call the template with a href
|
||
parameter in the XSL.
|
||
|
||
</p>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Values for some other attributes can also be passed to the this template as XSL
|
||
parameters:
|
||
|
||
</p>
|
||
<dl xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
<dt><code>hreflang</code></dt>
|
||
<dd>Language of the resource the link is pointing to.</dd>
|
||
<dt><code>title</code></dt>
|
||
<dd>
|
||
Value for the <code>title</code> attribute of the link. Usally this should
|
||
a very brief description of the target of the link
|
||
|
||
</dd>
|
||
<dt><code>type</code></dt>
|
||
<dd>The media type of the link target.</dd>
|
||
</dl>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>download</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Value for the HTML5 <code>download</code> attribute.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>href-property</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
The name of a property (aka the name of an XML element in the data-tree)
|
||
containing the URL of the link.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>href</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
A static URL for the link.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>rel</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
The relationship of the linking document with the target document.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>title-static</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
A key which identifies the translated title in <code>lang/global.xml</code>.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>title</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Static, not translated title of the link.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-a-element" title="
 Description of the a element in the HTML5 specification.
 ">
|
||
Description of the a element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="abbr" class="template-tag">
|
||
<h1>abbr</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a HTML <code>abbr</code> element used to tag abbreviations.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-abbr-element" title="
 Description of the abbr element in the HTML 5 specification.
 ">
|
||
Description of the abbr element in the HTML 5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="address" class="template-tag">
|
||
<h1>address</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>address</code> element in the HTML output.
|
||
The <code>address</code> elements represents the contact information of the
|
||
responsible author of <code>article</code> or <code>body</code> it appears in.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-address-element" title="
 Description of the address element in the HTML5 specification
 ">
|
||
Description of the address element in the HTML5 specification
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="article" class="template-tag">
|
||
<h1>article</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates the HTML5 <code>article</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-article-element" title="
 Description of the article element in the HTML5 specification
 ">
|
||
Description of the article element in the HTML5 specification
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="aside" class="template-tag">
|
||
<h1>aside</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a HTML5 <code>aside</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-aside-element" title="
 Description of the aside element in the HTML5 specification.
 ">
|
||
Description of the aside element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="audio" class="template-tag">
|
||
<h1>audio</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a HTML5 <code>audio</code> element. The source URL of the audio file can
|
||
be provided by a surrounding element, statically in the theme or by an property in
|
||
the data tree.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>src-static</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
A static URL for the source of the audio file
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>src-property</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Name of property in the data tree containing the source URL.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/embedded-content-0.html#the-audio-element" title="
 Description of the audio element in the HTML5 specification.
 ">
|
||
Description of the audio element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="b" class="template-tag">
|
||
<h1>b</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a HTML <code>b</code> element. Use this element only with semantics
|
||
defined in the HTML5 specification. Originally, in the early incarnations of HTML,
|
||
this element marked text as bold. In HTML5 the semantics of this element as been
|
||
redefined. For more information please refer to the HTML5 specification.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-b-element" title="
 Description of the b element in the HTML5 specification.
 ">
|
||
Description of the b element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="blockquote" class="template-tag">
|
||
<h1>blockquote</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>blockquote</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-blockquote-element" title="
 Description of the blockquote element in the HTML5 specification.
 ">
|
||
Description of the blockquote element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="body" class="template-tag">
|
||
<h1>body</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates the HTML <code>body</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-body-element" title="
 Description of the body element in the HTML5 specification.
 ">
|
||
Description of the body element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="button" class="template-tag">
|
||
<h1>button</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a button element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/forms.html#the-button-element" title="
 Description of the button element in the HTML5 specification.
 ">
|
||
Description of the button element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="canvas" class="template-tag">
|
||
<h1>canvas</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>canvas</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/scripting-1.html#the-canvas-element" title="
 Description of the canvas element in the HTML5 specification.
 ">
|
||
Description of the canvas element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="cite" class="template-tag">
|
||
<h1>cite</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>cite</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-cite-element" title="
 Description of the cite element in the HTML5 specification.
 ">
|
||
Description of the cite element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="code" class="template-tag">
|
||
<h1>code</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>code</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-code-element" title="
 Description of the code element in the HTML5 specification.
 ">
|
||
Description of the code element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="dd" class="template-tag">
|
||
<h1>dd</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
A definition of term in a definition list.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-dd-element" title="http://www.w3.org/TR/html5/grouping-content.html#the-dd-element">http://www.w3.org/TR/html5/grouping-content.html#the-dd-element</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="dfn" class="template-tag">
|
||
<h1>dfn</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>dfn</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-dfn-element" title="
 Description of the dfn element in the HTML5 specification.
 ">
|
||
Description of the dfn element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="div" class="template-tag">
|
||
<h1>div</h1>
|
||
<div><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">div</code></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-div-element" title="
 Description of the div element in the HTML5 specification.
 ">
|
||
Description of the div element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="divIfNotEmpty" class="template-tag">
|
||
<h1>divIfNotEmpty</h1>
|
||
<div><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">div</code></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="#div" title="#div">#div</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="dl" class="template-tag">
|
||
<h1>dl</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a definition list.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-dl-element" title="http://www.w3.org/TR/html5/grouping-content.html#the-dl-element">http://www.w3.org/TR/html5/grouping-content.html#the-dl-element</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="dt" class="template-tag">
|
||
<h1>dt</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
A term in a definition list.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-dt-element" title="http://www.w3.org/TR/html5/grouping-content.html#the-dt-element">http://www.w3.org/TR/html5/grouping-content.html#the-dt-element</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="footer" class="template-tag">
|
||
<h1>footer</h1>
|
||
<div></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-footer-element" title="http://www.w3.org/TR/html5/sections.html#the-footer-element">http://www.w3.org/TR/html5/sections.html#the-footer-element</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="h1" class="template-tag">
|
||
<h1>h1</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>h1</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements" title="
 Description of the h1, h2, h3, 
 h4, h5 and h6 elements in the HTML5 
 specification.
 ">
|
||
Description of the h1, h2, h3,
|
||
h4, h5 and h6 elements in the HTML5
|
||
specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="h2" class="template-tag">
|
||
<h1>h2</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>h2</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements" title="
 Description of the h1, h2, h3, 
 h4, h5 and h6 elements in the HTML5 
 specification.
 ">
|
||
Description of the h1, h2, h3,
|
||
h4, h5 and h6 elements in the HTML5
|
||
specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="h3" class="template-tag">
|
||
<h1>h3</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>h3</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements" title="
 Description of the h1, h2, h3, 
 h4, h5 and h6 elements in the HTML5 
 specification.
 ">
|
||
Description of the h1, h2, h3,
|
||
h4, h5 and h6 elements in the HTML5
|
||
specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="h4" class="template-tag">
|
||
<h1>h4</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>h4</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements" title="
 Description of the h1, h2, h3, 
 h4, h5 and h6 elements in the HTML5 
 specification.
 ">
|
||
Description of the h1, h2, h3,
|
||
h4, h5 and h6 elements in the HTML5
|
||
specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="h5" class="template-tag">
|
||
<h1>h5</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>h5</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements" title="
 Description of the h1, h2, h3, 
 h4, h5 and h6 elements in the HTML5 
 specification.
 ">
|
||
Description of the h1, h2, h3,
|
||
h4, h5 and h6 elements in the HTML5
|
||
specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="h6" class="template-tag">
|
||
<h1>h6</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>h6</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-h1,-h2,-h3,-h4,-h5,-and-h6-elements" title="
 Description of the h1, h2, h3, 
 h4, h5 and h6 elements in the HTML5 
 specification.
 ">
|
||
Description of the h1, h2, h3,
|
||
h4, h5 and h6 elements in the HTML5
|
||
specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="head" class="template-tag">
|
||
<h1>head</h1>
|
||
<div><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">head</code></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/document-metadata.html#the-head-element" title="
 Description of the head element in the HTML5 specification.
 ">
|
||
Description of the head element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="header" class="template-tag">
|
||
<h1>header</h1>
|
||
<div><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">header</code></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-header-element" title="
 Description of the header element in the HTML5 specification.
 ">
|
||
Description of the header element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="hr" class="template-tag">
|
||
<h1>hr</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>hr</code> element. This element has no content.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-hr-element" title="
 Description of the hr element in the HTML5 specification.
 ">
|
||
Description of the hr element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="i" class="template-tag">
|
||
<h1>i</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates an <code>i</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-i-element" title="
 Description of the i element in the HTML5 specification.
 ">
|
||
Description of the i element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="input" class="template-tag">
|
||
<h1>input</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>input</code> element. A preset value can be provided using a
|
||
XSL parameter by a surrounding element. The HTML5 <code>placeholder</code> attribute
|
||
has been split into two attributes. The <code>placeholder-module</code> attribute
|
||
contains the name of module parameter (the name of the file in the
|
||
<code>texts</code> directory) in which the text for the placeholder is stored. If
|
||
omitted the <code>global.xml</code> file is used. The placeholder attribute itself
|
||
contains the ID of the text to show as placeholder.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>placeholder-module</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
The name of the file in the <code>texts</code> directory which contains the
|
||
text to use as placeholder. If omitted the <code>global.xml</code> file is used.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>placeholder</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
The ID of the text to use as placeholder.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/forms.html#the-input-element" title="
 Description of the input element in the HTML5 specification.
 ">
|
||
Description of the input element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="ins" class="template-tag">
|
||
<h1>ins</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>ins</code> element
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/edits.html#the-ins-element" title="
 Description of the ins element in the HTML5 specification.
 ">
|
||
Description of the ins element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="kbd" class="template-tag">
|
||
<h1>kbd</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>kbd</code> element
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-kbd-element" title="
 Description of the kbd element in the HTML5 specification.
 ">
|
||
Description of the kbd element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="label" class="template-tag">
|
||
<h1>label</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>label</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/forms.html#the-label-element" title="
 Description of the label element in the HTML5 specification.
 ">
|
||
Description of the label element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="legend" class="template-tag">
|
||
<h1>legend</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>legend</code> element inside a form element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/forms.html#the-legend-element" title="
 Description of the legend element in the HTML5 specification.
 ">
|
||
Description of the legend element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="li" class="template-tag">
|
||
<h1>li</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>li</code> element inside an <code>ul</code> or <code>ol</code>.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-li-element" title="
 Description of the li element in the HTML5 specification.
 ">
|
||
Description of the li element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="main" class="template-tag">
|
||
<h1>main</h1>
|
||
<div><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">main</code></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-main-element" title="
 Description of the main element in the HTML5 specification.
 ">
|
||
Description of the main element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="meta" class="template-tag">
|
||
<h1>meta</h1>
|
||
<div><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">head</code></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="#head" title="#head">#head</a></li>
|
||
<li><a href="http://www.w3.org/TR/html5/document-metadata.html#the-meta-element" title="
 Description of the meta element in the HTML5 specification.
 ">
|
||
Description of the meta element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="nav" class="template-tag">
|
||
<h1>nav</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">Generates a HTML5 <code>nav</code> element.
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/sections.html#the-nav-element" title="
 Description of the nav element in the HTML5 specification.
 ">
|
||
Description of the nav element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="noscript" class="template-tag">
|
||
<h1>noscript</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">Generates a <code>noscript</code> element
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/scripting-1.html#the-noscript-element" title="
 Description of the noscript element in the HTML5 specification.
 ">
|
||
Description of the noscript element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="ol" class="template-tag">
|
||
<h1>ol</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates an <code>ol</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-ol-element" title="
 Description of the ol element in the HTML5 specification.
 ">
|
||
Description of the ol element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="optgroup" class="template-tag">
|
||
<h1>optgroup</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates an <code>optgroup</code> element. The label for the option group must be
|
||
provided by a surrounding element as XSL parameter.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/forms.html#the-optgroup-element" title="
 Description oft the optgroup element in the HTML5 specification.
 ">
|
||
Description oft the optgroup element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="option" class="template-tag">
|
||
<h1>option</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>option</code> element for use in <code>select</code> box. Several
|
||
values for attributes have to be provided by a surrounding element using XSL
|
||
parameters, for example the value of the <code>value</code> attribute.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/forms.html#the-option-element" title="
 Description of the option element in the HTML5 specification.
 ">
|
||
Description of the option element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="p" class="template-tag">
|
||
<h1>p</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>p</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-p-element" title="
 Description of the p element in the HTML5 specification
 ">
|
||
Description of the p element in the HTML5 specification
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="pre" class="template-tag">
|
||
<h1>pre</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>pre</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-pre-element" title="
 Description of the pre in the HTML5 specification.
 ">
|
||
Description of the pre in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="q" class="template-tag">
|
||
<h1>q</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>q</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-q-element" title="
 Description of the q element in the HTML5 specification.
 ">
|
||
Description of the q element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="s" class="template-tag">
|
||
<h1>s</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>s</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-s-element" title="
 Description of the s element in the HTML5 specification.
 ">
|
||
Description of the s element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="samp" class="template-tag">
|
||
<h1>samp</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>samp</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-samp-element" title="
 Description of the samp element in the HTML5 specification.
 ">
|
||
Description of the samp element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="script" class="template-tag">
|
||
<h1>script</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Used to include a script (usally a JavaScript). The script is either provided
|
||
a content of the element or as an external file. Embedded scripts should only be used
|
||
for small parts of code, like the code for activating jQuery plugins for some elements.
|
||
Everything which is longer than five or six lines should be put into a external file
|
||
in the scripts directory of the theme.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>origin</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
As usual <code>origin</code> attribute determines the how the path provided in
|
||
the <code>src</code> attribute is interpreted. The following values are
|
||
interpreted. In addition to the common values <code>internal</code>,
|
||
<code>master</code> and the default value the <code>script</code> element also
|
||
support the value <code>absolute</code>. If <code>origin</code> is set to
|
||
absolute the provided source path is processed by Foundry and is used as it is
|
||
provided.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>src</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
The path of the script to include. If the <code>origin</code> attribute is not
|
||
set (or not set to <code>absolute</code> the path is interpreted relative to the
|
||
theme directory. For example the path of a script included using
|
||
|
||
</p><pre xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
<script type="text/javascript" src="scripts/example.js"/>
|
||
</pre><p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
in the a theme named <code>my-theme</code> at the server
|
||
<code>http://www.example.org</code> is altered to the absolute path
|
||
<code>http://www.example.org/themes/published-themedir/itb/scripts/example.js</code>.
|
||
If the <code>absolute</code> attribute is set to <code>true</code> the path is not
|
||
altered. One usecase for an absolute path is to load an script from a content delivery
|
||
network.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>type</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
The type of the script. Usally this is <code>text/javascript</code>. If the
|
||
attribute is not set in the layout template, it is automatically set to
|
||
<code>text/javascript</code>.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/scripting-1.html#the-script-element" title="http://www.w3.org/TR/html5/scripting-1.html#the-script-element">http://www.w3.org/TR/html5/scripting-1.html#the-script-element</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="section" class="template-tag">
|
||
<h1>section</h1>
|
||
<div><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">section</code></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-section-element" title="http://www.w3.org/TR/html5/text-level-semantics.html#the-section-element">http://www.w3.org/TR/html5/text-level-semantics.html#the-section-element</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="select" class="template-tag">
|
||
<h1>select</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a select box in a form. The <code>name</code> of the select box and
|
||
the status for the <code>disabled</code> attribute can be provided by a surrounding
|
||
element via XSL parameters.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/forms.html#the-select-element" title="
 Description of the select element in the HTML5 specification.
 ">
|
||
Description of the select element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="small" class="template-tag">
|
||
<h1>small</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>small</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-small-element" title="
 Description of the small element in the HTML5 specification.
 ">
|
||
Description of the small element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="source" class="template-tag">
|
||
<h1>source</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>source</code> element for use in <code>audio</code> and
|
||
<code>video</code> elements. The source URL (value of the <code>src</code>
|
||
attribute) can either provided by a surrounding element as XSL parameter or
|
||
via the <code>src-static</code> or <code>src-property</code> attribute.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>src-static</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
An URL to an static resource.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>src-property</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Name of an XML node in the <code>data-tree</code> providing the URL of the
|
||
resource.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</section>
|
||
<section id="span" class="template-tag">
|
||
<h1>span</h1>
|
||
<div><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">span</code></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-span-element" title="http://www.w3.org/TR/html5/text-level-semantics.html#the-span-element">http://www.w3.org/TR/html5/text-level-semantics.html#the-span-element</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="spanIfNotEmpty" class="template-tag">
|
||
<h1>spanIfNotEmpty</h1>
|
||
<div><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">span</code></div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-span-element" title="http://www.w3.org/TR/html5/text-level-semantics.html#the-span-element">http://www.w3.org/TR/html5/text-level-semantics.html#the-span-element</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="strong" class="template-tag">
|
||
<h1>strong</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>strong</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-strong-element" title="http://www.w3.org/TR/html5/text-level-semantics.html#the-strong-element">http://www.w3.org/TR/html5/text-level-semantics.html#the-strong-element</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="sub" class="template-tag">
|
||
<h1>sub</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>sub</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-sub-and-sup-elements" title="
 Description of the sub element in the HTML5 specification.
 ">
|
||
Description of the sub element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="sup" class="template-tag">
|
||
<h1>sup</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>sup</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-sub-and-sup-elements" title="
 Description of the sup element in the HTML5 specification.
 ">
|
||
Description of the sup element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="table" class="template-tag">
|
||
<h1>table</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>table</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/tabular-data.html#the-table-element" title="
 Description of the table element in the HTML5 specification.
 ">
|
||
Description of the table element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="table//caption" class="template-tag">
|
||
<h1>table//caption</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>caption</code> element representing the caption of a table.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/tabular-data.html#the-caption-element" title="
 Description of the caption element in the HTML5 specification.
 ">
|
||
Description of the caption element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="tbody" class="template-tag">
|
||
<h1>tbody</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>tbody</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/tabular-data.html#the-tbody-element" title="
 Description of the tbody element in the HTML5 specification.
 ">
|
||
Description of the tbody element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="td" class="template-tag">
|
||
<h1>td</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>td</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/tabular-data.html#the-td-element" title="
 Description of the td element in the HTML5 specification.
 ">
|
||
Description of the td element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="textarea" class="template-tag">
|
||
<h1>textarea</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>textarea</code>. The value may be provided as XSL parameter
|
||
by a surrounding tag.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>placeholder-module</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
The name of the file in the <code>texts</code> directory which contains the
|
||
text to use as placeholder. If omitted the <code>global.xml</code> file is used.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>placeholder</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
The ID of the text to use as placeholder.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/forms.html#the-textarea-element" title="
 Description of the textarea element in the HTML5 specification.
 ">
|
||
Description of the textarea element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="tfoot" class="template-tag">
|
||
<h1>tfoot</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>tfoot</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/tabular-data.html#the-tfoot-element" title="
 Description of the tfoot element in the HTML5 specification.
 ">
|
||
Description of the tfoot element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="th" class="template-tag">
|
||
<h1>th</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>th</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/tabular-data.html#the-th-element" title="
 Description of the th element in the HTML5 specification.
 ">
|
||
Description of the th element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="thead" class="template-tag">
|
||
<h1>thead</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>thead</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/tabular-data.html#the-thead-element" title="
 Description of the thead element in the HTML5 specification.
 ">
|
||
Description of the thead element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="time" class="template-tag">
|
||
<h1>time</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>time</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-time-element" title="
 Description of the time element in the HTML5 specification.
 ">
|
||
Description of the time element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="title" class="template-tag">
|
||
<h1>title</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates the title in the HTML head. The other elements are allowed in the
|
||
<code><title></code> tag:
|
||
|
||
</p>
|
||
<ul xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
<li><code>show-text</code></li>
|
||
<li><code>show-page-title</code></li>
|
||
</ul>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/document-metadata.html#the-title-element" title="http://www.w3.org/TR/html5/document-metadata.html#the-title-element">http://www.w3.org/TR/html5/document-metadata.html#the-title-element</a></li>
|
||
<li><a href="#show-text" title="#show-text">#show-text</a></li>
|
||
<li><a href="#show-page-title" title="#show-page-title">#show-page-title</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="tr" class="template-tag">
|
||
<h1>tr</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>tr</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/tabular-data.html#the-tr-element" title="
 Description of the tr element in the HTML5 specification.
 ">
|
||
Description of the tr element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="track" class="template-tag">
|
||
<h1>track</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>track</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/embedded-content-0.html#the-track-element" title="
 Description of the track element in the HTML5 specification.
 ">
|
||
Description of the track element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="u" class="template-tag">
|
||
<h1>u</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>u</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-u-element" title="
 Description of the u element in the HTML5 specification.
 ">
|
||
Description of the u element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="ul" class="template-tag">
|
||
<h1>ul</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates an <code>ul</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/grouping-content.html#the-ul-element" title="
 Description of the ul element in the HTML5 specification.
 ">
|
||
Description of the ul element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="var" class="template-tag">
|
||
<h1>var</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates an <code>var</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-var-element" title="
 Description of the var element in the HTML5 specification.
 ">
|
||
Description of the var element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="video" class="template-tag">
|
||
<h1>video</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a HTML5 <code>video</code> element. The source URL and the URL of preview
|
||
image (<code>poster</code>) can be provided by a surrounding element, statically in
|
||
the theme or by an property in the data tree.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>src-static</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
A static URL for the source of the video file
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>src-property</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Name of property in the data tree containing the source URL.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>poster-static</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
A static URL for the source of the preview image
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>poster-property</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Name of property in the data tree containing the poster URL.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/embedded-content-0.html#the-video-element" title="
 Description of the video element in the HTML5 specification.
 ">
|
||
Description of the video element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
<section id="wbr" class="template-tag">
|
||
<h1>wbr</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Generates a <code>wbr</code> element.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>See also</h2>
|
||
<ul>
|
||
<li><a href="http://www.w3.org/TR/html5/text-level-semantics.html#the-wbr-element" title="
 Description of the wbr element in the HTML5 specification.
 ">
|
||
Description of the wbr element in the HTML5 specification.
|
||
</a></li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-template-tags-loaders.xsl">
|
||
<h1>Loaders</h1>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
This tags are used to load resources required by the generated HTML documents,
|
||
for example CSS files and JavaScript files.
|
||
|
||
</p>
|
||
<section id="load-css-files" class="template-tag">
|
||
<h1>load-css-files</h1>
|
||
<div><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">conf/css-files.xml</code><code xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0"><link></code><a xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" href="#css-files">CSS files section</a></div>
|
||
</section>
|
||
<section id="load-html5shiv" class="template-tag">
|
||
<h1>load-html5shiv</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Loads the <a href="https://github.com/aFarkas/html5shiv">html5shiv</a> JavaScript
|
||
library which fixes a bug of old Internet Explorers
|
||
(up to version 8) with elements unknown by the Internet Explorer. You need this
|
||
library if you want to use HTML 5 elements like <code>article</code> or
|
||
<code>nav</code> in your templates. All other browser thread unknown elements
|
||
like <code>div</code> or <code>span</code>. The Internet Explorer to version 8
|
||
however adds a closing elements to the DOM tree directly after the unknown opening
|
||
element, effectively removing the element from the DOM. The <em>html5shiv</em>
|
||
library fixes the DOM tree using JavaScript.
|
||
|
||
</p>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
This tag adds a
|
||
<a href="http://en.wikipedia.org/wiki/Conditional_comment">conditional comment</a>
|
||
to load the html5shiv library only for old Internet Explorers
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="load-jquery" class="template-tag">
|
||
<h1>load-jquery</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Loads the <a href="http://jquery.com">jQuery</a> JavaScript library provided by CCM.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="load-jquery-ui" class="template-tag">
|
||
<h1>load-jquery-ui</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Loads the <a href="http://jqueryui.com">jQuery UI</a> JavaScript library provided
|
||
by CCM.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="load-mathjax" class="template-tag">
|
||
<h1>load-mathjax</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Loads the <a href="http://www.mathjax.org/">MathJAX JavaScript</a> library which can
|
||
render mathematical formulas written in MathML or LaTeX syntax.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-template-tags-navigation.xsl">
|
||
<h1>Tags for ccm-navigation</h1>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
These tags are used to output data provided by the <em>ccm-navigation</em> module.
|
||
More exactly the navigation menu(s) and the breadcrumbs on a site are generated
|
||
using these tags.
|
||
|
||
</p>
|
||
<section id="breadcrumbs" class="template-tag">
|
||
<h1>breadcrumbs</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
Show the breadcrumbs for the current page. The separator between each breadcrumb is
|
||
provided by the child element <code>breakcrumb-separator</code>. The contents
|
||
of this element is used a separator between the breadcrumbs. This allows it to
|
||
use simple characters of more complex HTML.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>omit-root</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
If set the <code>yes</code>, the breadcrumb for the root level is omitted.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>omit-last</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
If set the <code>yes</code>, the breadcrumb for last entry (the current
|
||
category) is omitted.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</section>
|
||
<section id="navigation" class="template-tag">
|
||
<h1>navigation</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
Root element for rendering a navigation menu. This element has several attributes
|
||
which control some aspects of the rendering.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>navigation-id</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
The ID of the navigation/category system to use for the menu. If not set
|
||
the default value <code>categoryMenu</code> is used which should be sufficent
|
||
in most use cases.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>with-colorset</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
Decides if the navigation elements gets colorset classes. Default value is
|
||
<code>false</code></p>
|
||
</dd>
|
||
<dt>min-level</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
The minimum level to render. If set to a value higher than <code>1</code> all
|
||
levels below this value will be skipped. Use this if you want to split your
|
||
navigation menu. For example: First level as horizontal menu at the top,
|
||
other levels as horizontal menu on the left. Default value is <code>1</code>.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>max-level</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
The maximum level to render. Only levels below and including this level will
|
||
be used for the menu.. Use this if you want to split your
|
||
navigation menu. For example: First level as horizontal menu at the top,
|
||
other levels as horizontal menu on the left. Default value is <code>999</code>.
|
||
|
||
</p>
|
||
</dd>
|
||
<dt>show-description-text</dt>
|
||
<dd>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
Decides if the description of each category is passed to the link
|
||
(<code>a</code> element) for the <code>title</code> attribute. Default value
|
||
is <code>true</code>.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</section>
|
||
<section id="navigation-home-link//navigation-title" class="template-tag">
|
||
<h1>navigation-home-link//navigation-title</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:foundry="http://foundry.libreccm.org" xmlns:bebop="http://www.arsdigita.com/bebop/1.0">
|
||
Outputs the title of the current navigation inside a
|
||
<code>navigation-home-link</code>.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="user-template-tags-object-list.xsl">
|
||
<h1></h1>
|
||
<section id="object-list//paginator" class="template-tag">
|
||
<h1>object-list//paginator</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Root element for creating the paginator for an object list. Provides the paginator
|
||
data for the elements enclosed by this element via XSL parameters. The content is
|
||
of this element is only processed if the number of pages is greater than one or
|
||
if the <code>show</code> attribute is set to <code>always</code>.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Attributes</h2>
|
||
<dl>
|
||
<dt>show</dt>
|
||
<dd>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
If set to <code>always</code> the paginator is shown even if there is only one
|
||
page.
|
||
|
||
</p>
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
</section>
|
||
<section id="object-list//paginator//current-page" class="template-tag">
|
||
<h1>object-list//paginator//current-page</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Outputs the number of the current page.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="object-list//paginator//first-page-link" class="template-tag">
|
||
<h1>object-list//paginator//first-page-link</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Provides the URL to the first page of the list for an enclosed <code>a</code>
|
||
element.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="object-list//paginator//last-page-link" class="template-tag">
|
||
<h1>object-list//paginator//last-page-link</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Provides the URL to the last page of the list for an enclosed <code>a</code>
|
||
element.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="object-list//paginator//next-page-link" class="template-tag">
|
||
<h1>object-list//paginator//next-page-link</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Provides the URL to the next page of the list for an enclosed <code>a</code>
|
||
element.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="object-list//paginator//object-begin" class="template-tag">
|
||
<h1>object-list//paginator//object-begin</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Outputs the index of the first object shown on the current page. The value is
|
||
provided by the surrounding <code>paginator</code> element via a XSL parameter.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="object-list//paginator//object-count" class="template-tag">
|
||
<h1>object-list//paginator//object-count</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Outputs the number of elements in list.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="object-list//paginator//object-end" class="template-tag">
|
||
<h1>object-list//paginator//object-end</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Outputs the index of the last object shown on the current page. The value is
|
||
provided by the surrounding <code>paginator</code> element via a XSL parameter.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="object-list//paginator//page-count" class="template-tag">
|
||
<h1>object-list//paginator//page-count</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Outputs the number of pages.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="object-list//paginator//page-size" class="template-tag">
|
||
<h1>object-list//paginator//page-size</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Outputs the size of page (the number of items on each page).
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="object-list//paginator//prev-page-link" class="template-tag">
|
||
<h1>object-list//paginator//prev-page-link</h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0" xmlns:xs="http://www.w3.org/2001/XMLSchema">
|
||
Provides the URL to the previous page of the list for an enclosed <code>a</code>
|
||
element.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</article>
|
||
<article id="developer-manual">
|
||
<h1>Developer Manual</h1>
|
||
<section id="foundry-structure">
|
||
<h1>The structure of Foundry</h1>
|
||
<main xmlns="">
|
||
<h2>Top level structure</h2>
|
||
<p>
|
||
Foundry supports two kinds of themes: Parent themes and child themes. Parent themes
|
||
are also called master themes.
|
||
Normally there
|
||
should be only one parent theme in a CCM installation at <code>/themes/foundry</code>.
|
||
All other themes should be child themes. An example for a child theme should also be
|
||
installed at <code>/themes/foundry-base</code>.
|
||
|
||
</p>
|
||
<p>
|
||
A complete Foundry theme (a parent theme) contains of the following directories:
|
||
|
||
</p>
|
||
<dl>
|
||
<dt><code>conf</code></dt>
|
||
<dd>
|
||
Configuration files for the theme.
|
||
|
||
</dd>
|
||
<dt><code>doc</code></dt>
|
||
<dd>
|
||
The documentation of Foundry. The document you reading at the moment is
|
||
generated using these files.
|
||
|
||
</dd>
|
||
<dt><code>fonts</code></dt>
|
||
<dd>
|
||
Webfonts used in the theme.
|
||
|
||
</dd>
|
||
<dt><code>foundry</code></dt>
|
||
<dd>
|
||
The directory contains the XSL files which contain the logic part of Foundry.
|
||
|
||
</dd>
|
||
<dt><code>images</code></dt>
|
||
<dd>
|
||
Static images for the theme.
|
||
|
||
</dd>
|
||
<dt><code>libs</code></dt>
|
||
<dd>
|
||
Additional JavaScript libraries, for example jQuery plugins.
|
||
|
||
</dd>
|
||
<dt><code>scripts</code></dt>
|
||
<dd>
|
||
Custom JavaScripts
|
||
|
||
</dd>
|
||
<dt><code>styles</code></dt>
|
||
<dd>
|
||
CSS files
|
||
|
||
</dd>
|
||
<dt><code>templates</code></dt>
|
||
<dd>
|
||
The layout templates
|
||
|
||
</dd>
|
||
<dt><code>texts</code></dt>
|
||
<dd>
|
||
Static texts for the theme
|
||
|
||
</dd>
|
||
<dt><code>user</code></dt>
|
||
<dd>
|
||
Custom extensions. Not supported yet.
|
||
|
||
</dd>
|
||
</dl>
|
||
<p>
|
||
A child theme has only the directories which contain files which the designer needs
|
||
to change. These are:
|
||
|
||
</p>
|
||
<ul>
|
||
<li><code>conf</code></li>
|
||
<li><code>fonts</code></li>
|
||
<li><code>images</code></li>
|
||
<li><code>libs</code></li>
|
||
<li><code>scripts</code></li>
|
||
<li><code>styles</code></li>
|
||
<li><code>templates</code></li>
|
||
<li><code>texts</code></li>
|
||
</ul>
|
||
<p>
|
||
The <code>foundry</code> directory contains the following files and directories:
|
||
|
||
</p>
|
||
<dl>
|
||
<dt><code>fonts</code></dt>
|
||
<dd>Webfonts used internally, for example for the Content Center.</dd>
|
||
<dt><code>images</code></dt>
|
||
<dd>Images used internally.</dd>
|
||
<dt><code>lib</code></dt>
|
||
<dd>The XSL files from Foundry.</dd>
|
||
<dt><code>scripts</code></dt>
|
||
<dd>Java Scripts used internally.</dd>
|
||
<dt><code>styles</code></dt>
|
||
<dd>CSS files for internal templates like the Content Center</dd>
|
||
<dt><code>templates</code></dt>
|
||
<dd>Internal templates for example for the Content Center.</dd>
|
||
<dt><code>texts</code></dt>
|
||
<dd>Internal texts</dd>
|
||
<dt><code>main.xsl</code></dt>
|
||
<dd>
|
||
Entry point. The <code>start.xsl</code> in the base directory acts only as
|
||
entry point for the XSL processor and delegates all work to the
|
||
<code>main.xsl</code>.
|
||
|
||
</dd>
|
||
<dt><code>lib.xsl</code></dt>
|
||
<dd>
|
||
A simple import file which imports the XSL files from the lib directory.
|
||
|
||
</dd>
|
||
</dl>
|
||
<p>
|
||
The <code>main.xsl</code> file contains the <code>xsl:output</code> element
|
||
which tells the XSL processor that we want to create HTML. There is only two
|
||
XSL templates in the <code>main.xsl</code> file along with some helper functions.
|
||
This first template is the entry point for CCM and
|
||
matches the <code>bebop:page</code> element which is the root element of the
|
||
data tree XML created by CCM. The template processes the
|
||
<code>conf/templates.xsl</code> file calls the XSL templates for parsing the
|
||
layout templates.
|
||
|
||
</p>
|
||
<p>
|
||
The second templates is the entry point for the documentation system Foundry.
|
||
|
||
</p>
|
||
<h2>The lib directory</h2>
|
||
<p>
|
||
The <code>lib</code> is the core part of Foundry and contains the following
|
||
sub directories and files:
|
||
|
||
</p>
|
||
<dl>
|
||
<dt><code>bebop</code></dt>
|
||
<dd>
|
||
XSL files for creating the backend UI. The XSL files were taken from Mandalay
|
||
and have only been adapted to work inside Foundry.
|
||
|
||
</dd>
|
||
<dt><code>search</code></dt>
|
||
<dd>XSL files for the various search applications.</dd>
|
||
<dt><code>template-tags</code></dt>
|
||
<dd>
|
||
XSL files implementing the tags which can be used in the templates.
|
||
|
||
</dd>
|
||
<dt><code>template-tags</code></dt>
|
||
<dd>
|
||
This directory contains the XSL files which implement the tags which can be used
|
||
in the layout templates.
|
||
|
||
</dd>
|
||
<dt><code>bebop.xsl</code></dt>
|
||
<dd>
|
||
Imports the files from the <code>bebop</code> directory.
|
||
|
||
</dd>
|
||
<dt><code>global-vars.xsl</code></dt>
|
||
<dd>
|
||
These file is very important. It defines various global variables like the
|
||
<code>theme-prefix</code> or the <code>context-prefix</code> variables. A
|
||
complete list can be found in the
|
||
<a href="#devel-lib-global-vars.xsl">reference part</a>.
|
||
|
||
</dd>
|
||
<dt><code>search.xsl</code></dt>
|
||
<dd>Import file for the XSL files in the <code>search</code> directory.
|
||
</dd>
|
||
<dt><code>template-parser.xsl</code></dt>
|
||
<dd>
|
||
This file contains the XSL templates for parsing the layout templates.
|
||
|
||
</dd>
|
||
<dt><code>template-tags.xsl</code></dt>
|
||
<dd>
|
||
Import file for the XSL files in the <code>template-tags</code> directory.
|
||
|
||
</dd>
|
||
<dt><code>utils.xsl</code></dt>
|
||
<dd>
|
||
Helper functions. A complete list is available in the
|
||
<a href="#devel-lib-utils.xsl">reference part</a>.
|
||
|
||
</dd>
|
||
</dl>
|
||
<h2>Template tags</h2>
|
||
<p>
|
||
The <code>template-tags</code> directory contains the XSL file which are
|
||
implementing the tags which can be used in the layout templates. For a complete
|
||
list please refer to the
|
||
<a href="#template-tags-reference">Template Tags Reference</a> in the user manual.
|
||
|
||
</p>
|
||
</main>
|
||
</section>
|
||
<section id="coding-style">
|
||
<h1>Coding style</h1>
|
||
<main xmlns="">
|
||
<p>
|
||
This document describes the coding conventions for the Foundry theming engine.
|
||
|
||
</p>
|
||
<h2>Naming</h2>
|
||
<p>
|
||
The naming rules described here apply to all names: Names of layout elements,
|
||
XSL template names, XSL functions, files, ids and classes (in the
|
||
<code>class</code> attribute).
|
||
|
||
</p>
|
||
<p>
|
||
Use the dash "-" to separate parts of a name instead of camel case or the
|
||
underscore. For example: <code>get-setting</code> instead of <code>getSetting</code> or
|
||
<code>set_setting</code>.
|
||
|
||
</p>
|
||
<p>
|
||
Names should be lowercase.
|
||
|
||
</p>
|
||
<h2>Namespace declarations</h2>
|
||
<p>
|
||
In the XSL files, XML namespaces are only defined at the
|
||
<code><xsl:stylesheet></code> element. The XSL namespace is the first one is
|
||
declared first. The other namespace follow in alphabetic order (ordered by their
|
||
prefix).
|
||
|
||
</p>
|
||
<h2>Indention, line length and formating</h2>
|
||
<p>
|
||
Indention is done using spaces. Indention depth is four (4) spaces per level.
|
||
|
||
</p>
|
||
<p>
|
||
Try to keep the line length below 100 characters per line. Because of some restrictions
|
||
of XML this will be possible in every case.
|
||
|
||
</p>
|
||
<p>
|
||
Insert a line break after each attribute of an XML element. The first attribute
|
||
is on the same line as the element. For example write
|
||
|
||
</p><pre>
|
||
<xsl:param name=example-param"
|
||
select="'example'"/>
|
||
</pre><p>
|
||
instead of
|
||
|
||
</p><pre>
|
||
<xsl:param name=example-param" select="'example'"/>
|
||
</pre></main>
|
||
</section>
|
||
<section id="tutorial-content-types">
|
||
<h1>Adding support for content types</h1>
|
||
<main xmlns="">
|
||
<p>
|
||
To enable Foundry to output a Content Item of specific content type two things must be
|
||
available: One or more layout template associated with the content type and appropriate
|
||
template tags to display to informations of the content item from the data tree.
|
||
|
||
</p>
|
||
<p>
|
||
Foundry provides a general tag <a href="#show-property"><code>show-property</code></a>
|
||
which can be used to output properties of a content type. For simple types this maybe
|
||
sufficent. The name of the property can
|
||
be found out from the XML output which can be viewed by adding the parameter
|
||
<code>output=xml</code> to an URL.
|
||
|
||
</p>
|
||
<p>
|
||
For more complex types or if the value of the property should be formatted in a special
|
||
way it is maybe necessary to implement some new template tags. Tags which part of the
|
||
official distribution of Foundry are found in the
|
||
<code>foundry/lib/template-tags/content-items</code> directory. Custom extensions can
|
||
be put into the <code>user</code> directory (not supported yet).
|
||
|
||
</p>
|
||
<p>
|
||
For each content type there should be a separate file named after the content type.
|
||
A relatively simple example is the <em>NewsItem</em> type. In this case the
|
||
date of the news needs some formatting. The <code>news.xsl</code> file provides the tag
|
||
<code>news-date</code> which allows the template author to choose the format of the
|
||
date.
|
||
|
||
</p>
|
||
<p>
|
||
A more complex example is the <em>MultiPartArticle</em> type. The type needs some
|
||
templates for creating the menu with the sections etc. The tags for are evaluating the
|
||
data tree and creating the menu.
|
||
|
||
</p>
|
||
<p>
|
||
One important rule is that the template tags should not create any HTML. They should
|
||
only provided the necessary informations and output the values of properties. HTML is
|
||
only generated by the HTML tags provided by Foundry. A template tag for a content type
|
||
may enclose several HTML elements which are used to define the HTML output.
|
||
|
||
</p>
|
||
</main>
|
||
</section>
|
||
<section id="doc-system">
|
||
<h1>The documentation system of Foundry</h1>
|
||
<main xmlns="">
|
||
<h2>Overview</h2>
|
||
<p>
|
||
Foundry comes with a documentation system which creates the reference documentations
|
||
for template tags and helper functions on the fly. The documentation system –
|
||
which you using at the moment by the way – consists of three parts:
|
||
|
||
</p>
|
||
<ul>
|
||
<li>
|
||
An <code>index.jsp</code> file in the <code>doc</code> directory which invokes the
|
||
XSL transformer. Using an JSP here has the advantage that the behaviour is similar
|
||
to an <code>index.html</code>.
|
||
|
||
</li>
|
||
<li>
|
||
Some XSL templates.
|
||
|
||
</li>
|
||
<li>
|
||
And the documentation itself which consists of some XML files, some static texts
|
||
and the documentation in the other templates.
|
||
|
||
</li>
|
||
</ul>
|
||
<p>
|
||
The general structure of the documentation is defined by the
|
||
<code>doc/foundry-documentation.xml</code> file. This file is the entry point for the
|
||
XSL processor. The chapters of the documentation are defined by the
|
||
<code>foundry:doc-chapter</code> elements. The sections of the chapters are defined using
|
||
<code>foundry:doc-section</code> elements. The section which use static texts have
|
||
a <code>static</code>. The value of the <code>static</code> attribute is the name of the
|
||
file to include from the <code>doc/static-texts</code> directory. These files are normal
|
||
HTML files in XML syntax. They must have a <code>main</code> element. Only the content
|
||
of the <code>main</code> element is included into the documentation.
|
||
|
||
</p>
|
||
<p>
|
||
Sections which are generated on the fly from the XSL files of Foundry have a
|
||
<code>generate</code> attribute. The <code>generate</code> attribute controls which
|
||
documentations appear in the section.
|
||
|
||
</p>
|
||
<h2>Documentation inside XSL templates</h2>
|
||
<p>
|
||
Templates, functions and global variables are documented using the
|
||
<code>foundry:doc</code> element which is placed in the XSL directly before the element
|
||
to document. The <code>foundry:doc</code> element has two mandatory attributes. The
|
||
<code>section</code> elements is used to control in which section the documentation
|
||
appears. The second attribute is the <code>type</code> attribute. This attribute is
|
||
used to format the documentation. The possible values are:
|
||
|
||
</p>
|
||
<dl>
|
||
<dt><code>template-tag</code></dt>
|
||
<dd>
|
||
The following XSL template is a tag which can be used in the layout templates.
|
||
|
||
</dd>
|
||
<dt><code>env-var</code></dt>
|
||
<dd>
|
||
The following <code>xsl:variable</code> or <code>xsl:param</code> defines
|
||
a global variable.
|
||
|
||
</dd>
|
||
<dt><code>function</code></dt>
|
||
<dd>
|
||
The following <code>xsl:function</code> is a helper function which can be used
|
||
in the implementation of template tags.
|
||
|
||
</dd>
|
||
<dt><code>function-template</code></dt>
|
||
<dd>
|
||
The following <code>xsl:template</code> is a helper template.
|
||
|
||
</dd>
|
||
</dl>
|
||
<p>
|
||
A <code>foundry:doc</code> element can have to following child elements:
|
||
|
||
</p>
|
||
<dl>
|
||
<dt><code>foundry:doc-desc</code></dt>
|
||
<dd>
|
||
A text describing the template, function or variable. The must be structured
|
||
using HTML elements like <code>p</code>, even it is only a single paragraph.
|
||
Otherwise the text is not copied into the documentation. Look at one of the
|
||
XSL files of Foundry for an example.
|
||
|
||
</dd>
|
||
<dt><code>foundry:doc-attributes</code></dt>
|
||
<dd>
|
||
Surrounds the documentation for attributes which can be used on a template tag.
|
||
The individual attributes are documented by <code>foundry:doc-attribute</code>
|
||
elements. The <code>foundry:doc-attribute</code> has a mandatory attribute
|
||
<code>name</code> which contains the name of the attribute. The documentation of
|
||
the attribute must be enclosed in HTML elements. Look at one of the
|
||
XSL files of Foundry for an example.
|
||
|
||
</dd>
|
||
<dt><code>foundry:doc-parameters</code></dt>
|
||
<dd>
|
||
Surrounds the documentation for parameters which can be used on a function.
|
||
The individual parameters are documented by <code>foundry:doc-parameter</code>
|
||
elements. The <code>foundry:doc-parameter</code> has a mandatory parameter
|
||
<code>name</code> which contains the name of the parameter. The documentation of
|
||
the parameter must be enclosed in HTML elements. Look at one of the
|
||
XSL files of Foundry for an example.
|
||
|
||
</dd>
|
||
<dt><code>foundry:doc-see-also</code></dt>
|
||
<dd>
|
||
Contains links to other parts of the documentation or the external resources.
|
||
The links are defined using <code>foundry:doc-link</code> attributes. Each
|
||
<code>foundry:doc-link</code> has a <code>href</code> attribute which the link.
|
||
The description of the link is the content of the element.
|
||
|
||
</dd>
|
||
</dl>
|
||
</main>
|
||
</section>
|
||
<section id="function-reference">
|
||
<h1>XSL Templates and Function references</h1>
|
||
<section id="devel-lib-global-vars.xsl">
|
||
<h1>Global/environment variables</h1>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Global variables either provided by the calling CCM instance or by Foundry itself.
|
||
|
||
</p>
|
||
<section id="foundry-version" class="template-tag">
|
||
<h1>foundry-version</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The version of Foundry. Kept in sync with the version of CCM, so the first version
|
||
was be 2.2.3.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="theme-mode" class="template-tag">
|
||
<h1>theme-mode</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The mode of the theme. If the theme is standalone theme, the value is
|
||
<code>master</code>. If the theme is a child theme the value is <code>child</code>.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="master-theme" class="template-tag">
|
||
<h1>master-theme</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The master theme of the current if the theme is a child theme. if theme is direct
|
||
child of the Foundry base theme the value is <code>foundry</code>. Otherwise it is
|
||
the name of master theme.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="theme-prefix" class="template-tag">
|
||
<h1>theme-prefix</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The path the to theme file. This path is used at several points to load files which are
|
||
part of the theme, like CSS files, images and fonts.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="context-prefix" class="template-tag">
|
||
<h1>context-prefix</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The context prefix in which CCM is installed. If CCM is installed into the ROOT context
|
||
of the servlet container, this variable will be empty.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="dispatcher-prefix" class="template-tag">
|
||
<h1>dispatcher-prefix</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The path on which the CCM dispatcher Servlet is mounted. Usually this is
|
||
<code>CCM</code>.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="username" class="template-tag">
|
||
<h1>username</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The name of user currently login in CCM.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
<section id="data-tree" class="template-tag">
|
||
<h1>data-tree</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
This variable stores the XML created by CCM for later access.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
This variables stores the XML definition of the Foundry documentation.
|
||
|
||
Activate double click protection on buttons?
|
||
|
||
Activate double click protection on links?
|
||
|
||
<section class="template-tag">
|
||
<h1></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The language negotiated between CCM and the user agent.
|
||
|
||
</p>
|
||
</div>
|
||
</section>
|
||
The language to use as negotiated by CCM.
|
||
|
||
<section id="supported-languages" class="template-tag">
|
||
<h1>supported-languages</h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The languages supported by this theme. They are configured in
|
||
<code>conf/global.xml</code> using the <code><supported-languages></code>
|
||
element. Example for german and english:
|
||
<pre>
|
||
<?xml version="1.0"?>
|
||
<foundry:configuration>
|
||
…
|
||
<supported-languages default="de">
|
||
<language locale=de">
|
||
<language locale=en">
|
||
</supported-languages>
|
||
…
|
||
</foundry:configuration>
|
||
</pre></p>
|
||
</div>
|
||
</section>
|
||
<section class="template-tag">
|
||
<h1></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The language to use by theme engine for static texts etc. The language is determined
|
||
as follows:
|
||
|
||
</p>
|
||
<ul xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
<li>If the negotiated language is also in the <code>supported-languages</code></li>
|
||
<li>If not the language which set by the default attribute of the
|
||
<code><supported-languages></code> is used, but only if this language
|
||
is in the supported languages.
|
||
</li>
|
||
<li>Otherwise the first of the supported languages is used.</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="devel-lib-template-parser.xsl">
|
||
<h1>Root template tags</h1>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
These tags are the root elements of a layout template.
|
||
|
||
</p>
|
||
<section id="foundry:gen-src-url" class="function">
|
||
<h1>
|
||
Function <code>foundry:gen-src-url</code></h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Variant of <code>foundry:gen-src-url</code> without the <code>parameters</code> string
|
||
parameter.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>any</code></p>
|
||
<h3>Description</h3>
|
||
<div></div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:gen-src-url" class="function">
|
||
<h1>
|
||
Function <code>foundry:gen-src-url</code></h1>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Processes a given URL for use in the <code>src</code> attribute of an
|
||
<code>audio</code>, <code>img</code> or <code>video</code> element. The function
|
||
distigushes between this cases:
|
||
|
||
</p>
|
||
<dl xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
<dt>The URL starts with <code>http://</code> or <code>https://</code></dt>
|
||
<dd>
|
||
In this case the URL is threated as an absolute URL pointing to a resource
|
||
outside of CCM. If any parameters are passed to the function they are appended
|
||
to the URL.
|
||
|
||
</dd>
|
||
<dt>The URL starts with a slash (<code>/</code>)
|
||
</dt>
|
||
<dd>
|
||
In this case the URL points to a resource managed by the CCM which also
|
||
manages the theme. In this case the URL is prefixed with the
|
||
<code>dispatcher-prefix</code> and the parameters, if any, are appended.
|
||
|
||
</dd>
|
||
<dt>Other cases</dt>
|
||
<dd>
|
||
If none of the two other cases match the URL points to a URL in the theme. In
|
||
this case the URL is processed by the
|
||
<a href="#gen-path"><code>gen-path</code></a> function. The parameters, if any
|
||
are appended.
|
||
|
||
</dd>
|
||
</dl>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
If parameters are passed to this function they are appended to the URL. The
|
||
parameters are passed as string formatted as URL parameters, for example
|
||
<code>foo=hello&bar=world</code>. A leading <code>?</code> or <code>&</code>
|
||
is removed before adding the string the URL. If the URL already contains parameters
|
||
(if the URL contains a <code>?</code>) the paramters string is added with a leading
|
||
ampersand (<code>&</code>). If not the parameters are appended using a
|
||
<code>?</code> character.
|
||
|
||
</p>
|
||
</div>
|
||
<h2>Parameters</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Mandatory</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>src-raw</td>
|
||
<td>yes</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The raw URL to process.
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>parameters</td>
|
||
<td>yes</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
Parameters to append to the URL.
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>string</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
The processed URL.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
<section id="devel-template-tags-loaders.xsl">
|
||
<h1>Loaders</h1>
|
||
<p xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:foundry="http://foundry.libreccm.org" xmlns:ui="http://www.arsdigita.com/ui/1.0">
|
||
This tags are used to load resources required by the generated HTML documents,
|
||
for example CSS files and JavaScript files.
|
||
|
||
</p>
|
||
A helper template for generating the
|
||
<link rel="stylesheet" href="..."/> elements for loading the CSS
|
||
files.
|
||
|
||
The name of the CSS file to load. If the filename contains slashes the filename
|
||
is used as it is provided. If there are not slashes in the filename the filename
|
||
is prefixed with styles/.
|
||
|
||
The media for which the file should be loaded. If no set, the CSS file is used for all
|
||
media types.
|
||
|
||
The origin of the CSS file. If not set or the parameter is empty, the CSS file
|
||
is loaded from current theme. There also some values with
|
||
a special meaning:
|
||
master
|
||
File is loaded from the master/parent theme.
|
||
Please read the section about parent and child themes for more details.
|
||
internal
|
||
The file is loaded from the internal directories
|
||
If the current theme is a child theme, the file is loaded
|
||
from the internal directories of the parent theme.
|
||
|
||
Some examples:
|
||
<css-file>public.css</css-file>
|
||
The CSS file public.css is loaded from styles
|
||
directory in the current theme.
|
||
<css-file>bootstrap/css/bootstrap.min.css</css-file>
|
||
The CSS file bootstrap.min.css is loaded from the directory
|
||
bootstrap/css in the current theme.
|
||
<css-file origin="internal">admin.css</code>
|
||
If the current theme is a master theme, the CSS file admin.css is
|
||
loaded from the directory foundry/styles in the current theme. If
|
||
the current theme is child theme the CSS file admin.css is loaded
|
||
from the directory foundry/styles of the Foundry theme installed
|
||
at /themes/foundry.
|
||
|
||
</section>
|
||
<section id="devel-lib-utils.xsl">
|
||
<h1>Utility functions</h1>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
This file provides several utility functions and templates.
|
||
|
||
</p>
|
||
<section id="foundry:boolean" class="function">
|
||
<h1>
|
||
Function <code>foundry:boolean</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
A helper function for evaluating certain string values to boolean. This function has
|
||
two purposes. First it simplifies some expressions. for example if you have a
|
||
template tag with a attribute containing a (pseudo) boolean value (attribute values
|
||
are always treated as strings) you would have to write something like:
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
...
|
||
<xsl:if test="./@attr = 'true'">
|
||
...
|
||
</xsl:if>
|
||
...
|
||
</pre><p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
Using <code>foundry:boolean</code> this can be simplified to
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
...
|
||
<xsl:if test="foundry:boolean(./@attr)">
|
||
...
|
||
</xsl:if>
|
||
...
|
||
</pre><p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The more important purpose is to make the usage of boolean values more user
|
||
friendly, especially in the templates. Using <code>foundry:boolean</code> no only
|
||
<code>true</code> is evaluated to boolean <code>true</code>. A number of other
|
||
strings is also evaluated to <code>true</code>:
|
||
|
||
</p>
|
||
<ul xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
<li><code>true</code></li>
|
||
<li><code>TRUE</code></li>
|
||
<li><code>yes</code></li>
|
||
<li><code>YES</code></li>
|
||
<li><code>t</code></li>
|
||
<li><code>T</code></li>
|
||
<li><code>y</code></li>
|
||
<li><code>Y</code></li>
|
||
</ul>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
All other values are evaluated to <code>false</code>.
|
||
|
||
</p>
|
||
</div>
|
||
<h2>Parameters</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Mandatory</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>value</td>
|
||
<td>yes</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The value to evaluate.
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>boolean</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The evaluated boolean value.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:gen-path" class="function">
|
||
<h1>
|
||
Function <code>foundry:gen-path</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
Helper function for generating paths to theme resources like CSS files etc. Use this
|
||
function instead of concatenating paths yourself. For example, instead of
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
document(concat($theme-prefix, 'path/to/resource/file')
|
||
</pre><p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
use <code>foundry:gen-path</code>:
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
document(foundry:gen-path('path/to/resource/file'))
|
||
</pre><p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org"><code>path/to/resource/file</code> is meant as a placeholder here. A real world
|
||
example is a settings file, for example <code>conf/global.xml</code>. For this file
|
||
a usage of the <code>foundry:gen-path</code> function would look like this
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
document(foundry:gen-path('conf/global.xml')
|
||
</pre><p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The advantage of this function is the encapsulation of the path generation process.
|
||
<code>foundry:gen-path</code>.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>string</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The absolute path for the file.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:gen-path" class="function">
|
||
<h1>
|
||
Function <code>foundry:gen-path</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
Variant of <code>gen-path</code> with an additional <code>origin</code>
|
||
parameter. This parameter can have three values:
|
||
If set to <code>true</code> the file is loaded from the
|
||
<code>foundry</code> directory.
|
||
|
||
</p>
|
||
<dl xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
<dt>empty string (<code>''</code>)
|
||
</dt>
|
||
<dd>
|
||
The path points to a resource in the theme directory. The return value is the
|
||
concatenation of the theme-prefix, a slash and the path provided as first
|
||
parameter. In XPath Syntax: <code>concat($theme-prefix, '/', $path</code>.
|
||
|
||
</dd>
|
||
<dt>master</dt>
|
||
<dd>
|
||
If the theme mode (which is set in <code>conf/global.xml</code>) is set to
|
||
<code>master</code> the result is the same as for the empty string. If the
|
||
the theme mode is set to <code>child</code> the generated path points to
|
||
the parent/master theme. More exactly the result is the concatenation of the
|
||
context-prefix environment variable, the string <code>/themes/</code>, the
|
||
name of the master theme (set in <code>conf/global.xml</code>,
|
||
usally <code>foundry</code>), a slash the the path provided as first parameter.
|
||
Or in XPath syntax:
|
||
<code>concat($content-prefix, '/themes/', $master-theme, '/', $path.)</code>.
|
||
|
||
</dd>
|
||
<dt>internal</dt>
|
||
<dd>
|
||
The path points to an internal resource which is provided by Foundry. If the
|
||
theme mode is <code>master</code> the generated path is the concatenation of
|
||
the theme prefix, the string <code>/foundry/</code> and the path provided as
|
||
first parameter (XPath: <code>concat($theme-prefix, '/foundry/', $path)</code>.
|
||
If the theme mode is <code>child</code> the generated path
|
||
is the concatenation of the context prefix, the string
|
||
<code>/themes/foundry/foundry/</code> and the path provided as first parameter
|
||
(XPath: <code>concat($context-prefix, '/themes/foundry/foundry/', $path)</code>).
|
||
|
||
</dd>
|
||
</dl>
|
||
</div>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>any</code></p>
|
||
<h3>Description</h3>
|
||
<div></div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:log-level" class="function">
|
||
<h1>
|
||
Function <code>foundry:log-level</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
Helper function to generate an info message. This function be used together with
|
||
<code><xsl:message></code> to output a message in the CCM log warning
|
||
the administrator about some things in the theme, for example a missing
|
||
configuration file. Example:
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
...
|
||
<xsl:message>
|
||
<xsl:message select="foundry:message-info('Something is strange...')" />
|
||
</xsl:message>
|
||
</pre></div>
|
||
<h2>Parameters</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Mandatory</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>message</td>
|
||
<td>yes</td>
|
||
<td><code>any</code></td>
|
||
<td></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>xs:string</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
A message string of the form <code>[Foundry WARNING] $message</code> with
|
||
<code>$message</code> replaced by the value of the parameter.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:log-level" class="function">
|
||
<h1>
|
||
Function <code>foundry:log-level</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
Helper function to generate an info message. This function be used together with
|
||
<code><xsl:message></code> to output a message in the CCM log when
|
||
something goes wrong in the theme, for example when a layout file has a wrong
|
||
structure. Example:
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
...
|
||
<xsl:message>
|
||
<xsl:message select="foundry:message-info('Some error has occurred...')" />
|
||
</xsl:message>
|
||
...
|
||
</pre></div>
|
||
<h2>Parameters</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Mandatory</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>message</td>
|
||
<td>yes</td>
|
||
<td><code>any</code></td>
|
||
<td></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>xs:string</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
A message string of the form <code>[Foundry ERROR] $message</code> with
|
||
<code>$message</code> replaced by the value of the parameter.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:get-attribute-value" class="function">
|
||
<h1>
|
||
Function <code>foundry:get-attribute-value</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
A helper function for retrieving an attribute value from an element. If the
|
||
attribute is set on the current element the value of the attribute is used as
|
||
result. If the attribute is not set the <code>default-value</code> is used. This
|
||
method is used by several layout tags with optional attributes. A common use pattern
|
||
looks like this:
|
||
|
||
</p><pre xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
<xsl:template match="example">
|
||
<xsl:variable name="width"
|
||
select="foundry:get-attribute-value(current(), 'width', '640')" />
|
||
<xsl:variable name="height"
|
||
select="foundry:get-attribute-value(current(), 'height', '480')" />
|
||
/<xsl:template>
|
||
</pre><p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
In this example, the element <code>example</code> has two optional attributes:
|
||
<code>with</code> and <code>height</code>. If the attribute is set in processed XML,
|
||
the value set there is used. Otherwise the default value (<code>640</code>
|
||
respectively <code>480</code>) is used. Without this function a code block like the
|
||
one in the <code>xsl:choose</code> block of this function would be necessary for
|
||
each of the variables.
|
||
|
||
</p>
|
||
</div>
|
||
<h2>Parameters</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Mandatory</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>node</td>
|
||
<td></td>
|
||
<td><code>any</code></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>attribute-name</td>
|
||
<td></td>
|
||
<td><code>any</code></td>
|
||
<td></td>
|
||
</tr>
|
||
<tr>
|
||
<td>default-value</td>
|
||
<td></td>
|
||
<td><code>any</code></td>
|
||
<td></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>any</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The value of the attribute if it is set on the current element, the
|
||
<code>default-value</code> otherwise.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:get-setting" class="function">
|
||
<h1>
|
||
Function <code>foundry:get-setting</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
Convenient function for calling <code>foundry:get-setting</code> with only the
|
||
module name and setting name.
|
||
|
||
</p>
|
||
</div>
|
||
<h2>Parameters</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Mandatory</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>module</td>
|
||
<td>yes</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The module of the settings. May be an empty string (<code>''</code>).
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>setting</td>
|
||
<td>yes</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The name of the setting to retrieve.
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>string</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The value of the setting.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:get-setting" class="function">
|
||
<h1>
|
||
Function <code>foundry:get-setting</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
Convenient function for calling <code>foundry:get-setting</code> with only the
|
||
module name, the setting name and an default value.
|
||
|
||
</p>
|
||
</div>
|
||
<h2>Parameters</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Mandatory</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>module</td>
|
||
<td>yes</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The module of the settings. May be an empty string (<code>''</code>).
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>setting</td>
|
||
<td>yes</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The name of the setting to retrieve.
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>default</td>
|
||
<td>yes</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
A default value which is used when the setting is not configured.
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>string</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The value of the setting or the default value if the setting is not configured.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
The module of the settings. At the moment this corresponds to the name of the file
|
||
in the conf directory. The empty string as value corresponds to the
|
||
global.xml file.
|
||
|
||
The name of the setting to retrieve.
|
||
|
||
The value to use if there is no entry for the setting in the settings file.
|
||
|
||
A node from the layout template which overrides the value from the configuration.
|
||
|
||
The value of the requested setting or if no value has been set the provided default
|
||
value. If no default value has been provided the result is an empty string.
|
||
|
||
This function retrieves the value of a setting from the theme configuration. For
|
||
more informations about the configuration system of Foundry please refer to the
|
||
configuration section of the Foundry documentation.
|
||
|
||
<section id="foundry:get-static-text" class="function">
|
||
<h1>
|
||
Function <code>foundry:get-static-text</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
Retrieves at static text. For more informations about static texts in Foundry please
|
||
refer to the static texts section in the Foundry documentation.
|
||
|
||
</p>
|
||
</div>
|
||
<h2>Parameters</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Name</th>
|
||
<th>Mandatory</th>
|
||
<th>Type</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>module</td>
|
||
<td>yes</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The module of the settings. At the moment this corresponds to the name of the file
|
||
in the <code>texts</code> directory. The empty string as value corresponds to the
|
||
<code>global.xml</code> file.
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>id</td>
|
||
<td>yes</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The name of the text to retrieve.
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
<tr>
|
||
<td>lang</td>
|
||
<td>no</td>
|
||
<td><code>string</code></td>
|
||
<td>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The language to retrieve. Normally there is no need to set this parameter because
|
||
it is determined automatically.
|
||
|
||
</p>
|
||
</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>string</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The requested static text. If there is no value for the requested static text in the
|
||
module provided by the module parameter the value depends if the debug mode is
|
||
enabled or not. If the debug mode is <em>not</em> not enabled the result is an empty
|
||
string. If the debug mode is enabled, a identifier of the text (the value of the
|
||
<code>id</code> parameter) is displayed. If you point the mouse pointer of the
|
||
placeholder, the complete path of the text is shown as hovering box.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:debug-enabled" class="function">
|
||
<h1>
|
||
Function <code>foundry:debug-enabled</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
A helper function to determine if the debug mode should be enabled. The debug mode
|
||
of foundry is automatically enabled if the theme is viewed as development theme.
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>any</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org"><code>true</code> if the debug mode if active, <code>false</code> otherwise.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:parse-link" class="function">
|
||
<h1>
|
||
Function <code>foundry:parse-link</code></h1>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
Helper template to adjust links. (Copied from Mandalay)
|
||
|
||
</p>
|
||
</div>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>any</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The adjusted link.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
<section id="foundry:read-current-category" class="function">
|
||
<h1>
|
||
Function <code>foundry:read-current-category</code></h1>
|
||
<div></div>
|
||
<div>
|
||
<h2>Result</h2>
|
||
<h3>Result type</h3>
|
||
<p><code>any</code></p>
|
||
<h3>Description</h3>
|
||
<div>
|
||
<p xmlns="" xmlns:xsl="http://www.w3.org/1999/XSL/Transform" xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:bebop="http://www.arsdigita.com/bebop/1.0" xmlns:cms="http://www.arsdigita.com/cms/1.0" xmlns:foundry="http://foundry.libreccm.org">
|
||
The path of the current category.
|
||
|
||
</p>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
</section>
|
||
</article>
|
||
</main>
|
||
<footer>
|
||
<div class="border-wrapper">
|
||
(c) 2014 LibreCCM Foundation
|
||
|
||
</div>
|
||
</footer>
|
||
</body>
|
||
</html> |