Introduction

Wikispaces Variables allow you to use dynamic content in your pages. That is, the content you create using variables is automatically updated to reflect some underlying information, like the number of pages in your space or the current date.

Variables can be used anywhere in the Wikitext, and are replaced with their values when the page is displayed. Variables take the form {$VARIABLENAME} and can optionally be modified with a modifier in the form {$VARIABLENAME|MODIFIERNAME}.

Variables are particularly useful when used with [[include page="..."]] and templates to create customized default pages, common headers and footers, or other dynamic pages.

Note: Since pages are sometimes cached after being created, some items, such as the number of pages in the space, may not be updated immediately.

Examples

Template

This example is for a simple product review template header that inserts the product name based on the page name, the reviewer and date of the review. It can be saved as a template available for new pages.
=Product Review=
Item Name: {$page}
Product Website: [[http://www.a.different.website.com/{$page|url}]]
Reviewed By: {$revisioneditor}
Reviewed On: {$revisiondate}

Last Edit Footer

This is a snippet of wikitext that can be included in a footer at the bottom of the page to show information about the last revision of the page.
----
This page has been edited {$pagerevisions} times. The last modification was made by
[[user:{$revisioneditor}]] on {$revisiondate}

Variable Description

Namespace

Space name
{$spacename}
www
Space text
{$spacetext}
Greenwich Public Schools
Space description
{$spacedescription}

Page Count
{$pagesinspace}
132
Servername (the hostname of the Wikispace)
{$servername}
www.greenwich.wikispaces.net
Server (the url for the main page of the Wikispace)
{$server}
http://www.greenwich.wikispaces.net
License
{$licensename}
Creative Commons Attribution Share-Alike 3.0 License
License URL
{$licenseurl}
http://www.creativecommons.org/licenses/by-sa/3.0
Member Count
{$membersinspace}
10
Organizer Count
{$organizersinspace}
2

Page

Page Name
{$page}
wikitext variables
Revision count
{$pagerevisions}
1
Full Page Name (alias for {$spacename}:{$page})
{$fullpagename}
www:wikitext variables

Revision

Editor (Username of the user, or the IP address of the guest, who created this revision)
{$revisioneditor}
fran_kompar
Comment
{$revisioncomment}

Revision ID
{$revisionid}
14759257

Revision Dates

Date (In human readable format)
{$revisiondate}
Jan 15, 2008 11:53 am
Day
{$revisionday}
15
Day (with leading zero)
{$revisionday2}
15
Month
{$revisionmonth}
1
Year
{$revisionyear}
2008
Timestamp (In ISO 8601 Format)
{$revisiontimestamp}
2008-01-15T19:53:10+00:00

Creation

Creator(Username of the user, or the IP address of the guest, who created this page)
{$creator}
fran_kompar
Comment
{$creationcomment}

Creation Page ID
{$creationid}
14759257

Creation Dates

Date (In human readable format)
{$creationdate}
Jan 15, 2008 11:53 am
Day
{$creationday}
15
Day (with leading zero)
{$creationday2}
15
Month
{$creationmonth}
1
Year
{$creationyear}
2008
Timestamp (In ISO 8601 Format)
{$creationtimestamp}
2008-01-15T19:53:10+00:00

Modifiers

Modifiers are used to change the value of the variable into a different format. Modifiers are separated from the variable name with the pipe (|) character, and can be combined together. For example, {$pagename|ignoreinclude|url}

Output Modifiers

Url escaping
|url (e.g. {$server|url} )
http%3A%2F%2Fwww.greenwich.wikispaces.net

Scope Modifiers

Ignore Include (Gets the value for the variable at the actual page that the variable lives on, possibly an included file)
|ignoreinclude (e.g. {$pagename|ignoreinclude} )
wikitext variables

Javascript Variables

While editing Pages, it is possible to include Javascript inside an Embedded Object.
Several variables can be accessed from the client side to determine the current state of the application, as follows:

User/Space Definition Variables



wikispaces_isUserLoggedIn
boolean
set if user has entered valid login information
wikispaces_username
string
set to current user's login handle
wikispaces_spaceName
string
set to current Space that user is viewing

URL Construction Variables



wikispaces_method
string
system - type of function being performed ( 'view', etc. )
wikispaces_object
string
system - type of object being viewed/modified ( 'message', etc. )
wikispaces_page
string
set to name of current wikipage
wikispaces_id
string
system - object identifier ( for messages )

This page last edited by - fran_kompar fran_kompar on Jan 15, 2008 11:53 am (1 total edits)