Add KPAC configuration info to the community docs user/kmlussier/kpac-doc-addition
authorKathy Lussier <klussier@masslnc.org>
Tue, 5 Feb 2013 15:24:17 +0000 (10:24 -0500)
committerKathy Lussier <klussier@masslnc.org>
Tue, 5 Feb 2013 15:38:41 +0000 (10:38 -0500)
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>
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 268d9fb..f387800 100644 (file)
@@ -191,11 +191,4 @@ copy information.
 
 image::media/Kids_OPAC10.jpg[Kids_OPAC10]
 
-Configuration Files
-~~~~~~~~~~~~~~~~~~~
-
-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 configruation files is available in the Evergreen respository.
 
index 4cd8b95..17348ce 100644 (file)
@@ -135,8 +135,15 @@ include::opac/new_skin_customizations.txt[]
 
 include::admin/auto_suggest_search.txt[]
 
-include::admin/customize_staff_client.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[]
 
 Using the Staff Client
 ======================