Changes between Version 1 and Version 2 of WikiMacros


Ignore:
Timestamp:
May 13, 2012, 9:15:45 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiMacros

    v1 v2  
    1 =  Wiki マクロ =
    2 Wiki マクロとは、 Python で書かれた 'カスタム関数' によって Trac の Wiki エンジンを拡張するプラグインです。 WikiFormatting エンジンが利用可能なあらゆるコンテキストにおいて、マクロを使用することによって、動的な HTML データが挿入されます。
     1= Trac マクロ = #TracMacros
    32
    4 もう 1 種類のマクロは WikiProcessors です。これは通常、Wiki以外のマークアップ形式と表示を取り扱うために使用し、多くは、 (ソースコードハイライトのような) より大きいブロックに使用します。
     3[[PageOutline]]
    54
    6 == マクロの利用 ==
     5Trac マクロとは、 Python で書かれた 'カスタム関数' によって Trac の Wiki エンジンを拡張するプラグインです。 WikiFormatting エンジンが利用可能なあらゆるコンテキストにおいて、マクロを使用することによって、動的な HTML データが挿入されます。
     6
     7もう 1 種類のマクロは WikiProcessors です。これは通常、 Wiki 以外のマークアップ形式と表示を取り扱うために使用し、多くは、 (ソースコードハイライトのような) より大きいブロックに使用します。
     8
     9== マクロの利用 == #UsingMacros
     10
    711マクロ呼び出しは、二つの ''角括弧 (square brackets) '' で括られた箇所です。 Python 関数のように、マクロは引数を取ることができ、括弧 (parenthesis) の中に、カンマで区切ったリストで表記します。
    812
    9 === 利用例 ===
     13=== 詳細なヘルプを見るには ===#GettingDetailedHelp
     14マクロの一覧と完全なヘルプは、 下記の[#AvailableMacros マクロ一覧] にある !MacroList マクロを使用してみることができます。
    1015
    11 {{{
    12  [[Timestamp]]
     16簡単なマクロ一覧は ![[MacroList(*)]] や ![[?]] で見ることができます。
     17
     18特定のマクロの詳細なヘルプを参照したい場合は、 !MacroList マクロに引数渡すことによって参照することができます。例) ![[MacroList(MacroList)]] 。もしくは、便宜上、 ![[MacroList?]] のようにマクロ名にクエスチョンマーク (?) をつけることでヘルプをみることができます。
     19
     20
     21
     22=== 利用例 === #Example
     23
     24'Trac' で始まる Wiki ページの最近の変更履歴 3 件分を表示するマクロです:
     25
     26||= Wiki マークアップ =||= 表示 =||
     27{{{#!td
     28  {{{
     29  [[RecentChanges(Trac,3)]]
     30  }}}
    1331}}}
    14 は、以下のように表示されます:
    15  [[Timestamp]]
     32{{{#!td style="padding-left: 2em;"
     33[[RecentChanges(Trac,3)]]
     34}}}
     35|-----------------------------------
     36{{{#!td
     37  {{{
     38  [[RecentChanges?(Trac,3)]]
     39  }}}
     40}}}
     41{{{#!td style="padding-left: 2em;"
     42[[RecentChanges?(Trac,3)]]
     43}}}
     44|-----------------------------------
     45{{{#!td
     46  {{{
     47  [[?]]
     48  }}}
     49}}}
     50{{{#!td style="padding-left: 2em"
     51{{{#!html
     52<div style="font-size: 80%" class="trac-macrolist">
     53<h3><code>[[Image]]</code></h3>画像を Wiki 形式のテキストに組み込みます。
    1654
    17 {{{
    18  [[HelloWorld(Testing)]]
     551 番目の引数は、ファイル名を指定します。ファイルの指定は添付ファイルなど …
     56<h3><code>[[InterTrac]]</code></h3>設定済みの <a class="wiki" href="/wiki/InterTrac">InterTrac</a> のプレフィックスを表示します。
     57<h3><code>[[InterWiki]]</code></h3><a class="wiki" href="/wiki/InterWiki">InterWiki</a> のプレフィックスの概要を表示します。
     58<h3><code>[[KnownMimeTypes]]</code></h3><a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a> で処理できる既知の mime-type を表示します。
     59引数が与えられた場合は、 mime-type …</div>
    1960}}}
    20 は、以下のように表示されます:
    21  [[HelloWorld(Testing)]]
     61etc.
     62}}}
    2263
    23 == マクロ一覧 ==
     64== マクロ一覧 == #AvailableMacros
    2465
    2566''Note: 以下に示すリストはマクロドキュメントを含むものだけです。 `-OO` による最適化や、 [wiki:TracModPython mod_python] での `PythonOptimize` オプションが設定されていると表示されません。''
    … …  
    2768[[MacroList]]
    2869
    29 == Macros from around the world ==
     70== 世界のマクロを共有 == #Macrosfromaroundtheworld
    3071
    31 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.
     72[http://trac-hacks.org/ Trac Hacks] というサイトは、コミュニティに寄稿されたマクロと [TracPlugins プラグイン] を収集し提供しています。新しいマクロを探している、共有したいマクロを作成した、などの場合は遠慮なく Trac Hacks のサイトを訪問してください。
    3273
    33 == カスタムマクロを開発する ==
    34 マクロは、 Trac 自身と同じように [http://www.python.org/ Python programming language] で書かれています。とてもシンプルなモジュールで、たった一つの `execute()` 関数だけを持ちます。マクロの識別はファイル名で行います。 Trac は、呼び出されたマクロが返却したデータをマクロが呼び出された Wiki ページの HTML に挿入して表示を行います。
     74== カスタムマクロを開発する == #DevelopingCustomMacros
     75マクロは、 Trac 本体と同様 [http://python.org/ Python] で書かれています。そして TracPlugins の一種として開発します
    3576
    36 最も簡単なマクロの例です:
     77マクロの開発についての詳しい情報は [http://trac.edgewall.org/wiki/TracDev リソースの開発] を参照してください。
     78
     79
     80Trac 0.11 でマクロを作成する簡単な例を 2 つ紹介します。
     81
     82古いマクロと新しいマクロの違いを示す例は [http://trac.edgewall.org/browser/tags/trac-0.11/sample-plugins/Timestamp.py Timestamp.py] を参照してください。また、古いマクロから新しいマクロに移行するための情報は [http://trac.edgewall.org/browser/tags/trac-0.11/wiki-macros/README macros/README] を参照してください。
     83
     84=== 引数なしのマクロ === #Macrowithoutarguments
     85下記のソースコードをテストするためには、このソースコードを `timestamp_sample.py` として保存し、 TracEnvironment の `plugins/` に配置しなければなりません。
    3786{{{
    3887#!python
    39 # MyMacro.py -- The world's simplest macro
     88from datetime import datetime
     89# Note: since Trac 0.11, datetime objects are used internally
    4090
    41 def execute(hdf, args, env):
    42     return "Hello World called with args: %s" % args
     91from genshi.builder import tag
     92
     93from trac.util.datefmt import format_datetime, utc
     94from trac.wiki.macros import WikiMacroBase
     95
     96class 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'))
    43105}}}
    44106
    45 Environment (`env`) オブジェクトを使用することも出来ます。この例では、コンフィグレーションとデータベースにアクセスしています:
     107=== 引数付きのマクロ === #Macrowitharguments
     108下記のソースコードをテストするためには、このソースコードを `helloworld_sample.py` として保存し、 TracEnvironment の `plugins/` に配置しなければなりません。
    46109{{{
    47110#!python
    48 def execute(hdf, txt, env):
    49     return env.config.get('trac', 'repository_dir')
     111from genshi.core import Markup
     112
     113from trac.wiki.macros import WikiMacroBase
     114
     115class HelloWorldMacro(WikiMacroBase):
     116    """Simple HelloWorld macro.
     117
     118    Note that the name of the class is meaningful:
     119     - it must end with "Macro"
     120     - what comes before "Macro" ends up being the macro name
     121
     122    The documentation of the class (i.e. what you're reading)
     123    will become the documentation of the macro, as shown by
     124    the !MacroList macro (usually used in the WikiMacros page).
     125    """
     126
     127    revision = "$Rev$"
     128    url = "$URL$"
     129
     130    def expand_macro(self, formatter, name, text, args):
     131        """Return some output that will be displayed in the Wiki content.
     132
     133        `name` is the actual name of the macro (no surprise, here it'll be
     134        `'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.
     140        """
     141        return 'Hello World, text = %s, args = %s' % \
     142            (Markup.escape(text), Markup.escape(repr(args)))
     143
    50144}}}
    51145
    52 Note: バージョン 0.9 以降、 Wiki マクロは TracPlugins でも書くことが出来るようになりました。これによって、 HTTP request へのダイレクトアクセスなど、 "古い" マクロでは実現できなかったことが出来るようになりました。
     146Note: `expand_macro` は 第4パラメータに、 ''`args`'' を任意に取ることもできます。 このマクロが [WikiProcessors WikiProcessor] として呼ばれたとき、 `key=value` 形式の [WikiProcessors#UsingProcessors プロセッサパラメータ] を渡すことも可能です。もし、このパラメータを指定したとき、これらの値は、ディクショナリの中に保存され、 追加の `args` パラメータによって渡されます。一方で、マクロとして呼び出されたときは、 `args` パラメータは、 `None` として扱われます (''0.12 以降'') 。
    53147
    54 マクロ開発についての詳しい情報は、プロジェクトメインサイトの [http://trac.edgewall.org/wiki/TracDev 開発リソース] を参照してください。
     148例として、このように記述した場合:
     149{{{
     150{{{#!HelloWorld style="polite"
     151<Hello World!>
     152}}}
    55153
    56 ----
    57 See also:  WikiProcessors, WikiFormatting, TracGuide
     154{{{#!HelloWorld
     155<Hello World!>
     156}}}
     157
     158[[HelloWorld(<Hello World!>)]]
     159}}}
     160結果はこのようになります:
     161{{{
     162Hello World, text = <Hello World!> , args = {'style': u'polite'}
     163Hello World, text = <Hello World!> , args = {}
     164Hello World, text = <Hello World!> , args = None
     165}}}
     166
     167Note: `expand_macro` が返す値は、 HTML がエスケープされて '''いない''' ことに注意して下さい。期待する戻り値によっては、あなた自身でエスケープする必要があります (`return Markup.escape(result)` を使用できます)。また、戻り値として HTML が返ってくると分かっているならば、結果を (`return Markup(result)`) という風に Genshi が提供している Markup (`from genshi.core import Markup`) オブジェクトでラップすることもできます。
     168
     169また、`text` を Wiki としてマークアップする場合、 Wiki Formatter (`from trac.wiki import Formatter`) オブジェクトも再帰的に使用することができます。以下がサンプルです:
     170
     171{{{
     172#!python
     173from genshi.core import Markup
     174from trac.wiki.macros import WikiMacroBase
     175from trac.wiki import Formatter
     176import StringIO
     177
     178class 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())
     185}}}