Wiki

From CLEW Wiki

Jump to: navigation, search

Contents

How To...?

How to Add, Edit or Delete Wiki Pages to CLEW

Adding the Wiki tool from Site Info

To add the Wiki tool using Site Info:

  1. In your site's menubar, click Site Info.
  2. Click Edit Tools.
  3. Check the box next to Wiki, and then click Continue'.
  4. Click Finish.

Adding the Wiki tool from Worksite Setup

To add the Wiki tool using Worksite Setup in My Workspace:

  1. From your My Workspace menubar, click Worksite Setup.
  2. Check the box corresponding to the site for which you're adding the Wiki tool, and then click Edit.
  3. Click Edit Tools.
  4. Check the box next to Wiki, and then click Continue.
  5. Click Finish.

Adding a Wiki Page to CLEW

To add a page to your site's wiki:

  1. In your site's left menu, click on Wiki link, which will take you to the Home page for your site's wiki.
  2. From the top menu, click on Edit Wiki Edit Icon.png icon.
  3. In the editing field, you will see the text and formatting notations for the Home page. Determine where you want to place the link to your new page, and then create the link by typing the page name enclosed twice by square brackets (e.g., [[New page]]). You cannot use the following characters in a Wiki link or title:
    • : (colon)
    • @ (at)
    • # (hash)
    • | (pipe)
    • \ (backslash)
  4. To return to the Home page, click Save Wiki Save Icon.png icon. You will see that your page name has become a link with a question mark (?) after it. The question mark indicates that the page to which the link leads doesn't have any content associated with it yet. Once you add content to the new page, the question mark will disappear.
  5. Click the link for your new page. You will see a new page that contains the following warning:
    PAGE DOES NOT EXIST. The page you just accessed does not exist, and so has been created for you. You may now edit this page to change its content.
  6. To add content to your new page, from the top menu, click on Edit Wiki Edit Icon.png icon.
  7. In the editing field, you will see the text and formatting notations for the warning message mentioned above. Delete this text and add your own.
    Note: You will find several formatting options just above the editing field using a small WYSIWYG editor. To use a formatting option, just click its name; Wiki will automatically insert the appropriate notation into the editing field. Also, to the right of the editing field, you will see a Help Tips sidebar that includes commonly used formatting options and their corresponding wiki notations.
  8. To save your work when you are finished, click on Save button. Alternatively, to preview your page before saving, click Preview. To cancel your changes, click Cancel.

Editing a Wiki Page

To edit a wiki page in your site:

  1. In your site's left menu, click on Wiki link
  2. Find and navigate to the page you wish to edit.
  3. At the top of the page, click on Edit Wiki Edit Icon.png icon.
    Note: If you receive a Permission Denied message, you do not have the appropriate permissions needed to update pages. If you think this is a mistake, contact the site leader.
  4. Make your changes in the text box. At the top of the text box are a series of icons and links for saving your work, formatting text, and inserting tables, links, and images. Use the tabs to change between Edit and Preview modes. To the right of the text box, under "Help Tips", you will see a partial list of the codes used for text formatting. To view the full list, click Full Help Page.
  5. Once you are satisfied with your changes, click on Save Wiki Save Icon.png icon. Check the box next to Minor Change for small updates that do not require notification or updates to the RSS feed. To cancel, click on Cancel button.
Warning on Overwriting Content

Wiki Bulb Icon.gif Note: If another site participant edits and saves the page while you are editing it, when you attempt to save your changes you will see a message saying that the page has altered. The other participant's page will be displayed above yours. You can then decide to overwrite their changes (using the Save Wiki Save Icon.png icon) or to keep their changes by clicking on Cancel button to abort the edition.

How to View and Search for Content on Wiki Pages

Viewing Wiki Pages

To move from page to page in Wiki, follow the links within each page. Links with an arrow icon Wiki Link Icon.png beside them link to external websites or to attachments. These will open in the same window unless you open them in a new tab/window using your browser's right-click options.

As you navigate around Wiki, your breadcrumb trail will appear at the top of the page. (A breadcrumb trail lists the pages that you have visited in order under Recently visited at the right side) You can use this to return to any page at any time.

Unlike some wiki tools, Wiki does not have a separate menu to navigate through the pages. All navigation must be done through links on the pages.

Searching for Content on Wiki Pages

To search for content, type your search term in the search box and press Enter key. All pages on that wiki site containing your search terms will be listed. Do not forget that pages which are not in the wiki will not be searched. This includes other Sakai pages (e.g. Calendar, Syllabus) and attachments to the wiki.

This search will be recorded in your breadcrumb trail and you can return to your results page at any time.

Wiki will recognize the and operator but not not or or. For example, searching for children and dahlias will find pages which contain both the word children and the word dahlias but not pages which contain one of the words but not both.

How to Create Subsections on Wiki Pages

By default, a wiki is not organized following a clear hierarchy. All wiki pages are created at the root level, meaning that every page has to have a unique name to avoid confusion. The Wiki tool offers a convenient way to create subsections or, in other words, to create a page hierarchy. In addition to solving some page naming confusion, using subsections will give instructors the opportunity to use a specific default template for each subsection. To create a subsection, add a forward slash (/) in the name of a page when creating a link.

Syntax
Markup Syntax [Page Name|SubsectionName/PageName]
Rendering on Wiki

Wiki PageName Image.png

Subsections are ideal to help you create student-, team-, or assignment-specific pages.

Student-specific: you could ask all your students to create a personal profile. In such a case, you could pre-populate a page with a series of links to individual student pages. For teams, you could follow the same pattern as with students, but replace the subsection name by Team/ instead:

Syntax
Markup Syntax

*[Student1 Name|Student/Student1Name]
*[Student2 Name|Student/Student2Name]

Rendering on Wiki

Wiki StudentSpecific Image.png

Assignment-specific: You could create subsections for assignments to avoid having students delete each other’s work. You could define subsections and ask students to put their name or team number after the forward slash (/).

Syntax
Markup Syntax

*[Assignment 1 - Team 1|Assignment1/1]
*[Assignment 1 - Team 2|Assignment1/2]

Rendering on Wiki

Wiki AssignmentSpecific Image.png

How to Modify the Default Template

The Wiki tool comes with a default template for all new pages, but instructors can modify this template to better suit their needs. This template is an excellent way to provide instructions to your students regarding the way they should use the wiki. When you create subsections (see How to Create Subsections on Wiki Pages), you also create a unique template page for that subsection. You can customize this page without altering any of the other templates in other subsections and at the root level of the wiki.

To modify the default template follow these steps:

  1. If it is the first time you are using the wiki tool in a site, the first page shows a list of Recent Changes at the bottom.
  2. Locate the page called Default_template and click its link. This template is the root level template.
  3. To change the root level template, click on From the top menu, click on Edit Wiki Edit Icon.png icon.
  4. When you create a new subsection page and access it, you will see a link to the default template at the bottom of the page. Clicking on this link will modify the subsection default template.

Wiki Bulb Icon.gif Note: You can also use the index macro to access a specific template.

Customizing your default template is an excellent way to provide intrinsic support to your students, as they are about to modify a page. This support can be of multiple natures:

How to Look at the Wiki Site Map

It is always interesting to have an overview of all the pages of a wiki. Though it is possible to have such a view in the Wiki tool, knowing how to view it is not intuitive. Using the Index macro, it is possible to access every page in your wiki, including the ones that have no incoming links (like default templates).

To show the wiki site map follow these steps:

  1. Find and navigate to the page you wish to edit.
  2. From the top menu, click on Edit Wiki Edit Icon.png icon.
  3. Add the code {index} on a new line.
  4. Click on Save button and you will now see the wiki site map, including all subsections.

Note that you can collapse and expand subsections. Showing the wiki site map might be a good way to provide one-click navigation for any page in your wiki. This is particularly useful for large sites that require a lot of clicks to access content.

How to Use the Built-in Navigation Patterns

When a lot of people work collaboratively on a wiki web site, you are bound to be lost from time to time. The following built-in navigation patterns will allow you to track the changes made by a large group:

How to Track Recent Changes

Recent changes lists all page creation and edition activity on your wiki site. There are three ways to view the recent changes:

  1. The Wiki Home: By default, recent changes are listed on your wiki home, at the bottom of the page.
  2. Visit the Recent Changes page: If you have used the index macro (see How to Look at the Wiki Site Map), there is a link to a page called Recent Changes. You can subscribe to get email notifications on that page by clicking on the Watch Wiki Watch Icon.png icon in the toolbar.
  3. Use the recent-changes macro: Just like the index macro, you can type {recent-changes} on a new line anywhere in a wiki page and then click on Save button to view the list.

How to Promote Usability with Headings, Links, and Anchors

Being an open and unstructured system, a wiki does not do well at providing shortcuts and a navigation bar by itself. Users have to be made aware of the consequences of not providing a clear structure to their content. A messy wiki can be a serious barrier to adoption. Here are some guidelines to help you keep your wiki usable by using headings, links and anchors.

Headings

Headings are easy to use in the wiki tool. All you have to do is to start a new line with hn, where n represents the level of the heading.

Syntax
Markup Syntax

h1 Heading 1
h2 Heading 2

Rendering on Wiki

Wiki Headings Image.png

Links

To create a link, put words between square brackets ([ ]) and save your page. To use an alias (a name for your link), you need to type the alias followed by a pipe ( | ) then type the link. The following example shows the same destination page without and with an alias.

Syntax
Markup Syntax

[simplelink]
[Simple Link With Alias|simplelink]

Rendering on Wiki

Wiki Links Image.png

Anchors

To create a link to an anchor, you use the same syntax as to create a link, but you have to add a pound sign (#) in front of the destination. In addition, you need to use the anchor macro in your page

Syntax
Markup Syntax

[Link To Anchor 1|#anchor1]

{anchor:anchor1}
H2 Name of Section
{anchor}

Rendering on Wiki

Wiki Anchors Image.png

If your content is sequential (minutes from meetings for instance), it would be smart to insert a navigation area at the top of your page. Simply put a link to the previous and next page. This way, users will not have to go back one level to drill down again.

Syntax
Markup Syntax

[< Previous Meeting|6-4Meeting] - [Next Meeting >|6-18Meeting]
----
Content here

Rendering on Wiki

Wiki Anchors2 Image.png

If you have a long page with a lot of content, you can put a bulleted list of the topics that are covered on this page at the top. Then it is fairly easy to add anchors to that list to direct users to the content they are looking for. This serves a dual purpose:

  1. Helps users see what is on this page at a glance without having to scroll down.
  2. Gives access to specific content in one click.

When using anchors, it is also good practice to put a link back to the top of the page (the page navigation area).

Syntax
Markup Syntax

{anchor:top}
On this page:
{anchor}
# [Topic 1|#topic1]
# [Topic 2|#topic2]
# [Topic 3|#topic3]
----
{anchor:topic1}
h2 Topic 1
{anchor}
Content of Topic 1

[< Back to top|#top]

Rendering on Wiki

Wiki Anchors3 Image.png

How to Add an Item (File, Image, etc.) from Resources to a Wiki Page

Students are not able to add content to the Resources tool by default. The article Creating a Student Folder in Resources explains how an instructor can create a place for students to add items to.

While editing a wiki page, you can add an item from Resources. You can add a link to an item, such as a text document, or you can add an embedded image, such as a picture.

To add an item from Resources to your wiki page:

  1. While you're editing your page, from the formatting options above the editing field, click the Link icon to add a link or the Image Wiki Image Icon.png icon to add a picture.
  2. On the Add Attachment page, you can choose a file from your site's Resources, from your My Workspace Resources, or from the Resources of any other site to which you belong. To view Resources files from My Workspace and other sites, click Show other sites.

    Wiki Bulb Icon.gif Note: If you use a file from My Workspace or another site, make sure the file is publicly viewable (i.e., accessible by participants outside of the site where the file resides). For more information, see Making your Resources items publicly accessible.

  3. To select a file, to the right of its name, click Select.
  4. Click Continue to add the link to your wiki page. From here you can choose to save, preview, or cancel the changes you have made.

How to Add Mathematical Notations to a Wiki Page

The wiki tool supports the jsMath Javascript library which generates mathematics formulas in web pages through your browser. You can find useful information on jsMath at jsMath Javascript. To add a mathematical notation follow these steps:

  1. Click Edit Wiki Edit Icon.png icon to edit the page.
  2. Type {math} to activate the math processor.
  3. Type your equation using mathematical notation (i.e.: LaTeX Math Commands, LaTeX Math and Text Modes)
  4. Type {math} to deactivate the math processor
  5. Click on Save Wiki Save Icon.png icon and you will see the equation or expression in mathematical symbols.

Wiki Bulb Icon.gif Note: You can click on Options and set the math font display to be larger.

Syntax
Markup Syntax

{math}
f(x) = \frac{1}{2 x} \sin(\pi x^2)^{2/3}
\lim \Gamma \Pi \sum^\infty_{n=0}
{math}

Rendering on Wiki

Wiki LaTeX Image.png

See also: Editing an Equation Demo)

Superscripts and Subscripts

You can use superscripts or subscripts by using the following markup language:

Syntax
Markup Syntax

10^^2^^
CO%%2%%

Rendering on Wiki

Wiki SuperscriptSubscript Image.png

Spreadsheet Functions in Tables

Two simple operations are available in tables. You can do a sum or an average of numeric data. Within the table macro, you have to use the sum, avg, min, or max macros, as follows:

Syntax
Markup Syntax

{table}
A|B|C|Total/maximum|Average/Minimum
1|2|3|=SUM(A2:C2)|=AVG(A2:C2)
7|8|9|=MAX(A4:C4)|=AVG(A4:C4)
{table}

Rendering on Wiki

Wiki SpreadsheetInTables Image.png

How to Add, Edit or Delete a Comment on a Wiki Page

Comment Window

To leave a comment on a wiki page follow these steps:

  1. At the bottom of the page, click on Be the first to comment or Add Comment Wiki Comment Icon.png icon.
  2. In the box that appears below, type your comment, and then click on Save button. Your comment will appear at the bottom of the page beneath a Comment by line, which will include your name and the time and date you posted your comment.
  3. If you need to edit your comment, on the Comment by line, click on Edit button. In the box that appears, make the necessary edits, and then click on Save button.

There is no way to delete a comment, but you can click on Edit button and then erase the text. The Comment by line will remain, but the comment itself will no longer be visible.

Wiki Bulb Icon.gif Note: You can also comment on a comment. To do so, on the Comment by line of the particular comment, click on Comment button. In the box that appears below, type your comment, and then click on Save button. Your comment will appear below the first comment, indented to the left, similar to a threaded discussion view.

How to View Information about a Wiki Page

To get technical and statistical information about a Wiki page, click on the Info Wiki Info Icon.png icon. This option gives you the following information about the corresponding Wiki page:

Printer friendly Wiki Print Icon.png
Public View HTML Wiki HTML Icon.png
Rich Text Format RTF Wiki RTF Icon.png
Portable Document Format PDF Wiki PDF Icon.png.

How to View History of a Wiki Page

To get the history of a Wiki page, click on the History Wiki History Icon.png icon. This option gives you the following information about the corresponding Wiki page:

How to Configure Permissions and Roles for a Wiki Page

Wiki Bulb Icon.gif Note: By default students cannot modify the Main Wiki page. This can be changed by instructors (Super Admin) by changing Site-level permissions.

Review roles and permissions.png

Permissions and Roles

To complete the procedures in this article, you must be assigned a role having the necessary permissions. This often excludes Students and TAs by default. To determine your role and accompanying permissions, follow the directions in Permissions and Roles.


Wiki Role Permissions.png

The Wiki has 2 levels of permissions: Site-level and Page-level. Site-level permission are the default permissions for all pages but this option can be changed for individual pages. There are 5 levels of permissions within Wiki:

The permissions cascade downwards (you cannot edit a page if you cannot read it). Hence, enabling Create or Edit will automatically enable Read as well. The following table shows the default configuration for permissions.

Default Setting for Permissions
Read Create Edit Admin Super Admin
Access yes yes yes no no
Maintain yes yes yes yes yes

Page-level Permissions

Page-level Permissions

This option applies to a particular Wiki page. For example, you can change the permissions so that wiki becomes edible by all users, apart from one page which can only be edited by its creator. To alter the page-level permission follow these steps:

  1. Click on Info Wiki Info Icon.png icon.
  2. Check and uncheck the boxes below the permissions to alter the permissions settings considering that permissions cascade downwards in the order described in the previous section.

The Create permission is not applicable to page-level permissions and can only be changed at site level.

Site-level Permissions

Site-level Permissions

To alter the Site-level permissions, follow these steps:

  1. Click on Info Wiki Info Icon.png icon.
  2. Click on Edit Site Permissions from the middle of the page.
  3. Select which role should have which level of abilities in the wiki: Create, Read, Edit, Admin, Super Admin
  4. When done click on Save button.

How to Monitor Activity on a Wiki Page

Example of how different version of a wiki page can be compared

To monitor the activity on a page, you can set up email notifications to alert you when someone has edited the page. Email notifications are sent to your authorized email address; see Changing your authorized email address. To set up email notifications, follow these steps:

Visit the Creating Subsections part of this site for more information on sub-sections.

Related Articles

FAQ - Wiki

How do I . . .?

Use math notation in Wiki?

The Wiki tool of CLEW now supports mathematical notation. You can include mathematical notations using LaTeX. To learn how to add mathematical notation in CLEW's Wiki tool, read How to Add Mathematical Notations to a Wiki Page in the Wiki article on this site.

Use a Wiki for assessment?

The University of New South Wales has developed a useful article that deals with common ways to use a wiki tool for assessment. Additionally, the article discusses some advantages and disadvantages of using a wiki for assessment and ways to design and administer the assessment. Assessing with Wikis.

Please note that assessments using the Wiki with CLEW will require manual grading and entry into Gradebook, as it is not integrated like other tools such as Forums, or Assignments.


This article is based on the equivalent Sakai help article created by Indiana University found at: http://kb.iu.edu/data/arcr.html.
Additional sources of content include Brock University's Sakai / Isaak Wiki and the University of Florida Sakai / e-Learning Documentation with thanks and appreciation for the collaboration.

All respective sources used are under a free-for-reuse license and additional permission has been obtained.

Help icon.png
600px-Andy Tools Hammer Spanner.png

Other articles about Sakai tools and how instructors can use them:

Core Tools: Announcements | Assignments | Email | Forums | Gradebook | Quizzes & Tests II | Resources | Site Editor | Syllabus

More Tools: Polls | Chat | Drop Box | Home | Discussions | News | Feedback | Sections | Lessons | Site Stats | Web Content | Wiki

Related articles: How to add tools to CLEW | Using the Text Editor | Manage Groups | Permissions and Roles | Contact the CTL for help

Amber icons 029 checkmark.png

We are constantly trying to improve the information in this Wiki.
If you notice any errors or omissions with this material, please advise the LMS Team or submit a Service Request at http://www.uwindsor.ca/bbhelp.

Creative Commons status


Additional sources of content in this article were given with permission from University of Delaware, IT Client Support & Services with thanks and appreciation for the collaboration.

University of Delaware Logo

Content is attributed as Creative Commons. All respective sources used are under a free-for-reuse license and additional permission has been obtained.

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox