-
Notifications
You must be signed in to change notification settings - Fork 0
User Manual
User manual that I created as part of the coursework.
A form is provided to create a page when you start WikiVLE for the first time. Fill out your desired page title and add some content to the page in the box below.
Click the “Submit the page” button to save it. Don’t worry about filling out all your content - you can always come back to the page to edit it further. Once you have clicked the submit button, you are directed to the page that you just created.
To view a page, either click a link on the Home screen, or perform a search for it using the Search bar. The Display screen is divided into two sections - at the top is an area is provided for displaying files related to your page, and below is an area for displaying the notes that you have written. These areas will automatically update themselves every 10 seconds, so you are always kept up to date with the latest content.
Once you have created at least one page, the Home screen will no longer show the page creation form. To create another page, perform a search (detailed below) using the search bar for the page title of the page that you wish to create.
This will bring you to a search results page, where a link is provided to create a new page. Once you have clicked this link, a button is provided that, once clicked, will show a form for filling out the content of the new page. To save it, click the “Submit the page” button at the bottom.
To edit a page either click on the “Edit the page” link in the Tools sidebar, or click on the “Edit” link on the right hand side of the screen. This will bring you to the Edit screen. As you can see, a textbox with the last version of the notes is provided.
WikiVLE uses a text syntax called Markdown to help you to format your notes nicely, with headers, bullet points, links to other pages and code blocks. A cheatsheet for the most commonly used syntax is provided - click on the “Markdown cheatsheet” button to expand it. A full explanation of what is possible with Markdown is provided in the documentation links at the bottom of the cheatsheet.
Once you have finished editing, you can preview the page - this will allow you to see how your version will look on the Display screen. Note: your edit has not been saved yet - you can continue editing if you wish.
To save your version, click the “Edit the page” button at the bottom of the text box. This will save your version of the page, and send you back to the Display screen. Your edited version is now the version shown on the Display screen.
You may wish to upload a file that is related to the page, so that others can view and download it. A list of all files currently uploaded to the page is available on the main display page. Click on the file to view it in your browser, or right click and select “Save As” to download.
To upload a file, click on the “Choose File” or “Browse” button on the Upload screen - it may vary depending on the computer and browser that you are using. Select the file that you wish to upload and click “Open”. Next, click the “Submit” button to upload the file.
To view previous versions of a page, click on the “History” link in the Tools sidebar. This will take you to the History screen.
A “Revert” button is also provided for all versions, except the most recent. This allows to you quickly and easily revert a page back to how it was in that version. This is very useful for removing vandalism quickly and rolling back to a previous clean version. To revert back, simply click the “Revert” button for the version that you wish to go back to.
To view the citations page, click the “Cite this page” link in the Tools sidebar. This will take you to the Cite screen. The page in split into two sections - at the top is a list of all details needed for most citation styles, and below the APA citation style is provided for you to copy and paste.
To use the search function, either click the “Search” link in the sidebar, or use the search box provided on every page. Additionally, a keyboard shortcut to the search bar is provided - press Ctrl-Shift-F to automatically select the search bar wherever you are in WikiVLE.
Once you have entered a search query, you are taken either directly to the page you searched for, or to a search results page. If WikiVLE finds an exact match between the query you searched for and a page title, it will take you directly to the page. Otherwise, a list of possible matches is shown on the Search results screen. Matches between the search query and the sample content of the results are shown in bold.
WikiVLE allows users to log into the system, so that their actions are recorded. This allows other users to see who has made changes to a page.
To log in with LDAP, fill out the LDAP form on the Log in screen with either your university computer network username or your Jupiter number and your computer network password. Then click the “Log in with LDAP” button. To log in with the built-in account system, enter your username and password provided when you registered for the system (detailed below). To log out, click the “Logout” link at the top of the screen. To register an account with the built-in system, Simply enter your desired username and password on the Register screen, and click the “Register this account” button.
Some users of WikiVLE have “Admin rights”, which means that they have special privileges to change parts of the system.
Firstly on the Admin screen is a form to select which stylesheet is used. Admin users can select which stylesheet they would like to use by selecting the radio button of the stylesheet’s filename. They can also upload new stylesheets in much the same way as uploading a file to a page. Admin users can lock notes - set a page as locked, so that it cannot be edited. A form listing all the currently saved pages is provided, with a button to lock or unlock the page. Finally on the Admin page, a form is provided for selecting which page is to be featured on the Home page. The featured page is displayed with expanded content at the top of the Home page. Users with admin rights additionally can delete pages entirely from WikiVLE. To delete a page, navigate to the page that is to be deleted and click the “Delete this page” in the Tools sidebar. A confirmation page is then shown to prevent accidental deletions.