====== Web Staff Client Documentation Project ====== ===== Priorities ===== * Focus Area: [[#circulation_chapters|Chapters on Circulation]] * Focus Area: [[#cataloging_chapters|Chapters on Cataloging]] ===== How to Help ===== * [[https://github.com/evergreen-library-system/Evergreen/tree/master/docs|Edit on GitHub]] * Write documentation in any format! We prefer [[http://powerman.name/doc/asciidoc|AsciiDoc]], but we can convert whatever you send us. * If you want more guidance, check out our [[evergreen-docs:dig_style_guide|documentation style guide]] * Take updated screenshots of the demo web client (see login details below) * Add your name next to a task below (or request a wiki account by emailing [[docs@evergreen-ils.org]]) * Connect via [[http://evergreen-ils.org/communicate/irc/|IRC]], this wiki, and the [[http://libmail.georgialibraries.org/mailman/listinfo/open-ils-documentation|Documentation email list]]. * Learn more about the [[evergreen-docs:dig|Documentation Interest Group]] (DIG) ===== Demo of the Web Client ===== * For the most accurate info: https://wiki.evergreen-ils.org/doku.php?id=community_servers * Copied from that page on Feb 6, 2018: * https://demo.evergreencatalog.com/eg/staff/home * username: admin * password: demo123 * Evergreen 3.0.0 * After logging in the first time, create a workstation (the name doesn't matter) ===== Chapters Needing Review ===== Many of these chapters only need a quick review and no changes. Claim a chapter below by adding your name in the "Claimed By" column. Make edits on [[https://github.com/evergreen-library-system/Evergreen/tree/master/docs|GitHub]], and then create a Pull Request. Update the "Progress" column below as you go. Whenever possible, please share a link to your work in progress. This enables others to help also. See also the (probably outdated) [[https://docs.google.com/spreadsheets/d/1O0m89RblpKvS5IfYlgTT4PJe-fPI6jOFyNstyyJmlbc/edit?usp=sharing|XUL vs. Web Client]] comparison document by Andrea Neiman. ==== Statuses ==== * **NO CHANGE**: Reviewer determined that no changes are necessary. * **DONE**: Changes have been made and committed into the 2.12+ code repositories. * Any other link: Probably a link to changes to review and commit to the code repositories. * [blank]: No progress has been made. Needs review, and possibly needs changes. ==== Circulation Chapters ==== **[[https://github.com/evergreen-library-system/Evergreen/tree/master/docs/circulation|EDIT ON GITHUB]]** ^Claimed By ^Progress ^Chapter ^Link ^ | | NO CHANGE | **XI. Circulation** |[[http://docs.evergreen-ils.org/dev/_circulation_2.html |Link]] | | |NO CHANGE| 100. Introduction | | | | DONE | 101. Circulating Items |[[http://docs.evergreen-ils.org/dev/_circulating_items.html |Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1775402|Bug #1775402]] | | 102. Holds Management |[[http://docs.evergreen-ils.org/dev/_holds_management.html |Link]] | | | DONE | 103. Booking Module |[[http://docs.evergreen-ils.org/dev/_booking_module.html |Link]] | | | DONE | 104. Circulation - Patron Record |[[http://docs.evergreen-ils.org/dev/_circulation_patron_record.html |Link]] | | | DONE | 105. Triggered Events and Notices |[[http://docs.evergreen-ils.org/dev/_triggered_events_and_notices.html |Link]] | | | DONE | 106. Offline Circulation | [[http://docs.evergreen-ils.org/dev/_offline_circulation.html |Link]] | | | NO CHANGE | 107. Self checkout |[[http://docs.evergreen-ils.org/dev/_self_checkout_2.html |Link]] | | | DONE (No longer exists. Removed from docs.) | 108. RFID Product Integration |[[http://docs.evergreen-ils.org/dev/_rfid_product_integration.html |Link]] | ==== Cataloging Chapters ==== **[[https://github.com/evergreen-library-system/Evergreen/tree/master/docs/cataloging|EDIT ON GITHUB]]** ^Claimed By ^Progress ^Chapter ^Link ^ | | NO CHANGE | **IX. Cataloging** |[[http://docs.evergreen-ils.org/dev/_cataloging_2.html |Link]] | | | NO CHANGE | 79. Introduction | | | | DONE | 80. Working with the MARC Editor |[[http://docs.evergreen-ils.org/dev/_working_with_the_marc_editor.html |Link]] | | | NO CHANGE | 81. Batch Importing MARC Records |[[http://docs.evergreen-ils.org/dev/_batch_importing_marc_records.html |Link]] | | FIXME Angela | | 82. Overlay Existing Catalog Record via Z39.50 Import |[[http://docs.evergreen-ils.org/dev/_overlay_existing_catalog_record_via_z39_50_import.html |Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1775929|Bug #1775929]] | | 83. Z39.50 Search Enhancements |[[http://docs.evergreen-ils.org/dev/_z39_50_search_enhancements.html |Link]] | | | DONE | 84. Monograph Parts |[[http://docs.evergreen-ils.org/dev/_monograph_parts.html |Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1775930|Bug #1775930]] | | 85. Conjoined Items |[[http://docs.evergreen-ils.org/dev/_conjoined_items.html |Link]] | | | NO CHANGE | 86. Cataloging Electronic Resources — Finding Them in Catalog Searches |[[http://docs.evergreen-ils.org/dev/_cataloging_electronic_resources_8201_8212_8201_finding_them_in_catalog_searches.html |Link]] | | | NO CHANGE | 87. TPAC Copy Edit Links |[[http://docs.evergreen-ils.org/dev/_tpac_copy_edit_links.html |Link]] | | | NO CHANGE | 88. MARC Batch Edit |[[http://docs.evergreen-ils.org/dev/_marc_batch_edit.html |Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1775931|Bug #1775931]] | | 89. Managing Authorities |[[http://docs.evergreen-ils.org/dev/_managing_authorities.html |Link]] | | | NO CHANGE | 90. Link Checker |[[http://docs.evergreen-ils.org/dev/_link_checker.html |Link]] | ==== All Other Chapters ==== ^ Claimed By ^ Progress ^ Chapter ^ Link ^ | | | **V. Using the Browser Staff Client** | [[http://docs.evergreen-ils.org/dev/_using_the_browser_staff_client.html|Link]] | | | DONE | 34. Introduction | | | FIXME Angela (ws req.) | | 35. Logging in to Evergreen | [[http://docs.evergreen-ils.org/dev/_logging_into_evergreen.html|Link]] | | | DONE (No longer exists. Removed from docs.) | 36. Button Bar/Toolbar | | | [[https://bugs.launchpad.net/evergreen/+bug/1775933|Bug #1775933]] | Not consistent in Web client (particularly in circ). Include other "sticky" settings (dropdowns, etc.)? | 37. Check-boxes | [[http://docs.evergreen-ils.org/2.11/_check_boxes.html|Link in 2.11]] | | | DONE | 38. Tab Buttons | [[http://docs.evergreen-ils.org/dev/_tab_buttons_and_keyboard_shortcuts.html|Link]] | | | DONE (No longer exists. Removed from docs.) | 39. New Options for Double Clicking | | | | DONE (No longer exists. Removed from docs.) | 40. Patron Border Color Enhancement | | | [[https://bugs.launchpad.net/evergreen/+bug/1776763|Bug #1776763]] | | 41. Sorting Columns | [[http://docs.evergreen-ils.org/2.11/_sorting_columns.html|Link]] | | | DONE | 42. Column Picker | [[http://docs.evergreen-ils.org/dev/_column_picker.html|Link]] | | | NO CHANGE | 43. Recent Staff Searches | [[http://docs.evergreen-ils.org/dev/_recent_staff_searches.html|Link]] | | | DONE! | 44. Return to Search Results from MARC Record | [[http://docs.evergreen-ils.org/2.12/_return_to_search_results_from_marc_record.html|Link]] | | FIXME Kathy | See [[https://bugs.launchpad.net/evergreen/+bug/1642023|Bug #1642023: Docs: Web Client Print / Receipt Templates]] -- **NOTE** Configure Printers still reflecting XUL information as of 3.2 docs version | 45. Workstation Administration | [[http://docs.evergreen-ils.org/dev/_workstation_administration.html|Link]] Include documentation on hatch | | | | **VIII. Acquisitions** | [[http://docs.evergreen-ils.org/dev/_acquisitions.html|Link]] | | | NO CHANGE | 73. Acquisitions | [[http://docs.evergreen-ils.org/dev/_acquisitions_2.html|Link]] | | | DONE | 74. Selection Lists and Purchase Orders | [[http://docs.evergreen-ils.org/dev/_selection_lists_and_purchase_orders.html|Link]] | | | DONE | 75. Invoices | [[http://docs.evergreen-ils.org/dev/_invoices.html|Link]] | | | NO CHANGE | 76. Load MARC Order Records | [[http://docs.evergreen-ils.org/dev/_load_marc_order_records.html|Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1774277|Bug #1774277]] | Not implemented yet [[https://bugs.launchpad.net/evergreen/+bug/1733691|see bug #1733691]]. | 77. Placing purchase requests from a patron record | [[http://docs.evergreen-ils.org/dev/_placing_purchase_requests_from_a_patron_record.html|Link]] | | | NO CHANGE | 78. Managing patron purchase requests | [[http://docs.evergreen-ils.org/dev/_managing_patron_purchase_requests.html|Link]] | | | DONE | **X. Serials** | [[http://docs.evergreen-ils.org/dev/_serials_2.html|Link]] | | | NO CHANGE | **IV. System Configuration and Customization** | [[http://docs.evergreen-ils.org/dev/_system_configuration_and_customization.html|Link]] | | | NO CHANGE | 13. Introduction | | | | [[http://git.evergreen-ils.org/?p=Evergreen.git;a=commit;h=dadadc1e76bd7a1d336595d5d3bec9351c646fe8| DONE]] | 14. Describing your organization | [[http://docs.evergreen-ils.org/dev/_describing_your_organization.html|Link]] | | | [[http://git.evergreen-ils.org/?p=Evergreen.git;a=commit;h=dadadc1e76bd7a1d336595d5d3bec9351c646fe8| DONE]] | 15. Describing your people | [[http://docs.evergreen-ils.org/dev/_describing_your_people.html|Link]] | | | NO CHANGE | 16. Migrating Patron Data | [[http://docs.evergreen-ils.org/dev/_migrating_patron_data.html|Link]] | | | NO CHANGE | 17. Migrating from a legacy system | [[http://docs.evergreen-ils.org/dev/_migrating_from_a_legacy_system.html|Link]] | | | NO CHANGE | 18. Importing materials in the staff client | [[http://docs.evergreen-ils.org/dev/_importing_materials_in_the_staff_client.html|Link]] | | | DONE | 19. Ordering materials | [[http://docs.evergreen-ils.org/dev/_ordering_materials.html|Link]] | | | DONE | 20. Designing your catalog | [[http://docs.evergreen-ils.org/dev/_designing_your_catalog.html|Link]] | | | DONE | 21. Borrowing items: who, what, for how long | [[http://docs.evergreen-ils.org/dev/_borrowing_items_who_what_for_how_long.html|Link]] | | | NO CHANGE | 22. Hard due dates | [[http://docs.evergreen-ils.org/dev/_hard_due_dates.html|Link]] | | | NO CHANGE | 23. TPac Configuration and Customization | [[http://docs.evergreen-ils.org/dev/_tpac_configuration_and_customization.html|Link]] | | | NO CHANGE | 24. Creating a New Skin: the Bare Minimum | [[http://docs.evergreen-ils.org/dev/_creating_a_new_skin_the_bare_minimum.html|Link]] | | | NO CHANGE | 25. Auto Suggest in Catalog Search | [[http://docs.evergreen-ils.org/dev/_auto_suggest_in_catalog_search.html|Link]] | | | NO CHANGE | 26. Authentication Proxy | [[http://docs.evergreen-ils.org/dev/_authentication_proxy.html|Link]] | | | NO CHANGE | 27. Kid's OPAC Configuration | [[http://docs.evergreen-ils.org/dev/_kid_8217_s_opac_configuration.html|Link]] | | | DONE (No longer exists. Removed from docs.) | 28. Customizable Toolbar | [[http://docs.evergreen-ils.org/dev/_customizable_toolbar.html|Link]] | | | NO CHANGE | 29. Patron Address City/State/County Pre-Populate by ZIP Code | [[http://docs.evergreen-ils.org/dev/_patron_address_city_state_county_pre_populate_by_zip_code.html|Link]] | | | NO CHANGE | 30. Phonelist.pm Module | [[http://docs.evergreen-ils.org/dev/_phonelist_pm_module.html|Link]] | | | NO CHANGE | 31. SIP Server | [[http://docs.evergreen-ils.org/dev/_sip_server.html|Link]] | | | NO CHANGE | 32. Apache Rewrite Tricks | [[http://docs.evergreen-ils.org/dev/_apache_rewrite_tricks.html|Link]] | | | NO CHANGE | 33. Apache Access Handler Perl Module | [[http://docs.evergreen-ils.org/dev/_apache_access_handler_perl_module.html|Link]] | | | NO CHANGE | **VI. System Administration From the Staff Client** | [[http://docs.evergreen-ils.org/dev/_system_administration_from_the_staff_client.html|Link]] | | | NO CHANGE | 46. Introduction | | | | DONE | 47. Acquisitions Administration | [[http://docs.evergreen-ils.org/dev/_acquisitions_administration.html|Link]] | | | NO CHANGE | 48. Age hold protection | [[http://docs.evergreen-ils.org/dev/_age_hold_protection.html|Link]] | | | DONE | 49. Authorities | [[http://docs.evergreen-ils.org/dev/_authorities.html|Link]] | | | NO CHANGE | 50. Best-Hold Selection Sort Order | [[http://docs.evergreen-ils.org/dev/_best_hold_selection_sort_order.html|Link]] | | | DONE | 51. Booking Module Administration | [[http://docs.evergreen-ils.org/dev/_booking_module_administration.html|Link]] | | | NO CHANGE | 52. Call Number Prefixes and Suffixes | [[http://docs.evergreen-ils.org/dev/_call_number_prefixes_and_suffixes.html|Link]] | | | DONE | 53. Circulation Limit Sets | [[http://docs.evergreen-ils.org/dev/_circulation_limit_sets_2.html|Link]] | | | DONE | 54. Copy Status | [[http://docs.evergreen-ils.org/dev/_copy_status.html|Link]] | | | NO CHANGE | 55. Floating Groups | [[http://docs.evergreen-ils.org/dev/_floating_groups.html|Link]] | | | DONE | 56. MARC Import Remove Fields | [[http://docs.evergreen-ils.org/dev/_marc_import_remove_fields.html|Link]] | | | DONE | 57. MARC Record Attributes | [[http://docs.evergreen-ils.org/dev/_marc_record_attributes.html|Link]] | | | NO CHANGE | 58. Org Unit Proximity Adjustments | [[http://docs.evergreen-ils.org/dev/_org_unit_proximity_adjustments.html|Link]] | | | DONE | 59. User and Group Permissions | [[http://docs.evergreen-ils.org/dev/_user_and_group_permissions.html|Link]] | | | DONE | 60. SMS Text Messaging | [[http://docs.evergreen-ils.org/dev/_sms_text_messaging.html|Link]] | | | DONE | 61. User Activity Types | [[http://docs.evergreen-ils.org/dev/_user_activity_types.html|Link]] | | | DONE | 62. Z39.50 Servers | [[http://docs.evergreen-ils.org/dev/_z39_50_servers.html|Link]] | | | | **VII. Local Administration** | [[http://docs.evergreen-ils.org/dev/_local_administration.html|Link]] | | | NO CHANGE | 63. Introduction | | | | DONE | 64. Library Settings Editor | [[http://docs.evergreen-ils.org/dev/_library_settings_editor.html|Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1776977|Bug #1776977 ]] | | 65. Address Alert | [[http://docs.evergreen-ils.org/dev/_address_alert.html|Link]] | | | DONE | 66. Barcode Completion | [[http://docs.evergreen-ils.org/dev/_barcode_completion.html|Link]] | | | DONE | 67. Hold-driven recalls | [[http://docs.evergreen-ils.org/dev/_hold_driven_recalls.html|Link]] | | | NO CHANGE | 68. Notifications / Action Triggers | [[http://docs.evergreen-ils.org/dev/_notifications_action_triggers.html|Link]] | | | NO CHANGE | 69. Recent Staff Searches | [[http://docs.evergreen-ils.org/dev/_recent_staff_searches_3.html|Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1776986|Bug #1776986]] | DONE (updated in latest docs) | 70. Standing Penalties | [[https://docs.evergreen-ils.org/eg/docs/latest/admin/lsa-standing_penalties.html|Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1776990|Bug #1776990]] | | 71. Statistical Categories Editor | [[http://docs.evergreen-ils.org/dev/_statistical_categories_editor.html|Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1767378|Bug #1767378]] | | 72. Work Log | [[http://docs.evergreen-ils.org/dev/_work_log.html|Link]] | | | | **XII. Reports** | [[http://docs.evergreen-ils.org/dev/_reports_2.html|Link]] | | | NO CHANGE | 113. Introduction | | | | NO CHANGE | 114. Starting and Stopping the Reporter Daemon | [[http://docs.evergreen-ils.org/dev/_starting_and_stopping_the_reporter_daemon.html|Link]] | | | NO CHANGE | 115. Folders | [[http://docs.evergreen-ils.org/dev/reporter_folders.html|Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1776988|Bug #1776988]] | | 116. Creating Templates | [[http://docs.evergreen-ils.org/dev/reporter_creating_templates.html|Link]] | | | NO CHANGE | 117. Generating Reports from Templates | [[http://docs.evergreen-ils.org/dev/generating_reports.html|Link]] | | | NO CHANGE | 118. Viewing Report Output | [[http://docs.evergreen-ils.org/dev/viewing_report_output.html|Link]] | | | DONE | 119. Cloning Shared Templates | [[http://docs.evergreen-ils.org/dev/_cloning_shared_templates.html|Link]] | | | NO CHANGE | 120. Adding Data Sources to Reporter | [[http://docs.evergreen-ils.org/dev/_adding_data_sources_to_reporter.html|Link]] | | | NO CHANGE | 121. Running Recurring Reports | [[http://docs.evergreen-ils.org/dev/recurring_reports.html|Link]] | | FIXME Felicia Beaudry | | 122. Template Terminology | [[http://docs.evergreen-ils.org/dev/_template_terminology.html|Link]] | | [[https://bugs.launchpad.net/evergreen/+bug/1776991|Bug #1776991]] | | 123. Template Enhancements | [[http://docs.evergreen-ils.org/dev/_template_enhancements.html|Link]] | | | NO CHANGE | 124. Exporting Report Templates Using phpPgAdmin | [[http://docs.evergreen-ils.org/dev/_exporting_report_templates_using_phppgadmin.html|Link]] |