CNCat 4.3.3 User Manual

Theme Files and Templates

Note: We do not recommend changing files of standard themes: it may influence correctness of the web directory update. To change the web directory design, you should create a new theme.

Design themes are located at the folder /cncat_config/themes/. Each theme is placed into a separate folder.

To create a new theme one should copy any standard theme to a new folder and specify the theme title in theme.txt file (see below).

A theme consists of template description files (*.tpl), theme description file (theme.txt) and secondary files (style.css, image files etc.).

The file theme.txt contains the name and description of the theme:

title – the theme title (displayed upon selection of a theme);
screenshot – the file name with the theme screenshot;
description – the theme description.

Template description files contain description of one or more templates, which are used depending on the displayed page:

Page	Template Files (.tpl)
Web directory page – the page, containing the list of categories and links. The main page and all categories pages belong here.	index item article category common
Detailed description of the site – the page, available by clicking the icon [+].	extended extended_article common
Web directory map – displays the list of all categories of the web directory.	map common
Search results page	search item article common
Link addition page	add add_article mail common js
Administrative interface pages	admin common mail js

Each design template describes one of the page elements or a part of the element. Below is the list of templates for each tpl-file.

Template for general structure of the web directory pages:

index.tpl
index	Defines general structure of the main page. One can specify the order of the main elements on a page.

General templates for all (or most part) user pages.

common.tpl
top	Top of the page (header)
bottom	Bottom of the page (footer)
menu	Menu items (Web Directory, Add a link etc.)
searchform	Search form
sort_top	Beginning of links sorting block
sort	Sorting block element
sort_delim	Delimiter between elements of sorting block
sort_bottom	End of links sorting block
pagenav_top	Beginning of pages navigation block
pagenav_curpage	Current page number
pagenav_pageitem	Page number
pagenav_delim1	Delimiter between adjacent page numbers
pagenav_delim2	Delimiter between distant page numbers
pagenav_bottom	End of pages navigation block
filters_top	Beginning of filters block
filter_top	Beginning of filter description
filtval	Filter value
filtval_delim	Delimiter between filter values
filter_bottom	End of filter description
filters_delim	Delimiter between filters descriptions
filters_end	End of filters block

Templates for displaying categories and subcategories, as well as path to the current category.

category.tpl
cats_top	Beginning of categories block
cats_column_top	Beginning of categories block column
cat	Description of a category; includes calling of «subcat…» templates with the list of subcategories for this category.
cats_column_bottom	End of categories block column
cats_bottom	End of categories block
subcats_top	Beginning of subcategories block for the current category
subcat	Description of a subcategory
subcats_delim	Delimiter between subcategories
subcats_more	Ellipsis or any other symbol at the end of subcategories list in case they are more than can be displayed on a page.
subcats_bottom	End of subcategories block
catpath_top	Beginning of description of the path to the current category (Main->Subcategory->Subcategory->Current category)
catpath_rootcat	Root category
catpath_parentcat_delim	Delimiter between parent categories
catpath_parentcat	One of parent categories
catpath_currentcat_delim	Delimiter between the current category
catpath_currentcat	Current category
catpath_bottom	End of description of the path to the current category

Templates for displaying links at user pages of the web directory.

item.tpl
items_top	Beginning of links block
item	Link description
items_bottom	End of links block
admin_rating_top	Beginning of the administrator’s vote block (only for the administrator)
admin_rating_num	Rating
admin_rating_num_active	Current rating of a link
admin_rating_delim	Delimiter between rating marks
admin_rating_bottom	End of the administrator’s vote block
itemcount	Number of links in a category
favitems_top	Beginning of favourite links block (the block is included into the beginning of general list of links)
favitems_bottom	End of favourite links block
brokenscript	Script for displaying a dialog box confirming broken link warning (when pressing [x] icon)
newitems_top	Beginning of new links block
newitem	Description of a new link
newitems_bottom	End of new links block

Templates for displaying articles on user pages of the web directory.

article.tpl
article	Article description
newarticles_top	Beginning of new articles block
newarticle	Description of a new article
newarticles_bottom	End of new articles block

Templates for a page with detailed description of a link.

extended.tpl
ext	Defines general structure of a page with detailed description of a link, including the description itself. Contains calling of «ext…» templates, describing the list of categories and filters for the link.
ext_cats_top	Beginning of categories list block for the current link
ext_cat	Description of a category
ext_cat_delim	Delimiter between categories
ext_cats_bottom	End of categories list block
ext_filter_top	Beginning of filters description
ext_filtval	Filter value
ext_filter_delim	Delimiter between filter values
ext_filter_bottom	End of filter description

Templates for a page containing the article text.

extended_article.tpl
ext_article	Defines general structure of a page which contains the text of an article. Contains calling of «ext…» templates, describing the list of categories and filters for the article.
ext_cats_top	Beginning of categories list block for the current article
ext_cat	Description of a category
ext_cat_delim	Delimiter between categories
ext_cats_bottom	End of categories list block
ext_filter_top	Beginning of filters description
ext_filtval	Filter value
ext_filter_delim	Delimiter between filter values
ext_filter_bottom	End of filter description

Templates for the page «Web directory map».

map.tpl
map	Defines structure of the web directory map page
map_cat_next_level	Displayed upon increasing of the category nesting level
map_cat	Description of a category
map_cat_prev_level	Displayed upon decreasing of the category nesting level

Templates for search results page. Templates from item.tpl file are used for links displaying.

search.tpl
search	Defines structure of search results page.

Templates for link addition page.

add.tpl
add	Defines general structure of all pages of link addition
form	Defines structure of link addition form (for «One-step» mode)
step1 step2 step3	Defines structure of link addition forms (for «Wizard» mode)
final	Defines information, displayed upon link addition
field_link_url field_back_link field_site_title field_cats field_email field_descr field_descr_full field_meta_keywords field_meta_descr field_captcha field_submit	Define elements of link fields
extfield_ext_int1 extfield_ext_double1 extfield_ext_varchar1 extfield_ext_datetime1 extfield_ext_text1 extfield_ext_text2 extfield_ext_text3	Define elements of extended link fields
add_filter_top	Beginning of filter value selection block (includes filter name)
add_filtval	Element of filter value selection
add_filter_bottom	End of filter value selection block
add_backlinks_top	Beginning of backward links block
add_backlink	Description of a backward link
add_backlinks_bottom	End of backward links block
add_errors_top	Beginning of errors list block
add_error	Description of an error
add_errors_bottom	End of errors list block
add_cat_next_level	Displayed upon increasing of categories nesting level in the list of categories
add_cat	Categories selection element
add_cat_prev_level	Displayed upon decreasing of categories nesting level in the list of categories

Templates for a page to add articles on.

add_article.tpl
add_article_form	Defines the structure of a form for adding articles

Templates for displaying links in the administrative interface.

admin.tpl
admin_items_begin	Beginning of links block in the administrative interface
admin_item	Description of a link
admin_items_end	End of links block
admin_item_cat	Description of a link category
admin_item_cat_delim	Delimiter between categories
admin_item_rating	Element of a link rating

Description of JavaScript scripts.

js.tpl
js_calendar	Options for displaying built-in calendar (in the administrative interface)

Templates of notification letters for administrators and users.

mail.tpl
mail_admin_to mail_admin_from mail_admin_subject mail_admin_body	Description of a template for letters notifying the administrator and moderators
mail_add_from mail_add_reply_to mail_add_subject mail_add_body	Description of a template for letters notifying users about preliminary addition of a link to the web directory at the administrator’s consideration
mail_approve_from mail_approve_reply_to mail_approve_subject mail_approve_body	Description of a template for letters notifying users about link submission in the web directory
mail_decline_from mail_decline_reply_to mail_decline_subject mail_decline_body	Description of a template for letters notifying users about link refusal

Previous | Table of Contents | Next

Documentation

Our Products

CNCat 4.3.3 User Manual