1.1 --- a/docs/preferences.txt Sun Jan 31 00:46:29 2016 +0100
1.2 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000
1.3 @@ -1,233 +0,0 @@
1.4 -Preferences and Settings
1.5 -========================
1.6 -
1.7 -CN
1.8 ---
1.9 -
1.10 -Default: (none)
1.11 -Alternatives: (see below)
1.12 -
1.13 -The common name of the user, employed in iCalendar objects and user
1.14 -interfaces.
1.15 -
1.16 -LANG
1.17 -----
1.18 -
1.19 -Default: en (English)
1.20 -Alternatives: (any recognised and supported locale)
1.21 -
1.22 -The language for messages and user interface text.
1.23 -
1.24 -TZID
1.25 -----
1.26 -
1.27 -Default: system timezone (see /etc/timezone)
1.28 -Alternatives: (any recognised Olson time zone identifier)
1.29 -
1.30 -The default time zone/regime for calendars, new events and local times.
1.31 -
1.32 -add_method_response
1.33 --------------------
1.34 -
1.35 -Default: refresh
1.36 -Alternatives: (see below)
1.37 -
1.38 -Indicate how ADD methods shall be responded to when received by a recipient:
1.39 -
1.40 - add apply them to events as received
1.41 -
1.42 - ignore ignore attempts to add event occurrences
1.43 -
1.44 - refresh respond with a REFRESH message to obtain a proper
1.45 - request with all event details
1.46 -
1.47 -event_refreshing
1.48 -----------------
1.49 -
1.50 -Default: never
1.51 -Alternative: always
1.52 -
1.53 -Indicate whether messages requesting a refresh of event details shall be
1.54 -handled automatically. If not, such messages will be passed on to the
1.55 -recipient for their mail program to handle.
1.56 -
1.57 -freebusy_bundling
1.58 ------------------
1.59 -
1.60 -Default: never
1.61 -Alternative: always
1.62 -
1.63 -Indicate whether to bundle free/busy details with other payloads such as
1.64 -event and free/busy objects. The freebusy_sharing setting must be configured
1.65 -for bundling to operate.
1.66 -
1.67 -freebusy_messages
1.68 ------------------
1.69 -
1.70 -Default: none
1.71 -Alternative: notify
1.72 -
1.73 -Indicate whether recipients are notified about received free/busy payloads.
1.74 -
1.75 -freebusy_offers
1.76 ----------------
1.77 -
1.78 -Default: (none)
1.79 -Alternative: (see below)
1.80 -
1.81 -Define the period for which free/busy offers are extended by participants
1.82 -supporting this setting when counter-proposals are made during event
1.83 -scheduling.
1.84 -
1.85 -This setting requires a value indicating a duration as described in the
1.86 -iCalendar format specification:
1.87 -
1.88 -http://tools.ietf.org/html/rfc5545#section-3.3.6
1.89 -
1.90 -For example:
1.91 -
1.92 - PT10M extend scheduling offers for 10 minutes
1.93 - PT600S extend scheduling offers for 600 seconds (10 minutes)
1.94 - PT1D extend offers for 1 day
1.95 -
1.96 -freebusy_publishing
1.97 --------------------
1.98 -
1.99 -Default: no
1.100 -Alternative: publish
1.101 -
1.102 -Indicate whether to publish free/busy details as Web resources. The
1.103 -freebusy_sharing setting must be configured for publishing to operate.
1.104 -
1.105 -freebusy_sharing
1.106 -----------------
1.107 -
1.108 -Default: no
1.109 -Alternative: share
1.110 -
1.111 -Share free/busy details generally:
1.112 -
1.113 - * bundling in e-mail messages if bundling is configured
1.114 - * responding to free/busy requests via e-mail
1.115 - * publishing as Web resources if a static Web resource is configured and if
1.116 - publishing is configured
1.117 -
1.118 -incoming
1.119 ---------
1.120 -
1.121 -Default: summary-wraps-message
1.122 -Alternatives: (see below)
1.123 -
1.124 -Define how incoming event messages are delivered to recipients:
1.125 -
1.126 - message-only deliver only the incoming message as it was received
1.127 -
1.128 - message-then-summary deliver the message first followed by a summary
1.129 - message
1.130 -
1.131 - summary-then-message deliver a summary first followed by the message
1.132 -
1.133 - summary-only deliver only a summary of the message
1.134 -
1.135 - summary-wraps-message deliver a summary that includes the original message
1.136 - as an attachment
1.137 -
1.138 -organiser_replacement
1.139 ----------------------
1.140 -
1.141 -Default: attendee
1.142 -Alternatives: (see below)
1.143 -
1.144 -Indicate whether the organiser of an event can be replaced and the nature of
1.145 -any replacement:
1.146 -
1.147 - any any identity, regardless of whether it is already
1.148 - present or even previously unknown, may become the
1.149 - organiser
1.150 -
1.151 - attendee any new organiser must be a previously-recognised
1.152 - attendee
1.153 -
1.154 - never forbid the replacement of an event's organiser
1.155 -
1.156 -participating
1.157 --------------
1.158 -
1.159 -Default: participate
1.160 -Alternative: no
1.161 -
1.162 -Indicate whether a recipient participates in the calendar system. Note that
1.163 -participation by default occurs because the handler programs will be defined
1.164 -in the mail system for recipients fulfilling certain criteria; other
1.165 -recipients will be handled in other ways. Thus, initial non-participation must
1.166 -be defined by initialising this setting to "no" for all eligible users, if
1.167 -this is the general policy on initial calendar system participation.
1.168 -
1.169 -permitted_times
1.170 ----------------
1.171 -
1.172 -Default: (none)
1.173 -Alternatives: (see below)
1.174 -
1.175 -Define the time values at which events can be scheduled. In its simplest form,
1.176 -this indicates the resolution of a calendar for a participant supporting this
1.177 -setting, with the given minute values being those allowed for the start and
1.178 -end of an event. This setting requires a value of one of the following forms:
1.179 -
1.180 - <minute values>
1.181 - <hour values>:<minute values>
1.182 - <hour values>:<minute values>:<second values>
1.183 -
1.184 -Each list of values is a comma-separated collection of permissible values for
1.185 -the unit of time being constrained. Any unspecified list is taken to permit
1.186 -all normally permissible values for that unit of time. For example:
1.187 -
1.188 - 0,15,30,45 every 15 minutes from the start of each hour
1.189 - 10,12,14,16:0,20,40 every 20 minutes from 10:00 until 16:40 inclusive
1.190 - 12::0,30 every 30 seconds from the start of each minute during
1.191 - the period from 12:00:00 until 12:59:30 inclusive
1.192 -
1.193 -The purpose of this setting is not necessarily to impose availability
1.194 -constraints but instead to impose a "grid" to which event start and end points
1.195 -shall be "locked".
1.196 -
1.197 -The values are interpreted in the local time of the participant. Thus, a time
1.198 -represented in UTC may have apparently inappropriate hour (and for some zones)
1.199 -minute values that correspond to permitted values in this participant's own
1.200 -time zone.
1.201 -
1.202 -scheduling_function
1.203 --------------------
1.204 -
1.205 -Default: schedule_in_freebusy
1.206 -Alternatives: (see below)
1.207 -
1.208 -Indicates the scheduling functions used by resources to find an appropriate
1.209 -period for an event, with each function to be applied to a scheduling request
1.210 -appearing on a separate line.
1.211 -
1.212 -The imiptools.handlers.scheduling module contains the built-in scheduling
1.213 -functions which include the following:
1.214 -
1.215 - same_domain_only accept an invitation only if the organiser employs an
1.216 - address in the same domain as the resource
1.217 -
1.218 - schedule_in_freebusy accept an invitation if the event periods are free
1.219 - according to the free/busy records for the resource;
1.220 - decline otherwise
1.221 -
1.222 - schedule_corrected_in_freebusy correct periods in an event according to
1.223 - the permitted_times setting (see above),
1.224 - then attempt to schedule the event according to the
1.225 - free/busy records for the resource
1.226 -
1.227 - schedule_next_available_in_freebusy correct periods in an event according
1.228 - to the permitted_times setting (see
1.229 - above), if configured, and attempt to schedule the
1.230 - event according to the free/busy records for the
1.231 - resource and for any attendees for whom records are
1.232 - available, seeking the next available free period for
1.233 - each period that conflicts with an existing event
1.234 -
1.235 -The scheduling mechanism can be extended by implementing additional scheduling
1.236 -functions or by extending the handler framework directly.
2.1 --- a/imiptools/config.py Sun Jan 31 00:46:29 2016 +0100
2.2 +++ b/imiptools/config.py Sun Jan 31 00:49:04 2016 +0100
2.3 @@ -68,7 +68,7 @@
2.4 # Preferences defaults applicable unless overridden by the user.
2.5 # Changing these allows organisational policy to be defined while still
2.6 # allowing users to choose more appropriate settings themselves.
2.7 -# See: docs/preferences.txt
2.8 +# See: docs/wiki/Preferences
2.9
2.10 # Default language for messages.
2.11
3.1 --- a/imiptools/profile.py Sun Jan 31 00:46:29 2016 +0100
3.2 +++ b/imiptools/profile.py Sun Jan 31 00:49:04 2016 +0100
3.3 @@ -3,7 +3,7 @@
3.4 """
3.5 User profile management.
3.6
3.7 -Copyright (C) 2015 Paul Boddie <paul@boddie.org.uk>
3.8 +Copyright (C) 2015, 2016 Paul Boddie <paul@boddie.org.uk>
3.9
3.10 This program is free software; you can redistribute it and/or modify it under
3.11 the terms of the GNU General Public License as published by the Free Software
3.12 @@ -38,7 +38,7 @@
3.13
3.14 "A simple preferences file manager."
3.15
3.16 - # See: docs/preferences.txt
3.17 + # See: docs/wiki/Preferences
3.18
3.19 known_keys = {
3.20 "CN" : "",