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 Page Section

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 as outlined in the screencap below.

The variables available to the Wiki Page section are divided into the following broad categories:

Single Variables
Namespace Variables
Path Variables
Member Variables
Conditional Variables
List of Categories - {wiki:categories_list}

elapsed_time

{elapsed_time}

Time to render page

original_page

{original_page}

If a page is redirected, this tag displays the name of the original page. This is used inside redirected conditional.

redirect_page

{redirect_page}

If a page redirects this variable sets the page to which it redirects. The value is set dynamically by ExpressionEngine. This variable is used inside redirect_page conditional.

revision_id

{revision_id}

If you are viewing a revision of an article, this variable displays the the revision id for that revision.

title

{title}

Displays the Title/Name of the article page. This variable also works with Special and File template sections too).

wiki_name

{wiki_name}

Displays the Wiki's Full Name (see the Wiki Control Panel).

XID_HASH

{XID_HASH}

This variable is a required value for hidden form field 'XID' used in secure forms.

Namespace Variables

{namespace}
{category_namespace}
{file_namespace}
{image_namespace}
{main_namespace}
{special_namespace}

namespace

{namespace}

The current namespace being viewed on the page.

category_namespace

{category_namespace}

The name of the 'Category' namespace.

file_namespace

{file_namespace}

The name of the 'File' namespace.

image_namespace

{image_namespace}

The name of the 'Image' namespace.

main_namespace

{main_namespace}

The name of the 'Main' default namespace, which is where all articles without a namespace in their title are put.

special_namespace

{special_namespace}

The name of the 'Special' namespace.

Path Variables

{path:wiki_home}
{path:view_article}
{path:edit_article}
{path:article_history}

path:wiki_home

{path:wiki_home}

This variable will generate the URL for the wiki's homepage which is set in the Wiki Control Panel. For example, this:

<a href="{path:wiki_home}">Home</a>

Would be rendered like this:

<a href="http://example.com/index.php/wiki/">Home</a>

This is useful for linking to special pages like Categories, Title list, etc... For example, this:

<a href="{path:wiki_home}Special:Titles">Title List</a>

Would be rendered like this:

<a href="http://example.com/index.php/wiki/Special:Titles">Title List</a>

path:view_article

{path:view_article}

When viewing an article page this variable displays the URL to view the article. Think of it as the article's "permalink".

path:edit_topic

{path:edit_topic}

When viewing an article page this variable displays the URL to edit the article.

path:article_history

{path:topic_history}

When viewing an article page this variable displays the URL to an article's history.

Member Variables

{if logged_out}
{if logged_in}
{screen_name}
{path:login}
{path:register}
{path:memberlist}
{path:your_profile}
{path:your_control_panel}
{path:logout}

if logged_out

{if logged_out}

This conditional checks to see if the user IS NOT logged in.

if logged_in

{if logged_in}

This conditional checks to see if the user IS logged in.

screen_name

{screen_name}

Displays the Screen Name for logged in user.

path:login

{path:login}

Displays the URL to the Login page.

path:register

{path:register}

Displays the URL to the Register page.

path:memberlist

{path:memberlist}

Displays the URL to the Member List page.

path:your_profile

{path:your_profile}

Displays the URL to the Profile page of the logged in user.

path:your_control_panel

{path:your_control_panel}

Displays the URL to the Your Control Page of the logged in user.

path:logout

{path:logout}

Displays the URL to the logout script.

NOTE to Discussion Forum Module users: The Wiki tag has an optional parameter called profile_path="". When this parameter is used, you can direct the member paths from the default member area of your ExpressionEngine installation to the Discussion Forum member area.

Conditional Variables

The best way to understand how these conditionals are used is to look at the code in the themes/wiki_themes/default/default.php file. Do a search for the conditional you are reviewing and see how it is used in the template.

{if new_article}
{if article}
{if redirected}
{if redirect_page}
{if revision}
{if edit_article}
{if article_history}
{if special_page}
{if file_page}
{if can_edit}
{if cannot_edit}
{if can_admin}
{if cannot_admin}
{if uploads}

if new_article

{if new_article}

Checks to see if current page is a new article.

if article

{if article}

Checks to see if the current page is an article.

if redirected

{if redirected}

Checks to see if the current page has been redirected from another page.

if redirect_page

{if redirect_page}

Checks if the current page should redirect to another page.

if revision

{if revision}

Checks to see if the current page is a revision of an article.

if edit_article

{if edit_article}

Checks to see if the current page is the article's Editing page.

if article_history

{if article_history}

Checks to see if the current page is the article's History page.

if special_page

{if special_page}

Checks to see if the current page is a Special page(Categories, Title list, etc...) in the wiki.

if file_page

{if file_page}

Checks to see if the current page is the special File page in the wiki.

if can_edit

{if can_edit}

Checks to see if the current visitor to the page is logged in and has permission to edit the article.

if cannot_edit

{if cannot_edit}

Checks to see if the current visitor to the page is logged in and does not have permission to edit the article.

if can_admin

{if can_admin}

Checks to see if the logged in user is a wiki administrator.

if cannot_admin

{if cannot_admin}

Checks to see if the current user is not a wiki admin.

if uploads

{if uploads}

Checks to see if the wiki allows uploads and if the upload info is valid.

{wiki:categories_list}

This tag is used to display all the wiki's categories. Unlike the {wiki:categories} tag, it is not affected by being put in an article page. It has Parameters and Variables available to it.

{wiki:categories_list} | Parameters

backspace=""
show_empty=""
style=""

backspace=""

{wiki:categories backspace="#"}

This removes "#" number of characters from the output at the end of the loop. This is useful for removing commas and <br />'s.

show_empty=""

{wiki:categories show_empty="n"

This parameter lets you tell the wiki whether or not to display categories with no articles assigned to it. The possible values are:

n: Categories with no articles will not be displayed.

style=""

{wiki:categories style=""}

This will automatically nest the categories for you as standard xhtml using <ul> or render a list without any formatting. The values are:

nested: renders the categories in a xhtml list with <ul>.
linear: renders the categories with no formatting.

For more information on nesting please see the Style parameter in the Weblog section of the User Guide.

{wiki:categories_list} | Variables

Single Variables
Conditional Variables

{wiki:categories_list} | Single Variables

{path:view_category}
{category_name}
{depth}

{if depth}
{if children}
{if first_child}
{if last_child}