Themes

From wmwikisnet.wmwikis.net
Revision as of 18:32, 25 March 2008 by Wmadmin (talk | contribs) (Imported from Wikispaces)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Themes

You can customize nearly all aspects of your Wikispaces theme using a template language based on HTML. The theme is displayed as an HTML page, with certain pieces of Wikispaces functionality inserted.

You can find common theme customizations on the Theme Customizations page.


HTML Theme Components

Components are added to a theme using the <$ComponentName$> syntax. No spaces are allowed in the tag and the component name must match one of the following, and is case sensitive.

WikiPageMenuStar

Component shows a a clickable star that users can use to mark favorite pages. Only visible on Wiki pages. WikiPageMenuStar CSS class.

WikiPageMenuTitle

Component displays the name of the wiki page, or the title of the page. WikiPageMenuTitle CSS class.

WikiPageMenuEntries

Component provides a list of submenus for the particular page, along with the currently active menu. WikiPageMenuEntries CSS class. Current submenu uses the WikiPageMenuEntryOn CSS class, and other submenus use the WikiPageMenuEntryOff CSS class.

WikiPageMenuEditButton

Component provides a context sensitive edit link for the content of Wiki pages. On non-Wiki pages, the output is empty. On pages that the current user can edit, the CSS class is WikiPageMenuEditButton. On locked (read only) pages, the CSS class is WikiPageMenuEditButtonLocked and on pages that the user lacks permission for editing, the CSS class is WikiPageMenuEditButtonNoPermission. Once the button is pushed, and on the edit page, the class is changed to WikiPageMenuEditButtonDisabled. This tag is optional, if it is not included in the theme, a default button will be provided inside the content area.

WikiContent

The main content section of the page. Includes the Wiki page text, or any Wikispaces content, along with ad text. No CSS class is provided, styles should avoid making changes to this component.

WikiUserSpaceList

Component provides a list of the spaces the currently logged in user is a member of. WikiUserSpaceList CSS class.

WikiNotices

Component provides the action notices that alert users to changes or problems. These are wrapped in the WikiNotice CSS class. It also provides persistent banners that alert users of actions they need to perform. These are wrapped in the WikiBanner CSS class.

WikiHeaderNav

Component provides the username, settings, help, sign-in/sign-out links along with an image link back to the main "www" Wikispaces. 2 elements, the outer uses the WikiHeaderNav CSS class, the inner uses the WikiHeaderNavInner CSS class.

WikiSearch

Component provides the search form and input box. Wrapped in the WikiSearch CSS class, the individual components use the WikiSearchInput and WikiSearchSubmit CSS classes.

WikiBreadcrumb

Component provides a context sensitive, clickable, heirarchy of pages leading to the current page, similar to the page title. Uses the WikiBreadcrumb CSS class.

WikiFooterNav

Component provides the help, about, blog, terms, privacy, invite, and upgrade links. Uses the WikiFooterNav CSS class.

WikiLicense

Component provides the space content license information. Uses the WikiLicense CSS class.

Component provides the custom space logo image. WikiLogo CSS class.

WikiLogoOrSpaceName

Component provides the custom space logo, or falls back on a default logo with the current space name. If the logo is available, the output is the same as WikiLogo. Otherwise, WikiLogoTable wraps a table with the image and space name.

WikiCustomNav

Component provides the content of the editable space.menu Wiki page, used to create custom navigation elements. WikiCustomNav CSS class.

WikiActions

Component provides the actions the user can take in the current space (make a new page, recent changes, invite people, manage space). WikiActions CSS class.


Text and Data Elements

WikiSiteUrl

The URL to the main wiki site. (e.g., | http:www.wikispaces.com)

WikiBackgroundColor

The custom background color selected by the current space, as 6 hex digits starting with the # sign (e.g., #F0F0F0). Used to make the theme customizable by individual Wikispaces.

WikiHighlightColor

The custom highlight color selected by the current space, as 6 hex digits starting with the # sign (e.g., #F0F0F0). Used to make the theme customizable by individual Wikispaces.

WikiTextColor

The custom text color selected by the current space, as 6 hex digits starting with the # sign (e.g., #F0F0F0). Used to make the theme customizable by individual Wikispaces. The color should only apply to the text outside the content area.

WikiLinkColor

The custom link text color selected by the current space, as 6 hex digits starting with the # sign (e.g., #F0F0F0). Used to make the theme customizable by individual Wikispaces. The color should only apply to the link text outside the content area.

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

The short name of the current space, used in the URL.

WikiSpaceText

The user specified name of the current space.

WikiSpaceDescription

The user specified description of the current space.

WikiSpaceUrl

The URL of the current space.

WikiPageName

The name of the current content page, useful only when in a /page or /message section. See also WikiIsPageContext.


Conditional Tags

//Conditionals are wrapped around text, HTML and components that are to be displayed only when the condition is met. They are used with the following sytnax: <ConditionalName> ...conditional text, HTML, and components go here... </ConditionalName> No spaces can exist in the tag, and the conditional name must match one of the following, and are case sensitive. All conditionals must be closed.//

WikiIsLoggedIn

Applies when the current user is logged in and not a guest user.

WikiIsNotLoggedIn

Applies when the current user is not logged in and is the guest user.

WikiIsSpaceMember

Applies when the current user is logged in and the user is a member of the current space.

WikiIsNotSpaceMember

Applies when the user is not logged in, or when the logged in user is not a member of the current space.

WikiIsSpaceOrganizer

Applies when the current user is logged in and the user is the organizer of the current space.

WikiIsNotSpaceOrganizer

Applies when the user is not logged in, or when the logged in user is not the organizer of the current space.

WikiIsEditor

Applies when the current user is allowed to edit the current page.

WikiIsNotEditor

Applies when the current user is not allowed to edit the current page.

WikiUserCanView

Applies when the user has access to the current page.

WikiUserCannotView

Applies when the user does not have access to the current page, as in a private space.

WikiIsPageObject

Applies when the URL is in the form of /page/

WikiIsNotPageObject

Applies when the URL is not in the form of /page/

WikiIsSpaceObject

Applies when the URL is in the form of /space/

WikiIsNotSpaceObject

Applies when the URL is not in the form of /space/

WikiIsUserObject

Applies when the URL is in the form of /user/

WikiIsNotUserObject

Applies when the URL is not in the form of /user/

WikiIsPageContext

Applies when the URL is in the form of /page/ or /message/ and has a page name

WikiIsNotPageContext

Applies when the URL is not in the form of /page/ or /message/ and does not have a page name

WikiIsHttps

Applies when the URL uses the https secure protocol

WikiIsNotHttps

Applies when the URL does not use the https secure protocol

Modifiers

Tag output can be modified from the original form through various filtering mechanisms. These are useful for escaping the information to be used in HTML code or URLs.

Modifier Usage Sample
url url$> "this page <here>" becomes "this+page+%3Chere%3E"
html html$> "this page <here>" becomes "this page <here>"