Changes between Version 12 and Version 13 of IcalViewPlugin


Ignore:
Timestamp:
May 1, 2015, 8:54:05 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, tagged with license

Legend:

Unmodified
Added
Removed
Modified

  • IcalViewPlugin

    v12 v13  
    1 = iCalendar plugin for ticket queries =
     1[[PageOutline(2-5,Contents,pullout)]]
    22
    3 == Description ==
     3= iCalendar plugin for ticket queries
    44
    5 Provide iCalendar feeds for ticket queries as standard [http://trac.edgewall.org/roadmap roadmap module]. It use 2 optional custom fields for event date and duration.
     5== Description
    66
    7 == Usage ==
     7This plugin provides iCalendar feeds for ticket queries as standard [http://trac.edgewall.org/roadmap roadmap module]. It uses 2 optional custom fields for event date and duration.
    88
    9 Zero configuration needed to start using the module. Without start date and duration, tickets can use the due date of associated milestone. To plan tickets the date and duration fields must be set in trac.ini
     9== Bugs/Feature Requests
    1010
    11 === Setup custom fields for date and duration ===
     11Existing bugs and feature requests for IcalViewPlugin are
     12[query:status!=closed&component=IcalViewPlugin&order=priority here].
    1213
    13 To transform a ticket to an event, we need at least a date. Trac only provide a creation date or an update date. So we need a planned date by adding a custom field, and set this new field as the dtstart field for events in (see [http://tools.ietf.org/html/rfc2445 RFC/2445]).
     14If you have any issues, create a
     15[/newticket?component=IcalViewPlugin&owner=xpech new ticket].
    1416
    15 trac.ini
    16 {{{
     17[[TicketQuery(component=IcalViewPlugin&group=type,format=progress)]]
     18
     19== Download and Source
     20
     21Download the [download:icalviewplugin zipped source], check out IcalViewPlugin [/svn/icalviewplugin using Subversion], or [source:icalviewplugin browse the source] with Trac.
     22
     23== Usage
     24
     25Zero configuration needed to start using the module. Without start date and duration, tickets can use the due date of associated milestone. To plan tickets the date and duration fields must be set in your `trac.ini` file.
     26
     27=== Setup custom fields for date and duration
     28
     29To transform a ticket to an event, we need at least one date. Trac only provides a creation date or an update date. So we need a planned date by adding a custom field, and set this new field as the dtstart field for events in (see [http://tools.ietf.org/html/rfc2445 RFC/2445]).
     30
     31Sample `trac.ini` file:
     32
     33{{{#!ini
    1734[ticket-custom]
    1835my_custom_dtstart_field = text
    … …  
    2340}}}
    2441
    25 We also need a duration fields :
    26 {{{
     42We also need a duration field:
     43{{{#!ini
    2744[ticket-custom]
    2845...
    … …  
    3451}}}
    3552
     53=== Date and duration input format
    3654
    37 === Date and duration input format ===
     55Default input date format are:
     56 * "'%m/%d/%Y" (month/day/year) for strict date.
     57 * "%m/%d/%Y %H:%M" for date and time.
    3858
    39 Default input date format are : "'%m/%d/%Y"  (month/day/year) for strict date and and "%m/%d/%Y %H:%M" for date and time.
     59To customize this format, use the "short_date_format" and "date_time_format" configuration options:
    4060
    41 To customize this format, use the "short_date_format" and "date_time_format" configuration options :
    42 
    43 {{{
     61{{{#!ini
    4462[icalendar]
    4563short_date_format = %d/%m/%Y
    … …  
    4765}}}
    4866
    49 to support multiple format, use a ';' to separate them:
     67To support multiple formats, use a ';' to separate them:
    5068
    51 {{{
     69{{{#!ini
    5270[icalendar]
    5371short_date_format = %d/%m/%Y;%Y-%m-%d
    … …  
    5573}}}
    5674
     75Duration field supports the following syntaxes:
     76 * Standard hours:minutes format: H:MM, examples: "8:45", "12:30".
     77 * A number of days ending by a 'd', example: 15d.
     78 * Standard [http://tools.ietf.org/html/rfc2445#section-4.3.6 RFC/2445] duration beginning  with a "P": "P1W" "P1D".
    5779
    58 Duration fied support 4 syntaxes :
    59  * Standard hours:minutes format : H:MM ( "8:45" "12:30" ...)
    60  * a number of days ending by a 'd' : 15d
    61  * the standard [http://tools.ietf.org/html/rfc2445#section-4.3.6 RFC/2445] duration begining  with a "P" : "P1W" "P1D" ...
     80Some tips:
     81 * Tickets with a planned date and no duration are planned as a day event.
     82 * Tickets without a planned date are transformed as TODO. For tickets attached to a milestone, the due date of the milestone is used as TODO due date (since 0.2).
    6283
    63 Some tips  :
    64  * Tickets with a planned date and no duration are planned as a day event
    65  * Tickets without a planned date are transfomed as TODO. For tickets attached to a milestone, the due date of the milestone is used as TODO due date (since 0.2).
     84=== Priority
    6685
    67 === Priority ===
    68 
    69 icalandar support the priority tags but use an integer from 1 (highest) to 9 (lowest). So we need a map to transform trac priorities to integer. The plugin integrate a default mapping :
     86iCalendar supports the priority tags, but uses an integer from 1 (highest) to 9 (lowest). So we need a map to transform Trac priorities to integer. The plugin integrate a default mapping :
    7087
    7188{{{
    … …  
    7996You can customise the mapping and adding other values with the configuration option 'custom_priority_map':
    8097
    81 {{{
     98{{{#!ini
    8299[icalendar]
    83100custom_priority_map = major:3;lessmajor:4;lessmajorbutnotminor:5;crazy:1;undefined:0
    84101}}}
    85102
    86 
    87 == Limitations ==
     103== Limitations
    88104
    89105The calendar is read only.
    90106
    91 == Bugs/Feature Requests ==
    92 
    93 Existing bugs and feature requests for IcalViewPlugin are
    94 [query:status!=closed&component=IcalViewPlugin&order=priority here].
    95 
    96 If you have any issues, create a
    97 [/newticket?component=IcalViewPlugin&owner=xpech new ticket].
    98 
    99 == Download and Source ==
    100 
    101 Download the [download:icalviewplugin zipped source], check out IcalViewPlugin [/svn/icalviewplugin using Subversion], or [source:icalviewplugin browse the source] with Trac.
    102 
    103 == Example ==
     107== Example
    104108
    105109Add a iCalendar links in ticket's queries footer.
    106110
    107 == Release note ==
     111== Release notes
    108112
    109 === 0.4 ===
    110  * adding description of tickets (#6323  thanks to clown for the patch). We do not  yet filter Wiki tags from description, I hope fix it in a future release.
    111 Resolve some problems :
     113=== 0.4
     114 * Adding description of tickets (#6323 thanks to clown for the patch). We do not yet filter Wiki tags from description, I hope to fix it in a future release.
     115Resolve some problems:
    112116 * Fix #6325 : charset bug which can stop installation (thanks to clown for the patch)
    113117 * Fix #6322 : bug with user defined priority (thanks to clown for the patch)
    114118
    115 === 0.3 ===
    116  * Better support for timezone
     119=== 0.3
     120 * Better support for timezone.
    117121
    118 === 0.2 ===
    119  * adding support for milestone due date for tickets without not planned.
     122=== 0.2
     123 * Adding support for milestone due date for tickets without not planned.
    120124
    121 === 0.1 ===
    122  * initial release
     125=== 0.1
     126 * Initial release
    123127
    124 == Recent Changes ==
     128== Recent Changes
    125129
    126130[[ChangeLog(icalviewplugin, 3)]]
    127131
    128 == Author/Contributors ==
     132== Author/Contributors
    129133
    130134'''Author:''' [wiki:xpech] [[BR]]
     135'''Maintainer:''' [[Maintainer]] [[BR]]
    131136'''Contributors:'''