Version 1 から Version 2 における更新: WikiMacros

Timestamp:

Nov 29, 2010, 3:25:29 PM (13 years 前)

Author:

trac (IP: 127.0.0.1)

Comment:

--

WikiMacros

@@ -1 @@
-= Trac マクロ = #TracMacros
+= Trac Macros =
 
 [[PageOutline]]
 
-Trac マクロとは、 Python で書かれた 'カスタム関数' によって Trac の Wiki エンジンを拡張するプラグインです。 WikiFormatting エンジンが利用可能なあらゆるコンテキストにおいて、マクロを使用することによって、動的な HTML データが挿入されます。
+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.
 
-もう 1 種類のマクロは WikiProcessors です。これは通常、 Wiki 以外のマークアップ形式と表示を取り扱うために使用し、多くは、 (ソースコードハイライトのような) より大きいブロックに使用します。
+Another kind of macros are WikiProcessors. They typically deal with alternate markup formats and representation of larger blocks of information (like source code highlighting).
 
-== マクロの利用 == #UsingMacros
-マクロ呼び出しは、二つの ''角括弧 (square brackets) '' で括られた箇所です。 Python 関数のように、マクロは引数を取ることができ、括弧 (parenthesis) の中に、カンマで区切ったリストで表記します。
+== Using Macros ==
 
-Trac マクロは、 TracPlugins としても作成することができます。 TracPlugins として Trac マクロを作成することで「直接 HTTP リクエストにアクセスする。」といった通常の Trac マクロでは実現できない機能を実装することができます。
+Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses.
 
-=== 利用例 === #Example
+=== Getting Detailed Help ===
+The list of available macros and the full help can be obtained using the !MacroList macro, as seen [#AvailableMacros below].
 
-'Trac' で始まる Wiki ページの最近の変更履歴 3 件分を表示するマクロです:
+A brief list can be obtained via ![[MacroList(*)]] or ![[?]].
 
-{{{
- [[RecentChanges(Trac,3)]]
+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?]].
+
+
+
+=== Example ===
+
+A list of 3 most recently changed wiki pages starting with 'Trac':
+
+||= Wiki Markup =||= Display =||
+{{{#!td
+  {{{
+  [[RecentChanges(Trac,3)]]
+  }}}
+}}}
+{{{#!td style="padding-left: 2em;"
+[[RecentChanges(Trac,3)]]
+}}}
+|-----------------------------------
+{{{#!td
+  {{{
+  [[RecentChanges?(Trac,3)]]
+  }}}
+}}}
+{{{#!td style="padding-left: 2em;"
+[[RecentChanges?(Trac,3)]]
+}}}
+|-----------------------------------
+{{{#!td
+  {{{
+  [[?]]
+  }}}
+}}}
+{{{#!td style="padding-left: 2em; font-size: 80%"
+[[?]]
 }}}
 
-は、以下のように表示されます:
- [[RecentChanges(Trac,3)]]
+== Available Macros ==
 
-== マクロ一覧 == #AvailableMacros
-
-''Note: 以下に示すリストはマクロドキュメントを含むものだけです。 `-OO` による最適化や、 [wiki:TracModPython mod_python] での `PythonOptimize` オプションが設定されていると表示されません。''
+''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].''
 
 [[MacroList]]
 
-== 世界のマクロを共有 == #Macrosfromaroundtheworld
+== Macros from around the world ==
 
-[http://trac-hacks.org/ Trac Hacks] というサイトは、コミュニティに寄稿されたマクロと [TracPlugins プラグイン] を収集し提供しています。新しいマクロを探している、共有したいマクロを作成した、などの場合は遠慮なく Trac Hacks のサイトを訪問してください。
+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.
 
-== カスタムマクロを開発する == #DevelopingCustomMacros
-マクロは、 Trac 自身と同じように [http://www.python.org/ Python] で書かれています。
+== Developing Custom Macros ==
+Macros, like Trac itself, are written in the [http://python.org/ Python programming language] and are developed as part of TracPlugins.
 
-マクロの開発についての詳しい情報は [http://trac.edgewall.org/wiki/TracDev リソースの開発] を参照してください。
+For more information about developing macros, see the [trac:TracDev development resources] on the main project site.
 
 
-== マクロの実装 == #Implementation
+Here are 2 simple examples showing how to create a Macro with Trac 0.11. 
 
-[http://trac.edgewall.org/wiki/0.11 Trac 0.11] でマクロを作成する 2 つの単純な例を紹介します。古いマクロと新しいマクロの違いを示す例は [http://trac.edgewall.org/browser/trunk/sample-plugins/Timestamp.py Timestamp.py] を参照してください。また古いマクロから新しいマクロに移行するための情報は [http://trac.edgewall.org/browser/trunk/wiki-macros/README README] を参照してください。
+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.
 
-=== 引数なしのマクロ === #Macrowithoutarguments
-Trac は マクロ名としてモジュール名を使用するので以下は `TimeStamp.py` という名前で保存しなければなりません。
+=== Macro without arguments ===
+To test the following code, you should saved it in a `timestamp_sample.py` file located in the TracEnvironment's `plugins/` directory.
 {{{
 #!python
@@ -55 +84 @@
 from trac.wiki.macros import WikiMacroBase
 
-class TimestampMacro(WikiMacroBase):
+class TimeStampMacro(WikiMacroBase):
     """Inserts the current time (in seconds) into the wiki page."""
 
@@ -61 +90 @@
     url = "$URL$"
 
-    def expand_macro(self, formatter, name, args):
+    def expand_macro(self, formatter, name, text):
         t = datetime.now(utc)
         return tag.b(format_datetime(t, '%c'))
 }}}
 
-=== 引数付きのマクロ === #Macrowitharguments
-Trac は マクロ名としてモジュール名を使用するので以下は `HelloWorld.py` という名前で (plugins/ ディレクトリ内に ) 保存しなければなりません。
+=== Macro with arguments ===
+To test the following code, you should saved it in a `helloworld_sample.py` file located in the TracEnvironment's `plugins/` directory.
 {{{
 #!python
+from genshi.core import Markup
+
 from trac.wiki.macros import WikiMacroBase
 
@@ -87 +118 @@
     url = "$URL$"
 
-    def expand_macro(self, formatter, name, args):
+    def expand_macro(self, formatter, name, text, 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.
+        `text` 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`.
+          [[HelloWorld]]), then `text` is `None`.
+        `args` are the arguments passed when HelloWorld is called using a
+        `#!HelloWorld` code block.
         """
-        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.
+        return 'Hello World, text = %s, args = %s' % \
+            (Markup.escape(text), Markup.escape(repr(args)))
+
 }}}
 
+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'').
+
+For example, when writing:
 {{{
-#!div class=important
-訳注 '''重要''':
-
-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))
-}}}
+{{{#!HelloWorld style="polite"
+<Hello World!>
 }}}
 
-=== {{{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 してください。
+{{{#!HelloWorld
+<Hello World!>
+}}}
 
-マクロで HTML ではなく Wiki マークアップを使用したい場合、以下のように HTML に変換します:
+[[HelloWorld(<Hello World!>)]]
+}}}
+One should get:
+{{{
+Hello World, text = <Hello World!> , args = {'style': u'polite'}
+Hello World, text = <Hello World!> , args = {}
+Hello World, text = <Hello World!> , args = None
+}}}
+
+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`).  
+
+You can also recursively use a wiki Formatter (`from trac.wiki import Formatter`) to process the `text` as wiki markup, for example by doing:
 
 {{{
 #!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())
+    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())
 }}}