Retired Documentation: You are using the documentation for version 1.7.3 which was retired in 2013. Go here for the latest version documentation or check here for your available upgrades to the latest version.

Wiki Theme Template

The wiki's theme (visual design) is determined by a single php file (the template) located in the themes/wiki_themes directory. The following describes how the Theme Template is put together and lists the available tags, parameters, and variables for each section of the Theme Template.

NOTE: The included default wiki theme is fully commented with all the tags, parameters, and variables available in the wiki. This provides a quick reference while building your own theme or modifying the default one.

How the Template Works

The Theme Template is divided up into sections. Each section determines how a portion of the wiki is rendered. Each section has tags, parameters, and/or variables available to it. They work like normal ExpressionEngine tags, parameters, and variables except that you'll use them in a Theme Template instead of a ExpressionEngine Template within the Control Panel.

When you open the Theme Template in a text editor you'll find the beginning of each section clearly marked with a comment. For example, the start of the History section looks like this:


/* ----------------------------------------

/*  Template - History

/* ----------------------------------------*/

You'll find all the available tags, parameters, and variables at the end of the section.

Sections

This is a list of all the sections in the order they appear in the default template. It will be helpful to have the default template file (themes/wiki_themes/default/default.php) open in a text editor while reviewing the Template section documentation.

Wiki Page: This is the wrapper section that contains the header, sidebar, navigation, CSS, and the elements found in a standard HTML page including the CSS. It "wraps" around all the user editable content.
Wiki Article: Displays the article and a list of it's assigned categories.
Wiki History: Displays an article's history.
Wiki Edit: Displays a article's editing interface.
Special sections: Content created dynamically by the wiki.
- Recent Changes: This section creates a page that shows the wiki's recent changes.
- Categories: This section creates a page of the wiki's categories.
- Titles: This section creates a page of all the wiki's articles by title.
- Uncategorized: This section creates a page of all uncategorized wiki articles.
- Search Results: This section creates a page to display wiki search results.
- Files list: This section creates a page of all the files uploaded to the wiki.
- File page: This displays the information about a single uploaded file.
- Upload Form: This section creates the wiki's upload form.
- Associated Pages: This section displays a list of pages that link to the current article.
RSS and ATOM feeds: The templates used to generate the wiki's feeds.
Email notification: The templates used to create the article moderator notification email.