1 Kid's OPAC Configuration
2 ========================
11 ------------------------------------------------------------------------------
13 PerlSetVar OILSWebContextLoader "OpenILS::WWW::EGKPacLoader"
14 PerlSetVar KPacConfigFile "/openils/conf/kpac.xml.example"
16 ------------------------------------------------------------------------------
18 XML Configuration File
19 ~~~~~~~~~~~~~~~~~~~~~~
21 * The XML configuration file defines the layout of the kid's OPAC.
22 * It is read with each restart/reload of the Apache web server.
23 * The file lives by default at /openils/conf/kpac.xml.example
24 * There are two top-level elements: <pages> and <layout>.
25 * The layout defines the owning org unit and the start page, both by ID.
26 * At runtime, the layout is determined by the context org unit. If no
27 configuration is defined for the context org unit, the layout for the
28 closest ancestor is used.
31 ------------------------------------------------------------------------------
32 <layout owner="1" page="1"/>
33 ------------------------------------------------------------------------------
35 * The pages section is a container for <page> elements.
36 * Each page defines an ID, the number of columns to display for the page,
37 the page name, and an icon.
40 ------------------------------------------------------------------------------
41 <page id="1" columns="5" name="Home" img="/images/home.jpg">
42 ------------------------------------------------------------------------------
44 * Each page is a container of cells
46 ** type (topic, search, link)
50 * The content for type="topic" cells is the ID of the page this topic
51 jumps to. The name and img for the referenced page is used as the
55 ------------------------------------------------------------------------------
56 <cell type="topic">12</cell>
57 ------------------------------------------------------------------------------
59 * The content for type="search" cells is the search query. The name and
60 img are used for the display content.
63 ------------------------------------------------------------------------------
64 <cell name="Piano" img="category.png" type="search">su:piano</cell>
65 ------------------------------------------------------------------------------
67 * The content for type="link" cells is the URL. The name and img are used
68 for the display content.
71 ------------------------------------------------------------------------------
72 <cell name="Clarinet" img="category.png"
73 type="link">http://en.wikipedia.org/wiki/Clarinet</cell>
74 ------------------------------------------------------------------------------
80 The following example enables you to configure the alternate skin for the Kids
84 ------------------------------------------------------------------------------
85 % cp -r Open-ILS/examples/web/css/skin/kpac2 /openils/var/web/css/skin/
86 % cp -r Open-ILS/examples/web/images/kpac/* /openils/var/web/images/kpac/ #
88 % mkdir /openils/var/templates_kpac2
89 % cp -r Open-ILS/examples/web/templates/kpac /openils/var/templates_kpac2/
90 -------------------------------------------------------------------------------
92 Then set up 443/80 vhosts for serving the alternate skin in eg.conf, something
96 ------------------------------------------------------------------------------
98 ServerName xyz.dev198.esilibrary.com:80
99 DocumentRoot /openils/var/web/
100 DirectoryIndex index.xml index.html index.xhtml
101 Include eg_vhost.conf
103 PerlSetVar OILSWebContextLoader "OpenILS::WWW::EGKPacLoader"
104 PerlSetVar KPacConfigFile "/openils/conf/kpac.xml.example"
105 PerlAddVar OILSWebTemplatePath "/openils/var/templates"
106 PerlAddVar OILSWebTemplatePath "/openils/var/templates_kpac2"
109 -------------------------------------------------------------------------------
111 Considerations for Community Adoption
112 -------------------------------------
114 The templates for the Kid's OPAC were developed long before the TPAC was
115 integrated into Evergreen and it has many of the same limitations that
116 were part of the TPAC.
118 * Fixed width elements (divs, images, etc.), which complicates the
119 addition of new features and local customizations.
120 * Images with text, which prevents l10n/i18n.
121 * While the KPAC does not attempt to match the color scheme of any one
122 institution, it's inconsistent with the standard Evergreen color
123 palette. Creating an additional skin to act as the Evergreen default
126 Outstanding Development (Unsponsored)
127 -------------------------------------
129 ** Port the XML configuration file to a DB structure, complete with UI for
130 managing the various components and upgrade path.