Changes between Version 1 and Version 2 of WikiMacros

Timestamp:

2009/10/03 12:40:44 (17 years ago)

Author:

trac

Comment:

--

WikiMacros

@@ -1 @@
-=  Wiki マクロ =
-Wiki マクロとは、 Python で書かれた 'カスタム関数' によって Trac の Wiki エンジンを拡張するプラグインです。 WikiFormatting エンジンが利用可能なあらゆるコンテキストにおいて、マクロを使用することによって、動的な HTML データが挿入されます。
+= Trac マクロ = #TracMacros
 
-もう 1 種類のマクロは WikiProcessors です。これは通常、Wiki以外のマークアップ形式と表示を取り扱うために使用し、多くは、 (ソースコードハイライトのような) より大きいブロックに使用します。
+[[PageOutline]]
 
-== マクロの利用 ==
+Trac マクロとは、 Python で書かれた 'カスタム関数' によって Trac の Wiki エンジンを拡張するプラグインです。 WikiFormatting エンジンが利用可能なあらゆるコンテキストにおいて、マクロを使用することによって、動的な HTML データが挿入されます。
+
+もう 1 種類のマクロは WikiProcessors です。これは通常、 Wiki 以外のマークアップ形式と表示を取り扱うために使用し、多くは、 (ソースコードハイライトのような) より大きいブロックに使用します。
+
+== マクロの利用 == #UsingMacros
 マクロ呼び出しは、二つの ''角括弧 (square brackets) '' で括られた箇所です。 Python 関数のように、マクロは引数を取ることができ、括弧 (parenthesis) の中に、カンマで区切ったリストで表記します。
 
-=== 利用例 ===
+Trac マクロは、 TracPlugins としても作成することができます。 TracPlugins として Trac マクロを作成することで「直接 HTTP リクエストにアクセスする。」といった通常の Trac マクロでは実現できない機能を実装することができます。
+
+=== 利用例 === #Example
+
+'Trac' で始まる Wiki ページの最近の変更履歴 3 件分を表示するマクロです:
 
 {{{
- [[Timestamp]]
+ [[RecentChanges(Trac,3)]]
 }}}
+
 は、以下のように表示されます:
- [[Timestamp]]
+ [[RecentChanges(Trac,3)]]
 
-{{{
- [[HelloWorld(Testing)]]
-}}}
-は、以下のように表示されます:
- [[HelloWorld(Testing)]]
-
-== マクロ一覧 ==
+== マクロ一覧 == #AvailableMacros
 
 ''Note: 以下に示すリストはマクロドキュメントを含むものだけです。 `-OO` による最適化や、 [wiki:TracModPython mod_python] での `PythonOptimize` オプションが設定されていると表示されません。''
@@ -27 +29 @@
 [[MacroList]]
 
-== Macros from around the world ==
+== 世界のマクロを共有 == #Macrosfromaroundtheworld
 
-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.
+[http://trac-hacks.org/ Trac Hacks] というサイトは、コミュニティに寄稿されたマクロと [TracPlugins プラグイン] を収集し提供しています。新しいマクロを探している、共有したいマクロを作成した、などの場合は遠慮なく Trac Hacks のサイトを訪問してください。
 
-== カスタムマクロを開発する ==
-マクロは、 Trac 自身と同じように [http://www.python.org/ Python programming language] で書かれています。とてもシンプルなモジュールで、たった一つの `execute()` 関数だけを持ちます。マクロの識別はファイル名で行います。 Trac は、呼び出されたマクロが返却したデータをマクロが呼び出された Wiki ページの HTML に挿入して表示を行います。
+== カスタムマクロを開発する == #DevelopingCustomMacros
+マクロは、 Trac 自身と同じように [http://www.python.org/ Python] で書かれています。
 
-最も簡単なマクロの例です:
+マクロの開発についての詳しい情報は [http://trac.edgewall.org/wiki/TracDev リソースの開発] を参照してください。
+
+
+== マクロの実装 == #Implementation
+
+Trac 0.11 でマクロを作成する簡単な例を 2 つ紹介します。
+
+古いマクロと新しいマクロの違いを示す例は [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] を参照してください。
+
+=== 引数なしのマクロ === #Macrowithoutarguments
+Trac は マクロ名としてモジュール名を使用するので以下は `TimeStamp.py` という名前で保存しなければなりません。
 {{{
 #!python
-# MyMacro.py -- The world's simplest macro
+from datetime import datetime
+# Note: since Trac 0.11, datetime objects are used internally
 
-def execute(hdf, args, env):
-    return "Hello World called with args: %s" % args
+from genshi.builder import tag
+
+from trac.util.datefmt import format_datetime, utc
+from trac.wiki.macros import WikiMacroBase
+
+class TimeStampMacro(WikiMacroBase):
+    """Inserts the current time (in seconds) into the wiki page."""
+
+    revision = "$Rev$"
+    url = "$URL$"
+
+    def expand_macro(self, formatter, name, args):
+        t = datetime.now(utc)
+        return tag.b(format_datetime(t, '%c'))
 }}}
 
-Environment (`env`) オブジェクトを使用することも出来ます。この例では、コンフィグレーションとデータベースにアクセスしています:
+=== 引数付きのマクロ === #Macrowitharguments
+Trac は マクロ名としてモジュール名を使用するので以下は `HelloWorld.py` という名前で (plugins/ ディレクトリ内に ) 保存しなければなりません。
 {{{
 #!python
-def execute(hdf, txt, env):
-    return env.config.get('trac', 'repository_dir')
+from trac.wiki.macros import WikiMacroBase
+
+class HelloWorldMacro(WikiMacroBase):
+    """Simple HelloWorld macro.
+
+    Note that the name of the class is meaningful:
+     - it must end with "Macro"
+     - what comes before "Macro" ends up being the macro name
+
+    The documentation of the class (i.e. what you're reading)
+    will become the documentation of the macro, as shown by
+    the !MacroList macro (usually used in the WikiMacros page).
+    """
+
+    revision = "$Rev$"
+    url = "$URL$"
+
+    def expand_macro(self, formatter, name, args):
+        """Return some output that will be displayed in the Wiki content.
+
+        `name` is the actual name of the macro (no surprise, here it'll be
+        `'HelloWorld'`),
+        `args` is the text enclosed in parenthesis at the call of the macro.
+          Note that if there are ''no'' parenthesis (like in, e.g.
+          [[HelloWorld]]), then `args` is `None`.
+        """
+        return 'Hello World, args = ' + unicode(args)
+    
+    # Note that there's no need to HTML escape the returned data,
+    # as the template engine (Genshi) will do it for us.
 }}}
 
-Note: バージョン 0.9 以降、 Wiki マクロは TracPlugins でも書くことが出来るようになりました。これによって、 HTTP request へのダイレクトアクセスなど、 "古い" マクロでは実現できなかったことが出来るようになりました。
+{{{
+#!div class=important
+訳注 '''重要''':
 
-マクロ開発についての詳しい情報は、プロジェクトメインサイトの [http://trac.edgewall.org/wiki/TracDev 開発リソース] を参照してください。
+Wiki マクロが引数を持つ場合、引数は必ずサニタイズしてください。
+expand_macro の戻り値は `<script>` タグやイベントハンドラなどもそのまま出力するので、入力をチェックせずに、そのまま戻り値に使用するのは極めて危険です。
+Genshi の tag オブジェクトにラップすれば、エスケープ機構が働きますので、通常はこれを使うとよいでしょう。
+`HelloWorld.py` は、以下の通り書き直すことができます:
+{{{
+#!python
+from trac.wiki.macros import WikiMacroBase
+from genshi.builder import tag
+class HelloWorldMacro(WikiMacroBase):
+    def expand_macro(self, formatter, name, args):
+        return tag.div(u'Hello World, args = ', unicode(args))
+}}}
+}}}
 
-----
-See also:  WikiProcessors, WikiFormatting, TracGuide
+=== {{{expand_macro}}} について === #expand_macrodetails
+{{{expand_macro}}} は HTML として解釈できる単純な文字列か Markup オブジェクト ({{{from trac.util.html import Markup}}} を使用する ) のどちらかを返さなければなりません。 {{{Markup(string)}}} はそのまま `string` を解釈するので、 HTML 文字列はエスケープされずに、そのとおり表示されます。 Wiki フォーマッタを使用した場合は {{{from trac.wiki import Formatter}}} のように import してください。
+
+マクロで HTML ではなく Wiki マークアップを使用したい場合、以下のように HTML に変換します:
+
+{{{
+#!python
+  text = "whatever wiki markup you want, even containing other macros"
+  # Convert Wiki markup to HTML, new style
+  out = StringIO()
+  Formatter(self.env, formatter.context).format(text, out)
+  return Markup(out.getvalue())
+}}}