The configuration file, theme.ini
, identifies the theme to
Perforce Chronicle and specifies its initial configuration. The following example shows the
contents of a typical configuration file:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 | ; Chronicle Theme title = Theme Name version = 1.0 description = A description of the theme. icon = icon.png tags = free-form, tags, describing, theme [maintainer] name = Maintainer Name email = maintainer@email.address [stylesheets] all.href[] = reset.css all.href[] = text.css screen.media = screen screen.href = layout.css print.media = print print.href = print.css [scripts] javascript[] = common.js [regions] sidebar.1.title = Menu Widget sidebar.1.type = menu/widget sidebar.1.options.menu = sidebar |
The following section provides details about the elements of the configuration file. All elements are optional unless they are specifically marked as required.
Table 11.1. Theme Configuration Elements
Element | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
title | The title of the theme. | |||||||||
version | The revision of the theme. | |||||||||
description | Describes the general characteristics of the theme. For example, its appearance, special features, or intended use. | |||||||||
tags | Descriptive terms for ad-hoc categorization of themes. Can be space or comma separated. | |||||||||
icon | A graphic for the theme, specified using an absolute URL or a URL that is relative to the theme folder. The suggested size is 256 x 256 pixels. | |||||||||
maintainer | The name, email, and web site of the theme maintainer. | |||||||||
stylesheets |
Defines the CSS stylesheets that need to be included
during HTML presentation. Specify each stylesheet using
an absolute URL or a URL that is
relative to the theme folder. Stylesheets can target specific media types as
follows:
|
|||||||||
regions |
Defines widgets to be installed in named regions when the theme is applied.
The format of the section is as follows:
<Valid properties for widgets in the regions section are as
follows:
|
|||||||||
scripts | A list of client-side script files to include on every page. You must group scripts by type (e.g. javascript, vbscript). Specify each script using an absolute URL or a URL that is relative to the theme folder. | |||||||||
doctype |
Specifies the version of markup that this theme is written in. The default
is XHTML1_STRICT . Valid values are as follows:
|
|||||||||
menus |
Defines menus and menu items to be installed when the theme is applied.
For example:
|
|||||||||
meta |
Defines document metadata to include on every page. Support is provided for
named meta tags (such as description and keywords) as well as
http-equiv tags (such as content-type). For example:
|
|||||||||
types |
Defines content types to be installed when the theme is applied. Content
types control the structure of content entries. For example:
|