ImageVisit DNNStuff

Aggregator Templates

Modified: 2008/03/25 09:30 by dnnstuffadmin - Categorized as: Aggregator - Paths: Aggregator

The layout of each Aggregator is defined by a template. A template corresponds to a sub folder of the /Templates folder. Each template is then made up of a number of html template files. There are currently 5 different html files that are needed to make up a complete template.

Edit

HTML Template Files

Layout.html - this defines the overall layout of the module and should contain the [TABSTRIP] and [TABPAGES] tokens. This file will determine the overall layout of the skin such as whether tabs are on the top, bottom, left, right or inline.

TabStrip.html - this defines the layout of the section that contains the tabs should contain a [TABS] token.

Tab.html - this defines how each tab will be rendered and must contain [TABID], [TABACTION] and [TABCAPTION] tokens.

TabPage.html - this defines how each content pane will be rendered and must contain [TABPAGEID], [TABPAGEACTION] and [TABPAGECONTENT] tokens.

Paging.html - this defines how the paging controls will be rendered and should contain a combination of [PAGEFIRSTACTION], [PAGELASTACTION], [PAGEPREVACTION], [PAGENEXTACTION] and [PAGINGITEMLIST] tokens.

PagingItem.html - this defines how the individual paging page number controls will be rendered and must contain a [PAGEACTION] token.

Image

Anatomy of a Skin Template


Edit

Tokens

Tokens are used inside template html and are replaced at runtime with content specific to the token name.

[TABSTRIP]
Replaced with contents of the tabstrip.html template

[TABPAGES]
Replaced with the content created by multiple applications of the tabpage.html template, once for each tab.

[TABS]
Replaced with the content created by multiple applications of the tab.html template, once for each tab.

[PREVNEXT]
Replaced with the content created by the prevnext.html template. If the prev/next option is not turned on in the module settings, this will be replaced with an empty string. If the prev/next option is turned on and you have not defined a [PREVNEXT] token in your template layout, one will be automatically added to the bottom of your layout.

[TABID]
Replaced by a unique id for the tab.

[TABNUMBER]
Replaced by the numeric tab number of the tab.

[TABACTION]
Replaced by the click actions required by a tab.

[TABCAPTION]
Replaced by the tab caption.

[SKIN]
Replaced by the combination of skin name and template name (i.e. Default_Top) or by the theme name only if still using old theme names. This is generally used to create a full class name for an element.

[TABPAGEID]
Replaced by a unique id for the tab page.

[TABPAGEACTION]
Replaced by the actions required for the tab page.

[TABPAGECONTENT]
Replaced by the content contained on the tab page, i.e. the modules you are including on the tab

[PREVACTION]
Replaced by the click actions required by the previous button.

[NEXTACTION]
Replaced by the click actions required by the next button.

[SKINFOLDER]
Replaced by the path to the skin folder. This is generally used to provide a path to images in templates. For instance, if your skin is named 'Default' and your template is 'Top', this will point to the '\DesktopModules\DNNStuff - Aggregator\Skins\Default\Top' folder

[SKINBASEFOLDER]
Replaced by the path to the skin base folder. This is generally used to provide a path to images in templates that are used for the whole skin series. For instance, if your skin is named 'Default', this will point to the '\DesktopModules\DNNStuff - Aggregator\Skins\Default' folder





ScrewTurn Wiki version 2.0.19. Some of the icons created by FamFamFam.