Changes between Version 2 and Version 3 of WikiMacros

Timestamp:

2012/06/16 22:07:38 (12 years ago)

Author:

trac

Comment:

--

WikiMacros

@@ -8 +8 @@
 
 == マクロの利用 == #UsingMacros
+
 マクロ呼び出しは、二つの ''角括弧 (square brackets) '' で括られた箇所です。 Python 関数のように、マクロは引数を取ることができ、括弧 (parenthesis) の中に、カンマで区切ったリストで表記します。
 
-Trac マクロは、 TracPlugins としても作成することができます。 TracPlugins として Trac マクロを作成することで「直接 HTTP リクエストにアクセスする。」といった通常の Trac マクロでは実現できない機能を実装することができます。
+=== 詳細なヘルプを見るには ===#GettingDetailedHelp 
+マクロの一覧と完全なヘルプは、 下記の[#AvailableMacros マクロ一覧] にある !MacroList マクロを使用してみることができます。
+
+簡単なマクロ一覧は ![[MacroList(*)]] や ![[?]] で見ることができます。
+
+特定のマクロの詳細なヘルプを参照したい場合は、 !MacroList マクロに引数渡すことによって参照することができます。例) ![[MacroList(MacroList)]] 。もしくは、便宜上、 ![[MacroList?]] のようにマクロ名にクエスチョンマーク (?) をつけることでヘルプをみることができます。
+
+
 
 === 利用例 === #Example
@@ -16 +24 @@
 'Trac' で始まる Wiki ページの最近の変更履歴 3 件分を表示するマクロです:
 
-{{{
- [[RecentChanges(Trac,3)]]
+||= Wiki マークアップ =||= 表示 =||
+{{{#!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"
+{{{#!html 
+<div style="font-size: 80%" class="trac-macrolist">
+<h3><code>[[Image]]</code></h3>画像を Wiki 形式のテキストに組み込みます。
 
-は、以下のように表示されます:
- [[RecentChanges(Trac,3)]]
+1 番目の引数は、ファイル名を指定します。ファイルの指定は添付ファイルなど …
+<h3><code>[[InterTrac]]</code></h3>設定済みの <a class="wiki" href="/wiki/InterTrac">InterTrac</a> のプレフィックスを表示します。
+<h3><code>[[InterWiki]]</code></h3><a class="wiki" href="/wiki/InterWiki">InterWiki</a> のプレフィックスの概要を表示します。
+<h3><code>[[KnownMimeTypes]]</code></h3><a class="wiki" href="/wiki/WikiProcessors">WikiProcessors</a> で処理できる既知の mime-type を表示します。
+引数が与えられた場合は、 mime-type …</div>
+}}}
+etc.
+}}}
 
 == マクロ一覧 == #AvailableMacros
@@ -34 +73 @@
 
 == カスタムマクロを開発する == #DevelopingCustomMacros
-マクロは、 Trac 自身と同じように [http://www.python.org/ Python] で書かれています。
+マクロは、 Trac 本体と同様 [http://python.org/ Python] で書かれています。そして TracPlugins の一種として開発します
 
 マクロの開発についての詳しい情報は [http://trac.edgewall.org/wiki/TracDev リソースの開発] を参照してください。
 
-
-== マクロの実装 == #Implementation
 
 Trac 0.11 でマクロを作成する簡単な例を 2 つ紹介します。
@@ -46 +83 @@
 
 === 引数なしのマクロ === #Macrowithoutarguments
-Trac は マクロ名としてモジュール名を使用するので以下は `TimeStamp.py` という名前で保存しなければなりません。
+下記のソースコードをテストするためには、このソースコードを `timestamp_sample.py` として保存し、 TracEnvironment の `plugins/` に配置しなければなりません。
 {{{
 #!python
@@ -63 +100 @@
     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'))
@@ -69 +106 @@
 
 === 引数付きのマクロ === #Macrowitharguments
-Trac は マクロ名としてモジュール名を使用するので以下は `HelloWorld.py` という名前で (plugins/ ディレクトリ内に ) 保存しなければなりません。
+下記のソースコードをテストするためには、このソースコードを `helloworld_sample.py` として保存し、 TracEnvironment の `plugins/` に配置しなければなりません。
 {{{
 #!python
+from genshi.core import Markup
+
 from trac.wiki.macros import WikiMacroBase
 
@@ -89 +128 @@
     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: `expand_macro` は 第4パラメータに、 ''`args`'' を任意に取ることもできます。 このマクロが [WikiProcessors WikiProcessor] として呼ばれたとき、 `key=value` 形式の [WikiProcessors#UsingProcessors プロセッサパラメータ] を渡すことも可能です。もし、このパラメータを指定したとき、これらの値は、ディクショナリの中に保存され、 追加の `args` パラメータによって渡されます。一方で、マクロとして呼び出されたときは、 `args` パラメータは、 `None` として扱われます (''0.12 以降'') 。
+
+例として、このように記述した場合:
 {{{
-#!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!>)]]
+}}}
+結果はこのようになります:
+{{{
+Hello World, text = <Hello World!> , args = {'style': u'polite'}
+Hello World, text = <Hello World!> , args = {}
+Hello World, text = <Hello World!> , args = None
+}}}
+
+Note: `expand_macro` が返す値は、 HTML がエスケープされて '''いない''' ことに注意して下さい。期待する戻り値によっては、あなた自身でエスケープする必要があります (`return Markup.escape(result)` を使用できます)。また、戻り値として HTML が返ってくると分かっているならば、結果を (`return Markup(result)`) という風に Genshi が提供している Markup (`from genshi.core import Markup`) オブジェクトでラップすることもできます。
+
+また、`text` を Wiki としてマークアップする場合、 Wiki Formatter (`from trac.wiki import Formatter`) オブジェクトも再帰的に使用することができます。以下がサンプルです:
 
 {{{
 #!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())
+from genshi.core import Markup
+from trac.wiki.macros import WikiMacroBase
+from trac.wiki import Formatter
+import StringIO
+
+class HelloWorldMacro(WikiMacroBase):
+        def expand_macro(self, formatter, name, text, args):
+                text = "whatever '''wiki''' markup you want, even containing other macros"
+                # Convert Wiki markup to HTML, new style
+                out = StringIO.StringIO()
+                Formatter(self.env, formatter.context).format(text, out)
+                return Markup(out.getvalue())
 }}}