Skip to content

Instantly share code, notes, and snippets.

@cherimarie

cherimarie/gist:af38cd489d9b3c86117a

Forked from patrickdent/gist:eba9d29e457136d09193
Last active August 29, 2015 14:16
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save cherimarie/af38cd489d9b3c86117a to your computer and use it in GitHub Desktop.
Save cherimarie/af38cd489d9b3c86117a to your computer and use it in GitHub Desktop.
Download ZIP
LibCat User Guide
Raw
gistfile1.md

Basic Usage

Contents

  1. Creating a new user
  2. User roles and abilities
  3. Changing user roles
  4. Creating a new loan
  5. Renewing and returning loans
  6. Selecting items and the list feature

1. Creating a new user

  1. Have the new user click the "sign up" link on the home page and fill out the sign up form. ![alt text][signuplink] ![alt text][signupform]
  • note that both the user name and email fields are optional, but the user won't be able to receive reminders or reset her password without an email address.
  1. Once she completes the form, she will be returned to the home page: have her click on the "logout" link. ![alt text][logoutlink]
  2. A librarian or administrator must now login (via the login link on the home page) to complete the signup process.
  3. From the home page, click on the "dashboard" link and then on the "manage users" link. ![alt text][dashboard]
  4. Find the user's name and click on the "edit" link on that user's line. ![alt text][usereditlink]
  5. Fill in the rest of the fields with the user's information and click the "submit" link. ![alt text][edituserform]
  • remember that a user must have a name and either an email address or a phone number to borrow items from the library.

2. User roles and abilities

anyone can:

  • browse by keyword/genre/author or search the collection and see which items are available to borrow

patrons can:

  • view their own information including borrowing history
  • edit their own login information

librarians can:

  • do anything a patron can do
  • manage users
  • change user information (excluding email and password)
  • view any user's information (excluding email and password)
  • manage keywords
  • create new keywords
  • add keywords to books
  • edit and delete keywords
  • manage loans
  • check-oout items
  • renew a loan
  • return a loan
  • select books to view as a list

admin users can:

  • do anything a librarian or patron can do
  • delete other users
  • promote/demote other users
  • manage authors (edit/create/delete)
  • manage books (edit/create/delete)
  • manage genres (edit/create/delete)
  • import books from the web via ISBN 10
  • upload items to the database via a CSV file (as exported by BookCat)

3. Changing user roles

  1. You must be logged in as an administrator to change another user's role (you cannot change your own role)
  2. From the home page, click the "dashboard" link and then click the "manage users" link.
  3. Find the user who's role you'd like to change and click on her "edit" link.
  4. Near the bottom of the form the three roes are listed as radio buttons, select one and click the "submit" link. ![alt text][roleradiobutton]

4. Creating a new loan

From a user's page

  1. Navigate to the user's page by clicking on her user name on any page on which it appears (ex. the manage user's page, accessible via the dashboard) ![alt text][usernamelink]
  2. Click on the "loan book" link located above the user's loan history. ![alt text][loanlink]
  • if the user is unable to borrow more item's this option will not be available (ex. she has reached her borrowing limit)
  1. Select a book from the list (you may begin typing the title of the book to narrow down the books displayed). ![alt text][loanfromuserform]
  2. Click the "submit" link.

From an item's page

  1. Navigate to the item's page by clicking on it's title on any page on which it appears (ex. via search) ![alt text][booktitlelink]
  2. Click on the "loan book" link located above the item's loan history. ![alt text][loanlink]
  • if the book is unable to lend this option will not be available (ex. it's alread on loan)
  1. Select a user from the list (you may begin typing a user name to narrow down the users displayed). ![alt text][loanfrombookform]
  2. Click the "submit" link.

5. Renewing and returning loans

From a user's page

  1. Navigate to the user's page by clicking on her user name on any page on which it appears (ex. the manage user's page, accessible via the dashboard)
  2. Find the book in the user's loan history.
  3. If the item is still out on loan, there will be buttons to renew and return loans: click the button for the desired action. ![alt text][renewreturnfromuser]
  • if the the user is no longer able to renew the book, the renew option won't appear.

From an item's page

  1. Navigate to the item's page by clicking on it's title on any page on which it appears (ex. via search)
  2. Find the user in the book's loan history.
  3. If the item is still out on loan, there will be buttons to renew and return loans: click the button for the desired action. ![alt text][renewreturnfrombook]
  • if the the user is no longer able to renew the book, the renew option won't appear.

Selecting and unselecting items (and the list feature)

  1. Items may be selected from any page on which they are displayed (ex. via search).
  2. Click on the check-box next to the item's title to select or unselect it. ![alt text][checkbox]
  3. You may vew selected books by clicking the "view selected books" link. ![alt text][viewselected]
  4. You may clear the books you have selected by clicking the "clear selected books" link. ![alt text][clearselectedlink] [dashboard]: http://i1381.photobucket.com/albums/ah207/p_s_dent/dashboardlinkgist_zps21d9fe63.jpg [usernamelink]: http://i1381.photobucket.com/albums/ah207/p_s_dent/usernamelinkgist_zps68c16903.jpg [signuplink]: http://i1381.photobucket.com/albums/ah207/p_s_dent/signupgist_zps705cc85e.jpg [viewselected]: http://i1381.photobucket.com/albums/ah207/p_s_dent/viewselectedgist_zps5ed14502.jpg [logoutlink]: http://i1381.photobucket.com/albums/ah207/p_s_dent/logoutlinkgist_zps9a10c309.jpg [manageuserslink]: http://i1381.photobucket.com/albums/ah207/p_s_dent/manageuserslinkgist_zps7ec0262c.jpg [signupform]: http://i1381.photobucket.com/albums/ah207/p_s_dent/signupformgist_zps9a27bff5.jpg [usereditlink]: http://i1381.photobucket.com/albums/ah207/p_s_dent/usereditlinkgist_zpsce6b08b2.jpg [loanfrombookform]: http://i1381.photobucket.com/albums/ah207/p_s_dent/loanfrombookgist_zps48a964df.jpg [loanfromuserform]: http://i1381.photobucket.com/albums/ah207/p_s_dent/loanfromusergist_zps9f0182de.jpg [clearselectedlink]: http://i1381.photobucket.com/albums/ah207/p_s_dent/clearlselectedgist_zps9aeea438.jpg [checkbox]: http://i1381.photobucket.com/albums/ah207/p_s_dent/checkboxgist_zpsccd65505.jpg [loanlink]: http://i1381.photobucket.com/albums/ah207/p_s_dent/loanbooklinkgist_zps929ce3c1.jpg [booktitlelink]: http://i1381.photobucket.com/albums/ah207/p_s_dent/booktitlelinkgist_zps7a0fae6c.jpg [roleradiobutton]: http://i1381.photobucket.com/albums/ah207/p_s_dent/roleradiobuttongist_zps3824e224.jpg [edituserform]: http://i1381.photobucket.com/albums/ah207/p_s_dent/edituserformsubmitgist_zpsf8a3a8d9.jpg [renewreturnfromuser]: http://i1381.photobucket.com/albums/ah207/p_s_dent/renewreturnfromusergist_zps6e357636.jpg [renewreturnfrombook]: http://i1381.photobucket.com/albums/ah207/p_s_dent/renewreturnfrombookgist_zps2295d93a.jpg
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment