From 1750090b756940e6001d6e657f4209e4b3520ebc Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Sat, 1 Jan 2005 18:12:09 +0000 Subject: [PATCH] Asset macros documented --- lib/WebGUI/Help/Asset.pm | 10 ++++++++++ lib/WebGUI/i18n/English/Asset.pm | 30 +++++++++++++++++++++++++++++- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/lib/WebGUI/Help/Asset.pm b/lib/WebGUI/Help/Asset.pm index 27ecc3da0..5cc2238b0 100644 --- a/lib/WebGUI/Help/Asset.pm +++ b/lib/WebGUI/Help/Asset.pm @@ -7,6 +7,16 @@ our $HELP = { related => [ ] }, + 'asset macros' => { + title => 'asset macros title', + body => 'asset macros body', + related => [ + { + tag => 'macros using', + namespace => 'WebGUI' + }, + ] + }, }; 1; diff --git a/lib/WebGUI/i18n/English/Asset.pm b/lib/WebGUI/i18n/English/Asset.pm index 72d0f1c43..58d099dff 100644 --- a/lib/WebGUI/i18n/English/Asset.pm +++ b/lib/WebGUI/i18n/English/Asset.pm @@ -74,7 +74,35 @@ A short description of an asset. It is used in default meta tags, site maps and 'asset add/edit title' => { message => q|Asset, Add/Edit|, lastUpdated => 1100463645, - }, + }, + + 'asset macros title' => { + message => q|Asset Macros|, + lastUpdated => 1104544909, + }, + + 'asset macros body' => { + message => q|

These macros are used to access Assets on your site.

+

^AssetProxy();
+^AssetProxy(Asset URL);
+This macro is used to render an Asset and display it inline according +to its template. Any Asset can be displayed, including Navigations, +images, links to files for downloading, snippets or for displaying +content from another part of the site on this page. + +

^FileUrl();
+^FileUrl(Asset URL);
+This macro is used to return a filesystem URL to an Asset that isn't in the database (file, image, snippet) identified by its Asset URL. + +

^RandomAssetProxy();
+^RandomAssetProxy(Asset URL);
+This macro works similarly to the ^AssetProxy(); macro except instead of displaying the +Asset, it picks a random Asset from the descendents of the Asset whose URL is supplied as the +argument. +

+ |, + lastUpdated => 1104545608, + }, 'asset' => { message => q|Asset|,