From c5d862fb8e3d466d0b4c06a7a5ca9deec3c09065 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Sat, 30 Dec 2006 05:37:26 +0000 Subject: [PATCH] Removed some very old, out of date docs about when the Navigation configs were managed. Updated the template variables, and added ISA relationships and asset template variables. --- lib/WebGUI/Help/Asset_Navigation.pm | 82 +++++++++++++------ lib/WebGUI/i18n/English/Asset_Navigation.pm | 87 ++++++++++++++++----- 2 files changed, 129 insertions(+), 40 deletions(-) diff --git a/lib/WebGUI/Help/Asset_Navigation.pm b/lib/WebGUI/Help/Asset_Navigation.pm index c37fb1d32..35aa32608 100644 --- a/lib/WebGUI/Help/Asset_Navigation.pm +++ b/lib/WebGUI/Help/Asset_Navigation.pm @@ -72,10 +72,6 @@ our $HELP = { tag => 'navigation template', namespace => 'Asset_Navigation' }, - { - tag => 'navigation manage', - namespace => 'Asset_Navigation' - }, { tag => 'template add/edit', namespace => 'Asset_Template' @@ -86,7 +82,11 @@ our $HELP = { 'navigation template' => { title => '1096', body => '1097', - fields => [ + isa => [ + { + namespace => "Asset_Navigation", + tag => "navigation asset template variables" + }, ], variables => [ { @@ -289,7 +289,61 @@ our $HELP = { namespace => 'Asset_Navigation' }, { - tag => 'navigation manage', + tag => 'template language', + namespace => 'Asset_Template' + } + ] + }, + + 'navigation asset template variables' => { + title => 'navigation asset template variables title', + body => 'navigation asset template variables body', + isa => [ + { + namespace => "Asset_Wobject", + tag => "wobject template variables" + }, + ], + fields => [ + ], + variables => [ + { + 'name' => 'templateId' + }, + { + 'name' => 'mimeType variable' + }, + { + 'name' => 'assetsToInclude' + }, + { + 'name' => 'startType' + }, + { + 'name' => 'startPoint' + }, + { + 'name' => 'ancestorEndPoint' + }, + { + 'name' => 'descendantEndPoint' + }, + { + 'name' => 'showSystemPages' + }, + { + 'name' => 'showHiddenPages' + }, + { + 'name' => 'showUnprivilegedPages' + }, + { + 'name' => 'reversePageLoop' + }, + ], + related => [ + { + tag => 'navigation add/edit', namespace => 'Asset_Navigation' }, { @@ -299,22 +353,6 @@ our $HELP = { ] }, - 'navigation manage' => { - title => '1094', - body => '1095', - fields => [ - ], - related => [ - { - tag => 'navigation template', - namespace => 'Asset_Navigation' - }, - { - tag => 'navigation add/edit', - namespace => 'Asset_Navigation' - } - ] - }, }; 1; diff --git a/lib/WebGUI/i18n/English/Asset_Navigation.pm b/lib/WebGUI/i18n/English/Asset_Navigation.pm index 75beffba0..12af30ed3 100644 --- a/lib/WebGUI/i18n/English/Asset_Navigation.pm +++ b/lib/WebGUI/i18n/English/Asset_Navigation.pm @@ -205,7 +205,7 @@ vertical, horizontal and crumbtrail. These templates can often be styled via CS of rewriting the templates.

The Navigation Asset can also be used to generate XML output by creating a template and setting the MIME Type appropriately. This could be useful for building -a Google sitemap of your site.

+a Google sitemap of your site or RSS feeds.

|, lastUpdated => 1140139614, @@ -552,23 +552,6 @@ given page inside of the page_loop

lastUpdated => 1163720438, }, - '1094' => { - message => q|Navigation, Manage|, - lastUpdated => 1078208044 - }, - - '1095' => { - message => q|

The general idea behind the navigation system is that instead of hardwiring all the various choices you might make into the code, the system manages a 'library' of these styles, just the way it does with Snippets, Images, Templates, Page Styles, and other types of reusable information. You can create a new 'Navigation menu style', give it a name, and then use it anywhere on your site that you like.

-

The navigation system consists of two parts:

-
    -
  1. The ^Navigation(); macro, which determines which files may be included in the menu and which template to use.
    2. -
  2. The Navigation Template, which creates the menu and presents it to the user.
    3. -
-

To create a new menu for your site, place a ^Navigation(myMenu); macro into a style. An "edit myMenu" link will be displayed if "myMenu" is not defined.

-

Note: In this example "myMenu" is used, but you can pick any name, as long as it is unique.

|, - lastUpdated => 1101774239 - }, - 'mimeType' => { message => q|MIME Type|, lastUpdated => 1140129010, @@ -580,6 +563,74 @@ given page inside of the page_loop

lastUpdated => 1140129008, }, + 'navigation asset template variables title' => { + message => q|Navigation Asset Template Variables|, + lastUpdated => 1164841146 + }, + + 'navigation asset template variables body' => { + message => q|Every asset provides a set of variables to most of its +templates based on the internal asset properties. Some of these variables may +be useful, others may not.|, + lastUpdated => 1164841201 + }, + + 'templateId' => { + message => q|The ID of the template used to display this Navigation|, + lastUpdated => 1164841201 + }, + + 'mimeType variable' => { + message => q|The MIME type of the page containing the Navigation.|, + lastUpdated => 1164841201 + }, + + 'assetsToInclude' => { + message => q|An newline separated string containg the kids of assets to include in the Navigation, by relationship. Ancestors, the asset itself, siblings, descendents and/or pedigree.|, + lastUpdated => 1164841201 + }, + + 'startType' => { + message => q|A string that describes how the Navigation will be told to start finding Assets to display, "specificUrl", "relateiveToCurrentUrl", "relativeToRoot"|, + lastUpdated => 1164841201, + context => q|Note to translators, the strings in quotes should not be translated.| + }, + + 'startPoint' => { + message => q|Depending on startType, this is specifies at which page the Navigation will begin listing Assets.|, + lastUpdated => 1164841201, + }, + + 'ancestorEndPoint' => { + message => q|Depending on the startType, how many levels up to begin listing Assets in the Navigation.|, + lastUpdated => 1164841201, + }, + + 'descendantEndPoint' => { + message => q|Depending on the startType, how many levels down to go before stopping the list of Assets for the Navigation.|, + lastUpdated => 1164841201, + }, + + 'showSystemPages' => { + message => q|Whether or not the Navigation has been configured to display system pages, like the Trash.|, + lastUpdated => 1164841201, + }, + + 'showHiddenPages' => { + message => q|Whether or not the Navigation has been configured to display Assets that are set to be hidden from Navigations.|, + lastUpdated => 1164841201, + }, + + 'showUnprivilegedPages' => { + message => q|Whether or not the Navigation has been configured to display Assets that the current user is not allowed to see.|, + lastUpdated => 1164841201, + }, + + 'reversePageLoop' => { + message => q|Whether or not the Navigation has been configured to display Assets depth first, instead of top to bottom.|, + lastUpdated => 1164841201, + }, + }; 1;