Theme Components

The components on this page will add Wikispaces functionality to your custom theme HTML. These components are case-sensitive and must be used as given below, with no spaces.

The main themes page has some more general information on building custom themes, and our themes customization page has pointers on a few of the more popular modifications. If you have any questions or concerns, contact Wikispaces support.

The following components are required in all themes: WikiInternalHead, WikiInternalHeadEnd, WikiInternalBodyEnd, WikiActions.



HTML Theme Components

Theme component
What the theme component does
CSS class
<$WikiPageTags$>
Adds a list of tags for the current page
N/A
<$WikiContent$>
Indicates the main content section of the page, including the wiki page text and any Wikispaces content (along with ad text). Styles should avoid making changes to this component.
No CSS class is provided. Styles should avoid making changes to this component.
<$WikiSearch$>
Provides the search form and input box
Wrapped in the WikiSearch CSS class.
Individual components use the WikiSearchInput and WikiSearchSubmit CSS classes.
<$WikiFooterNav$>
Provides the Help, About, Blog, Terms, Privacy, Invite, and Upgrade links
WikiFooterNav CSS class
<$WikiLicense$>
Provides the wiki content license information
WikiLicense CSS class
<$WikiLogo$>
Provides the custom wiki logo image
WikiLogo CSS class
<$WikiLogoOrSpaceName$>
Provides the custom wiki logo, or falls back on a default logo with the current wiki name
If the wiki has a custom logo, the output is the same as WikiLogo.
Otherwise, WikiLogoTable wraps a table with the image and wiki name.
<$WikiCustomNav$>
Provides the content of the editable space.menu wiki page (can be used to create custom navigation elements)
WikiCustomNav CSS class
<$WikiActions$>
Provides links to the actions a visitor can take in the current wiki (make a new page, recent changes, invite people, manage wiki)
WikiActions CSS class


Text and Data Theme Components

Theme component
What the theme component does
<$WikiSiteUrl$>
Plugs in the home URL of the current Private Label site
<$WikiBackgroundColor$>
Plugs in the custom background color selected by the current wiki
<$WikiHighlightColor$>
Plugs in the custom highlight color selected by the current wiki
<$WikiTextColor$>
Plugs in the custom text color selected by the current wiki
<$WikiLinkColor$>
Plugs in the custom link text color selected by the current wiki
<$WikiTitle$>
The context-sensitive page title, to be used in the HTML <title> tag
<$WikiSearchWords$>
The currently submitted search term, used for building a custom search form
<$WikiSpaceName$>
Plugs in the short name of the current wiki, as used in the URL
<$WikiSpaceText$>
Plugs in the user-specified name of the current wiki
<$WikiSpaceDescription$>
Plugs in the user specified description of the current wiki
<$WikiSpaceUrl$>
Plugs in the URL of the current wiki
<$WikiTeamName$>
Plugs in the name of the current team
<$WikiTeamUrl$>
Plugs in the URL of the current team
<$WikiPageName$>
Plugs in the name of the current content page (mainly useful in a /page or /message section)


Conditional Components

If you want some text, HTML, or other components to be displayed only when certain conditions are met, wrap them in these conditional components. The component that you want to restrict must go between the opening tag and the closing tag of the conditional component, as in this example:
<ConditionalName>
Now you see me!
</ConditionalName>
You can nest conditionals, but the conditional must be closed appropriately for every level.

Restrictions by visitor category

Theme component
What the theme component does
<WikiIsLoggedIn>
... </WikiIsLoggedIn>
Restricts the contents to logged-in users
<WikiIsNotLoggedIn>
... </WikiIsNotLoggedIn>
Restricts the contents to guests
<WikiIsSiteAdministrator>
... </WikiIsSiteAdministrator>
Restricts the contents to logged-in site administrators of the current Private Label site
<WikiIsNotSiteAdministrator>
... </WikiIsNotSiteAdministrator>
Restricts the contents to visitors who are not logged-in site administrators of the current Private Label site
<WikiIsSpaceMember>
... </WikiIsSpaceMember>
Restricts the contents to members of the current wiki
<WikiIsNotSpaceMember>
... </WikiIsNotSpaceMember>
Restricts the contents to visitors who are not logged-in members of the current wiki
<WikiIsSpaceOrganizer>
... </WikiIsSpaceOrganizer>
Restricts the contents to logged-in organizers of the current wiki
<WikiIsNotSpaceOrganizer>
... </WikiIsNotSpaceOrganizer>
Restricts the contents to visitors who are not logged-in organizers of the current wiki
<WikiIsEditor>
... </WikiIsEditor>
Restricts the contents to visitors who have permission to edit the current page
<WikiIsNotEditor>
... </WikiIsNotEditor>
Restricts the contents to visitors who do not have permission to edit the current page
<WikiUserCanView>
... </WikiUserCanView>
Restricts the contents to visitors who have permission to view the current page
<WikiUserCannotView>
... </WikiUserCannotView>
Restricts the contents to visitors who do not have permission to view the current page
<WikiIsAdministrator>
... </WikiIsAdministrator>
Restricts the contents to visitors who have permission to administer the current wiki (wiki organizers and site administrators).
<WikiIsNotAdministrator>
... </WikiIsNotAdministrator>
Restricts the contents to visitors who do not have permission to administer the current wiki.

Restrictions by URL

Theme component
What the theme component does
<WikiIsPageObject>
... </WikiIsPageObject>
Displays the contents only when the URL is in the form of /page/
<WikiIsNotPageObject>
... </WikiIsNotPageObject>
Displays the contents only when the URL is not in the form of /page/
<WikiIsSpaceObject>
... </WikiIsSpaceObject>
Displays the contents only when the URL is in the form of /space/
<WikiIsNotSpaceObject>
... </WikiIsNotSpaceObject>
Displays the contents only when the URL is not in the form of /space/
<WikiIsUserObject>
... </WikiIsUserObject>
Displays the contents only when the URL is in the form of /user/
<WikiIsNotUserObject>
... </WikiIsNotUserObject>
Displays the contents only when the URL is not in the form of /user/
<WikiIsPageContext>
... </WikiIsPageContext>
Displays the contents only when there is a page name and the URL is in the form of /page/ or /message/
<WikiIsNotPageContext>
... </WikiIsNotPageContext>
Displays the contents only when there is no page name, or the URL is not in the form of /page/ or /message/
<WikiIsHttps>
... </WikiIsHttps>
Displays the contents only when the URL uses the https secure protocol
<WikiIsNotHttps>
... </WikiIsNotHttps>
Displays the contents only when the URL does not use the https secure protocol
<WikiIsValidSpace>
... </WikiIsValidSpace>
Displays the contents only when the wiki was found and is not deleted
<WikiIsNotValidSpace>
... </WikiIsNotValidSpace>
Displays the contents only when the wiki was not found or is deleted
<WikiIsHomePage>
... </WikiIsHomePage>
Displays the content only when on the wiki home page
<WikiIsNotHomePage>
... </WikiIsNotHomePage>
Displays the content only when not on the wiki home page
<WikiIsWww>
... </WikiIsWww>
Displays the contents only when the wiki is the "www" wiki (for use on Private Label sites)
<WikiIsNotWww>
... </WikiIsNotWww>
Displays the contents only when the wiki is not the "www" wiki (for use on Private Label sites)


Modifiers

Some theme components may generate content containing characters that can interfere with your code (spaces, brackets, etc.). These modifiers will replace those characters with alternatives that are safe to use in HTML code or URLs.
Modifier
Usage
What the modifier does
Sample
|url
<$WikiPageName|url$>
Replaces illegal characters in a URL with non-disruptive characters
"this page <here>" becomes "this+page+%3Chere%3E"
|html
<$WikiPageName|html$>
Replaces illegal characters in HTML with non-disruptive characters
"this page <here>" becomes "this page &lt;here&gt;"


Still have questions? Contact Wikispaces support.