From 0b5d5f44b119b41d2d0d32370c3c1b8ed38e3659 Mon Sep 17 00:00:00 2001 From: Andrea Buntz Neiman Date: Thu, 1 Jul 2021 16:58:23 -0400 Subject: [PATCH] Docs: updates to library settings; filename fixes Signed-off-by: Andrea Buntz Neiman --- docs/modules/admin/pages/librarysettings.adoc | 48 +++++++++++++++++++++ .../admin_initial_setup/pages/dym_admin.adoc | 5 +-- ...geosort_entry_box.PNG => geosort_entry_box.png} | Bin ...osort_results_km.PNG => geosort_results_km.png} | Bin ...ieval_error.PNG => geosort_retrieval_error.png} | Bin 5 files changed, 50 insertions(+), 3 deletions(-) rename docs/modules/opac/assets/images/media/{geosort_entry_box.PNG => geosort_entry_box.png} (100%) rename docs/modules/opac/assets/images/media/{geosort_results_km.PNG => geosort_results_km.png} (100%) rename docs/modules/opac/assets/images/media/{geosort_retrieval_error.PNG => geosort_retrieval_error.png} (100%) diff --git a/docs/modules/admin/pages/librarysettings.adoc b/docs/modules/admin/pages/librarysettings.adoc index b696e20cfd..414a4d028a 100644 --- a/docs/modules/admin/pages/librarysettings.adoc +++ b/docs/modules/admin/pages/librarysettings.adoc @@ -64,6 +64,24 @@ per-library basis. At the bottom is the table with a list of xref:#data_types[data types] with details about acceptable settings values. +Jump to a specific table: + +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> +* <> + ((("Acquisitions", "Library Settings Editor"))) [[lse-acq]] @@ -95,6 +113,8 @@ values. |Upload Merge on Single Match by Default|Merge records on single match by default during ACQ file upload|True/False| |======== +<> + ((("Booking", "Library Settings Editor"))) ((("Cataloging", "Library Settings Editor"))) @@ -121,6 +141,8 @@ values. |Spine label maximum lines|Set the default maximum number of lines for spine labels.|Number| |====================== +<> + ((("Circulation", "Library Settings Editor"))) [[lse-circulation]] @@ -184,6 +206,8 @@ values. |Warn when patron account is about to expire|If set, the staff client displays a warning this number of days before the expiry of a patron account. Value is in number of days.|Duration| |=========== +<> + ((("Credit Card Processing", "Library Settings Editor"))) [[lse-credit-cards]] @@ -213,6 +237,8 @@ values. |Stripe secret key|Secret API key from stripe.|Text| |====================== +<> + ((("Finances", "Library Settings Editor"))) [[lse-finances]] @@ -242,6 +268,8 @@ values. |Void overdue fines when items are marked lost|If true overdue fines are voided when an item is marked lost|True/False| |======== +<> + ((("GUI", "Library Settings Editor"))) ((("Graphic User Interface", "Library Settings Editor"))) ((("Patron Registration Settings", "Library Settings Editor"))) @@ -303,6 +331,8 @@ values. !Work Log: maximum patrons logged!Maximum entries for "Most Recently Affected Patrons..." section of the Work Log interface.!Number! !=========================== +<> + ((("Global", "Library Settings Editor"))) [[lse-global]] @@ -318,6 +348,8 @@ values. |Patron username format|Regular expression defining the patron username format, used for patron registration and self-service username changing only|Regular expression| |====== +<> + ((("Holds", "Library Settings Editor"))) [[lse-holds]] @@ -354,6 +386,8 @@ For multiple branch libraries |Use weight-based hold targeting|Use library weight based hold targeting|True/False| |===== +<> + ((("Library", "Library Settings Editor"))) [[lse-library]] @@ -373,6 +407,8 @@ The default is at midnight each night for items with "Reshelving" status for ove |Telephony: Arbitrary line(s) to include in each notice callfile|This overrides lines from opensrf.xml. Line(s) must be valid for your target server and platform (e.g. Asterisk 1.4).|Text| |======= +<> + ((("OPAC", "Library Settings Editor"))) [[lse-opac]] @@ -398,6 +434,8 @@ The default is at midnight each night for items with "Reshelving" status for ove |Warn patrons when adding to a temporary book list|Present a warning dialogue when a patron adds a book to the temporary book list.|True/False| |==== +<> + ((("Offline", "Library Settings Editor"))) ((("Program", "Library Settings Editor"))) @@ -414,6 +452,8 @@ The default is at midnight each night for items with "Reshelving" status for ove |Sending email address for patron notices|This email address is for automatically generated patron notices (e.g. email overdues, email holds notification). It is good practice to set up a generic account, like info@nameofyourlibrary.org, so that one person’s individual email inbox doesn’t get cluttered with emails that were not delivered.|Text| |=================== +<> + ((("Receipt Templates", "Library Settings Editor"))) ((("SMS Settings", "Library Settings Editor"))) ((("Text Messaging", "Library Settings Editor"))) @@ -432,6 +472,8 @@ The default is at midnight each night for items with "Reshelving" status for ove |Enable features that send SMS text messages.|Current features that use SMS include hold-ready-for-pickup notifications and a "Send Text" action for call numbers in the OPAC. If this setting is not enabled, the SMS options will not be offered to the user. Unless you are carefully silo-ing patrons and their use of the OPAC, the context org for this setting should be the top org in the org hierarchy, otherwise patrons can trample their user settings when jumping between orgs.|True/False| |====================================== +<> + ((("Security", "Library Settings Editor"))) [[lse-security]] @@ -454,6 +496,8 @@ usernames in addition to barcode. For this setting to work, a barcode format mus |Staff login inactivity timeout (in seconds)|Number of seconds of inactivity before staff client prompts for login and password.|Number| |======== +<> + ((("Self Check", "Library Settings Editor"))) [[lse-selfcheck]] @@ -477,6 +521,8 @@ usernames in addition to barcode. For this setting to work, a barcode format mus |Number of seconds to wait between URL test attempts|Throttling mechanism for batch URL verification runs. Each running process will wait this number of seconds after a URL test before performing the next.|Duration| |===================== +<> + ((("Vandelay", "Library Settings Editor"))) [[lse-vandelay]] @@ -493,6 +539,8 @@ usernames in addition to barcode. For this setting to work, a barcode format mus |Vandelay Generate Default Call Numbers|Auto-generate default item call numbers when no item call number is present|True/False|These are pulled from the MARC Record. |======== +<> + [#data_types] === Data Types === diff --git a/docs/modules/admin_initial_setup/pages/dym_admin.adoc b/docs/modules/admin_initial_setup/pages/dym_admin.adoc index f74ccc65aa..538d53636f 100644 --- a/docs/modules/admin_initial_setup/pages/dym_admin.adoc +++ b/docs/modules/admin_initial_setup/pages/dym_admin.adoc @@ -44,7 +44,7 @@ For examples of where suggestions display in various public catalog interfaces, Search suggestions in the Staff Catalog appear at the bottom of the search area. -image::media/staffcat.png[Search suggestions in the Staff Catalog] +image::media/dym_staffcat.png[Search suggestions in the Staff Catalog] == Administration @@ -95,8 +95,7 @@ suggestions for most catalogs. ** Input can be any positive or negative whole number, but testing demonstrates that setting this to 1 can improve suggestions for catalogs that are primarily English. -* *QWERTY Keyboard similarity score weighting in OPAC spelling -suggestions* +* *Keyboard distance score weighting in OPAC spelling suggestions* ** Defaults to 0 for "off". ** Controls the relative weight of the scaled keyboard distance component. ** While this option is available, it can have a negative impact on diff --git a/docs/modules/opac/assets/images/media/geosort_entry_box.PNG b/docs/modules/opac/assets/images/media/geosort_entry_box.png similarity index 100% rename from docs/modules/opac/assets/images/media/geosort_entry_box.PNG rename to docs/modules/opac/assets/images/media/geosort_entry_box.png diff --git a/docs/modules/opac/assets/images/media/geosort_results_km.PNG b/docs/modules/opac/assets/images/media/geosort_results_km.png similarity index 100% rename from docs/modules/opac/assets/images/media/geosort_results_km.PNG rename to docs/modules/opac/assets/images/media/geosort_results_km.png diff --git a/docs/modules/opac/assets/images/media/geosort_retrieval_error.PNG b/docs/modules/opac/assets/images/media/geosort_retrieval_error.png similarity index 100% rename from docs/modules/opac/assets/images/media/geosort_retrieval_error.PNG rename to docs/modules/opac/assets/images/media/geosort_retrieval_error.png -- 2.11.0