Evergreen DokuWiki - newdevs

3rdparty

Anonymous (anonymous@undisclosed.example.com) — 2023-02-14T17:49:02+00:00

New Developers Working Group Integration with Third Parties Things to add to this page * Overview * Existing Web Services * Describe which third party tools have been integrated with Evergreen * Geolocation * Google Maps * Bing Maps * Ebooks

accessibility

Anonymous (anonymous@undisclosed.example.com) — 2023-07-10T22:10:00+00:00

New Developers Working Group Accessibility Moved to Accessibility section

angular_making_calls

Anonymous (anonymous@undisclosed.example.com) — 2024-03-29T03:16:19+00:00

Calling OpenSRF from the Angular Client The Angular client doesn't talk to the database directly, it instead communicates with OpenSRF to get the information and perform the actions it needs. To do this, it uses the NetService, which is itself a wrapper around the

angular

Anonymous (anonymous@undisclosed.example.com) — 2023-01-19T19:26:27+00:00

New Developers Working Group Angular Tips Compiling Working with Angular development is a little different than working in other areas of the webclient. Normally you might make a change to a file, clear your cache, refresh, and instantly see your change. Angular is different; it also includes an additional step called compiling.

angularclient

Anonymous (anonymous@undisclosed.example.com) — 2025-03-28T16:15:11+00:00

New Developers Working Group Angular Staff Client This is an Angular 15 application found under Open-ILS/src/eg2 and installed to /openils/var/web/eg2/. Note that the language used is TypeScript. Many of the current Angular interfaces were built using Angular 12 or earlier conventions. We only use

angularjs

Anonymous (anonymous@undisclosed.example.com) — 2025-08-29T03:47:43+00:00

New Developers Working Group AngularJS Staff Interfaces * Template Files: Open-ILS/src/templates/staff * JavaScript Files: Open-ILS/web/js/ui/default/staff/ UI widgets beginning with uib-* come from the AngularJS Bootstrap library. The AngularJS interfaces use Glyphicons, which used to be bundled with Bootstrap. See

apis

Anonymous (anonymous@undisclosed.example.com) — 2024-01-17T21:06:42+00:00

New Developers Working Group Calling APIs Examples of Using Specific APIs Get an Auth Token An Auth Token is needed for many of the other API calls. https:///osrf-gateway-v1?service=open-ils.auth&method=open-ils.auth.login¶m={"username":"","password":""}

bootstrap

Anonymous (anonymous@undisclosed.example.com) — 2023-04-28T13:51:14+00:00

New Developers Working Group Bootstrap OPAC The Evergreen Bootstrap OPAC is a mod_perl2 application that uses Template Toolkit for HTML templates. It uses vanilla Javascript and some jQuery, but is designed to function with JavaScript turned off. The Bootstrap version replaces the

frontends

Anonymous (anonymous@undisclosed.example.com) — 2025-08-09T02:52:41+00:00

New Developers Working Group Overview of Evergreen's Various Interfaces Tutorial: Minimum working examples in Angular and AngularJS Things to add to this page: * Explain what the main interfaces are (OPAC vs staff client) * Explain that the staff client includes interfaces built in different ways at different times, discuss goal of moving everything to Angular

glossary

Anonymous (anonymous@undisclosed.example.com) — 2025-07-26T21:46:11+00:00

New Developers Working Group Glossary * CCVMs -- config coded value maps * Clark Kent or just Clark -- the report service (it's the mild-mannered reporter) * Fieldmapper (the IDL) * See birds_eye_view for an old but useful outline of the most common Fieldmapper classes * See

grid

Anonymous (anonymous@undisclosed.example.com) — 2023-12-04T20:56:56+00:00

CSS Grid Most Angular interfaces in Evergreen use the Bootstrap grid for layout. Bootstrap's 12-column grid is based on Flexbox, which is great for laying out items of unknown width horizontally, but not so great at layouts that require control of both axes. Some newer interfaces are beginning to use the

historic

Anonymous (anonymous@undisclosed.example.com) — 2024-06-13T15:17:08+00:00

New Developers Working Group Historic Staff Interfaces Dojo Like the OPAC, this uses Template Toolkit for the HTML and JavaScript: * Template Files: Open-ILS/src/templates/ except the staff/ and opac/ subdirectories. * JavaScript Files: Open-ILS/web/js/dojo

i18n

Anonymous (anonymous@undisclosed.example.com) — 2025-09-02T14:16:13+00:00

New Developers Working Group Internationalization Evergreen is designed to work in multiple languages, but it requires a bit of configuration to get it set up. Enabling a Language 1. Install Translation Files Prerequisite: As root, install a translation tool:

ideas

Anonymous (anonymous@undisclosed.example.com) — 2023-01-18T21:49:55+00:00

New Developers Working Group Project Ideas Types of projects the working group might consider working on: * Flesh out this wiki * Components of Evergreen * Checklist to get started -- link for creating your own testbox * Pull in various training documents from various sources

kpac

Anonymous (anonymous@undisclosed.example.com) — 2024-11-01T20:04:13+00:00

New Developers Working Group KPAC NOTE: The KPAC is currently being updated to a more responsive Bootstrap version. The Evergreen KPAC (Kid's Catalog) is a mod_perl2 application that uses Template Toolkit for HTML templates. It uses vanilla Javascript and some jQuery, but is designed to function with JavaScript turned off.

logs

Anonymous (anonymous@undisclosed.example.com) — 2023-02-14T21:34:30+00:00

Working with EG Logs Logs in a standard Evergreen installation are located at var/log/evergreen. From there, logs are divided into year/month/day folders. Within a day's folder, there are 4 different types of logs: * activity.log * gateway.log

meetings

Anonymous (anonymous@undisclosed.example.com) — 2026-04-23T18:12:55+00:00

New Developers Working Group Meetings The New Developers Working Group meets the third Wednesday of each month at 3pm Eastern. Meeting login info will be sent out to the eg-newdevs list-serv prior to each meeting. * July 15, 2026: Agenda - Joint Meeting with DIG

opensrf

Anonymous (anonymous@undisclosed.example.com) — 2025-03-04T16:33:11+00:00

New Developers Working Group The OpenSRF API * Making Calls to OpenSRF from the Angular client -- interacting with the Evergreen database via PCRUD and/or NetService * Easing Gently into OpenSRF (2010) * OpenSRF Workshop (2010) * The Inside of OpenSRF (Diagram) * OpenSRF - The Book * OpenSRF Method * Example Application Evergreen Conference Sessions Tip of the Iceberg: The Absolute Basics of OpenSRF, by Cesar Velez & Rogan Hamby Things to add to this page: * Summarize what…

perl

Anonymous (anonymous@undisclosed.example.com) — 2024-01-18T15:11:58+00:00

New Developers Working Group The Perl Logic Layer Structure Most of Evergreen's business logic can be found in perl modules. In the git repository, these can be found at Open-ILS/src/perlmods/lib. Perl modules typically have the .pm file extension.

resources

Anonymous (anonymous@undisclosed.example.com) — 2026-01-16T16:36:00+00:00

New Developers Working Group Recommended Resources This list of web sites, classes, and books is not meant to be comprehensive, but they are all resources that people in the new developer group have actually used: General: * Evergreen Developer Overview * Code Formatting Standards Accessibility

restarting

Anonymous (anonymous@undisclosed.example.com) — 2024-03-18T16:10:54+00:00

New Developers Working Group Restarting Things All Services Switch to the opensrf user and run: osrf_control -l --restart-all Apache Switch to the root user and run: /etc/init.d/apache2 restart OR systemctl restart apache2 Autogen Switch to the opensrf user and run:

sanitize

Anonymous (anonymous@undisclosed.example.com) — 2024-01-17T20:55:12+00:00

New Developers Working Group Data Validation and Sanitization Things to add to this page: * Inserting & escaping form content * See for ideas:

searching

Anonymous (anonymous@undisclosed.example.com) — 2023-02-15T14:08:43+00:00

New Developers Working Group Searching and Indexing * Bibliographic Indexing in Evergreen * Bibliographic Queries in Evergreen * Note that this documentation does not include some filters that are used internally such as container() and from_metarecord(). * Angular Staff Client Catalog Search Service Location: Open-ILS/src/eg2/src/app/share/catalog/search-context.ts

sidebar

Anonymous (anonymous@undisclosed.example.com) — 2026-02-18T16:44:05+00:00

Introduction Meetings Building Blocks * Developer Tools * VSCode * Browser Dev Tools * Vim * Bash * Scripting and Markup Languages * CSS Grid * File Locations * Setting up a Development Environment * Testing Email in a Development Environment * Restarting Things (Cheat Sheet) * Troubleshooting Git * Quick Overview * Installation * Create a Branch * Test a Branch * Sign Off on a Branch * Useful Commands * Evergreen Git Repositories The Front End(…

start

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

New Developers Working Group The New Developers Working Group was formed at the 2019 Evergreen International Conference with the intent of gathering together people in the Evergreen community who have interest in learning more about coding for Evergreen, but very little experience. Our goal is to pool our current knowledge, share and review code, and learn together. At times we will invite experienced developers to assist us with reviewing our code or give us mini-tutorials on specific topics.

testserver

Anonymous (anonymous@undisclosed.example.com) — 2026-04-12T07:25:17+00:00

New Developers Working Group Setting Up a Development Environment Setting up a Development Environment Thank you to Blake Henderson and MOBIUS for the development of this Docker container that is specifically set up to edit Evergreen and have on-the-fly results on the Evergreen server. This container has been tested on Windows and Linux and OSX.

tpac

Anonymous (anonymous@undisclosed.example.com) — 2023-04-28T12:28:13+00:00

New Developers Working Group TPAC The Evergreen TPAC is a mod_perl2 application that uses Template Toolkit for HTML templates. It uses vanilla Javascript and some jQuery, but is designed to function with JavaScript turned off. * Template Files: Open-ILS/src/templates/opac/

translations

Anonymous (anonymous@undisclosed.example.com) — 2024-04-09T20:27:28+00:00

New Developers Working Group Translations Evergreen manages translation files through POEditor. * POEditor site * Working with POEditor * eg_translations

tt2

Anonymous (anonymous@undisclosed.example.com) — 2024-03-19T19:32:05+00:00

New Developers Working Group Template Toolkit Things to add to this page: * Template Toolkit Reference * EGCatLoader.pm -- this is where ctx is defined * Summary of what Template Toolkit is / how it relates to the Perl files * Tips on things like displaying dates in a human-readable format

tutorials-wanted

Anonymous (anonymous@undisclosed.example.com) — 2023-09-12T19:12:54+00:00

Tutorials Wanted * Add a new column to a grid with local sorting * How grid cell templates work * Markdown * Happy to modify / port to wiki as/where needed. * Add missing field to print template * Do a database call (Galen’s cat counter) *