Minor stylistic edits to documentation.

modules/tmrec/README

@@ -10,7 +10,13 @@ Daniel-Constantin Mierla
 
    <[email protected]>
 
-   Copyright © 2012 asipto.com
+Edited by
+
+Alex Balashov
+
+   <[email protected]>
+
+   Copyright © 2012 asipto.com
      __________________________________________________________________
 
    Table of Contents
@@ -59,9 +65,9 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   This module provides time recurrence matching functions. Definitions of
-   recurrences are based on Internet Calendaring and Scheduling Core
-   Object Specification (Calendar COS - RFC 2445).
+   This module provides time recurrence matching functions. The format of
+   recurrence definitions is based on Internet Calendaring and Scheduling
+   Core Object Specification (Calendar COS - RFC 2445).
 
 2. Dependencies
 
@@ -85,7 +91,7 @@ Chapter 1. Admin Guide
 
 3.1. separator (str)
 
-   Separator character used to delimit the attributes in time reccurence
+   Separator character used to delimit attributes in time reccurence
    definitions.
 
    Default value is '|'.
@@ -100,61 +106,62 @@ modparam("tmrec", "separator", ";")
    4.1. tmrec_match(timerec [, timestamp])
    4.2. is_leap_year([year])
 
-4.1. tmrec_match(timerec [, timestamp])
+4.1.  tmrec_match(timerec [, timestamp])
 
-   Match a time recurrence rules against the timestamp. If timestamp
-   parameter is missing, the value of current unix timestamp is used.
+   Match a time recurrence rule against the timestamp (UNIX epoch format).
+   If the timestamp parameter is missing, the current UNIX epoch time is
+   used.
 
    The parameters can include pseudo-variables.
 
    The timerec paramter is a list of attributes defined by RFC2445,
-   delimited by 'separator' (module parameter) character. The format of
-   timerec parameter, using '|' as separator, is (all in one line without
-   white spaces):
+   delimited by the 'separator' (module parameter) character. The format
+   of timerec parameter, using '|' as the separator, is (all in one line
+   without white spaces):
 ...
 [startdate]|[duration]|[frequency]|[until]|[interval]|[byday]
   |[bymonthday]|[byyearday]|[byweekno]|[bymonth]
 ...
 
    When an attribute is not specified, the corresponding place must be
-   left empty, whenever another attribute that follows in the list has to
-   be specified.
+   left empty, provided that one or more additional attributes follow.
 
    Description of time recurrence attributes:
      * startdate - date for the start of the first period.
      * duration - the duration of the time period. For a recurring
-       interval, the "duration" parameter MUST be small enough such that
+       interval, the “duration� parameter MUST be small enough such that
        subsequent intervals do not overlap. For non-recurring intervals,
-       durations of any positive length are permitted, zero-length
-       duration means "forever". Negative-length durations are not
+       durations of any positive length are permitted. Zero-length
+       duration means “forever�. Negative-length durations are not
        allowed.
-     * frequency - can be one of the following values: "daily" - specify
-       repeating periods based on an interval of a day or more; "weekly" -
+     * frequency - can be one of the following values: “daily� - specify
+       repeating periods based on an interval of a day or more; “weekly� -
        specify repeating periods based on an interval of a week or more;
-       "monthly" - specify repeating periods based on an interval of a
-       month or more; "yearly" - specify repeating periods based on an
-       interval of a year or more. These values are case insensitive.
+       “monthly� - specify repeating periods based on an interval of a
+       month or more; “yearly� - specify repeating periods based on an
+       interval of a year or more. These values are case-insensitive.
      * until - defines an iCalendar COS DATE or DATE-TIME value which
        bounds the recurrence rule in an inclusive manner. If the value
-       specified by "until" is synchronized with the specified recurrence,
+       specified by “until� is synchronized with the specified recurrence,
        this date or date-time becomes the last instance of the recurrence.
-       If not present, the recurrence is considered to repeat forever.
+       If it is not present, the recurrence is considered to repeat
+       forever.
      * interval - a positive integer representing how often the recurrence
-       rule repeats. The default value is "1", meaning every day for a
-       "daily" rule, every week for a "weekly" rule, every month for a
-       "monthly" rule and every year for a "yearly" rule.
+       rule repeats. The default value is “1�, meaning every day for a
+       “daily� rule, every week for a “weekly� rule, every month for a
+       “monthly� rule and every year for a “yearly� rule.
      * byday - a comma-separated list short codes of days of the week. The
-       days are specified as: "MO" for Monday; "TU" for Tuesday; "WE" for
-       Wednesday; "TH" for Thursday; "FR" for Friday; "SA" for Saturday;
-       "SU" for Sunday. These values are case insensitive.
-       Each "byday" value can also be prefixed by a positive (+n) or
+       days are specified as: “MO� for Monday; “TU� for Tuesday; “WE� for
+       Wednesday; “TH� for Thursday; “FR� for Friday; “SA� for Saturday;
+       “SU� for Sunday. These values are case insensitive.
+       Each “byday� value can also be prefixed by a positive (+n) or
        negative (-n) integer. If present, this indicates the n-th
-       occurrence of the specific day within the "monthly" or "yearly"
-       recurrence. For example, within a "monthly" rule, +1MO (or simply
+       occurrence of the specific day within the “monthly� or “yearly�
+       recurrence. For example, within a “monthly� rule, +1MO (or simply
        1MO) represents the first Monday within the month, whereas -1MO
        represents the last Monday of the month. If an integer modifier is
        not present, it means all days of this type within the specified
-       frequency. For example, within a "monthly" rule, MO represents all
+       frequency. For example, within a “monthly� rule, MO represents all
        Mondays within the month.
      * bymonthday - a comma-separated list of days of the month. Valid
        values are 1 to 31 or -31 to -1. For example, -10 represents the
@@ -168,43 +175,43 @@ modparam("tmrec", "separator", ";")
      * bymonth - parameter specifies a comma-separated list of months of
        the year. Valid values are 1 to 12.
 
-   A recurrence is specified by including the "frequency" parameter, which
-   indicates the type of recurrence rule. Parameters other than
-   "startdate" and "duration" SHOULD NOT be specified unless "frequency"
+   A recurrence is specified by including the “frequency� parameter, which
+   indicates the type of the recurrence rule. Parameters other than
+   “startdate� and “duration� SHOULD NOT be specified unless “frequency�
    is set.
 
-   If byxxx parameter values are found which are beyond the available
-   scope (ie, bymonthday="30" in February), they are simply ignored.
+   If invalid byxxx parameter values are found (ie, bymonthday=“30� in
+   February), they are simply ignored.
 
-   Byxxx parameters modify the recurrence rule matching. Byxxx rule, as
-   attribute for a period of time which is the same or greater than the
-   frequency, generally reduces or limits the number of occurrences for
-   the recurrence definition. For example, frequency="daily" bymonth="3"
-   reduces the number of recurrence instances from all days (if the
-   "bymonth" parameter is not present) to all days in March. Byxxx
+   Byxxx parameters modify the recurrence rule matching. The Byxxx rule,
+   as an attribute for a period of time which is greater than or equal to
+   the frequency, generally reduces or limits the number of occurrences
+   for the recurrence definition. For example, frequency=“daily�
+   bymonth=“3� reduces the number of recurrence instances from all days
+   (if the “bymonth� parameter is not present) to all days in March. Byxxx
    parameters for a period of time less than the frequency generally
    increases or expands the number of occurrences of the recurrence. For
-   example, frequency="yearly" bymonth="8,9" increases the number of days
-   within the yearly recurrence set from 1 (if "bymonth" parameter is not
+   example, frequency=“yearly� bymonth=“8,9� increases the number of days
+   within the yearly recurrence set from 1 (if “bymonth� parameter is not
    present) to 2.
 
    If multiple Byxxx parameters are specified, then after evaluating the
-   specified "frequency" and "interval" parameters, the Byxxx parameters
+   specified “frequency� and “interval� parameters, the Byxxx parameters
    are applied to the current set of evaluated occurrences in the
-   following order: "bymonth", "byweekno", "byyearday", "bymonthday",
-   "byday"; then "until" is evaluated.
+   following order: “bymonth�, “byweekno�, “byyearday�, “bymonthday�,
+   “byday�; then “until� is evaluated.
 
    Next is an example of evaluating multiple Byxxx parameters.
 
-   startdate="20100101T093000" duration="10H30M" frequency="yearly"
-   interval="4" bymonth="3" byday="SU"
+   startdate=“20100101T093000� duration=“10H30M� frequency=“yearly�
+   interval=“4� bymonth=“3� byday=“SU�
 
-   First, the interval="4" would be applied to frequency="yearly" to match
-   on "every 4th year" . Then, bymonth="1" would be applied to match on
-   "every March, every 4th year". Then, byday="SU" would be applied to
-   match on "every Sunday in March, every 4th year, from 9:30 to 20:00 ".
+   First, the interval=“4� would be applied to frequency=“yearly� to match
+   on “every 4th year� . Then, bymonth=“1� would be applied to match on
+   “every March, every 4th year�. Then, byday=“SU� would be applied to
+   match on “every Sunday in March, every 4th year, from 9:30 to 20:00 �.
    The start and end hours:minutes have been retrieved from the
-   "startdate" and "duration" parameters.
+   “startdate� and “duration� parameters.
 
    This function can be used in ANY_ROUTE.
 
@@ -216,10 +223,10 @@ modparam("tmrec", "separator", ";")
         xdbg("it is with working hours\n");
 ...
 
-4.2. is_leap_year([year])
+4.2.  is_leap_year([year])
 
    Return true if the value from parameter is a leap year. If the
-   parameter is missing, then the year from current time is taken.
+   parameter is missing, then the year from the current time is taken.
 
    The parameter can be pseudo-variable.
 

modules/tmrec/doc/tmrec.xml

@@ -23,6 +23,11 @@
 		<surname>Mierla</surname>
 		<email>[email protected]</email>
 	    </editor>
+	    <editor>
+		<firstname>Alex</firstname>
+		<surname>Balashov</surname>
+		<email>[email protected]</email>
+	    </editor>
 	</authorgroup>
 	<copyright>
 	    <year>2012</year>

modules/tmrec/doc/tmrec_admin.xml

@@ -16,9 +16,9 @@
 	<section>
 	<title>Overview</title>
 	<para>
-		This module provides time recurrence matching functions. Definitions
-		of recurrences are based on Internet Calendaring and Scheduling Core
-		Object Specification (Calendar COS - RFC 2445).
+		This module provides time recurrence matching functions. The format
+		of recurrence definitions is based on Internet Calendaring and 
+		Scheduling Core Object Specification (Calendar COS - RFC 2445).
 	</para>
 	</section>
 
@@ -57,7 +57,7 @@
 	<section>
 		<title><varname>separator</varname> (str)</title>
 		<para>
-			Separator character used to delimit the attributes in time
+			Separator character used to delimit attributes in time
 			reccurence definitions.
 		</para>
 		<para>
@@ -83,16 +83,17 @@ modparam("tmrec", "separator", ";")
 		<function moreinfo="none">tmrec_match(timerec [, timestamp])</function>
 	    </title>
 	    <para>
-			Match a time recurrence rules against the timestamp. If timestamp
-			parameter is missing, the value of current unix timestamp is used.
+			Match a time recurrence rule against the timestamp (UNIX epoch
+			format). If the timestamp parameter is missing, the current UNIX
+			epoch time is used.
 		</para>
 		<para>
 			The parameters can include pseudo-variables.
 		</para>
 		<para>
 			The timerec paramter is a list of attributes defined by RFC2445,
-			delimited by 'separator' (module parameter) character. The format
-			of timerec parameter, using '|' as separator, is (all in one line
+			delimited by the 'separator' (module parameter) character. The format
+			of timerec parameter, using '|' as the separator, is (all in one line
 			without white spaces):
 		</para>
 
@@ -105,8 +106,7 @@ modparam("tmrec", "separator", ";")
 
 		<para>
 		When an attribute is not specified, the corresponding place must be left
-		empty, whenever another attribute that follows in the list has to be
-		specified.
+		empty, provided that one or more additional attributes follow.
 		</para>
 		<para>
 		Description of time recurrence attributes:
@@ -124,7 +124,7 @@ modparam("tmrec", "separator", ";")
 			For a recurring interval, the <quote>duration</quote> parameter MUST
 			be small enough such that subsequent intervals do not overlap. 
 			For non-recurring intervals, durations of any positive length are 
-			permitted, zero-length duration means <quote>forever</quote>. 
+			permitted.  Zero-length duration means <quote>forever</quote>. 
 			Negative-length durations are not allowed.
 			</para>
 		</listitem>
@@ -137,7 +137,7 @@ modparam("tmrec", "separator", ";")
 			interval of a week or more; <quote>monthly</quote> - specify 
 			repeating periods based on an interval of a month or more; 
 			<quote>yearly</quote> - specify repeating periods based
-			on an interval of a year or more. These values are case insensitive.
+			on an interval of a year or more. These values are case-insensitive.
 			</para>
 		</listitem>
 		<listitem>
@@ -145,10 +145,9 @@ modparam("tmrec", "separator", ";")
 			<emphasis>until</emphasis> - defines an iCalendar COS DATE or DATE-TIME
 			value which bounds the recurrence rule in an inclusive manner. If the
 			value specified by <quote>until</quote> is synchronized with the 
-			specified 
-			recurrence, this date or date-time becomes the last instance of the 
-			recurrence. If not present, the recurrence is considered to repeat 
-			forever.
+			specified recurrence, this date or date-time becomes the last instance 
+			of the recurrence. If it is not present, the recurrence is considered 
+			to repeat forever.
 			</para>
 		</listitem>
 		<listitem>
@@ -215,19 +214,18 @@ modparam("tmrec", "separator", ";")
 		
 		<para>
 		A recurrence is specified by including the <quote>frequency</quote> 
-		parameter, which indicates the type of recurrence rule. Parameters 
+		parameter, which indicates the type of the recurrence rule. Parameters 
 		other than <quote>startdate</quote>
 		and <quote>duration</quote> SHOULD NOT be specified unless 
 		<quote>frequency</quote> is set.
 		</para>
 		<para>
-		If byxxx parameter values are found which are beyond the available 
-		scope (ie, bymonthday=<quote>30</quote> in February), they are simply
-		ignored. 
+		If invalid byxxx parameter values are found (ie, bymonthday=<quote>30</quote> in February), 
+		they are simply ignored. 
 		</para>
 		<para>
-		Byxxx parameters modify the recurrence rule matching. Byxxx rule, as
-		attribute for a period of time which is the same or greater than the 
+		Byxxx parameters modify the recurrence rule matching. The Byxxx rule, as
+		an attribute for a period of time which is greater than or equal to the 
 		frequency, generally reduces or limits the number of occurrences for the 
 		recurrence definition. For example, frequency=<quote>daily</quote> 
 		bymonth=<quote>3</quote> reduces the number of
@@ -289,7 +287,7 @@ modparam("tmrec", "separator", ";")
 	    </title>
 	    <para>
 			Return true if the value from parameter is a leap year. If the
-			parameter is missing, then the year from current time is taken.
+			parameter is missing, then the year from the current time is taken.
 		</para>
 		<para>
 		The parameter can be pseudo-variable.