first cut at documenting AdminBar template variables

This commit is contained in:
Colin Kuskie 2004-12-23 07:02:24 +00:00
parent 30234369ab
commit 1f88c760a3

View file

@ -142,10 +142,88 @@ our $I18N = {
<p/>
<b>&#94;AdminBar;</b><br>
Places the administrative tool bar on the page. This is a required element in the "body" segment of the Style Manager. This macro uses a style sheet class called <i>.adminBar </i>, which you may want to account for in your style.
<b>&#94;AdminBar(<i>custom template ID</i>);</b><br>
Places the administrative tool bar on the page. Omitting this macro will prevent you from adding content, pasting
content from the clipboard, accessing the help system and other administrative functions.
<p>
The macro takes up to one optional argument, an alternate template in the Macro/AdminBar namespace for generating the AdminBar. The following variables are available in the template:
<p/>
<b>packages.label</b><br/>
The internationalized label for adding packages.
<p/>
<b>packages.canAdd</b><br/>
A boolean indicating whether the current user can add packages.
<p/>
<b>addContent.label</b><br/>
The internationalized label for adding content.
<p/>
<b>contenttypes_loop</b><br/>
The loop containing different types of content to add
<blockquote>
<p/>
<b>contenttype.label</b><br/>
The internationalized label for this content type.
<p/>
<b>contenttype.url</b><br/>
The URL for adding an instance of this content type.
</blockquote>
<p/>
<b>addpage.label</b><br/>
The internationalized label for adding a page.
<p/>
<b>addpage.url</b><br/>
The URL for adding a page.
<p/>
<b>clipboard.label</b><br/>
The internationalized label for the clipboard.
<p/>
<b>clipboard_loop</b><br/>
The loop containing a list of items in the clipboard.
<blockquote>
<p/>
<b>clipboard.label</b><br/>
The label for this item in the clipboard.
<p/>
<b>clipboard.url</b><br/>
The URL for pasting this clipboard item onto the current page.
</blockquote>
<p/>
<b>admin.label</b><br/>
The internationalized label for administrative functions.
<p/>
<b>admin_loop</b><br/>
The loop containing a list of administrative functions, such as turning off admin mode or
validating the current page.
<blockquote>
<p/>
<b>admin.label</b><br/>
The label for this item in the clipboard.
<p/>
<b>admin.url</b><br/>
The URL for executing this admin function.
</blockquote>
<p/>
The <i>.adminBar</i> style sheet class is tied to the default template for this macro.
<b>&#94;c; - Company Name</b><br>
The name of your company specified in the settings by your Administrator.
@ -206,7 +284,7 @@ The translated label for the printable link, or the text that you supply to the
<p>
<b>NOTES:</b>The .makePrintableLink style sheet class is tied to this macro.
<b>NOTES:</b>The <i>.makePrintableLink</i> style sheet class is tied to the default template for this macro.
<p>
@ -234,7 +312,7 @@ The URL for your company specified in the settings by your Administrator.
|,
lastUpdated => 1101885686,
lastUpdated => 1103785706,
},
'1021' => {