"Fossies" - the Fresh Open Source Software Archive

Member "absence-v2.1/README-CONFIGURATION.txt" (10 Jun 2012, 6874 Bytes) of package /linux/www/web-absence-2.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 Configuration of Absence
    2 ========================
    3 
    4 There are some major (and some minor) configuration decisions you need
    5 to make before you start installing absence. They are:
    6 
    7 - do you want to allow multiple reservations per person per day?
    8 - do you want to use authentication/authorization?
    9 - are objects people? (probably they are)
   10 - where is the HTML hierarchy going to be installed?
   11 - where do the cgi scripts/modules belong?
   12 - should objects be allowed to be members of more than one group?
   13 - how to deal with holidays
   14 - appearance of absence
   15 
   16 ---------------------
   17 MULTIPLE RESERVATIONS
   18 ---------------------
   19 
   20 if you want multiple reservations (MR), you need to call install.pl
   21 with "-multi_res yes".  Additionally, you should decide whether you
   22 want the person-rows to have variable or fixed height.  This is
   23 controlled by "-variable_height yes/no".  If you choose variable height,
   24 then you need to decide what the minimum and maximum height for a
   25 person-row is.  These values are integer units and refer to "full" height
   26 reservations, as opposed to "half" or "quarter".  The parameters are:
   27 
   28 	-min_height X
   29 	-max_multi Y
   30 
   31 Thus "-min_height 2" would cause person-rows to always be at least the
   32 height of two "full" reservations. "-max_multi 4" would allow person-rows
   33 to grow to four "full" reservations, if needed.  I wouldn't recommend this,
   34 because the rows will get very fat and the calendar becomes hard for the
   35 eye to take in.  A maximum of two is probably good.
   36 
   37 If you instead choose not to allow multiple reservations, you get the
   38 appearance and behaviour of V1.8.
   39 
   40 
   41 --------------------------------
   42 AUTHENTICATION and AUTHORIZATION
   43 --------------------------------
   44 
   45 for details about these and whether objects are people
   46 please see "README-AUTH.txt".
   47 
   48 The corresponding parameters are:
   49 
   50 	-authentication
   51 	-manage_password
   52 	-auth_type
   53 	-credential_src
   54 	-gacl_default
   55 	-pacl_default
   56 	-pw_hash_format
   57 	-session_timeout
   58 
   59 	-objects_are_people
   60 
   61 --------------
   62 HTML HIERARCHY
   63 --------------
   64 
   65 The parameters controlling this are:
   66 
   67 	-data_dir_rel
   68 	-data_dir_abs
   69 	-image_dir_abs
   70 	-image_dir_rel
   71 	-js_dir_abs
   72 	-js_dir_rel
   73 	-top_page
   74 	-log_file
   75 	-js_acl_script
   76 	-main_script
   77 	-manage_script
   78 	-nph_lo_script
   79 
   80 with few exceptions (-data_dir_rel,-data_dir_abs) these can be left at
   81 their defaults.
   82 
   83 -----------------------
   84 CGI SCRIPTS AND MODULES
   85 -----------------------
   86 
   87 The parameters controlling this are:
   88 
   89 	-cgi_dir_abs
   90 	-cgi_dir_rel
   91 
   92 
   93 -----------------------------------------
   94 OBJECTS CAN BELONG TO MORE THAN ONE GROUP
   95 -----------------------------------------
   96 
   97 	-group_policy multiple/single
   98 
   99 
  100 --------
  101 HOLIDAYS
  102 --------
  103 
  104 holidays have gotten a little more complex, since v1.8.
  105 
  106 If all the people using absence are in the same region, you can use
  107 the "simple" holiday scheme, which means all holidays are displayed for all
  108 groups.
  109 
  110 If, however, the absence-users are in geographically distinct regions, with
  111 different holidays, you can use the "advanced" holiday scheme, which
  112 allows you to set a country and/or region for each person and then enter
  113 holidays into the database specifically for these countries and regions.
  114 Holidays are no longer displayed in the header by default, but rather
  115 in the person-rows for the corresponding days.  The header can still
  116 be configured to display holidays from a particular country and/or
  117 region, if desired.  The parameters:
  118 
  119 	-holiday_scheme		advanced/basic
  120 
  121 if -holiday_scheme is set to "advanced", then the following parameters
  122 are also valid:
  123 
  124 	-show_holidays_in_header	yes/no
  125 	-header_holiday_country		<country-code>
  126 	-header_holiday_region		<region-name>
  127 
  128 You will have to define the region later using the management script (see
  129 below).  The parameter
  130 
  131 	-holiday_label			<string>
  132 
  133 sets the label for holidays in the legend.
  134 
  135 
  136 Management of Holidays
  137 ----------------------
  138 
  139 since holidays are now stored in a table in the database, and not in the
  140 file "holiday.db", management has become somewhat more complex than simply
  141 editing the file.  In the ".../path/to/html-dir/absence/Utils" directory
  142 there is a script called "manage-holidays.pl".  Using this script you can:
  143 
  144 - list the holidays in the database, showing country/region info, if present
  145 - list the oountries in the database
  146 - list the regions in the database
  147 - add a single holiday to DB
  148 - import holidays from a file, in iCalendar (ical) or absence v1.8 format (legacy)
  149 - convert an iCalendar-format file to a legacy file
  150 - add a region to DB
  151 - delete a list of holidays from DB
  152 - delete a list of regions from DB
  153 
  154 When accessing the DB, (all ops except -convert) the script needs the
  155 parameters for accessing the database:
  156 
  157 	-db-name/-dbn	<DB-name>
  158 	-user/-u	<username>
  159 	-pass/-p	<password>
  160 	-host		<hostname> (default: localhost)
  161 
  162 listing holidays:
  163 ./manage-holidays.pl <db-params-above> -list holidays
  164 
  165 listing countries:
  166 ./manage-holidays.pl <db-params-above> -list countries
  167 
  168 listing regions:
  169 ./manage-holidays.pl <db-params-above> -list regions
  170 
  171 adding a single holiday:
  172 ./manage-holidays.pl <db-params-above> -add-holiday -date YYYY-MM-DD \
  173 	-desc <description> [-country <country-code>|-region <region-name>]
  174 
  175 converting a file from iCal format to legacy:
  176 ./manage-holidays.pl -convert <filename> > <some-other-file>
  177 
  178 adding a region:
  179 ./manage-holidays.pl <db-params-above> -add-region -name <name> -desc <descrip>
  180 
  181 importing holidays from file:
  182 ./manage-holidays.pl <db-params-above> -import <ical|legacy> -file <file> \
  183 	[-country <country-code>|-region <region-name>]
  184 
  185 deleting a list of holidays:
  186 first, get a list of holidays, as above, then use the holiday-IDs from above
  187 to designate the holidays to be deleted, or use "all" to delete *all*:
  188 ./manage-holidays.pl <db-params-above> -delete-holiday <list|all>
  189 
  190 deleting a list of regions:
  191 first, get a list of regions, as above, then use the region-IDs from above
  192 to designate the regions to be deleted:
  193 ./manage-holidays.pl <db-params-above> -delete-region <list>
  194 
  195 I have included some iCalendar format holiday collections under "holiday-files".
  196 
  197 NOTES:
  198 ------
  199 When importing, or adding single holidays, -country and -region are
  200 optional parameters.  If you are using the "advanced" scheme, all people
  201 with no country/region specified will have holidays displayed that also
  202 have no country/region specified.  Only -country *OR* -region can be
  203 specified, but not both.
  204 
  205 Fixed holidays, i.e., holidays that always fall on the same date, need only
  206 be entered into the database once.  They use year "0001".
  207 
  208 After adding/deleting/changing holidays in the database, you need to delete
  209 all month-images in order to see your changes.
  210 
  211 The holiday description is only displayed in a tool-tip pop-up if you have
  212 configured display of a holiday in the header.  On a person-row tool-tips
  213 do not work.
  214 
  215 
  216 --------------------------------------------------------------------------
  217 Robert Urban
  218 July, 2009