Difference between revisions of "Themes"
Jump to navigation
Jump to search
(Imported from Wikispaces) |
(Imported from Wikispaces) |
||
| Line 1: | Line 1: | ||
| − | + | <div id="content_view" class="wiki" style="display: block"> | |
| − | =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. | + | =themes= |
| − | + | <div id="toc"> | |
| − | You can find common theme customizations on the [[Theme Customizations]] page. | + | =Table of Contents= |
| + | <div style="margin-left: 1em">[[#Themes| Themes]]</div><div style="margin-left: 1em">[[#HTML Theme Components| HTML Theme Components]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiPageMenuStar| WikiPageMenuStar]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiPageMenuTitle| WikiPageMenuTitle]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiPageMenuEntries| WikiPageMenuEntries]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiPageMenuEditButton| WikiPageMenuEditButton]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiContent| WikiContent]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiUserSpaceList| WikiUserSpaceList]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiNotices| WikiNotices]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiHeaderNav| WikiHeaderNav]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiSearch| WikiSearch]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiBreadcrumb| WikiBreadcrumb]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiFooterNav| WikiFooterNav]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiLicense| WikiLicense]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiLogo| WikiLogo]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiLogoOrSpaceName| WikiLogoOrSpaceName]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiCustomNav| WikiCustomNav]]</div><div style="margin-left: 2em">[[#HTML Theme Components-WikiActions| WikiActions]]</div><div style="margin-left: 1em">[[#Text and Data Elements| Text and Data Elements]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiSiteUrl| WikiSiteUrl]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiBackgroundColor| WikiBackgroundColor]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiHighlightColor| WikiHighlightColor]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiTextColor| WikiTextColor]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiLinkColor| WikiLinkColor]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiTitle| WikiTitle]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiSearchWords| WikiSearchWords]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiSpaceName| WikiSpaceName]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiSpaceText| WikiSpaceText]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiSpaceDescription| WikiSpaceDescription]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiSpaceUrl| WikiSpaceUrl]]</div><div style="margin-left: 2em">[[#Text and Data Elements-WikiPageName| WikiPageName]]</div><div style="margin-left: 1em">[[#Conditional Tags| Conditional Tags]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsLoggedIn| WikiIsLoggedIn]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsNotLoggedIn| WikiIsNotLoggedIn]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsSpaceMember| WikiIsSpaceMember]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsNotSpaceMember| WikiIsNotSpaceMember]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsSpaceOrganizer| WikiIsSpaceOrganizer]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsNotSpaceOrganizer| WikiIsNotSpaceOrganizer]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsEditor| WikiIsEditor]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsNotEditor| WikiIsNotEditor]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiUserCanView| WikiUserCanView]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiUserCannotView| WikiUserCannotView]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsPageObject| WikiIsPageObject]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsNotPageObject| WikiIsNotPageObject]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsSpaceObject| WikiIsSpaceObject]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsNotSpaceObject| WikiIsNotSpaceObject]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsUserObject| WikiIsUserObject]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsNotUserObject| WikiIsNotUserObject]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsPageContext| WikiIsPageContext]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsNotPageContext| WikiIsNotPageContext]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsHttps| WikiIsHttps]]</div><div style="margin-left: 2em">[[#Conditional Tags-WikiIsNotHttps| WikiIsNotHttps]]</div><div style="margin-left: 1em">[[#Modifiers| Modifiers]]</div></div> | ||
| + | =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.<br /> <br /> You can find common theme customizations on the [[Theme Customizations]] page.<br /> | ||
---- | ---- | ||
| − | + | <br /> | |
| − | =HTML Theme Components= | + | =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.'' | + | ''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.''<br /> <br /> |
| − | + | ==WikiPageMenuStar== | |
| − | ==WikiPageMenuStar== | + | Component shows a a clickable star that users can use to mark favorite pages. Only visible on Wiki pages. ''WikiPageMenuStar'' CSS class.<br /> <br /> |
| − | 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.<br /> <br /> | |
| − | ==WikiPageMenuTitle== | + | ==WikiPageMenuEntries== |
| − | Component displays the name of the wiki page, or the title of the page. ''WikiPageMenuTitle'' CSS class. | + | 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.<br /> <br /> |
| − | + | ==WikiPageMenuEditButton== | |
| − | ==WikiPageMenuEntries== | + | 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.<br /> <br /> |
| − | 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. | + | ==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.<br /> <br /> | |
| − | ==WikiPageMenuEditButton== | + | ==WikiUserSpaceList== |
| − | 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. | + | Component provides a list of the spaces the currently logged in user is a member of. ''WikiUserSpaceList'' CSS class.<br /> <br /> |
| − | + | ==WikiNotices== | |
| − | ==WikiContent== | + | 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.<br /> <br /> |
| − | 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. | + | ==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.<br /> <br /> | |
| − | ==WikiUserSpaceList== | + | ==WikiSearch== |
| − | Component provides a list of the spaces the currently logged in user is a member of. ''WikiUserSpaceList'' CSS class. | + | Component provides the search form and input box. Wrapped in the ''WikiSearch'' CSS class, the individual components use the ''WikiSearchInput'' and ''WikiSearchSubmit'' CSS classes.<br /> <br /> |
| − | + | ==WikiBreadcrumb== | |
| − | ==WikiNotices== | + | Component provides a context sensitive, clickable, heirarchy of pages leading to the current page, similar to the page title. Uses the ''WikiBreadcrumb'' CSS class.<br /> <br /> |
| − | 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. | + | ==WikiFooterNav== |
| − | + | Component provides the help, about, blog, terms, privacy, invite, and upgrade links. Uses the ''WikiFooterNav'' CSS class.<br /> <br /> | |
| − | ==WikiHeaderNav== | + | ==WikiLicense== |
| − | 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. | + | Component provides the space content license information. Uses the ''WikiLicense'' CSS class.<br /> <br /> |
| − | + | ==WikiLogo== | |
| − | ==WikiSearch== | + | Component provides the custom space logo image. ''WikiLogo'' CSS class.<br /> <br /> |
| − | Component provides the search form and input box. Wrapped in the ''WikiSearch'' CSS class, the individual components use the ''WikiSearchInput'' and ''WikiSearchSubmit'' CSS classes. | + | ==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<br /> a table with the image and space name.<br /> <br /> | |
| − | ==WikiBreadcrumb== | + | ==WikiCustomNav== |
| − | Component provides a context sensitive, clickable, heirarchy of pages leading to the current page, similar to the page title. Uses the ''WikiBreadcrumb'' CSS class. | + | Component provides the content of the editable ''space.menu'' Wiki page, used to create custom navigation elements. ''WikiCustomNav'' CSS class.<br /> <br /> |
| − | + | ==WikiActions== | |
| − | ==WikiFooterNav== | + | 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.<br /> <br /> |
| − | 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. | ||
| − | |||
| − | ==WikiLogo== | ||
| − | 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= | + | =Text and Data Elements= |
| − | + | <br /> | |
| − | ==WikiSiteUrl== | + | ==WikiSiteUrl== |
| − | The URL to the main wiki site. (e.g., [http://www.wikispaces.com%29/ | + | The URL to the main wiki site. (e.g., [http://www.wikispaces.com%29/ http:''www.wikispaces.com)]<br /> <br /> |
| − | + | ==WikiBackgroundColor== | |
| − | ==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.<br /> <br /> |
| − | 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.<br /> <br /> | |
| − | ==WikiHighlightColor== | + | ==WikiTextColor== |
| − | 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. | + | 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.<br /> <br /> |
| − | + | ==WikiLinkColor== | |
| − | ==WikiTextColor== | + | 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.<br /> <br /> |
| − | 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. | + | ==WikiTitle== |
| − | + | The context sensitive page title, to be used in the HTML <title> tag.<br /> <br /> | |
| − | ==WikiLinkColor== | + | ==WikiSearchWords== |
| − | 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. | + | The currently submitted search term, used for building a custom search form.<br /> <br /> |
| − | + | ==WikiSpaceName== | |
| − | ==WikiTitle== | + | The short name of the current space, used in the URL.<br /> <br /> |
| − | The context sensitive page title, to be used in the HTML <title> tag. | + | ==WikiSpaceText== |
| − | + | The user specified name of the current space.<br /> <br /> | |
| − | ==WikiSearchWords== | + | ==WikiSpaceDescription== |
| − | The currently submitted search term, used for building a custom search form. | + | The user specified description of the current space.<br /> <br /> |
| − | + | ==WikiSpaceUrl== | |
| − | ==WikiSpaceName== | + | The URL of the current space.<br /> <br /> |
| − | The short name of the current space, used in the URL. | + | ==WikiPageName== |
| − | + | The name of the current content page, useful only when in a /page or /message section. See also WikiIsPageContext.<br /> <br /> | |
| − | ==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= | + | =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:<br /> <ConditionalName><br /> ...conditional text, HTML, and components go here...<br /> </ConditionalName><br /> 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.''<br /> <br /> | |
| − | <ConditionalName> | + | ==WikiIsLoggedIn== |
| − | ...conditional text, HTML, and components go here... | + | Applies when the current user is logged in and not a guest user.<br /> <br /> |
| − | </ConditionalName> | + | ==WikiIsNotLoggedIn== |
| − | 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.// | + | Applies when the current user is not logged in and is the guest user.<br /> <br /> |
| − | + | ==WikiIsSpaceMember== | |
| − | ==WikiIsLoggedIn== | + | Applies when the current user is logged in and the user is a member of the current space.<br /> <br /> |
| − | Applies when the current user is logged in and not a guest user. | + | ==WikiIsNotSpaceMember== |
| − | + | Applies when the user is not logged in, or when the logged in user is not a member of the current space.<br /> <br /> | |
| − | ==WikiIsNotLoggedIn== | + | ==WikiIsSpaceOrganizer== |
| − | Applies when the current user is not logged in and is the guest user. | + | Applies when the current user is logged in and the user is the organizer of the current space.<br /> <br /> |
| − | + | ==WikiIsNotSpaceOrganizer== | |
| − | ==WikiIsSpaceMember== | + | Applies when the user is not logged in, or when the logged in user is not the organizer of the current space.<br /> <br /> |
| − | Applies when the current user is logged in and the user is a member of the current space. | + | ==WikiIsEditor== |
| − | + | Applies when the current user is allowed to edit the current page.<br /> <br /> | |
| − | ==WikiIsNotSpaceMember== | + | ==WikiIsNotEditor== |
| − | Applies when the user is not logged in, or when the logged in user is not a member of the current space. | + | Applies when the current user is not allowed to edit the current page.<br /> <br /> |
| − | + | ==WikiUserCanView== | |
| − | ==WikiIsSpaceOrganizer== | + | Applies when the user has access to the current page.<br /> <br /> |
| − | Applies when the current user is logged in and the user is the organizer of the current space. | + | ==WikiUserCannotView== |
| − | + | Applies when the user does not have access to the current page, as in a private space.<br /> <br /> | |
| − | ==WikiIsNotSpaceOrganizer== | + | ==WikiIsPageObject== |
| − | Applies when the user is not logged in, or when the logged in user is not the organizer of the current space. | + | Applies when the URL is in the form of /page/<br /> <br /> |
| − | + | ==WikiIsNotPageObject== | |
| − | ==WikiIsEditor== | + | Applies when the URL is not in the form of /page/<br /> <br /> |
| − | Applies when the current user is allowed to edit the current page. | + | ==WikiIsSpaceObject== |
| − | + | Applies when the URL is in the form of /space/<br /> <br /> | |
| − | ==WikiIsNotEditor== | + | ==WikiIsNotSpaceObject== |
| − | Applies when the current user is not allowed to edit the current page. | + | Applies when the URL is not in the form of /space/<br /> <br /> |
| − | + | ==WikiIsUserObject== | |
| − | ==WikiUserCanView== | + | Applies when the URL is in the form of /user/<br /> <br /> |
| − | Applies when the user has access to the current page. | + | ==WikiIsNotUserObject== |
| − | + | Applies when the URL is not in the form of /user/<br /> <br /> | |
| − | ==WikiUserCannotView== | + | ==WikiIsPageContext== |
| − | Applies when the user does not have access to the current page, as in a private space. | + | Applies when the URL is in the form of /page/ or /message/ and has a page name<br /> <br /> |
| − | + | ==WikiIsNotPageContext== | |
| − | ==WikiIsPageObject== | + | Applies when the URL is not in the form of /page/ or /message/ and does not have a page name<br /> <br /> |
| − | Applies when the URL is in the form of /page/ | + | ==WikiIsHttps== |
| − | + | Applies when the URL uses the https secure protocol<br /> <br /> | |
| − | ==WikiIsNotPageObject== | + | ==WikiIsNotHttps== |
| − | Applies when the URL is not in the form of /page/ | + | Applies when the URL does not use the https secure protocol<br /> <br /> |
| − | + | =Modifiers= | |
| − | ==WikiIsSpaceObject== | + | ''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.''<br /> |
| − | Applies when the URL is in the form of /space/ | + | {| class="wiki_table" |
| − | + | ! Modifier<br /> | |
| − | ==WikiIsNotSpaceObject== | + | ! Usage<br /> |
| − | Applies when the URL is not in the form of /space/ | + | ! Sample<br /> |
| − | |||
| − | ==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 | ||
|- | |- | ||
| − | | url | + | | url<br /> |
| − | + | | <$WikiPageName|url$><br /> | |
| − | + | | "this page <here>" becomes "this+page+%3Chere%3E"<br /> | |
|- | |- | ||
| + | | html<br /> | ||
| + | | <$WikiPageName|html$><br /> | ||
| + | | "this page <here>" becomes "this page <here>"<br /> | ||
|} | |} | ||
| + | </div> | ||
Revision as of 14:28, 14 February 2019
themes
Table of Contents
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.
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.
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.
WikiLogo
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.
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>" |