plainblack.com
Username Password
search
Bookmark and Share
Subscribe

Assets

Introduction

Assets are the building blocks of any WebGUI site. They can be, for example, Article assets for serving static HTML content, Gallery assets for presenting multimedia content or Collaboration System assets, which are used for the realization of Fora, Weblogs, Guest Books, and many more. Even the visible pages presented to the user are assets - namely Page Layout assets. They serve as containers for other assets, determine the way they are arranged and build the hierarchical structure of the site. At the time of writing there are more than 40 assets available in WebGUI (Version 7.5) providing almost any functionality you can think of. And their number is continuosly growing. An overview of available assets is given in the following section.

New assets can be added to a Page Layout by changing into Administration Mode and clicking on one of the items in the New Content panel. If in Administration Mode, existing assets can be edited, copied, cut or deleted by using respective Admin Controls shown on top of each Asset. Alternatively, the Asset Manager in the Admin Console can be used for creating or managing assets. Although, the type of settings available for a particular asset very much depends on the asset itself, a number of common settings exist. Similarly, a number of common variables are available that can be used in templates of any asset. Both, settings and template variables, are described in respective sections below.

Overview

In the following, a summary of available assets is given, including a brief description of their functionality. Note that not all of them are truly assets in the sence of becoming a new object in the asset hierachy after creation. Instead, some of them are rather frontends that can be used to create other assets (e.g. a Folder in the case of the File Pile). In addition to assets included in the list, there exist other assets that cannot be created directly by content managers. Instead, they are managed through container assets, like e.g. the Collaboration System or Gallery. These assets will not be addressed here but in the documentation of respective containers.

Article - A multipurpose asset for serving static HTML content. The Rich Editor is used for editing.

Carousel - an object that will flip through objects by the push of a button.

Calendar - A full-featured calendar serving as a container for Event assets. Aggregated events are available in the ical format for export to external calendar applications.

Collaboration System - Probably the most versatile asset, which can be used for the realization of fora, weblogs, request trackers, guest books, FAQs and many more. It serves as a container for Post assets, which are bundled by Thread assets. Collaboration System assets feature a powerful subscription system. Optionally, aggregated posts can be made available via RSS feeds.

Dashboard -

Data Form -

Donation -

Event Management System -

File - Representation of an arbitrary file in the WebGUI asset hierarchy. File assets can only be created via the Asset Manager or indirectly via the File Pile or Zip Archive.

File Pile - A frontend to the Folder asset, which allows for uploading of many files at a time. A new Folder asset is created after submission, containing a File asset for each uploaded file.
(What about images? Are they detected automatically? - Bernd, 10/22/08)

Flat Discount Coupon -

Folder - A multipurpose container asset for structuring content on the site. Unlike the Page Layout, the Folder asset does not render the content of childrens for visual presentation. Instead, a file manager like view is given. By default, Folder assets are included in navigation.

Gallery - An advanced photo gallery, which replaces the old gallery provided through the Collaboration System. It serves as a container for Photo assets, which are bundled by Photo Album assets.

HTTP Proxy - The HTTP Proxy asset brings content from another site into your page. External content can be de-styled, filtered, and URLs may be rewritten.

Image - Representation of an arbitrary image file in the WebGUI asset hierarchy. Image assets can only be created via the Asset Manager or uploaded from within the Rich Editor.

In/Out Board - an object that is commonly used on an intranet to track a users status in the office (whether they are in or out for the day)

Matrix - an object that can be used to compare multiple products in a matrix (table) format.

MultiSearch - A common frontend for a number of popular search engines.

Message Board - A container for aggregating Collaboration System assets.

Navigation - A multipurpose navigation asset, which can be used for the realization of menus, sitemaps and locators. In particular when combined with javacscript, some fancy results can be produced.

Newsletter - An object for posting newsletters and also sending out newsletters to subscribed users.

Page Layout - A container asset for structuring content. It is the equivalent of a visual page on the site. Unlike the Folder asset, the Page Layout is used for rendering the content of children according to a certain layout. By default, Page Layout assets are included in navigation.

Poll - Simple poll asset for having users choose from a list of alternatives. Features the generation of different graphs for the display of results.

Product - An object that is sold in an ecommerce site. Often put on a Shelf or Page layout.

Project Manager - An object that is used to managing projects.

Redirect - An asset for redirecting page requests. Useful for forwarding to external content or if a page has moved. Note that for forwarding to internal content Shortcuts should be used instead.

Request Tracker - An object used to track change requests on a project or service. A todo list.

SQL Report - A flexible frontend for executing SQL queries and presetation of the results. Can be used to generate all kinds of reports from site internal data, but is not limited to that. Additional databases can be added via Databases in the Admin Console.

SQL Form - The counterpart of the SQL Report asset, which can be used to insert data into an external database. Access to WebGUI system tables is not allowed! Therefore, an external database has to be registered via Databases in the Admin Console before this asset can be used.

Search - General site-wide search asset. The scope can be limited to certain classes of assets. Note that Collaboration System assets come with a search function by themselves.

Shelf - A container object that holds products on an ecommerce site.

Snippet - A multipurpose asset for serving arbitrary text content. Typical applications are CSS stylesheets or HTML code for embedding external content. Unlike the Article asset, the content type may be different from text/html.

Stock Data - A widget of sorts that allows you to view how your stock is doing in the market place.

Subscription -

Surveys - A customizable survey asset supporting different types of questions (yes/no, opinion, text, etc.). It can be run in survey or quiz mode. The order of questions may be sequential, randomized or response-driven. Results from the survey are summarized in reports and can be exported to text files.

Syndicated Content - An RSS feed aggregator, which can be used to integrate external content provided in RSS feeds. Another use is the display of recent posts to Collaboration System assets or any other asset supporting RSS feeds.

Thingy - Each thing is like a table to use database terminology, or a form to use paper terminology. (See: Thingy - what is it and what can you do with it?)

Time Tracker - A object for tracking the amount of time spent a projects or activities.

User List - An asset for displaying a list of registered users.

Weather Data - A client for serving weather data from weather.com. An account is required, before this service can be used.

Web Services Client - A client to perform SOAP requests to webservices. It can be used, for example, to retrieve currency exchange rates, weather data or perform Google searches using your own templates to display the retrieved data.

Wiki - A basic Wiki implementation for collaborative writing. It serves as acontainer for Wiki Page assets, which correspond to individual articles. Features include automatic link generation, indexing based on keywords, and lists of most popular or recently updated articles.

Zip Archive - A Mechanism for importing and serving external web content. The specified zip archive is uploaded and unpacked into the uploads location. Afterwards, a link to the imported content is given.

 

Common Settings

Properties

AssetID - This is the unique identifier WebGUI uses to keep track of this Asset instance. Normal users should never need to be concerned with the asset id, but some advanced users may need to know it for things like SQL Reports. The asset id is not editable.

Title - The title of the Asset. This should be descriptive, but not very long. If left blank, this will be set to "Untitled". Macros, HTML and javascript may not be placed in the title. Note: You should always specify a title, even if the Asset template will not use it. In various places on the site, like the Page Tree, Clipboard and Trash, the title is used to distinguish this Asset from others.

Menu Title - A shorter title that will appear in navigation. If left blank, this will default to the Title.

URL - The URL for this Asset. It must be unique. If this field is left blank, then an URL will be made from the parent's URL and the Menu Title.

Description - A content area in which you can place as much content as you wish. For instance, even before an FAQ there is usually a paragraph describing what is contained in the FAQ.

Display

Hide from navigation? - Select yes, if you whish to hide this Asset from navigation menus and site maps. This setting may be overridden by the Show hidden pages setting in the Navigation asset.

Open in new window? - Select yes to open this Asset in a new window. This feature must be supported by the Navigation template in use. It may not work in some navigations, or if the user turns off javascript, or it may be blocked by some pop-up blockers.

Display the title? - Select yes, if you wish to display the Asset's title.

Style Template - The style template to enclose your asset if it is viewed directly. If the asset is displayed as part of a Page Layout, the Page Layout's style template is used instead.

Printable Style - The printable style template to enclose your Asset if it is printed from a direct view. If the asset is displayed as part of a Page Layout, the Page Layout's printable style is used instead.

Cache Timeout - The period of time this Asset may be cached. A long period increases performance while a short period should be chosen for rapidly changing content.

Security

Owner - The owner of this Asset. This user has full editing and viewing rights. The owner will default to the owner of the parent Asset. It can only be changed by an administrator.

Who can view? - The user group who can view this Asset. This will default to the group who can view the parent of this Asset. Note: If you want both visitors and registered users to be able to view this Asset, you should choose "Everybody".

Who can edit? - The user group who can edit this Asset. This will default to the group who can edit the parent of this Asset. Note: This group can also always view the Asset.

Metadata

Summary - A short description of this Asset. The Summary is used to fill the Synopsis template variable (see below) and plays a role in searching.

 

Extra <head> elements (tags) - These tags will be added to the < head>  section of each page on which this Asset appears.

Make package? - Select yes, if you want this Asset to be available as a package. Many WebGUI tasks are very repetitive. Automating these tasks in WebGUI, such as creating an Asset, or sets of Assets, is done by creating a package that can be reused throughout the site. See also Packages.

Make prototype? - Select yes, if you want this Asset to become a prototype. A prototype allows you to save the settings of an Asset, and then reuse that Asset throughout the site. See also Prototypes.

Make this asset exportable? - Select yes, if you want this Asset to be exportable as static HTML. Note that the Asset's parents must be exportable, too, for an export of the complete branch. Also, exporting has to be enabled in the WebGUI config file for this site. See also Static Exports.

Prepend URL from parent? - Select yes, if the URL of this asset should be prepended by the URL of its parent.

Keywords - Keywords to be added to the search index and as keyword metatags in the <head> section of each page on which the asset appears. Adding keywords will improve the meaningfulness of search results and potentially leads to better indexing by search engines.

Common Template Variables

Most assets feature the following set of common template variables. However, there is no general rule, which variables are indeed available. Respective indication will be given in the documentation for each asset.

assetSize - The size of this asset in bytes. It is calculated from the size of of all database fields and attachments.

controls - HTML snipped for rendering the icons and URLs that allow editing, cutting, copying, deleting and reordering the Asset.

encryptPage - A boolean that will be true if this Asset is set to be served over SSL.

extraHeadTags - Extra tags that will be added to the header of the page containing this Asset. These will be included by default so you do not need to add them youself, unless you want them to be included twice.

groupIdView - The ID of the group that is allowed to view this Asset.

groupIdEdit - The ID of the group that is allowed to edit this Asset.

isHidden - A boolean that will be true if this Asset is set not to be displayed in Navigations.

isPackage - A boolean that will be true if this Asset is set to be a Package.

isPrototype - A boolean that will be true if this Asset is set to be a Prototype.

menuTitle - The title of this Asset used in Navigations.

newWindow - A boolean that will be true if this Asset is set to open in a new browser window.

ownerUserId - The ID of the user who owns this Asset.

synopsis - A short description of the contents of this Asset. In most cases this variable is filled from the Summary setting (see above).

status - With respect to version control, the status of this Asset. Typically these are the English strings "approved", "pending", "committed".

title - The title of this Asset.

url - This Asset's URL.

Keywords: Assets overview settings Templates

2conexcol: "Good to have this page, but disappointing to see that the creators of the assets don't care about writing a good description of the asset. No description inside webgui either :("
Search | Most Popular | Recent Changes | Wiki Home
© 2018 Plain Black Corporation | All Rights Reserved