Widget Field Definitions

From Aikiframework wiki

Jump to: navigation, search

Contents

Definitions

Name

name of widget

Site

site widget exists in (usually default)

Target

Body & Header , output widget to body or header.

Type

Select the type of widget, div is default

Render Order

The order that the widget displays in a URL. The lower the number, the higher the position on the screen. This setting is also visually depicted in the Aiki Admin Widget menu.

Also, negative numbers work too.

Style (class)

Add's a class definition to the containing div or other object as defined in 'Type'.

Is Father

Set this to yes if this widget will have children.

Father Widget

Use this to select the Father widget of your current widget. (You can use this to create "nested divs").

Address (URL)

A set of the names of pages that the widget will appear in. Separate with one pipe "|".

homepage|blog|press

Kill URLS

If you have a url like writers/list, then you would put writers in the kill urls to stop reading by writers for the full url.

Select Query

enter a sql select query here to have the widget return database results.

Authorized Select Query

if the field Require Special Permissions is set then you may provide an authorized select query to the users in the defined Permissions Group. This can return different data than the above, but only one set depending on authorized permission.

No Results Error

This is what will be displayed if their is either an error in your sql, or an empty results set. In this case pagination if defined will not display and the widget will display this field.

Content

This is what is shown in the widget, note there is an authorized content that works like the Authorized select query.

CSS

You may enter css to style the widget. This css is added to one css file that is created for each url based on the widgets that are in it.

nogui Content

Its used when you have an ajax behavior over markuped up ouptut. If you want to do edit in place for wiki page, if you used the normal method it will show an edit box with html tags instead of wiki markup, so nogui is used to have the widget output the actual markup on ajax call

<bassel> it's a bit complicated

Display results in row of

self explanatory. If you have a sql statement and results to return this variable will help you to make rows with the returned data.

Records per page

set the number of records to show per page, provided the field below, Pagination Link Example, this will create your pagination inside of the widget.

Pagination Link Example

?page=[page] config[group_by:10]

Page Title

set the title of the page.

Require Special Permissions

yes/no , if this is yes then you may grant access to the groups provided in the field "Permissions Groups"

If Authorized content

this will appear if the viewer is an authorized user.

Permissions Group

the name of the permissions group.

Remove Container

set to yes to remove the surrounding div/object.

Cache timeout

Number of milliseconds to timeout on the widget being cached.

Custom Output

Yes/no , if you're using a custom http header then you want to set this to yes.

Send Custom Http Header

put your custom http header here.

Active

Yes/no

activates/deactivates widget

See Related Pages