| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| courses:cs335:spring2019:graffiti:admin [2019/04/28 23:09] – [Feature Description] admin | courses:cs335:spring2019:graffiti:admin [2019/05/01 02:25] (current) – [Relative Priority] cohene |
|---|
| =====Admin Tools===== | =====Admin Tools===== |
| The Admin Tools provides tools for the administrator to manage login information and access/edit the EpiDoc and the Index. A detailed list of tools is provided below. We need to have a protocol for the admin to login via valid login name and password and set up the infrastructure for the admin to make necessary changes. Additionally, the editing capacity for EpiDoc also needs to be mapped out and implemented. An understanding of the "blacklist" is also required to build the index editing tools. | |
| | The Admin Tools page will provide an administrator with the tools they need to manage the Ancient Graffiti Project's data. An administrator account (these will be the only accounts, but could they possibly have different permissions?), will be able to update their own passwords, add an editor, remove an editor, see all current editor accounts, edit graffiti, update EpiDocs, generate reports for all graffiti, export all graffiti as an EpiDoc file, add words to the blacklist, remove words from the blacklist, and see all words currently blacklisted. Before a user can have access to all of these features, they must first sign-in as an administrator. This is done through a login screen, where the user must supply a valid username and password. New accounts should not be created at this phase. Only current administrators should have the authority to add accounts. This will protect the integrity of the data on the site. Once the admin is logged in, they will be taken to an editing hub. Here they will find links to the pages where they can exercise their various permissions, neatly and properly organized of course. Each of these features respective pages will need to be designed and implemented, though it should be mentioned that preliminary versions of many already exist. |
| | |
| |
| |
| ====Feature Description==== | ====Feature Description==== |
| |
| * Create new logins | * [[createLogins|Manage Editor Accounts]] |
| * Password recovery | * [[passChange|Password Changes]] |
| * Email passwords | * [[grafEdit|Edit Graffiti and EpiDocify Content]] |
| * Use the Washington and Lee University Computer Science Department server\\ | * [[blacklist|Blacklist and Group Words]] |
| * Record revisions to Epidoc | * [[reports|Generate Reports for All Graffiti]] |
| * Save Epidoc | * [[export|Export all Graffiti Data as EpiDoc]] |
| * Reapply Epidoc | |
| * Edit Epidoc | |
| * Index maintenance | |
| * Add/remove words from the vocabulary index blacklist | |
| * Group words | |
| ====Prerequisites==== | ====Prerequisites==== |
| - An understanding of admin tools and their functionalities\\ | |
| - An understanding of the EpiDoc: how does it work? what is the existing EpiDoc function look like? Anything we need to change?\\ | |
| - An understanding of the blacklist index: what does the blacklist look like? what qualifies as a blacklist item? What data structures will best suit our needs\\ | |
| ==== What the User Sees ==== | |
| The Admin should see a window asking for a login name and a password at login (maybe a Reset Password option?). Once the admin logs in successfully, they should see a list of tools laid out clearly on the page, with each tool linking to a new page that has the corresponding admin functionality. The EpiDoc functionality should be implemented in the specific graffiti selection, allowing highlighting abilities. Besides, the user should be able to save the EpiDoc in the case of uploading new data. The blacklist index, which should have similar functionality to the actual index, should use the same structure as the actual index. We will communicate closely with the Index team to make sure they match. Besides, the website should be able to check if the items entered qualified as blacklist items. | |
| |
| | ===For Use=== |
| | * The user must first navigate to the admin login portal (something for which there is not currently a link) |
| | * The user must have a valid username and password, which they remember |
| | * The users session must not have timed-out. |
| | |
| | ===For Implementation=== |
| | * An understanding of the various admin tools and their functionalities |
| | * An understanding of the EpiDoc |
| | * How does it work? |
| | * What does the existing EpiDoc function look like? |
| | * Is their anything we need to change? |
| | * An understanding of the blacklist and the index |
| | * What does the blacklist look like? |
| | * What qualifies as a blacklist item? |
| | * What data structures will best suit our needs? |
| | ==== What the User Sees ==== |
| | The administrator or a user that managed to navigate to the admin authorization page should see a window asking for a username and a password. These two fields are represented by text field and password field respectively. Once the admin logs in successfully, they should see a list of tools laid out clearly on the page, with each tool linking to a new page that has the corresponding admin functionality. These links will ideally be sorted in a way that maximizes usability for administrators and editors. Currently we consider three groupings of the links: account management, editor management, and content management. More or fewer categories can be used per the preferences of the client. |
| ====User Behavior==== | ====User Behavior==== |
| |
| While the administrator will have all of the functionality that a regular user does, they will have additional functionality to fit their needs. What the administrators are doing on the page might be slightly different than a typical user. First and foremost, an administrator might perform any of the activities listed when they first log in: Edit a Graffito, Generate a Report for all Graffiti, Download all Graffiti as an Epidoc, Change their Password, Add a new Editor, and/or Remove an Editor. When viewing any Graffito, an administrator can edit that Graffito. When viewing all of the graffiti, an admin can generate a report.\\ | While the administrator will have all of the functionality that a regular visitor of the site does, they will have additional functionality to fit their needs. Administrators will be able to use the features described on the individual feature pages, while other visitors will only be able to access the login page. This will be the extent of the access to Admin Tools that a visitor of the site will have, as they will not be able to successfully login.\\ |
| \\ | \\ |
| ====Use Cases==== | ====Use Cases==== |
| Many potential use cases of an administrator are listed above. Some functionality we are hoping to bring to this feature is to create new admin logins, store admin information, use that information to see who made revisions, allow admins to add/remove words from a list of "blacklist" vocabulary on the index, and to group words on the index. For example, if an administrator notices that there have been some changes on a graffito, they can look to see what administrator made those changes. There might be potential to even notify an administrator if a change has been made. \\ | The use cases of the various features are listed within the individual features. \\ |
| \\ | \\ |
| ====Relative Priority of Feature==== | ====Relative Priority==== |
| While this feature might not be the top priority, it still has fairly high priority as administrators will require different permissions than typical users to make updates and edits to the content easily and efficiently. Certain functionality within this feature has higher priority than others. For example, allowing new logins, and tracking the Epidoc is much more important to this feature than the vocabulary index "blacklist" and the ability to group words together. | While the Admin Tools might not be the top priority on this project, it still has fairly high priority as administrators will need to access functionality of the site that typical visitors of the site are unable to. In terms of priority of the individual Admin Tools features, the priority is as follows, from high priority to low priority: |
| | * **High:** Edit Graffiti and EpiDocify Content |
| | * **Medium:** Managing Editors, Password Changes |
| | * **Low:** Blacklist and Group Words for the Index, Generate Reports for All Graffiti, Export all Graffiti Data as Epidoc |
| | |
| | More in-depth descriptions about the prioritization of each feature can be seen within the individual feature's page. |
