Changes between Version 1 and Version 2 of WikiMacros


Игнорировать:
Время:
30 авг. 2019 г., 9:23:00 (7 лет назад)
Автор:
trac
Комментарий:

--

Обозначения:

Без изменений
Добавлено
Удалено
Изменено

  • WikiMacros

    v1 v2  
    1 = Trac Macros =
     1= Trac Macros
    22
    3 [[PageOutline]]
     3[[PageOutline(2-5,Contents,pullout)]]
    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.
     5'''Trac macros''' extend Trac with custom functionality. Macros are a special type of plugin and are written in Python. A macro generates HTML in any context supporting WikiFormatting.
    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 macro syntax is `[[macro-name(optional-arguments)]]`.
    88
    9 == Using Macros ==
     9'''WikiProcessors''' are another kind of macro, commonly used for source code highlighting using a processor like `!#python` or `!#apache`:
    1010
    11 Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses.
     11{{{
     12{{{#!wiki-processor-name
     13...
     14}}}
     15}}}
    1216
    13 === Getting Detailed Help ===
    14 The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
     17== Using Macros
     18
     19Macro calls are enclosed in double-square brackets `[[..]]`. Like Python functions macros can have arguments, which take the form of a comma separated list within parentheses `[[..(,)]]`.
     20
     21=== Getting Detailed Help
     22
     23The list of available macros and the full help can be obtained using the !MacroList macro, see [#AvailableMacros below].
    1524
    1625A brief list can be obtained via `[[MacroList(*)]]` or `[[?]]`.
    1726
    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?]]`.
     27Detailed 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?]]`.
    1928
     29=== Example
    2030
    21 
    22 === Example ===
    23 
    24 A list of 3 most recently changed wiki pages starting with 'Trac':
     31A list of the 3 most recently changed wiki pages starting with 'Trac':
    2532
    2633||= Wiki Markup =||= Display =||
    … …  
    5057{{{#!td style="padding-left: 2em"
    5158{{{#!html
    52 <div style="font-size: 80%" class="trac-macrolist">
     59<div class="trac-macrolist">
    5360<h3><code>[[Image]]</code></h3>Embed an image in wiki-formatted text.
    5461
    55 The first argument is the file …
     62The first argument is the file, as in <code>[[Image(filename.png)]]</code>
    5663<h3><code>[[InterTrac]]</code></h3>Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.
    5764<h3><code>[[InterWiki]]</code></h3>Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.
    5865<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>
     66</div>
    6067}}}
    6168etc.
    6269}}}
    6370
    64 == Available Macros ==
    65 
    66 ''Note that the following list will only contain the macro documentation if you've not enabled `-OO` optimizations, or not set the `PythonOptimize` option for [wiki:TracModPython mod_python].''
     71== Available Macros
    6772
    6873[[MacroList]]
    6974
    70 == Macros from around the world ==
     75== Macros from around the world
    7176
    72 The [http://trac-hacks.org/ Trac Hacks] site provides a wide collection of macros and other Trac [TracPlugins plugins] contributed by the Trac community. If you're looking for new macros, or have written one that you'd like to share with the world, please don't hesitate to visit that site.
     77The [http://trac-hacks.org/ Trac Hacks] site provides a large collection of macros and other Trac [TracPlugins plugins] contributed by the Trac community. If you are looking for new macros, or have written one that you would like to share, please visit that site.
    7378
    74 == Developing Custom Macros ==
    75 Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
     79== Developing Custom Macros
    7680
    77 For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
     81Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are a type of [TracPlugins plugin].
     82
     83Here are 2 simple examples showing how to create a Macro. For more information about developing macros, see the [trac:TracDev development resources].
     84
     85=== Macro without arguments
     86
     87To test the following code, copy it to `timestamp_sample.py` in the TracEnvironment's `plugins/` directory.
     88
     89{{{#!python
     90from trac.util.datefmt import datetime_now, format_datetime, utc
     91from trac.util.html import tag
     92from trac.wiki.macros import WikiMacroBase
    7893
    7994
    80 Here are 2 simple examples showing how to create a Macro with Trac 0.11.
     95class TimestampMacro(WikiMacroBase):
     96    _description = "Inserts the current time (in seconds) into the wiki page."
    8197
    82 Also, have a look at [trac:source:tags/trac-0.11/sample-plugins/Timestamp.py Timestamp.py] for an example that shows the difference between old style and new style macros and at the [trac:source:tags/trac-0.11/wiki-macros/README macros/README] which provides a little more insight about the transition.
     98    def expand_macro(self, formatter, name, content, args=None):
     99        t = datetime_now(utc)
     100        return tag.strong(format_datetime(t, '%c'))
     101}}}
    83102
    84 === Macro without arguments ===
    85 To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
    86 {{{
    87 #!python
    88 from datetime import datetime
    89 # Note: since Trac 0.11, datetime objects are used internally
     103=== Macro with arguments
    90104
    91 from genshi.builder import tag
     105To test the following code, copy it to `helloworld_sample.py` in the TracEnvironment's `plugins/` directory.
    92106
    93 from trac.util.datefmt import format_datetime, utc
     107{{{#!python
     108from trac.util.translation import cleandoc_
    94109from trac.wiki.macros import WikiMacroBase
    95110
    96 class TimeStampMacro(WikiMacroBase):
    97     """Inserts the current time (in seconds) into the wiki page."""
    98 
    99     revision = "$Rev$"
    100     url = "$URL$"
    101 
    102     def expand_macro(self, formatter, name, text):
    103         t = datetime.now(utc)
    104         return tag.b(format_datetime(t, '%c'))
    105 }}}
    106 
    107 === Macro with arguments ===
    108 To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
    109 {{{
    110 #!python
    111 from genshi.core import Markup
    112 
    113 from trac.wiki.macros import WikiMacroBase
    114111
    115112class HelloWorldMacro(WikiMacroBase):
     113    _description = cleandoc_(
    116114    """Simple HelloWorld macro.
    117115
    … …  
    123121    will become the documentation of the macro, as shown by
    124122    the !MacroList macro (usually used in the WikiMacros page).
    125     """
     123    """)
    126124
    127     revision = "$Rev$"
    128     url = "$URL$"
    129 
    130     def expand_macro(self, formatter, name, text, args):
     125    def expand_macro(self, formatter, name, content, args=None):
    131126        """Return some output that will be displayed in the Wiki content.
    132127
    133128        `name` is the actual name of the macro (no surprise, here it'll be
    134129        `'HelloWorld'`),
    135         `text` is the text enclosed in parenthesis at the call of the macro.
    136           Note that if there are ''no'' parenthesis (like in, e.g.
    137           [[HelloWorld]]), then `text` is `None`.
    138         `args` are the arguments passed when HelloWorld is called using a
    139         `#!HelloWorld` code block.
     130        `content` is the text enclosed in parenthesis at the call of the
     131          macro. Note that if there are ''no'' parenthesis (like in, e.g.
     132          [[HelloWorld]]), then `content` is `None`.
     133        `args` will contain a dictionary of arguments when called using the
     134          Wiki processor syntax and will be `None` if called using the
     135          macro syntax.
    140136        """
    141         return 'Hello World, text = %s, args = %s' % \
    142             (Markup.escape(text), Markup.escape(repr(args)))
    143 
     137        return 'Hello World, content = ' + unicode(content)
    144138}}}
    145139
    146 Note that `expand_macro` optionally takes a 4^th^ parameter ''`args`''. When the macro is called as a [WikiProcessors WikiProcessor], it's also possible to pass `key=value` [WikiProcessors#UsingProcessors processor parameters]. If given, those are stored in a dictionary and passed in this extra `args` parameter. On the contrary, when called as a macro, `args` is  `None`. (''since 0.12'').
     140Note that `expand_macro` optionally takes a 4^th^ parameter ''`args`''. When the macro is called as a [WikiProcessors WikiProcessor], it is also possible to pass `key=value` [WikiProcessors#UsingProcessors processor parameters]. If given, those are stored in a dictionary and passed in this extra `args` parameter. When called as a macro, `args` is `None`.
    147141
    148142For example, when writing:
    … …  
    158152[[HelloWorld(<Hello World!>)]]
    159153}}}
     154
    160155One should get:
    161156{{{
    162 Hello World, text = <Hello World!> , args = {'style': u'polite', 'silent': False, 'verbose': True}
    163 Hello World, text = <Hello World!> , args = {}
    164 Hello World, text = <Hello World!> , args = None
     157Hello World, text = <Hello World!>, args = {'style': u'polite', 'silent': False, 'verbose': True}
     158Hello World, text = <Hello World!>, args = {}
     159Hello World, text = <Hello World!>, args = None
    165160}}}
    166161
    167 Note that the return value of `expand_macro` is '''not''' HTML escaped. Depending on the expected result, you should escape it by yourself (using `return Markup.escape(result)`) or, if this is indeed HTML, wrap it in a Markup object (`return Markup(result)`) with `Markup` coming from Genshi, (`from genshi.core import Markup`). 
     162Note that the return value of `expand_macro` is '''not''' HTML escaped. Depending on the expected result, you should escape it yourself (using `return Markup.escape(result)`), or if this is indeed HTML, wrap it in a Markup object: `return Markup(result)` (`from trac.util.html import Markup`).
    168163
    169 You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup, for example by doing:
     164You can also recursively use a wiki formatter to process the `content` as wiki markup:
    170165
    171 {{{
    172 #!python
    173 from genshi.core import Markup
     166{{{#!python
     167from trac.wiki.formatter import format_to_html
    174168from trac.wiki.macros import WikiMacroBase
    175 from trac.wiki import Formatter
    176 import StringIO
    177169
    178170class HelloWorldMacro(WikiMacroBase):
    179         def expand_macro(self, formatter, name, text, args):
    180                 text = "whatever '''wiki''' markup you want, even containing other macros"
    181                 # Convert Wiki markup to HTML, new style
    182                 out = StringIO.StringIO()
    183                 Formatter(self.env, formatter.context).format(text, out)
    184                 return Markup(out.getvalue())
     171    def expand_macro(self, formatter, name, content, args):
     172        content = "any '''wiki''' markup you want, even containing other macros"
     173        # Convert Wiki markup to HTML
     174        return format_to_html(self.env, formatter.context, content)
    185175}}}