User Tools

Site Tools


newdevs:landscape:code

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
newdevs:landscape:code [2019/07/17 11:47] tmccannanewdevs:landscape:code [2024/06/13 11:43] (current) – updates to Bootstrap versions sleary
Line 1: Line 1:
 +**New Developers Working Group**
 ====== Scripting and Markup Languages Used in Evergreen ====== ====== Scripting and Markup Languages Used in Evergreen ======
  
 +**General:**
 +  * [[https://wiki.evergreen-ils.org/doku.php?id=eg_developer_overview | Evergreen Developer Overview]]
 +  * [[https://wiki.evergreen-ils.org/doku.php?id=code_formatting_standards | Code Formatting Standards]]
  
 **Angular:** Angular is the JavaScript framework that new Evergreen development uses for the web client. It supercedes AngularJS and uses TypeScript. See: [[https://angular.io/]] **Angular:** Angular is the JavaScript framework that new Evergreen development uses for the web client. It supercedes AngularJS and uses TypeScript. See: [[https://angular.io/]]
Line 8: Line 12:
 **AsciiDoc:** AsciiDoc is a plain text format for creating documentation. Evergreen uses it to write the official Evergreen documentation and release notes that get included with the software. **AsciiDoc:** AsciiDoc is a plain text format for creating documentation. Evergreen uses it to write the official Evergreen documentation and release notes that get included with the software.
  
-**Bootstrap:** See CSS below.+**Bootstrap:** The web client uses the Bootstrap CSS library ([[https://getbootstrap.com/]]). The older AngularJS pages use Bootstrap 4 and the newer Angular pages use Bootstrap 5. A version of the public-facing OPAC developed with Bootstrap 4 was made available with Evergreen version 3.6. If you would like to work on upgrading parts of the interface to a newer Bootstrap version, please refer to this [[https://docs.google.com/spreadsheets/d/1NFx09zghDW_sGcbPnM8iED0_7S2XyISwCnWNuOMhLK4/edit?usp=sharing|Bootstrap 3--5.2 migration guide]] for a consolidated reference to class and function name changes
  
-**CSS:** Cascading Style Sheets are used (along with HTML) to develop the look and feel of Evergreen's user interfaces in the OPAC and staff client. See [[https://developer.mozilla.org/en-US/docs/Web/CSS]]. The web client uses the Bootstrap CSS library ([[https://getbootstrap.com/]]. The older AngularJS pages use Bootstrap 3 and the newer Angular pages use Bootstrap 4.+**CSS:** Cascading Style Sheets are used (along with HTML) to develop the look and feel of Evergreen's user interfaces in the OPAC and staff client. See [[https://developer.mozilla.org/en-US/docs/Web/CSS]] and [[newdevs:grid|CSS Grid]]. 
  
 **Dojo:** The Dojo Toolkit set of JavaScript libraries was used throughout the XUL client. Dojo-based scripts are currently being deprecated as they are replaced with Angular scripts.  **Dojo:** The Dojo Toolkit set of JavaScript libraries was used throughout the XUL client. Dojo-based scripts are currently being deprecated as they are replaced with Angular scripts. 
Line 19: Line 23:
  
 **JSON:** JavaScript Object Notation is used throughout Evergreen. **JSON:** JavaScript Object Notation is used throughout Evergreen.
 +
 +**OpenSRF:** Messaging architecture based on XMPP (jabber) that is used to transmit information within Evergreen. See: https://journal.code4lib.org/articles/3284
  
 **Perl:** Much of the core business logic underlying Evergreen is built in Perl. If you are editing Perl files directly on the server, they are located under: usr/local/share/perl/[version number]/openils/www. If you are making changes to package into a Git branch, the files are located under: \Open-ILS\src\perlmods\lib\OpenILS\WWW\. **Perl:** Much of the core business logic underlying Evergreen is built in Perl. If you are editing Perl files directly on the server, they are located under: usr/local/share/perl/[version number]/openils/www. If you are making changes to package into a Git branch, the files are located under: \Open-ILS\src\perlmods\lib\OpenILS\WWW\.
  
-**Perl Template Toolkit:** Most of the OPAC and current staff client pages are built in Perl Template Toolkit (TT2), which blends HTML and CSS with some simple Perl code to create the web pages. See: [[http://www.template-toolkit.org/]]. If you are editing TT2 files directly on the server, they are located under: /openils/var/templates/. If you are making changes to package into a Git branch, they are under: \Open-ILS\src\templates\.+**Perl Template Toolkit:** Most of the OPAC is built in Perl Template Toolkit (TT2), which blends HTML and CSS with some simple Perl code to create the web pages. See: [[http://www.template-toolkit.org/]]. If you are editing TT2 files directly on the server, they are located under: /openils/var/templates/. If you are making changes to package into a Git branch, they are under: \Open-ILS\src\templates\. Note that CSS files may have the .tt2 file extension.
  
 **PostgreSQL:** Evergreen uses the open-source PostgreSQL database. See: [[https://www.postgresql.org/]] **PostgreSQL:** Evergreen uses the open-source PostgreSQL database. See: [[https://www.postgresql.org/]]
Line 30: Line 36:
 **XML:** XML (Extensible Markup Language) is used in several locations, including the Evergreen Fieldmapper (fm_IDL.xml) and the Kids' Catalog configuration file (kpac.xml),  **XML:** XML (Extensible Markup Language) is used in several locations, including the Evergreen Fieldmapper (fm_IDL.xml) and the Kids' Catalog configuration file (kpac.xml), 
  
-**XUL:** The original staff client was built on XULRunner, a Mozilla-based runtime environment. It is often referred to as "the XUL client" (pronounced like Zuul, the Gatekeeper of Gozer), and is no longer utilized by Evergreen.+**XUL:** The original staff client was built on XULRunner, a Mozilla-based runtime environment. It is often referred to as "the XUL client" (pronounced like Zuul, the Gatekeeper of Gozer), and is no longer utilized by Evergreen. (However, there are still some components that have not been converted to Angular.)
  
newdevs/landscape/code.1563378467.txt.gz · Last modified: 2022/02/10 13:34 (external edit)

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki

© 2008-2022 GPLS and others. Evergreen is open source software, freely licensed under GNU GPLv2 or later.
The Evergreen Project is a U.S. 501(c)3 non-profit organization.