Changes between Version 3 and Version 4 of WikiMacros


Ignore:
Timestamp:
Oct 6, 2013 10:56:46 AM (6 months ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiMacros

    v3 v4  
    33[[PageOutline]] 
    44 
    5 Trac macros are plugins to extend the Trac engine with custom 'functions' written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting. 
     5Trac macros are plugins to extend the Trac engine with custom 'functions' written in Python. A macro inserts dynamic HTML data in any context supporting WikiFormatting. Its syntax is `[[macro-name(optional-arguments)]]`. 
    66 
    7 Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting). 
     7The WikiProcessors are another kind of macros. They typically deal with alternate markup formats and transformation of larger "blocks" of information (like source code highlighting). They are used for processing the multiline `{{{#!wiki-processor-name ... }}}` blocks. 
    88 
    99== Using Macros == 
     
    1414The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below]. 
    1515 
    16 A brief list can be obtained via ![[MacroList(*)]] or ![[?]]. 
     16A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`. 
    1717 
    18 Detailed help on a specific macro can be obtained by passing it as an argument to !MacroList, e.g. ![[MacroList(MacroList)]], or, more conveniently, by appending a question mark (?) to the macro's name, like in ![[MacroList?]]. 
     18Detailed help on a specific macro can be obtained by passing it as an argument to !MacroList, e.g. `[[MacroList(MacroList)]]`, or, more conveniently, by appending a question mark (`?`) to the macro's name, like in `[[MacroList?]]`. 
    1919 
    2020 
     
    5353<h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text. 
    5454 
    55 The first argument is the file … 
     55The first argument is the file  
    5656<h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes. 
    5757<h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes. 
    5858<h3><code>[[KnownMimeTypes]]</code></h3>List all known mime-types which can be used as <a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a>. 
    59 Can be …</div> 
     59Can be </div> 
    6060}}} 
    6161etc. 
     
    148148For example, when writing: 
    149149{{{ 
    150 {{{#!HelloWorld style="polite" 
     150{{{#!HelloWorld style="polite" -silent verbose 
    151151<Hello World!> 
    152152}}} 
     
    160160One should get: 
    161161{{{ 
    162 Hello World, text = <Hello World!> , args = {'style': u'polite'} 
     162Hello World, text = <Hello World!> , args = {'style': u'polite', 'silent': False, 'verbose': True} 
    163163Hello World, text = <Hello World!> , args = {} 
    164164Hello World, text = <Hello World!> , args = None