Skip to end of metadata
Go to start of metadata

ThemeBuilder Macro - Use Skin

use-skin

Sets the skin used for the current page

Categories: development

Usage

Storage Format

<ac:macro ac:name="use-skin">
   <ac:parameter ac:name="parameter">value</ac:parameter>
</ac:macro> 

Wiki Markup

{use-skin:parameter=value}

Parameter

Name

Description

Type

Default

Required

skin

Skin

The ID of the skin to use

string

 

(tick)

latch

Latch

Latch the use of this skin for the remainder of the session

  • false – only change the layout for this page
  • true – change the layout for all pages

boolean

false

(error)

flaglogicRender Flag-LogicUse the flaglogic from the target skin instead of this skinbooleanfalse(error)

flag

Flag

A list of flags, one of which must be defined for the content to be displayed

string

 

(error)

notflag

Not Flag

A list of flags which must not be defined for the content to be displayed

string

 

(error)

Basic Example

Set the skin to be MYSKIN

<ac:macro ac:name="use-skin">
   <ac:parameter ac:name="skin">MYSKIN</ac:parameter>
</ac:macro> 
{use-skin:skin=MYSKIN}

Result

Skin is switched from the default to the one named in the macro, overriding anything set by ThemeBuilder.

Advanced Example

Use a previously set flag to switch the skin in edit mode. See Set Flag for how to set a flag.

<ac:macro ac:name="use-skin">
   <ac:parameter ac:name="skin">MYSKIN</ac:parameter>
   <ac:parameter ac:name="flag">edit</ac:parameter>
</ac:macro> 
{use-skin:skin=MYSKIN|flag=edit}

Result

Skin is switched from the default to the one named in the macro if the flag 'edit' is true, overriding anything set by ThemeBuilder.