/
Functional Specification

Functional Specification

Apr 25, 2006

Sakai 2.0 RWiki Functional Requirements and Specification

Contents

  • I. Introduction

  • II. Summary

  • III. Functional Requirements

  • IV. Roles and Groups

  • V. Non-functional Requirements

  • VI. Wireframes / Functional Specification

  • VII. Functional Roadmap

I. Introduction

RWiki is an open-source Wiki tool for Sakai that gives worksite members the ability to create and update wiki pages within the worksite. RWiki is designed and developed at the Centre for Applied Research into Educational Technology (CARET) at Cambridge Univeristy. Plans for further development of RWiki are outlined in Section VII.

II. Summary

RWiki will allow worksite members to

1. View wiki pages
2. Update wiki pages
3. Create new wiki pages
4. Link to document resources in Sakai
5. Include images in pages
6. Link to external pages
7. Use UTF8 character sets
8. Use TeX mathematical notation

III. Functional Requirements

Viewing content

1. View Wiki pages within Sakai
2. Follow links to internal pages
3. Follow links to documents and resources within Sakai
4. Follow links to external content
5. Increase or decrease text size

Editing content

1. Edit existing content.
2. Add a variety of headings, bulleted lists, tables, and text formatting
3. Link to other RWiki pages, under page aliases if desired
4. Link to external pages
5. Incorporate images uploaded into Sakai Resources.
6. Incorporate maths notation using TeX
7. Use UTF8 character sets, allowing content in a number of different languages
8. Preview your changes
9. Cancel your changes
10. Save your changes
11. Receive notification if the page has been changed by someone else while you are editing it, allowing you to choose which version to save.

Alter document permissions

Allows the owner of a page (usually the page?s creator) to make it available for public viewing within Sakai.

1. Apparently this is going to change?
2. Edit the conten
3. At bottom of the page, a ?show document permissions? button appears.

Information on content

1. Lists all pages the page references
2. Lists all pages that reference the page
3. Gives the page owner (usually the person who created it)
4. Gives the global page name, to allow linking to it from outside the RWiki
5. Gives the page permission detail (the site you need to be a member of to see it)
6. Gives details of when the page was last edited

History of content

1. Gives a list of all previous versions of that page, with the name of the user who altered it, the date.
2. Allows you to view any previous version.
3. Compare the contents of any version with the current version
4. Compare the contents of any version with the version immediately previous.
5. Allows you to revert to any previous version.

Search

1. View list of titles of pages including search content
2. Use ?and? operator (but not ?not? or ?or?)

IV. Roles and Groups

A number of use cases that have been suggested for RWiki require page-level permissions to be set and represent behaviour that is atypical of a ?standard? wiki. These page-level permissions are hidden by default. Sakai Admin should have RWiki superadmin permission in order to reveal page permissions to sites that wish to experiment.
Standard Wiki

There are 5 permission within RWiki:

  • RWiki read

  • RWiki create

  • RWiki update

  • RWiki admin

  • RWiki superadmin