| | 1 | = Macro Arguments = |
|---|
| | 2 | == General Information == |
|---|
| | 3 | |
|---|
| | 4 | The 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 | * Macro Argument Example: |
|---|
| | 7 | {{{ |
|---|
| | 8 | [[ProjectPlan(arg1,arg2,arg3)]] |
|---|
| | 9 | }}} |
|---|
| | 10 | 2. A Keyword/Value pair (short kw) must be seperated with '''=''': |
|---|
| | 11 | * Macro Keyword/Value (kw) Expample: |
|---|
| | 12 | {{{ |
|---|
| | 13 | [[ProjectPlan(key1=value,key2=anothervalue)]] |
|---|
| | 14 | }}} |
|---|
| | 15 | 3. It doesn't matter in which order kws/args are passed: |
|---|
| | 16 | * mixed |
|---|
| | 17 | {{{ |
|---|
| | 18 | [[ProjectPlan(arg1,key1=value,arg2,key2=anothervalue,arg3)]] |
|---|
| | 19 | }}} |
|---|
| | 20 | |
|---|
| | 21 | == Macro Arguments by Component == |
|---|
| | 22 | === General === |
|---|
| | 23 | |
|---|
| | 24 | ||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 | ||kw || renderer || Renderer ID || GVRenderer || use selected or default renderer || |
|---|
| | 28 | |
|---|
| | 29 | === Filter === |
|---|
| | 30 | |
|---|
| | 31 | ''not up to date'' |
|---|
| | 32 | |
|---|
| | 33 | ||kw/arg|| Keyword or Argument || Value || Description/Action || |
|---|
| | 34 | ||kw || filter_milestone || Milestone || || |
|---|
| | 35 | ||kw || filter_component || Component || || |
|---|
| | 36 | ||kw || filter_id || ID || || |
|---|
| | 37 | ||kw || filter_type || Type || || |
|---|
| | 38 | ||kw || filter_severity || Severity || || |
|---|
| | 39 | ||kw || filter_priority || Priority || || |
|---|
| | 40 | ||kw || filter_owner || Owner || || |
|---|
| | 41 | ||kw || filter_reporter || Reporter || || |
|---|
| | 42 | ||kw || filter_version || Version || || |
|---|
| | 43 | ||kw || filter_status || Status || || |
|---|
| | 44 | ||kw || filter_resolution || Resolution || || |
|---|
| | 45 | ||kw || filter_keywords (1) || Keyword || || |
|---|
| | 46 | ||arg || filter_owned || - |||| |
|---|
| | 47 | ||arg || filter_reported || - || || |
|---|
| | 48 | ||arg || notickets || - || || |
|---|
| | 49 | |
|---|
| | 50 | === Renderer === |
|---|
| | 51 | |
|---|
| | 52 | ''not up to date'' |
|---|
| | 53 | |
|---|
| | 54 | === Specific Renderer Arguments === |
|---|
| | 55 | |
|---|
| | 56 | ||Renderer||kw/arg||Keyword or Argument||Value||Description/Action|| |
|---|
| | 57 | ||gvrender|| arg || withbuffer || - || with critical path buffer|| |
|---|
| | 58 | ||gvhierarchical, gvrender|| arg || notickets || - || || |
|---|
| | 59 | ||gvhierarchical, gvrender|| arg || statuslegend || - || Legend for Status || |
|---|
| | 60 | ||gvhierarchical, gvrender|| arg || prioritylegend || - || Legend for Priority || |
|---|
| | 61 | ||report_* || kw || limitlines || number || maximum lines || |
|---|
| | 62 | |
|---|
| | 63 | ''not up to date'' |
|---|
| | 64 | |
|---|
