===== A Walk-Through of the Source Code (Alpha Version) =====

^ File ^ Description ^ Repository ^
| [[mozilla-devel:chrome:chrome|chrome/]] | The XUL, CSS, Javascript, etc. for our app spread into three directories: [[mozilla-devel:chrome:content:evergreen|content/]] [[mozilla-devel:chrome:locale:en-US:evergreen|locale/]] [[mozilla-devel:chrome:skin:evergreen|skin/]] \\ \\ Our install files tell Mozilla to expect these directories to be archived in **evergreen.jar**, which is built by our Makefile.\\ \\ There is also a **chrome.manifest** file ([[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/chrome/chrome.manifest|CVS]] [[http://www.mozilla.org/xpfe/ConfigChromeSpec.html|Info]]) which replaces the various old-style **contents.rdf** ([[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/chrome/content/evergreen/contents.rdf|CVS 1]] [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/chrome/locale/en-US/evergreen/contents.rdf|CVS 2]] [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/chrome/skin/evergreen/contents.rdf|CVS 3]] [[http://www.mozilla.org/build/jar-packaging.html|Info]]) files sprinkled through the chrome.  This file tells the chrome registry how to map chrome URL's to physical files.  XUL Runner expects this file to be here in the chrome/ directory, but this [[http://www.mozilla.org/projects/firefox/extensions/packaging/extensions.html|Firefox extensions document]] says Firefox expects it to be in the root directory.  Firefox does fall back on the contents.rdf files, however.  I'm not sure which is actually getting used in our case, but it may be best to have the Makefile make a copy of the chrome.manifest in the alternate location.\\ \\ Our entry point for the software is chrome://evergreen/content/auth/**auth.xul** ([[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/chrome/content/evergreen/auth/auth.xul|CVS]]) | [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/chrome/|CVS]] |
| defaults/ | Firefox documentation says, "defaults files other than default preferences files in defaults and default preferences files in defaults/preferences", but I'm not sure what these other default files could be.  We use a defaults/preferences/**evergreen.js** ([[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/defaults/preferences/evergreen.js|CVS]]).  The __toolkit.defaultChromeURI__ pref is required by XUL Runner| [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/defaults/|CVS]] |
| LICENSE  | | [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/LICENSE/|CVS]] |
| Makefile | Needs hand-editing, or alternatively, modification by parent Makefiles, or access to a central settings file | [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/Makefile/|CVS]] |
| README   | | [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/README/|CVS]] |
| application.ini | Used by XUL Runner | [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/application.ini/|CVS]] |
| install.js | Used by legacy Mozilla | [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/install.js/|CVS]] |
| install.rdf | Used by Firefox | [[http://open-ils.org/cgi-bin/viewcvs.cgi/ILS/Evergreen/staff_client/install.rdf/|CVS]] |