Manual

User Manual:

Open the PDF directly: View PDF PDF.
Page Count: 13

DownloadManual
Open PDF In BrowserView PDF
Whiskypedia
Created by Andrei Rotariu & Valerio Bucci
© Copyright Whiskypedia 2018

User Manual
October 2018

Vision
An intuitive wiki platform for whisky lovers to easily share their extensive knowledge and
enlightening ideas about alcoholic beverages in the company of like minded people.

System Requirements
Software:
Ruby (2.3.3)
Web Browser

Gems (Libraries):
Sinatra
Data_mapper

How to Run:
Open the root folder of the web application.
To open a terminal in this location (Shift + Right Click) in the directory and click “Open
Power​S​hell window here”.

2

This saves having to navigate through the terminal.
Typing in the following commands will run the server:
cmd
ruby webPage.rb
(Note: if your default windows terminal is cmd, and not powershell, the “cmd” command is not
required)
The program is now running. Typing “localhost:4567” in the url bar of your web browser will
show the output.

3

Features, Functionalities and How to Use Them:
User Features:
A user can access the webpage without an account. This will allow them to see the article and
and history of changes of the website. To gain the possibility to edit the article they must create
an account and have editing rights given to them by the administrator.
History
The history can be accessed by clicking the history button on the menu in the sidebar.

Clicking on a username on the history page allows the user to see that particular user’s changes
and contributions to the article.

4
Furthermore, clicking on a particular change opens a page showing the article with the
changes underlined.

Creating Account
To create an account the “Login” button must be clicked.

A link reading “Create Account” will appear. Clicking this will lead to the “Create Account” page.

5

Choosing a username and password and clicking the “Create!” button registers the account.

6
The user can now log in via the login page by entering their credentials and clicking “Login!”

Once a user is logged in they have the possibility of being given editing rights by the admin.

7
Editor Features:
Editing Article
If the user is granted editing rights by the administrator, it is now possible to edit the article.
This can be done by clicking the new edit button that appears on the menu in the sidebar.

Changing the text in the box and clicking the “Update” button changes the text on the article.

8
Administrator Features:
Logging in:
To access the administrator features, you must log into the administrator account as you would
any other account.
The default administrator account credentials are:
User: Admin
Password: admin
If this account does not exist. Create an account with the username “Admin” and the password
of your choice. (Note: only the first occurence of an “Admin” username)
Administrator Controls:
Once logged in as the administrator access more features is available.
Permissions
The permissions page allows the administrator to change the editing rights of other users.
The page can be accessed by clicking the “Permissions” button on the sidebar.

9
Checking/Unchecking a user’s box and clicking “Apply” will change a users edit rights.

Logs
This page can be accessed by clicking the “Logs” button on the sidebar.

10
Once on the log page, the administrator can monitor user activity such as when a user has
logged in/logged out, or when an edit has been made.

Clicking on a user’s name on the logs page shows the logs for that individual user.

11
Changing the article
The article can be updated the same way as an editor can. However, the administrator has more
options.
Going to the Edit page and clicking the “Reset” will revert the article to its default text.

Alternatively, default text in the text box can be set as the default text by clicking the “Make
Default” button. (Note: make sure to press update to save changes before clicking “Make
Default”.)

12

The Administrator can also revert to an older version of the page through the History page. Click
“History” on the sidebar.

Restoring can be done by going to a particular version of the article (explained in the history
section) and clicking the “Restore” button that will now appear for the “Admin” account.

13
Miscellaneous Features:
Dynamic word count:
●

Filters out html tags.

●

Provides styling flexibility within articles themselves without having to worry about word
count issues.

Database Driven:
●

Efficiency is increased with database.

●

No need for multiple files for different article versions as it can all be stored in a single
database table.

Unique Logo:
●

Eye-catching and enticing.

●

Acquired from ​https://hatchful.shopify.com/​ for free in compliance with terms of
service.

Cascading Style Sheet:
●

Tidier more efficient code using classes so that the same text formatting can be applied
to multiple areas with less repetition of code.
Source Exif Data: 
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.5
Linearized                      : Yes
Producer                        : Skia/PDF m71
Page Count                      : 13
EXIF Metadata provided by EXIF.tools

Navigation menu