GPTEngine logo

GPTEngine End User Documentation

<prev | up | next>

Themes development

Theme naming

The structure of a GPTEngine theme begins with its name.
Every theme must have an user friendly name and a system name.
The system name (lets call it shortname) must be a lowercase alphanumeric string (16 characters max) that uniquely identifies your theme within your system, while the user friendly name -- 32 characters max -- (lets call it displayname) is the way your theme will be identified by users (administrators).

Folder structure

A (installable) theme file is simply a tar compressed folder (whose contents will be discussed below) which is later renamed by changing the tar extension to gptm. The resulting file name, as the name of the original uncompressed folder, must be your theme's shortname.

shortname (folder)shortname.tarshortname.gptm

The contents of a minimal working theme folder should be as described below:

plugin folder structure

Styling settings (in order of listing, with SQL description)

Except for the field Extra_CSS, which includes the actual CSS code of your theme, all other fields are meant for backwards compatibility only and can be given arbitrary values.

FieldTypeNullKeyDefaultExtra
Theme (displayname)varchar(32)NOtheme
Main_Container_Margin_Topvarchar(8)NO0
Main_Container_Margin_Bottomvarchar(8)NO0
Main_Container_Margin_Leftvarchar(8)NO0
Main_Container_Margin_Rightvarchar(8)NO0
Main_Container_Padding_Topvarchar(8)NO0
Main_Container_Padding_Bottomvarchar(8)NO0
Main_Container_Padding_Leftvarchar(8)NO0
Main_Container_Padding_Rightvarchar(8)NO0
Main_Container_Background_Colorvarchar(32)NO#ffffff
Main_Container_Background_Image_URLvarchar(255)YESnone
Main_Container_Background_Image_Positionvarchar(16)NOtop left
Main_Container_Background_Image_Attachmentenum('scroll',
'fixed')
NOscroll
Main_Container_Background_Image_Repeatenum('repeat',
'repeat-x',
'repeat-x',
'no-repeat')
NOno-repeat
Main_Container_Border_Widthvarchar(8)NO0
Main_Container_Border_Styleenum('none',
'hidden',
'dotted',
'dashed',
'solid',
'double',
'groove',
'ridge',
'inset',
'outset')
NOnone
Main_Container_Border_Colorvarchar(32)NO#ffffff
Main_Container_Font_Familyvarchar(64)NOVerdana,
Arial,
sans-serif
Main_Container_Font_Sizevarchar(8)NO12px
Main_Container_Font_Styleenum('normal',
'italic',
'bold',
'bold/italic')
NOnormal
Main_Container_Font_Colorvarchar(32)NO#000000
Main_Container_Link_Colorvarchar(32)NO#0000ff
Main_Container_Link_Hover_Colorvarchar(32)NO#ff0000
Main_Container_Link_Active_Colorvarchar(32)NO#000000
Main_Container_Link_Visited_Colorvarchar(32)NO#ff00ff
Main_Content_Margin_Topvarchar(8)NO0
Main_Content_Margin_Bottomvarchar(8)NO0
Main_Content_Margin_Leftvarchar(8)NO0
Main_Content_Margin_Rightvarchar(8)NO0
Main_Content_Padding_Topvarchar(8)NO0
Main_Content_Padding_Bottomvarchar(8)NO0
Main_Content_Padding_Leftvarchar(8)NO0
Main_Content_Padding_Rightvarchar(8)NO0
Main_Content_Background_Colorvarchar(32)NO#ffffff
Main_Content_Background_Image_URLvarchar(255)YESnone
Main_Content_Background_Image_Positionvarchar(16)NOtop left
Main_Content_Background_Image_Attachmentenum('scroll',
'fixed')
NOscroll
Main_Content_Background_Image_Repeatenum('repeat',
'repeat-x',
'repeat-x',
'no-repeat')
NOno-repeat
Main_Content_Border_Widthvarchar(8)NO0
Main_Content_Border_Styleenum('none',
'hidden',
'dotted',
'dashed',
'solid',
'double',
'groove',
'ridge',
'inset',
'outset')
NOnone
Main_Content_Border_Colorvarchar(32)NO#ffffff
Main_Content_Font_Familyvarchar(64)NOVerdana,
Arial,
sans-serif
Main_Content_Font_Sizevarchar(8)NO12px
Main_Content_Font_Styleenum('normal',
'italic',
'bold',
'bold/italic')
NOnormal
Main_Content_Font_Colorvarchar(32)NO#000000
Main_Content_Link_Colorvarchar(32)NO#0000ff
Main_Content_Link_Hover_Colorvarchar(32)NO#ff0000
Main_Content_Link_Active_Colorvarchar(32)NO#000000
Main_Content_Link_Visited_Colorvarchar(32)NO#ff00ff
Header_Margin_Topvarchar(8)NO0
Header_Margin_Bottomvarchar(8)NO0
Header_Margin_Leftvarchar(8)NO0
Header_Margin_Rightvarchar(8)NO0
Header_Padding_Topvarchar(8)NO0
Header_Padding_Bottomvarchar(8)NO0
Header_Padding_Leftvarchar(8)NO0
Header_Padding_Rightvarchar(8)NO0
Header_Background_Colorvarchar(32)NO#ffffff
Header_Background_Image_URLvarchar(255)YESnone
Header_Background_Image_Positionvarchar(16)NOtop left
Header_Background_Image_Attachmentenum('scroll',
'fixed')
NOscroll
Header_Background_Image_Repeatenum('repeat',
'repeat-x',
'repeat-x',
'no-repeat')
NOno-repeat
Header_Border_Widthvarchar(8)NO0
Header_Border_Styleenum('none',
'hidden',
'dotted',
'dashed',
'solid',
'double',
'groove',
'ridge',
'inset',
'outset')
NOnone
Header_Border_Colorvarchar(32)NO#ffffff
Header_Font_Familyvarchar(64)NOVerdana,
Arial,
sans-serif
Header_Font_Sizevarchar(8)NO12px
Header_Font_Styleenum('normal',
'italic',
'bold',
'bold/italic')
NOnormal
Header_Font_Colorvarchar(32)NO#000000
Header_Link_Colorvarchar(32)NO#0000ff
Header_Link_Hover_Colorvarchar(32)NO#ff0000
Header_Link_Active_Colorvarchar(32)NO#000000
Header_Link_Visited_Colorvarchar(32)NO#ff00ff
Footer_Margin_Topvarchar(8)NO0
Footer_Margin_Bottomvarchar(8)NO0
Footer_Margin_Leftvarchar(8)NO0
Footer_Margin_Rightvarchar(8)NO0
Footer_Padding_Topvarchar(8)NO0
Footer_Padding_Bottomvarchar(8)NO0
Footer_Padding_Leftvarchar(8)NO0
Footer_Padding_Rightvarchar(8)NO0
Footer_Background_Colorvarchar(32)NO#ffffff
Footer_Background_Image_URLvarchar(255)YESnone
Footer_Background_Image_Positionvarchar(16)NOtop left
Footer_Background_Image_Attachmentenum('scroll',
'fixed')
NOscroll
Footer_Background_Image_Repeatenum('repeat',
'repeat-x',
'repeat-x',
'no-repeat')
NOno-repeat
Footer_Border_Widthvarchar(8)NO0
Footer_Border_Styleenum('none',
'hidden',
'dotted',
'dashed',
'solid',
'double',
'groove',
'ridge',
'inset',
'outset')
NOnone
Footer_Border_Colorvarchar(32)NO#ffffff
Footer_Font_Familyvarchar(64)NOVerdana,
Arial,
sans-serif
Footer_Font_Sizevarchar(8)NO12px
Footer_Font_Styleenum('normal',
'italic',
'bold',
'bold/italic')
NOnormal
Footer_Font_Colorvarchar(32)NO#000000
Footer_Link_Colorvarchar(32)NO#0000ff
Footer_Link_Hover_Colorvarchar(32)NO#ff0000
Footer_Link_Active_Colorvarchar(32)NO#000000
Footer_Link_Visited_Colorvarchar(32)NO#ff00ff
Left_Sidebar_Margin_Topvarchar(8)NO0
Left_Sidebar_Margin_Bottomvarchar(8)NO0
Left_Sidebar_Margin_Leftvarchar(8)NO0
Left_Sidebar_Margin_Rightvarchar(8)NO0
Left_Sidebar_Padding_Topvarchar(8)NO0
Left_Sidebar_Padding_Bottomvarchar(8)NO0
Left_Sidebar_Padding_Leftvarchar(8)NO0
Left_Sidebar_Padding_Rightvarchar(8)NO0
Left_Sidebar_Background_Colorvarchar(32)NO#ffffff
Left_Sidebar_Background_Image_URLvarchar(255)YESnone
Left_Sidebar_Background_Image_Positionvarchar(16)NOtop left
Left_Sidebar_Background_Image_Attachmentenum('scroll',
'fixed')
NOscroll
Left_Sidebar_Background_Image_Repeatenum('repeat',
'repeat-x',
'repeat-x',
'no-repeat')
NOno-repeat
Left_Sidebar_Border_Widthvarchar(8)NO0
Left_Sidebar_Border_Styleenum('none',
'hidden',
'dotted',
'dashed',
'solid',
'double',
'groove',
'ridge',
'inset',
'outset')
NOnone
Left_Sidebar_Border_Colorvarchar(32)NO#ffffff
Left_Sidebar_Font_Familyvarchar(64)NOVerdana,
Arial,
sans-serif
Left_Sidebar_Font_Sizevarchar(8)NO12px
Left_Sidebar_Font_Styleenum('normal',
'italic',
'bold',
'bold/italic')
NOnormal
Left_Sidebar_Font_Colorvarchar(32)NO#000000
Left_Sidebar_Link_Colorvarchar(32)NO#0000ff
Left_Sidebar_Link_Hover_Colorvarchar(32)NO#ff0000
Left_Sidebar_Link_Active_Colorvarchar(32)NO#000000
Left_Sidebar_Link_Visited_Colorvarchar(32)NO#ff00ff
Right_Sidebar_Margin_Topvarchar(8)NO0
Right_Sidebar_Margin_Bottomvarchar(8)NO0
Right_Sidebar_Margin_Leftvarchar(8)NO0
Right_Sidebar_Margin_Rightvarchar(8)NO0
Right_Sidebar_Padding_Topvarchar(8)NO0
Right_Sidebar_Padding_Bottomvarchar(8)NO0
Right_Sidebar_Padding_Leftvarchar(8)NO0
Right_Sidebar_Padding_Rightvarchar(8)NO0
Right_Sidebar_Background_Colorvarchar(32)NO#ffffff
Right_Sidebar_Background_Image_URLvarchar(255)YESnone
Right_Sidebar_Background_Image_Positionvarchar(16)NOtop left
Right_Sidebar_Background_Image_Attachmentenum('scroll',
'fixed')
NOscroll
Right_Sidebar_Background_Image_Repeatenum('repeat',
'repeat-x',
'repeat-x',
'no-repeat')
NOno-repeat
Right_Sidebar_Border_Widthvarchar(8)NO0
Right_Sidebar_Border_Styleenum('none',
'hidden',
'dotted',
'dashed',
'solid',
'double',
'groove',
'ridge',
'inset',
'outset')
NOnone
Right_Sidebar_Border_Colorvarchar(32)NO#ffffff
Right_Sidebar_Font_Familyvarchar(64)NOVerdana,
Arial,
sans-serif
Right_Sidebar_Font_Sizevarchar(8)NO12px
Right_Sidebar_Font_Styleenum('normal',
'italic',
'bold',
'bold/italic')
NOnormal
Right_Sidebar_Font_Colorvarchar(32)NO#000000
Right_Sidebar_Link_Colorvarchar(32)NO#0000ff
Right_Sidebar_Link_Hover_Colorvarchar(32)NO#ff0000
Right_Sidebar_Link_Active_Colorvarchar(32)NO#000000
Right_Sidebar_Link_Visited_Colorvarchar(32)NO#ff00ff
Extra_CSSlongtextYESNULL
© 2015 by popux. All rights reserved.