Add KPAC configuration info to the community docs
authorKathy Lussier <klussier@masslnc.org>
Tue, 5 Feb 2013 15:24:17 +0000 (10:24 -0500)
committerGalen Charlton <gmc@esilibrary.com>
Thu, 13 Nov 2014 18:44:42 +0000 (10:44 -0800)
Adds the KPAC TechRef docs to root.txt so that this information can be
available via the community docs. Also adds a section to the docs on
configuring the alternate skin and removes a reference to configuration
from the end-user KPAC docs.

Signed-off-by: Kathy Lussier <klussier@masslnc.org>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>
docs/TechRef/KidsOPAC.txt
docs/opac/kids_opac.txt
docs/root.txt

index 83d7875..856adb7 100644 (file)
@@ -1,5 +1,5 @@
-Kid's OPAC
-==========
+Kid's OPAC Configuration
+========================
 
 Configuration
 -------------
@@ -74,6 +74,40 @@ XML Configuration File
 ------------------------------------------------------------------------------
 
 
+Skin Configuration
+~~~~~~~~~~~~~~~~~~
+
+The following example enables you to configure the alternate skin for the Kids
+Catalog.
+
+[source, xml]
+------------------------------------------------------------------------------
+% cp -r Open-ILS/examples/web/css/skin/kpac2 /openils/var/web/css/skin/
+% cp -r Open-ILS/examples/web/images/kpac/* /openils/var/web/images/kpac/ #
+does not clobber
+% mkdir /openils/var/templates_kpac2
+% cp -r Open-ILS/examples/web/templates/kpac /openils/var/templates_kpac2/
+-------------------------------------------------------------------------------
+
+Then set up 443/80 vhosts for serving the alternate skin in eg.conf, something
+along the lines of:
+
+[source, xml]
+------------------------------------------------------------------------------
+<VirtualHost *:80>
+    ServerName xyz.dev198.esilibrary.com:80
+    DocumentRoot /openils/var/web/
+    DirectoryIndex index.xml index.html index.xhtml
+    Include eg_vhost.conf
+    <Location /eg/kpac>
+        PerlSetVar OILSWebContextLoader "OpenILS::WWW::EGKPacLoader"
+        PerlSetVar KPacConfigFile "/openils/conf/kpac.xml.example"
+        PerlAddVar OILSWebTemplatePath "/openils/var/templates"
+        PerlAddVar OILSWebTemplatePath "/openils/var/templates_kpac2"
+    </Location>
+</VirtualHost>
+-------------------------------------------------------------------------------
+
 Considerations for Community Adoption
 -------------------------------------
 
index 5e3f0f9..cc6d089 100644 (file)
@@ -198,4 +198,3 @@ Configuration files allow you to define labels for canned searches in the icon
 grid, determine how icons lead users to new pages, and define whether those icons 
 are canned searches or links to external resources.  Documentation describing how 
 to use the configuration files is available in the Evergreen repository.
-
index 653e266..c15589a 100644 (file)
@@ -135,6 +135,14 @@ include::admin/auto_suggest_search.txt[]
 
 include::admin/authentication_proxy.txt[]
 
+// Push titles down one level.
+:leveloffset: 1
+
+include::TechRef/KidsOPAC.txt[]
+
+// Return to normal title levels.
+:leveloffset: 0
+
 include::admin/customize_staff_client.txt[]
 
 // Push titles down one level.
@@ -147,7 +155,6 @@ include::admin/phonelist.txt[]
 
 include::admin/sip_server.txt[]
 
-
 Using the Staff Client
 ======================