From b7b8bcc8fb314e9164d8c52dc5da446d1015b918 Mon Sep 17 00:00:00 2001 From: Jane Sandberg Date: Sun, 5 Nov 2017 04:47:23 -0800 Subject: [PATCH] Docs: making public catalog docs more modular Signed-off-by: Jane Sandberg --- docs/opac/my_account.adoc | 272 +++++++++++++++ docs/opac/search_url.adoc | 55 +++ .../opac/using_the_public_access_catalog.adoc | 329 +----------------- docs/root_opac.adoc | 4 + 4 files changed, 332 insertions(+), 328 deletions(-) create mode 100644 docs/opac/my_account.adoc create mode 100644 docs/opac/search_url.adoc diff --git a/docs/opac/my_account.adoc b/docs/opac/my_account.adoc new file mode 100644 index 0000000000..240e6ab31f --- /dev/null +++ b/docs/opac/my_account.adoc @@ -0,0 +1,272 @@ + +anchor:my_account[] + + +My Account +~~~~~~~~~~ + +// ``First Login Password Update'' the following documentation comes from JSPAC +// as of 2013-03-12 this feature did not exist in EG 2.4 TPAC, +// so I am commenting it out for now because it will be added in the future +// see bug report https://bugs.launchpad.net/evergreen/+bug/1013786 +// Yamil Suarez 2013-03-12 + +//// + + +First Login Password Update +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +indexterm:[my account, first login password update] + +Patrons are given temporary passwords when new accounts are created, or +forgotten passwords are reset by staff. Patrons MUST change their password to +something more secure when they login or for the first time. Once the password +is updated, they will not have to repeat this process for subsequent logins. + +. Open a web browser and go to your Evergreen OPAC +. Click My Account +. Enter your _Username_ and _Password_. + * By default, your username is your library card number. + * Your password is a 4 digit code provided when your account was created. If +you have forgotten your password, contact your library to have it reset or use +the online the section called ``<>'' tool. +//// + + +Logging In +^^^^^^^^^^ + +indexterm:[my account, logging in] + +Logging into your account from the online catalog: + +. Open a web browser and navigate to your Evergreen OPAC. +. Click _My Account_ . +. Enter your _Username_ and _Password_. +** By default, your username is your library card number. +** Your password is a 4 digit code provided when your account was created. If +you have forgotten your password, contact your local library to have it reset or + use the the section called <> tool. +. Click Login. ++ +** At the first login, you may be prompted to change your password. +** If you updated your password, you must enter your _Username_ and _Password_ +again. ++ +. Your _Account Summary_ page displays. + + +To view your account details, click one of the _My Account_ tabs. + +To start a search, enter a term in the search box at the top of the page and +click _Search_! + +[CAUTION] +================= +If using a public computer be sure to log out! +================= + +anchor:password_reset[] + +Password Reset +^^^^^^^^^^^^^^ + +indexterm:[my account, password reset] + + +To reset your password: + +. click on the _Forgot your password?_ link located beside the login button. + +. Fill in the _Barcode_ and _User name_ text boxes. + +. A message should appear indicating that your request has been processed and +that you will receive an email with further instructions. + +. An email will be sent to the email addressed you have registered with your +Evergreen library. You should click on the link included in the email to open +the password reset page. Processing time may vary. ++ +[NOTE] +================= +You will need to have a valid email account set up in Evergreen for you to reset +your password. Otherwise, you will need to contact your library to have your +password reset by library staff. +================= ++ + +. At the reset email page you should enter the new password in the _New +password_ field and re-enter it in the _Re-enter new password_ field. + +. Click _Submit_. + +. A message should appear on the page indicating that your password has been reset. + +. Login to your account with your new password. + + +Account Summary +^^^^^^^^^^^^^^^ + +indexterm:[my account, account summary] + +In the *My Account* -> *Account Summary* page, you can see when your account +expires and your total number of items checked out, items on hold, and items +ready for pickup. In addition, the Account Summary page lists your current fines +and payment history. + + +Items Checked Out +^^^^^^^^^^^^^^^^^ + +indexterm:[my account, items checked out] + +Users can manage items currently checked out, like renew specific items. Users +can also view overdue items and see how many renewals they have remaining for +specific item. + +As of Evergreen version 2.9, sorting of selected columns is available in the + _Items Checked Out_ and _Check Out History_ pages. Clicking on the appropriate + column heads sorts the contents from "ascending" to "descending" to "no sort". +(The "no sort" restores the original list as presented in the screen.) The sort +indicator (an up or down arrow) is placed to the right of the column head, as +appropriate. + +Within *Items Checked Out* -> *Current Items Checked Out*, the following column + headers can be sorted: _Title_, _Author_, _Renewals Left_, _Due Date_, +_Barcode_, and _Call Number_. + +Within *Items Checked Out* -> *Check Out History*, the following column headers +can be sorted: _Title_, _Author_, _Checkout Date_, _Due Date_, _Date Returned_, +_Barcode_, and _Call Number_ + +[NOTE] +========== +To protect patron privacy, the Check Out History will be completely blank unless the patron has previously opted in under the _Account Preferences_ tab, in the _Search and History Preferences_ +area. +========== + + +Holds +^^^^^ + +indexterm:[my account, holds] + +From *My Account*, patrons can see *Items on Hold* and *Holds History* and +manage items currently being requested. In *Holds* -> *Items on Hold*, the +content shown can be sorted by clicking on the following column headers: +_Title_, _Author_, and _Format_ (based on format name represented by the icon). + +Actions include: + +* Suspend - set a period of time during which the hold will not become active, +such as during a vacation +* Activate - manually remove the suspension +* Cancel - remove the hold request + +Edit options include: + +* Change pick up library +* Change the _Cancel unless filled by_ date, also known as the hold expiration +date +* Change the status of the hold to either active or suspended. +* Change the _If suspended, activate on_ date, which reactivates a suspended +hold at the specified date + +To edit items on hold: + +. Login to _My Account_, click the _Holds_ tab. +. Select the hold to modify. +. Click _Edit_ for selected holds. +. Select the change to make and follow the instructions. + +[NOTE] +========== +To protect patron privacy, the Holds History will be completely blank unless the patron has previously opted in under the _Account Preferences_ tab, in the _Search and History Preferences_ +area. +========== + +Account Preferences +^^^^^^^^^^^^^^^^^^^ + +indexterm:[my account, account preferences] + +From here you can manage display preferences including your *Personal +Information*, *Notification Preferences*, and *Search and History Preferences*. +Additional static information, such as your _Account Expiration Date_, can be +found under Personal Information. + +For example: + +* Personal Information + +** change password - allows patrons to change their password + +** change email address - allows patrons to change their email address. + + + +* Notification Preferences + +** _Notify by Email_ by default when a hold is ready for pickup? + +** _Notify by Phone_ by default when a hold is ready for pickup? + +** _Default Phone Number_ + + +* Search and History Preferences + +** Search hits per page + +** Preferred pickup location + +** Keep history of checked out items? + +** Keep history of holds? + +[WARNING] +======== +Turning off the _Keep history of checked out items?_ or _Keep history of holds?_ features will permanently delete all entries in the relevant patron screens. After this is unchecked, +there is no way for a patron to recover those data. +======== + + +After changing any of these settings, you must click _Save_ to store your +preferences. + + +indexterm:[holds, preferred pickup location] + +Patron Messages +^^^^^^^^^^^^^^^ + +The Patron Message Center provides a way for libraries to communicate with +patrons through messages that can be accessed through the patron's OPAC account. + Library staff can create messages manually by adding an OPAC visible Patron +Note to an account. Messages can also be automatically generated through an +Action Trigger event. Patrons can access and manage messages within their OPAC +account. See Circulation - Patron Record - Patron Message Center for more +information on adding messages to patron accounts. + +*Viewing Patron Messages in the OPAC* + +Patrons will see a new tab for *Messages* in their OPAC account, as well as a +notification of *Unread Messages* in the account summary. + +image::media/message_center11.PNG[Message Center 11] + +Patrons will see a list of the messages from the library by clicking on the +*Messages* tab. + +image::media/message_center10.PNG[Message Center 10] + +Patrons can click on a message *Subject* to view the message. After viewing the +message, it will automatically be marked as read. Patrons have the options to +mark the message as unread and to delete the message. + +image::media/message_center12.PNG[Message Center 12] + +NOTE: Patron deleted messages will still appear in the patron's account in the +staff client under Other -> Message Center. diff --git a/docs/opac/search_url.adoc b/docs/opac/search_url.adoc new file mode 100644 index 0000000000..4e65c404e5 --- /dev/null +++ b/docs/opac/search_url.adoc @@ -0,0 +1,55 @@ +Search URL +~~~~~~~~~~ + +indexterm:[search, URL] + +When performing a search or clicking on the details links, Evergreen constructs +a GET request url with the parameters of the search. The url for searches and +details in Evergreen are persistent links in that they can be saved, shared and +used later. + +Here is a basic search URL structure: + + ++++[hostname]+++/eg/opac/results?query=[search term]&**qtype**=keyword&fi%3Aitem_type=&**locg**=[location id] + +locg Parameter +^^^^^^^^^^^^^^ +This is the id of the search location. It is an integer and maches the id of the +location the user selected in the location drop down menu. + +qtype Parameter +^^^^^^^^^^^^^^^ + +The _qtype_ parameter in the URL represents the search type values and represent +one of the following search or request types: + +* Keyword +* Title +* Journal Title +* Author +* Subject +* Series +* Bib Call Number + +These match the options in the search type drop-down box. + +Sorting +^^^^^^^ + +The _sort_ parameter sorts the results on one of these criteria. + +* `sort=pubdate` (publication date) - chronological order +* `sort=titlesort` - Alphabetical order +* `sort=authorsort` - Alphabetical order on family name first + +To change the sort direction of the results, the _sort_ parameter value has the +".descending" suffix added to it. + +* `sort=titlesort.descending` +* `sort=authorsort.descending` +* `sort=pubdate.descending` + +In the absence of the _sort_ parameter, the search results default to sorting by +relevance. + diff --git a/docs/opac/using_the_public_access_catalog.adoc b/docs/opac/using_the_public_access_catalog.adoc index f50daed1e3..4204c250df 100644 --- a/docs/opac/using_the_public_access_catalog.adoc +++ b/docs/opac/using_the_public_access_catalog.adoc @@ -385,62 +385,6 @@ can also re-order your search results using the _Sort Results_ dropdown list on the search result screen. -Search URL -~~~~~~~~~~ - -indexterm:[search, URL] - -When performing a search or clicking on the details links, Evergreen constructs -a GET request url with the parameters of the search. The url for searches and -details in Evergreen are persistent links in that they can be saved, shared and -used later. - -Here is a basic search URL structure: - - -+++[hostname]+++/eg/opac/results?query=[search term]&**qtype**=keyword&fi%3Aitem_type=&**locg**=[location id] - -locg Parameter -^^^^^^^^^^^^^^ -This is the id of the search location. It is an integer and maches the id of the -location the user selected in the location drop down menu. - -qtype Parameter -^^^^^^^^^^^^^^^ - -The _qtype_ parameter in the URL represents the search type values and represent -one of the following search or request types: - -* Keyword -* Title -* Journal Title -* Author -* Subject -* Series -* Bib Call Number - -These match the options in the search type drop-down box. - -Sorting -^^^^^^^ - -The _sort_ parameter sorts the results on one of these criteria. - -* `sort=pubdate` (publication date) - chronological order -* `sort=titlesort` - Alphabetical order -* `sort=authorsort` - Alphabetical order on family name first - -To change the sort direction of the results, the _sort_ parameter value has the -".descending" suffix added to it. - -* `sort=titlesort.descending` -* `sort=authorsort.descending` -* `sort=pubdate.descending` - -In the absence of the _sort_ parameter, the search results default to sorting by -relevance. - - Search Results ~~~~~~~~~~~~~~ @@ -595,7 +539,7 @@ details. You can view and cancel a hold at anytime. Before your hold is captured, which means an item has been held waiting for you to pick up, you can edit, suspend or - activate it. You need log into your patron <> to do it. + activate it. You need log into your patron account to do it. From your account you can also set up a _Cancel if not filled by_ date for your hold. _Cancel if not filled by_ date means after this date, even though your hold has not been fulfilled you do not need the item anymore. @@ -646,274 +590,3 @@ You can start a new search at any time by entering new search terms in the search box at the top of the page, or by selecting the _Another Search_ or _Advanced Search_ links in the left-hand sidebar. -anchor:my_account[] - - -My Account -~~~~~~~~~~ - -// ``First Login Password Update'' the following documentation comes from JSPAC -// as of 2013-03-12 this feature did not exist in EG 2.4 TPAC, -// so I am commenting it out for now because it will be added in the future -// see bug report https://bugs.launchpad.net/evergreen/+bug/1013786 -// Yamil Suarez 2013-03-12 - -//// - - -First Login Password Update -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -indexterm:[my account, first login password update] - -Patrons are given temporary passwords when new accounts are created, or -forgotten passwords are reset by staff. Patrons MUST change their password to -something more secure when they login or for the first time. Once the password -is updated, they will not have to repeat this process for subsequent logins. - -. Open a web browser and go to your Evergreen OPAC -. Click My Account -. Enter your _Username_ and _Password_. - * By default, your username is your library card number. - * Your password is a 4 digit code provided when your account was created. If -you have forgotten your password, contact your library to have it reset or use -the online the section called ``<>'' tool. -//// - - -Logging In -^^^^^^^^^^ - -indexterm:[my account, logging in] - -Logging into your account from the online catalog: - -. Open a web browser and navigate to your Evergreen OPAC. -. Click _My Account_ . -. Enter your _Username_ and _Password_. -** By default, your username is your library card number. -** Your password is a 4 digit code provided when your account was created. If -you have forgotten your password, contact your local library to have it reset or - use the the section called <> tool. -. Click Login. -+ -** At the first login, you may be prompted to change your password. -** If you updated your password, you must enter your _Username_ and _Password_ -again. -+ -. Your _Account Summary_ page displays. - - -To view your account details, click one of the _My Account_ tabs. - -To start a search, enter a term in the search box at the top of the page and -click _Search_! - -[CAUTION] -================= -If using a public computer be sure to log out! -================= - -anchor:password_reset[] - -Password Reset -^^^^^^^^^^^^^^ - -indexterm:[my account, password reset] - - -To reset your password: - -. click on the _Forgot your password?_ link located beside the login button. - -. Fill in the _Barcode_ and _User name_ text boxes. - -. A message should appear indicating that your request has been processed and -that you will receive an email with further instructions. - -. An email will be sent to the email addressed you have registered with your -Evergreen library. You should click on the link included in the email to open -the password reset page. Processing time may vary. -+ -[NOTE] -================= -You will need to have a valid email account set up in Evergreen for you to reset -your password. Otherwise, you will need to contact your library to have your -password reset by library staff. -================= -+ - -. At the reset email page you should enter the new password in the _New -password_ field and re-enter it in the _Re-enter new password_ field. - -. Click _Submit_. - -. A message should appear on the page indicating that your password has been reset. - -. Login to your account with your new password. - - -Account Summary -^^^^^^^^^^^^^^^ - -indexterm:[my account, account summary] - -In the *My Account* -> *Account Summary* page, you can see when your account -expires and your total number of items checked out, items on hold, and items -ready for pickup. In addition, the Account Summary page lists your current fines -and payment history. - - -Items Checked Out -^^^^^^^^^^^^^^^^^ - -indexterm:[my account, items checked out] - -Users can manage items currently checked out, like renew specific items. Users -can also view overdue items and see how many renewals they have remaining for -specific item. - -As of Evergreen version 2.9, sorting of selected columns is available in the - _Items Checked Out_ and _Check Out History_ pages. Clicking on the appropriate - column heads sorts the contents from "ascending" to "descending" to "no sort". -(The "no sort" restores the original list as presented in the screen.) The sort -indicator (an up or down arrow) is placed to the right of the column head, as -appropriate. - -Within *Items Checked Out* -> *Current Items Checked Out*, the following column - headers can be sorted: _Title_, _Author_, _Renewals Left_, _Due Date_, -_Barcode_, and _Call Number_. - -Within *Items Checked Out* -> *Check Out History*, the following column headers -can be sorted: _Title_, _Author_, _Checkout Date_, _Due Date_, _Date Returned_, -_Barcode_, and _Call Number_ - -[NOTE] -========== -To protect patron privacy, the Check Out History will be completely blank unless the patron has previously opted in under the _Account Preferences_ tab, in the _Search and History Preferences_ -area. -========== - - -Holds -^^^^^ - -indexterm:[my account, holds] - -From *My Account*, patrons can see *Items on Hold* and *Holds History* and -manage items currently being requested. In *Holds* -> *Items on Hold*, the -content shown can be sorted by clicking on the following column headers: -_Title_, _Author_, and _Format_ (based on format name represented by the icon). - -Actions include: - -* Suspend - set a period of time during which the hold will not become active, -such as during a vacation -* Activate - manually remove the suspension -* Cancel - remove the hold request - -Edit options include: - -* Change pick up library -* Change the _Cancel unless filled by_ date, also known as the hold expiration -date -* Change the status of the hold to either active or suspended. -* Change the _If suspended, activate on_ date, which reactivates a suspended -hold at the specified date - -To edit items on hold: - -. Login to _My Account_, click the _Holds_ tab. -. Select the hold to modify. -. Click _Edit_ for selected holds. -. Select the change to make and follow the instructions. - -[NOTE] -========== -To protect patron privacy, the Holds History will be completely blank unless the patron has previously opted in under the _Account Preferences_ tab, in the _Search and History Preferences_ -area. -========== - -Account Preferences -^^^^^^^^^^^^^^^^^^^ - -indexterm:[my account, account preferences] - -From here you can manage display preferences including your *Personal -Information*, *Notification Preferences*, and *Search and History Preferences*. -Additional static information, such as your _Account Expiration Date_, can be -found under Personal Information. - -For example: - -* Personal Information - -** change password - allows patrons to change their password - -** change email address - allows patrons to change their email address. - - - -* Notification Preferences - -** _Notify by Email_ by default when a hold is ready for pickup? - -** _Notify by Phone_ by default when a hold is ready for pickup? - -** _Default Phone Number_ - - -* Search and History Preferences - -** Search hits per page - -** Preferred pickup location - -** Keep history of checked out items? - -** Keep history of holds? - -[WARNING] -======== -Turning off the _Keep history of checked out items?_ or _Keep history of holds?_ features will permanently delete all entries in the relevant patron screens. After this is unchecked, -there is no way for a patron to recover those data. -======== - - -After changing any of these settings, you must click _Save_ to store your -preferences. - - -indexterm:[holds, preferred pickup location] - -Patron Messages -^^^^^^^^^^^^^^^ - -The Patron Message Center provides a way for libraries to communicate with -patrons through messages that can be accessed through the patron's OPAC account. - Library staff can create messages manually by adding an OPAC visible Patron -Note to an account. Messages can also be automatically generated through an -Action Trigger event. Patrons can access and manage messages within their OPAC -account. See Circulation - Patron Record - Patron Message Center for more -information on adding messages to patron accounts. - -*Viewing Patron Messages in the OPAC* - -Patrons will see a new tab for *Messages* in their OPAC account, as well as a -notification of *Unread Messages* in the account summary. - -image::media/message_center11.PNG[Message Center 11] - -Patrons will see a list of the messages from the library by clicking on the -*Messages* tab. - -image::media/message_center10.PNG[Message Center 10] - -Patrons can click on a message *Subject* to view the message. After viewing the -message, it will automatically be marked as read. Patrons have the options to -mark the message as unread and to delete the message. - -image::media/message_center12.PNG[Message Center 12] - -NOTE: Patron deleted messages will still appear in the patron's account in the -staff client under Other -> Message Center. diff --git a/docs/root_opac.adoc b/docs/root_opac.adoc index 09185bca70..4e650754d1 100644 --- a/docs/root_opac.adoc +++ b/docs/root_opac.adoc @@ -27,6 +27,10 @@ include::shared/about_evergreen.adoc[] include::opac/using_the_public_access_catalog.adoc[] +include::opac/search_url.adoc[] + +include::opac/my_account.adoc[] + :leveloffset: 0 include::opac/my_lists.adoc[] -- 2.43.2