Add development to 2.0 from 1.6
[working/Evergreen.git] / 2.0 / development / customizingstaffclient.xml
1 <?xml version='1.0' encoding='UTF-8'?>\r
2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
3             xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="customizingstaffclient">\r
4         <title>Customizing the Staff Client</title>\r
5         <indexterm><primary>staff client</primary><secondary>customizing</secondary></indexterm>\r
6         <para>This chapter will give you some guidance on customizing the staff client.</para>  \r
7         <para>The  files related to the staff client are located in the directory <filename class="directory">/openils/var/web/xul/[staff client version]/server/</filename></para>  \r
8          <section xml:id="staffclient_Changingcolors">\r
9                  <title>Changing Colors and Images</title>\r
10                 <para>To change or adjust the image  on the main screen edit <filename>/openils/var/web/xul/index.xhtml</filename>. By default, the image on this page is \r
11                 <filename>main_logo.jpg</filename> which is the same main logo used in the OPAC.</para>\r
12                  <para>To adjust colors on various staff client pages edit the corresponding cascading style sheets located in \r
13                 <filename class="directory">/openils/var/web/xul/[staff client version]/server/skin/</filename>. Other display aspects can also be adjusted using these cascading style sheets.</para>  \r
14         </section>\r
15         <section xml:id="staffclient_Changinglabels">\r
16                  <title>Changing Labels and Messages</title>\r
17                 <indexterm><primary>staff client</primary><secondary>customizing</secondary><tertiary>labels and messages</tertiary></indexterm>\r
18                  <para>You can customize labels in the staff client by editing the corresponding DTD files. The staff client uses the same <filename>lang.dtd</filename> used by the OPAC. This file is located in <filename class="directory">/openils/var/web/opac/locale/[<emphasis>your locale</emphasis>]</filename>. Other labels are controlled by the staff client specific <filename>lang.dtd</filename> file in <filename class="directory">/openils/var/web/xul/<emphasis>client version</emphasis>]/server/locale/[<emphasis>your locale</emphasis>]/</filename>.</para>\r
19         </section>\r
20          <section xml:id="staffclient_searchskin">\r
21                  <title>Changing the Search Skin</title>\r
22                 <para>There are a few ways to change the custom skin for OPAC searching in staff client.</para>         \r
23                 <simplesect>\r
24                         <title>Changing the Search Skin on Server - Overriding Local Settings</title> \r
25                         <para>To change the opac search skins used by the staff client create a file named <filename>custom.js</filename> and place it in the \r
26                         <filename class="directory">/openils/var/web/xul/[staff client version]/server/skin/</filename> directory. This will effect all staff clients since these settings will \r
27                         override local settings.</para> \r
28                         <para>For example, the following text in <filename>custom.js</filename> would set the staff client opac, details page, results page and browse function to the craftsman \r
29                         skin:</para> \r
30 <programlisting language="JavaScript">\r
31 urls['opac'] = '/opac/' + LOCALE + '/skin/craftsman/xml/advanced.xml?nps=1';\r
32 urls['opac_rdetail'] = '/opac/' + LOCALE + '/skin/craftsman/xml/rdetail.xml';\r
33 urls['opac_rresult'] = '/opac/' + LOCALE + '/skin/craftsman/xml/rresult.xml';\r
34 urls['browser'] = '/opac/' + LOCALE + '/skin/craftsman/xml/advanced.xml?nps=1';\r
35 </programlisting>\r
36                         <para>Restart the staff client to see the changes.</para> \r
37                 </simplesect>\r
38                 <simplesect>\r
39                         <title>Changing the Search Skin on an individual Machine</title> \r
40                         <para>To change the search skin on an individual machine for personal preferences or needs, edit the file \r
41                         <filename>/[Evergreen staff client path]/build/chrome/content/main/constants.js</filename>.</para> \r
42                         <para>Find the lines which point to the urls for the OPAC and edit accordingly. For example, here is an example to set the opac, details page, results page and browse \r
43                         function to the craftsman skin:</para> \r
44 <programlisting language="JavaScript">\r
45  'opac' : '/opac/' + LOCALE + '/skin/craftsman/xml/advanced.xml?nps=1',\r
46 'opac_rdetail' : '/opac/' + LOCALE + '/skin/craftsman/xml/rdetail.xml',\r
47 'opac_rresult' : '/opac/' + LOCALE + '/skin/craftsman/xml/rresult.xml',\r
48 ...\r
49 'browser' : '/opac/' + LOCALE + '/skin/craftsman/xml/advanced.xml?nps=1',\r
50 </programlisting>\r
51                         <para>After editing this file, save it and restart the staff client for the changes to take effect.</para> \r
52                 </simplesect>\r
53         </section>\r
54 </chapter>\r