Changes between Version 1 and Version 2 of ProjectPlanPlugin/MacroArgs


Ignore:
Timestamp:
Aug 30, 2017, 9:29:20 AM (7 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • ProjectPlanPlugin/MacroArgs

    v1 v2  
    1 = Macro Arguments =
    2 == General Information ==
     1= Macro Arguments
     2
     3== General Information
    34
    45The following examples show how Trac Macro Arguments are passed in general.
    5  1. Multiple Arguments (short arg) must be seperated with the following delimiter ''',''':
     6 1. Multiple Arguments (short arg) must be separated with the following delimiter ''',''':
    67  * Macro Argument Example:
    78{{{
    8 [[ProjectPlan(arg1,arg2,arg3)]]
     9[[ProjectPlan(arg1, arg2, arg3)]]
    910}}}
    1011 2. A Keyword/Value pair (short kw) must be seperated with '''=''':
    1112  * Macro Keyword/Value (kw) Expample:
    1213{{{
    13 [[ProjectPlan(key1=value,key2=anothervalue)]]
     14[[ProjectPlan(key1=value, key2=anothervalue)]]
    1415}}}
    1516 3. It doesn't matter in which order kws/args are passed:
    1617  * mixed
    1718{{{
    18 [[ProjectPlan(arg1,key1=value,arg2,key2=anothervalue,arg3)]]
     19[[ProjectPlan(arg1, key1=value, arg2, key2=anothervalue, arg3)]]
    1920}}}
    2021
    21 == Macro Arguments by Component ==
    22 === General ===
     22== Macro Arguments by Component
     23
     24=== General
    2325
    2426||kw/arg||Keyword or Argument||Value||Default||Description/Action||
    25 ||arg   || notickets || - || - || no tickets are queried or shown ( depends on renderer [#SpecificRendererArguments *] ) ||
    26 ||kw    || macroid   || string or integer || 1 || ProjectPlanPlugin uses this ID as instance Identifier, allowing multiple macros per page with separate control. ,,example: 2 macro instances on one page: ID1 and ID2, both handling referer/url coded arguments like <url>?id=ID1&dosomething=something and <url>?id=ID2&dosomething=nothing, passing different macro ids does allow detection which macro issued the current requested link,, ''currently not handled this way'' ||
     27||arg   || notickets || - || - || no tickets are queried or shown and depends on renderer [#SpecificRendererArguments *] ||
     28||kw    || macroid   || string or integer || 1 || ProjectPlanPlugin uses this ID as instance Identifier, allowing multiple macros per page with separate control. Example: 2 macro instances on one page: ID1 and ID2, both handling referer/url coded arguments like <url>?id=ID1&dosomething=something and <url>?id=ID2&dosomething=nothing, passing different macro ids does allow detection which macro issued the current requested link. ''Currently not handled this way'' ||
    2729||kw    || renderer  || Renderer ID || GVRenderer || use selected or default renderer ||
    2830
    29 === Filter ===
     31=== Filter
    3032
    3133''not up to date''
     
    4850||arg   || notickets || - ||  ||
    4951
    50 === Renderer ===
     52=== Renderer
    5153
    5254''not up to date''
    5355
    54 === Specific Renderer Arguments ===
     56=== Specific Renderer Arguments
    5557
    5658||Renderer||kw/arg||Keyword or Argument||Value||Description/Action||
     
    6264
    6365''not up to date''
    64