Translations of this page:

Structure of VI templates

Common templates

common/htmlheader.html

Contains html document header and head section. Ends by open body tag. This header is used on all Claromentis pages (including pop-ups), and so htmlheader and htmlfooter should contain only those scripts and stylesheets that are required for all Claromentis pages.
Includes: common/style.html

common/htmlfooter.html

Pair to htmlhader.html, contains closing tag body and html. Also can contains common scripts and other elements.

common/header.html

Contains structural elements of entire page layout, scripts and styles common for all pages except pop-ups. All not closed tags open in that file must be closed in template common/footer.html.
Includes: common/page_top.html, common/infobar.html
Must NOT be modified in custom VIs. Need to change common/page_top.html instead.

common/footer.html

Pair to header.html, contains closing tags for common/header.html and except them must not contain unopen or unclosed tags.
Includes: common/page_bottom.html
Must NOT be modified in custom VIs. Need to change common/page_bottom.html instead.

common/page_top.html

Contains layout of page header (company logo, accessibility menu, top navigation, status line, quick search form etc..). All tags open in this file must be closed. This template must not contain unopen of unclosed tags
Can be modified in custom VIs.

common/infobar.html

Contains infobar lauout. All open tags must be closed, no incomplete tags allowed.
Can be modified in custom VIs.

common/page_bottom.html

Contains page footer lauout. All open tags must be closed, no incomplete tags allowed.
Can be modified in custom VIs.

common/style.html

Contains tags to include stylesheet files. Only styles common for all applications should be there.

Application VI files

Templates forming layout and decoration of applications have the following structure:

[app_name]/[app_name]header.html
[app_name]/[app_name]footer.html
[app_name]/[appname]style.html
,

where [app_name] - application name. For example, docsheader.html, docsfooter.html etc.

[app_name]/[app_name]header.html

Includes common templates htmlheader and header, contains application title and application menu, includes application-specific styles. In order to keep compatibility with other VIs, template should not contain incomplete tags.
Includes: common/htmlheader.html, common/header.html, [appname]style.html

[app_name]/[app_name]footer.html

Pair to [app_name]header.html. Usually contains only lines including common/footer and common/htmlfooter. May contains application specific scripts. Should not contain incomplete tags.
Includes: common/footer.html, common/htmlfooter.html

[app_name]/[app_name]style.html

Template, describing application-specific stylesheets.

Common structure of html in Claromentis pages

All Claromentis pages have the structure of tags, described below. In order to create compatible VIs that won’t break with upgrades, it’s strongly recommended to keep that structure and only change content of its blocks.

<div id="page_box">
	<div id="header">
		Header
	</div>
	<div id="main_container">
		<div id="infobar_main">
			Infobar
		</div>
		<div id="page_content">
			Page Content
		</div>
		<div id="sidebar">
			Sidebar
		</div>
	</div>
	<div id="footer">
		Footer
	</div>
</div>
page_box Common page container
header Page header, usually including logotype, navigation, status line, infobar toggle button and quick search form. Content if this block is taken from file common/page_top.html.
main_container Container for multi-column content (infobar-content-sidebar)
infobar_main Infobar block.
For correct showing/hiding that block, it must have id=”infobar_main”, and also it must be direct sibling of block with id=”main_container”. Content of infobar is taken from common/infobar.html.
page_content Block of main content of a page.
sidebar Right column. Usually used only on home page and its content is taken from file main/right_column.html

See also

 
customisation/design/vi_structure.txt · Last modified: 07/06/2011 04:49 by admin
 
Recent changes RSS feed Creative Commons License Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki