Docs Reorganization Project

This page provides a place to discuss how to organize the official documentation.

Please add ideas, suggest a new approach, or create a new structure by copying the Table of Contents from below. Share your changes via your own wiki page, or send a text file (or Word Doc, etc.) to the DIG mailing list (open-ils-documentation@list.georgialibraries.org).

Specifications

Draft list of requirements

Meetings

Initial meeting (Thursday, February 19, 2015 at 1:00 PM EST)
- (Meetbot) Minutes
- Log
Planning meeting (Wednesday, February 10, 2016 at 2:00 PM EST)
- Agenda
- Minutes
- Log
March 2016 meeting (Monday, March 7, 2016 at 2:00 PM Eastern)
April 2016 meeting (Date not yet set)
- Agenda

Ideas for Organization

Focus on type of user (e.g. Installer, System Admin, Staff Admin, Staff User (by module: circ, cat, acq), etc.)
- Ideas for audience-focused layout
- One benefit: Each smaller "book" would be easier to read and evaluate for completeness than the current combined docs is.
Use the structure of "Evergreen in Action" as the main organizing structure for the docs
- Some chapters have already been merged from Evergreen in Action. The rest should also be considered.
- FIRST, get advice from the authors if possible (Dan Scott, Kathy Lussier, James Keenan, Lindsay Stratton, Robert Soulliere)
- Add a section at the beginning for installing/setting up Evergreen
- Add a section at the end for developer resources
- Integrate the rest of the docs into the appropriate sections
Design the docs for integration with the web client
- Targeted answers to specific task-based questions

Comments and Complaints about Current Doc Organization

Current Re-Organization

Getting Started Book
Acquisitions Book
Circulation Book
Staff Client System Administration Book
Command Line System Administration Book
- Copy help files from scripts into official docs?
- Example cron script: cron_services
Evergreen Developer Handbook
- Technical Introduction to Evergreen
- How to Participate in the Evergreen Community (communication channels, getting over initial fears, groups/meetings, etc.)
- How to contribute code/docs/etc. (intro to launchpad, pull request process, etc.)
Integrating Evergreen with Other Tools
- evergreen_compatible_products_results_survey_2017

Current Table of Contents

(Taken from the 2.7 docs at: http://docs.evergreen-ils.org/2.7/)

  I. Introduction
    1. About This Documentation
    2. About Evergreen

  II. Evergreen 2.7 Release Notes
    3. Upgrade notes
    4. New features
    5. Acknowledgments

  III. Software Installation
    6. Introduction
    7. System Requirements
        * Server Minimum Requirements
    8. Installing the Evergreen server
    9. Installing the Staff Client
    10. Upgrading the Evergreen Server
    11. Setting Up EDI Acquisitions

  IV. System Configuration and Customization
    12. Introduction
    13. Describing your organization
        * Organization Unit Types
        * Organizational Units
    14. Describing your people
        * Setting the staff user’s working location
        * Comparing approaches for managing permissions
        * Managing permissions in the staff client
        * Managing role-based permission groups in the staff client
        * Managing role-based permission groups in the database
    15. Migrating Patron Data
        * Creating an sql Script for Importing Patrons
        * Batch Updating Patron Data
    16. Migrating from a legacy system
        * Making electronic resources visible in the catalog
        * Migrating your bibliographic records
        * Migrating your call numbers, copies, and parts
    17. Importing materials in the staff client
        * Staff client batch record imports
    18. Ordering materials
        * When should libraries use acquisitions?
        * Managing Funds
        * Ordering
    19. Designing your catalog
        * Configuring and customizing the public interface
        * Setting the default physical location for your library environment
        * Setting a default language and adding optional languages
        * Editing the formats select box options in the search interface.
        * Adding and removing search fields in advanced search
        * Changing the display of facets and facet groups
        * Including external content in your public interface
        * Sitemap generator
        * Troubleshooting TPAC errors
    20. Borrowing items: who, what, for how long
        * Data elements that affect your circulation policies
        * Circulation Rules
        * Creating Circulation Policies
    21. TPac Configuration and Customization
    22. Creating a New Skin: the Bare Minimum
    23. Auto Suggest in Catalog Search
    24. Authentication Proxy
    25. Customizable Toolbar
    26. Phonelist.pm Module
    27. SIP Server

  V. Using the Staff Client
    28. Introduction
    29. Logging in to Evergreen
    30. Button Bar/Toolbar
    31. Check-boxes
    32. Tab Buttons
    33. New Options for Double Clicking
    34. Patron Border Color Enhancement
    35. Sorting Columns
    36. Column Picker
    37. Recent Staff Searches
    38. Return to Search Results from MARC Record
    39. Workstation Administration
        * Copy Editor: Copy Location Name First
        * Font and Sound Settings
        * Select Hotkeys
        * Configure Printers
        * Receipt Template Editor
        * Customizable Toolbar

  VI. System Administration From the Staff Client
    40. Introduction
    41. Acquisitions Administration
    42. Authorities
    43. Best-Hold Selection Sort Order
    44. Booking Module Administration
    45. Call Number Prefixes and Suffixes
    46. Circulation Limit Sets
    47. Copy Status
    48. Floating Groups
    49. MARC Import Remove Fields
    50. MARC Record Attributes
        * Multi Valued Fields and Composite Record Attributes
    51. Org Unit Proximity Adjustments
    52. User and Group Permissions
    53. SMS Text Messaging
    54. User Activity Types
    55. Z39.50 Servers

  VII. Local Administration
    56. Introduction
    57. Address Alert
    58. Hold-driven recalls
    59. Action Triggers
    60. Recent Staff Searches
    61. Library Settings Editor
    62. Standing Penalties
    63. Statistical Categories Editor
    64. Work Log

  VIII. Acquisitions
    65. Acquisitions
    66. Selection Lists and Purchase Orders
    67. Invoices
    68. Load MARC Order Records

  IX. Cataloging
    69. Introduction
    70. MARC Fixed Field Editor Right-Click Context Menu Options
    71. MARC 007 Field Physical Characteristics Wizard
    72. Batch Importing MARC Records
    73. Overlay Existing Catalog Record via Z39.50 Import
    74. Z39.50 Search Enhancements
    75. Monograph Parts
    76. Conjoined Items
    77. Cataloging Electronic Resources — Finding Them in Catalog Searches
    78. TPAC Copy Edit Links
    79. Link Checker

  X. Serials
    80. Serials
    81. Copy Template for Serials
    82. Serials Control View
    83. Alternate Serial Control View
    84. Edit Subscriptions
    85. Receiving
    86. Special Issues
    87. Holdings
    88. Group Serials Issues in the Template Toolkit OPAC

  XI. Circulation
    89. Introduction
    90. Circulating Items
    91. Holds Management
    92. Booking Module
    93. Circulation - Patron Record
    94. Triggered Events and Notices
    95. Offline Transactions
    96. Self checkout
    97. RFID Product Integration

  XII. Reports
    98. Introduction
    99. Starting and Stopping the Reporter Daemon
    100. Folders
    101. Creating Templates
    102. Generating Reports from Templates
    103. Viewing Report Output
    104. Cloning Shared Templates
    105. Adding Data Sources to Reporter
    106. Running Recurring Reports
    107. Template Terminology
    108. Template Enhancements
    109. Exporting Report Templates Using phpPgAdmin

  XIII. Using the Public Access Catalog
    110. Introduction
    111. Using the Public Access Catalog
    112. My Lists
    113. Kids OPAC
    114. Catalog Browse
    115. Bibliographic Search Enhancements
    116. Binary MARC21 Feeds
    117. TPAC Metarecord Search and Metarecord Level Holds
    118. Library Information Pages
    119. Adding OpenSearch to Firefox browser
    120. Adding an Evergreen search form to a web page

  XIV. Developer Resources
    121. Introduction
    122. Support Scripts
    123. Developing with pgTAP tests
    124. Easing gently into OpenSRF
    125. Updating translations using Launchpad