From e1b9856d6f01cb9afd62dbac7a004fab4186113e Mon Sep 17 00:00:00 2001 From: Bill Erickson Date: Tue, 17 Apr 2012 11:39:21 -0400 Subject: [PATCH] kpac : tech reference Signed-off-by: Bill Erickson Signed-off-by: Mike Rylander --- docs/TechRef/KidsOPAC.txt | 97 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) create mode 100644 docs/TechRef/KidsOPAC.txt diff --git a/docs/TechRef/KidsOPAC.txt b/docs/TechRef/KidsOPAC.txt new file mode 100644 index 0000000000..83d7875d31 --- /dev/null +++ b/docs/TechRef/KidsOPAC.txt @@ -0,0 +1,97 @@ +Kid's OPAC +========== + +Configuration +------------- + +Apache +~~~~~~ + +[source, bash] +------------------------------------------------------------------------------ + + PerlSetVar OILSWebContextLoader "OpenILS::WWW::EGKPacLoader" + PerlSetVar KPacConfigFile "/openils/conf/kpac.xml.example" + +------------------------------------------------------------------------------ + +XML Configuration File +~~~~~~~~~~~~~~~~~~~~~~ + + * The XML configuration file defines the layout of the kid's OPAC. + * It is read with each restart/reload of the Apache web server. + * The file lives by default at /openils/conf/kpac.xml.example + * There are two top-level elements: and . + * The layout defines the owning org unit and the start page, both by ID. + * At runtime, the layout is determined by the context org unit. If no + configuration is defined for the context org unit, the layout for the + closest ancestor is used. + +[source, xml] +------------------------------------------------------------------------------ + +------------------------------------------------------------------------------ + + * The pages section is a container for elements. + * Each page defines an ID, the number of columns to display for the page, + the page name, and an icon. + +[source, xml] +------------------------------------------------------------------------------ + +------------------------------------------------------------------------------ + + * Each page is a container of cells + * Each cell defines + ** type (topic, search, link) + ** name + ** icon + ** content + * The content for type="topic" cells is the ID of the page this topic + jumps to. The name and img for the referenced page is used as the + display content. + +[source, xml] +------------------------------------------------------------------------------ +12 +------------------------------------------------------------------------------ + + * The content for type="search" cells is the search query. The name and + img are used for the display content. + +[source, xml] +------------------------------------------------------------------------------ +su:piano +------------------------------------------------------------------------------ + + * The content for type="link" cells is the URL. The name and img are used + for the display content. + +[source, xml] +------------------------------------------------------------------------------ +http://en.wikipedia.org/wiki/Clarinet +------------------------------------------------------------------------------ + + +Considerations for Community Adoption +------------------------------------- + +The templates for the Kid's OPAC were developed long before the TPAC was +integrated into Evergreen and it has many of the same limitations that +were part of the TPAC. + + * Fixed width elements (divs, images, etc.), which complicates the + addition of new features and local customizations. + * Images with text, which prevents l10n/i18n. + * While the KPAC does not attempt to match the color scheme of any one + institution, it's inconsistent with the standard Evergreen color + palette. Creating an additional skin to act as the Evergreen default + my be necessary. + +Outstanding Development (Unsponsored) +------------------------------------- + + ** Port the XML configuration file to a DB structure, complete with UI for + managing the various components and upgrade path. + -- 2.11.0