An Introduction to the edikt Wiki
A 'Wiki', or WikiWeb is a web page which can be easily edited by its users.
A Wiki Page
In order to edit pages you need to be logged in. Here's what the Wiki looks like when you are not logged in:
Points to note (labelled in blue on the image above):
- The name of the current page at the top
- The row of navigation bar buttons
- The page contains some text and some links
Editing
To log in, click on 'Home' and then 'log in using EASE'. You will be redirected to the EASE site to log in, and then automatically return to the edikt Wiki.
In addition to the previously displayed page, you will see your username and an edit toolbar. Click on 'Edit (Text)' to edit the page.
Here you can see the web page represented in simple notation. Words squashed together (like UniversityOfEdinburgh) will links to the Wiki page with that name. An arbitrary word or phrase can be made into a Wiki link using ["brackets and double quotes"].
When you edit a page you will also see a brief guide to the markup used, with links to more help.
There is also a GUI editor similar to something like WordPad -- click on 'Edit (GUI)' to use this.
History Info
Click on the 'Info' link on the edit toolbar. This shows a list of changes to the page. From here you can view any specific revision, or differences between any two revisions.
Access Control and Groups
Users in the wiki can belong to groups, and this can be used to restrict access to pages. By default all pages can be read or written by anyone in the TrustedGroup. This is a group of users who belong to the edikt project -- if you are part of the project and you are not in this group please ask TerrySloan or AlisdairTullo and we'll add you.
A group in the Wiki is just a bulleted list of usernames.
To control access to a page, you will have to write (or change) a line at the top of the page which begins with #acl. For example,
#acl Default All:read
means that everyone can read the page, even users who are not logged in. The Default includes the default access controls so that TrustedGroup users can still write to the page -- if you don't do this you risk locking yourself out!
WARNING: Don't put a space in the middle of the permissions. For example,
#acl All: read
will deny all permissions to 'All' -- i.e. the page will not be readable or writable by anyone.
Another example: I want for only a certain group of people to have access to a page called AlisdairsCollaboration. Then I'd create a page called AlisdairsFriendsGroup with a bulleted list of their usernames. Then at the top of the new AlisdairsCollaboration page add:
#acl AlisdairsFriendsGroup:read,write AlisdairTullo:read,write,delete,revert,admin
(The 'admin' permission means that I still reserve the right to change the access control to myself).
Subscribe
Clicking on 'Subscribe' will add you to the notification list for a page. You will then be sent an email when that page changes. You can see a full list of the pages to which you are subscribed on your UserPreferences page.
Attachments and images
Every Wiki page has its own attachments page. To see this, click on 'Attachments'.
From the attachments page you can upload, delete, and view attachments. Attachments can also be referenced inside a Wiki page, by typing attachment:filename. If the attachment is an image it will be displayed in the page. For example typing:
attachment:edikt_banner.png
adds this to the page:
A non-image attachment will appear as a filename with a paperclip icon. For example:
attachment:example.doc
adds this to the page: