oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

added template variable definitions as an option to the help system

Browse source
This commit is contained in:
JT Smith 2006-05-14 04:05:51 +00:00
parent 7653f450b4
commit 0673df503d
7 changed files with 293 additions and 114 deletions
Download patch file Download diff file Expand all files Collapse all files

65
lib/WebGUI/Help/Asset_Folder.pm
View file

@ -37,7 +37,70 @@ our $HELP = {
'folder template' => {
title => 'folder template title',
body => 'folder template body',
fields => [
fields => [ ],
variables => [
{
name => 'addFile.url',
}, {
name => "addFile.label",
}, {
name => "subfolder_loop",
variables => [
{
name => "id",
description => "folder id"
}, {
name => "url",
description => "folder url"
}, {
name => "title",
description => "folder title"
}, {
name => "icon.small",
description => "folder icon.small"
}, {
name => "icon.big",
description => "folder icon.big"
}
]
}, {
name => "file_loop",
variables => [
{
name => "id",
}, {
name => "canView",
}, {
name => "title",
}, {
name => "synopsis",
}, {
name => "size",
}, {
name => "date.epoch",
}, {
name => "icon.small",
}, {
name => "icon.big",
}, {
name => "type",
}, {
name => "url",
}, {
name => "isImage",
}, {
name => "canEdit",
}, {
name => "controls",
}, {
name => "isFile",
}, {
name => "thumbnail.url",
}, {
name => "file.url",
}
],
}
],
related => [
{

2
lib/WebGUI/International.pm
View file

@ -86,7 +86,7 @@ A string that specifies the language that the user should see. Defaults to the
=cut
my $safeRe = qr/[^\w\d\s\/]/;
my $safeRe = qr/[^\.\w\d\s\/]/;
sub get {
my ($self, $id, $namespace, $language) = @_;

24
lib/WebGUI/Operation/Help.pm
View file

@ -247,6 +247,7 @@ sub www_viewHelp {
'uiLevel' => $row->{uiLevel},
} if ($uiOverride || ($userUiLevel >= ($row->{uiLevel} || 1)));
}
$vars{variable_loop1} = _getTemplateVars($session, 1, $help->{variables}, $i18n);
my $body = WebGUI::Asset::Template->new($session,"PBtmplHelp000000000001")->process(\%vars);
my $uiOverrideText = $uiOverride ? $i18n->get('show my fields','WebGUI') : $i18n->get('show all fields','WebGUI');
$ac->addSubmenuItem(_link($session, $session->form->process("hid"), $namespace).";uiOverride=".!$uiOverride, $uiOverrideText) if $userUiLevel < 9;
@ -259,6 +260,29 @@ sub www_viewHelp {
);
}
sub _getTemplateVars {
my $session = shift;
my $level = shift;
my $variables = shift;
my $i18n = shift;
my $template = [];
foreach my $row (@{$variables}) {
my $indent = [];
my $label = "";
if (exists $row->{variables}) {
my $newLevel = $level + 1;
$indent = _getTemplateVars($session, $newLevel, $row->{variables}, $i18n);
$label = "variable_loop".$newLevel;
}
push ( @{$template}, {
title => $row->{name},
description=> $i18n->get($row->{description} || $row->{name}),
$label => $indent
});
}
return $template;
}
#-------------------------------------------------------------------
=head2 _viewHelpIndex ( $session )

4
lib/WebGUI/Session.pm
View file

@ -371,7 +371,9 @@ sub open {
my $config = WebGUI::Config->new($webguiRoot,$configFile);
my $self = {_config=>$config, _server=>$server};
bless $self , $class;
$self->{_request} = Apache2::Request->new($request, POST_MAX => 1024 * $self->setting->get("maxAttachmentSize")) if (defined $request);
#$self->{_request} = Apache2::Request->new($request, POST_MAX => 1024 * $self->setting->get("maxAttachmentSize")) if (defined $request);
# something screwed about POST_MAX, must look at this later
$self->{_request} = Apache2::Request->new($request) if (defined $request);
my $sessionId = shift || $self->http->getCookies->{"wgSession"} || $self->id->generate;
my $noFuss = shift;
$self->{_var} = WebGUI::Session::Var->new($self,$sessionId, $noFuss);

237
lib/WebGUI/i18n/English/Asset_Folder.pm
View file

@ -62,95 +62,160 @@ to do you want to go to the new Folder?</p>|,
},
'folder template body' => {
message => q|<p>The following variables are available in Folder Templates:</p>
<p><b>addFile.url</b><br />
The url for adding files to the Folder.</p>
<p><b>addFile.label</b><br />
The internationalized label for adding files to the Folder.</p>
<p><b>subfolder_loop</b><br />
A loop containing all Folder assets which are children of the Folder.</p>
<div class="helpIndent">
<p><b>id</b><br />
The assetId of the Folder.</p>
<p><b>url</b><br />
The url of the Folder.</p>
<p><b>title</b><br />
The title of the Folder.</p>
<p><b>icon.small</b><br />
The URL to a small icon of the appropriate type for this Asset.</p>
<p><b>icon.big</b><br />
The URL to a big icon of the appropriate type for this Asset.</p>
</div>
<p><b>file_loop</b><br />
A loop containing all non-Folder assets which are children of the Folder.</p>
<div class="helpIndent">
<p><b>id</b><br />
The assetId of the Asset.</p>
<p><b>canView</b><br />
A conditional indicating if the current user can view this Asset.</p>
<p><b>title</b><br />
The title of the Asset.</p>
<p><b>synopsis</b><br />
The synopsis of the Asset.</p>
<p><b>size</b><br />
The size of the Asset, formatted.</p>
<p><b>date.epoch</b><br />
The date the Asset was last updated, relative to the epoch.</p>
<p><b>icon.small</b><br />
A URL to a small icon that represents the Asset.</p>
<p><b>icon.big</b><br />
A URL to an icon that represents the Asset.</p>
<p><b>type</b><br />
The type of this Asset.</p>
<p><b>url</b><br />
The URL of the Asset.</p>
<p><b>isImage</b><br />
A conditional indicating if this Asset is an Image Asset.</p>
<p><b>canEdit</b><br />
A conditional indicating if this Asset can be edited by the current user.</p>
<p><b>controls</b><br />
The editing control bar for this child</p>
<p><b>isFile</b><br />
A conditional indicating if this Asset is a File Asset.</p>
<p><b>thumbnail.url</b><br />
If this Asset is an Image, the URL to the thumbnail for it.</p>
<p><b>file.url</b><br />
If this Asset is a File Asset (File, Image or Zip Archive), the URL to the actual file for downloading. Otherwise,
this variable will be empty</p>
</div>
|,
message => q|The following variables are available in Folder Templates: |,
lastUpdated => 1146775736,
},
'addFile.url' => {
message => q|The url for adding files to the Folder.|,
lastupdated => 0,
context => q|Template variable description.|
},
'addFile.label' => {
message => q|The internationalized label for adding files to the Folder.|,
lastupdated => 0,
context => q|Template variable description.|
},
'subfolder_loop' => {
message => q|A loop containing all Folder assets which are children of the Folder.|,
lastupdated => 0,
context => q|Template variable description.|
},
'folder id' => {
message => q|The assetId of the Folder.|,
lastupdated => 0,
context => q|Template variable description.|
},
'folder url' => {
message => q|The url of the Folder.|,
lastupdated => 0,
context => q|Template variable description.|
},
'folder title' => {
message => q|The title of the Folder.|,
lastupdated => 0,
context => q|Template variable description.|
},
'folder icon.small' => {
message => q|The URL to a small icon of the appropriate type for this Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'folder icon.big' => {
message => q|The URL to a big icon of the appropriate type for this Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'file_loop' => {
message => q|A loop containing all non-Folder assets which are children of the Folder.|,
lastupdated => 0,
context => q|Template variable description.|
},
'id' => {
message => q|The assetId of the Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'canView' => {
message => q|A conditional indicating if the current user can view this Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'title' => {
message => q|The title of the Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'synopsis' => {
message => q|The synopsis of the Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'size' => {
message => q|The size of the Asset, formatted.|,
lastupdated => 0,
context => q|Template variable description.|
},
'date.epoch' => {
message => q|The date the Asset was last updated, relative to the epoch.|,
lastupdated => 0,
context => q|Template variable description.|
},
'icon.small' => {
message => q|A URL to a small icon that represents the Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'icon.big' => {
message => q|A URL to an icon that represents the Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'type' => {
message => q|The type of this Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'url' => {
message => q|The URL of the Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'isImage' => {
message => q|A conditional indicating if this Asset is an Image Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'canEdit' => {
message => q|A conditional indicating if this Asset can be edited by the current user.|,
lastupdated => 0,
context => q|Template variable description.|
},
'controls' => {
message => q|The editing control bar for this child.|,
lastupdated => 0,
context => q|Template variable description.|
},
'isFile' => {
message => q|A conditional indicating if this Asset is a File Asset.|,
lastupdated => 0,
context => q|Template variable description.|
},
'thumbnail.url' => {
message => q|If this Asset is an Image, the URL to the thumbnail for it.|,
lastupdated => 0,
context => q|Template variable description.|
},
'file.url' => {
message => q|If this Asset is a File Asset (File, Image or Zip Archive), the URL to the actual file for downloading. Otherwise, this variable will be empty.|,
lastupdated => 0,
context => q|Template variable description.|
},
'assetName' => {
message => q|Folder|,
context => q|label for Asset Manager|,