# HG changeset patch # User Paul Boddie # Date 1454197744 -3600 # Node ID d40596ab5044773c169ab221817818b42d0313e8 # Parent abbfbee0f858f3a9ec893903def799b3fe9e75b9 Deprecated the plain text version of the preferences documentation in favour of the wiki version. diff -r abbfbee0f858 -r d40596ab5044 docs/preferences.txt --- a/docs/preferences.txt Sun Jan 31 00:46:29 2016 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,233 +0,0 @@ -Preferences and Settings -======================== - -CN --- - -Default: (none) -Alternatives: (see below) - -The common name of the user, employed in iCalendar objects and user -interfaces. - -LANG ----- - -Default: en (English) -Alternatives: (any recognised and supported locale) - -The language for messages and user interface text. - -TZID ----- - -Default: system timezone (see /etc/timezone) -Alternatives: (any recognised Olson time zone identifier) - -The default time zone/regime for calendars, new events and local times. - -add_method_response -------------------- - -Default: refresh -Alternatives: (see below) - -Indicate how ADD methods shall be responded to when received by a recipient: - - add apply them to events as received - - ignore ignore attempts to add event occurrences - - refresh respond with a REFRESH message to obtain a proper - request with all event details - -event_refreshing ----------------- - -Default: never -Alternative: always - -Indicate whether messages requesting a refresh of event details shall be -handled automatically. If not, such messages will be passed on to the -recipient for their mail program to handle. - -freebusy_bundling ------------------ - -Default: never -Alternative: always - -Indicate whether to bundle free/busy details with other payloads such as -event and free/busy objects. The freebusy_sharing setting must be configured -for bundling to operate. - -freebusy_messages ------------------ - -Default: none -Alternative: notify - -Indicate whether recipients are notified about received free/busy payloads. - -freebusy_offers ---------------- - -Default: (none) -Alternative: (see below) - -Define the period for which free/busy offers are extended by participants -supporting this setting when counter-proposals are made during event -scheduling. - -This setting requires a value indicating a duration as described in the -iCalendar format specification: - -http://tools.ietf.org/html/rfc5545#section-3.3.6 - -For example: - - PT10M extend scheduling offers for 10 minutes - PT600S extend scheduling offers for 600 seconds (10 minutes) - PT1D extend offers for 1 day - -freebusy_publishing -------------------- - -Default: no -Alternative: publish - -Indicate whether to publish free/busy details as Web resources. The -freebusy_sharing setting must be configured for publishing to operate. - -freebusy_sharing ----------------- - -Default: no -Alternative: share - -Share free/busy details generally: - - * bundling in e-mail messages if bundling is configured - * responding to free/busy requests via e-mail - * publishing as Web resources if a static Web resource is configured and if - publishing is configured - -incoming --------- - -Default: summary-wraps-message -Alternatives: (see below) - -Define how incoming event messages are delivered to recipients: - - message-only deliver only the incoming message as it was received - - message-then-summary deliver the message first followed by a summary - message - - summary-then-message deliver a summary first followed by the message - - summary-only deliver only a summary of the message - - summary-wraps-message deliver a summary that includes the original message - as an attachment - -organiser_replacement ---------------------- - -Default: attendee -Alternatives: (see below) - -Indicate whether the organiser of an event can be replaced and the nature of -any replacement: - - any any identity, regardless of whether it is already - present or even previously unknown, may become the - organiser - - attendee any new organiser must be a previously-recognised - attendee - - never forbid the replacement of an event's organiser - -participating -------------- - -Default: participate -Alternative: no - -Indicate whether a recipient participates in the calendar system. Note that -participation by default occurs because the handler programs will be defined -in the mail system for recipients fulfilling certain criteria; other -recipients will be handled in other ways. Thus, initial non-participation must -be defined by initialising this setting to "no" for all eligible users, if -this is the general policy on initial calendar system participation. - -permitted_times ---------------- - -Default: (none) -Alternatives: (see below) - -Define the time values at which events can be scheduled. In its simplest form, -this indicates the resolution of a calendar for a participant supporting this -setting, with the given minute values being those allowed for the start and -end of an event. This setting requires a value of one of the following forms: - - - : - :: - -Each list of values is a comma-separated collection of permissible values for -the unit of time being constrained. Any unspecified list is taken to permit -all normally permissible values for that unit of time. For example: - - 0,15,30,45 every 15 minutes from the start of each hour - 10,12,14,16:0,20,40 every 20 minutes from 10:00 until 16:40 inclusive - 12::0,30 every 30 seconds from the start of each minute during - the period from 12:00:00 until 12:59:30 inclusive - -The purpose of this setting is not necessarily to impose availability -constraints but instead to impose a "grid" to which event start and end points -shall be "locked". - -The values are interpreted in the local time of the participant. Thus, a time -represented in UTC may have apparently inappropriate hour (and for some zones) -minute values that correspond to permitted values in this participant's own -time zone. - -scheduling_function -------------------- - -Default: schedule_in_freebusy -Alternatives: (see below) - -Indicates the scheduling functions used by resources to find an appropriate -period for an event, with each function to be applied to a scheduling request -appearing on a separate line. - -The imiptools.handlers.scheduling module contains the built-in scheduling -functions which include the following: - - same_domain_only accept an invitation only if the organiser employs an - address in the same domain as the resource - - schedule_in_freebusy accept an invitation if the event periods are free - according to the free/busy records for the resource; - decline otherwise - - schedule_corrected_in_freebusy correct periods in an event according to - the permitted_times setting (see above), - then attempt to schedule the event according to the - free/busy records for the resource - - schedule_next_available_in_freebusy correct periods in an event according - to the permitted_times setting (see - above), if configured, and attempt to schedule the - event according to the free/busy records for the - resource and for any attendees for whom records are - available, seeking the next available free period for - each period that conflicts with an existing event - -The scheduling mechanism can be extended by implementing additional scheduling -functions or by extending the handler framework directly. diff -r abbfbee0f858 -r d40596ab5044 imiptools/config.py --- a/imiptools/config.py Sun Jan 31 00:46:29 2016 +0100 +++ b/imiptools/config.py Sun Jan 31 00:49:04 2016 +0100 @@ -68,7 +68,7 @@ # Preferences defaults applicable unless overridden by the user. # Changing these allows organisational policy to be defined while still # allowing users to choose more appropriate settings themselves. -# See: docs/preferences.txt +# See: docs/wiki/Preferences # Default language for messages. diff -r abbfbee0f858 -r d40596ab5044 imiptools/profile.py --- a/imiptools/profile.py Sun Jan 31 00:46:29 2016 +0100 +++ b/imiptools/profile.py Sun Jan 31 00:49:04 2016 +0100 @@ -3,7 +3,7 @@ """ User profile management. -Copyright (C) 2015 Paul Boddie +Copyright (C) 2015, 2016 Paul Boddie This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software @@ -38,7 +38,7 @@ "A simple preferences file manager." - # See: docs/preferences.txt + # See: docs/wiki/Preferences known_keys = { "CN" : "",