WikiMacros のバージョン 1 とバージョン 2 との変更
- 日時:
- 2015/05/27 0:24:03 (11年前)
凡例:
- 変更なし
- 追加
- 削除
- 更新
-
WikiMacros
v1 v2 1 = Trac Macros =1 = Trac マクロ = #TracMacros 2 2 3 3 [[PageOutline]] 4 4 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 マクロとは、 Python で書かれた 'カスタム関数' によって Trac の Wiki エンジンを拡張するプラグインです。 WikiFormatting エンジンが利用可能なあらゆるコンテキストにおいて、マクロを使用することによって、動的な HTML データが挿入されます。 6 6 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). 7 もう 1 種類のマクロは WikiProcessors です。これは通常、 Wiki 以外のマークアップ形式と表示を取り扱うために使用し、多くは、 (ソースコードハイライトのような) より大きいブロックに使用します。 8 8 9 == Using Macros ==9 == マクロの利用 == #UsingMacros 10 10 11 Macro calls are enclosed in two ''square brackets''. Like Python functions, macros can also have arguments, a comma separated list within parentheses. 11 マクロ呼び出しは、二つの ''角括弧 (square brackets) '' で括られた箇所です。 Python 関数のように、マクロは引数を取ることができ、括弧 (parenthesis) の中に、カンマで区切ったリストで表記します。 12 12 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]. 13 === 詳細なヘルプを見るには === #GettingDetailedHelp 14 マクロの一覧と完全なヘルプは、 下記の[#AvailableMacros マクロ一覧] にある !MacroList マクロを使用してみることができます。 15 15 16 A brief list can be obtained via ![[MacroList(*)]] or ![[?]]. 16 簡単なマクロ一覧は `[[MacroList(*)]]` や `[[?]]` で見ることができます。 17 17 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?]]. 18 特定のマクロの詳細なヘルプを参照したい場合は、 !MacroList マクロに引数渡すことによって参照することができます。 例) `[[MacroList(MacroList)]]` 。もしくは、便宜上、 `[[MacroList?]]` のようにマクロ名にクエスチョンマーク ('?') をつけることでヘルプをみることができます。 19 19 20 20 21 21 22 === Example ===22 === 利用例 === #Example 23 23 24 A list of 3 most recently changed wiki pages starting with 'Trac':24 'Trac' で始まる Wiki ページの最近の変更履歴 3 件分を表示するマクロです: 25 25 26 ||= Wiki Markup =||= Display=||26 ||= Wiki マークアップ =||= 表示 =|| 27 27 {{{#!td 28 28 {{{ … … 49 49 }}} 50 50 {{{#!td style="padding-left: 2em" 51 {{{#!html 51 {{{#!html 52 52 <div style="font-size: 80%" class="trac-macrolist"> 53 <h3><code>[[Image]]</code></h3> Embed an image in wiki-formatted text.53 <h3><code>[[Image]]</code></h3>画像を Wiki 形式のテキストに組み込みます。 54 54 55 The first argument is the file…56 <h3><code>[[InterTrac]]</code></h3> Provide a list of known <a class="wiki" href="/wiki/InterTrac">InterTrac</a> prefixes.57 <h3><code>[[InterWiki]]</code></h3> Provide a description list for the known <a class="wiki" href="/wiki/InterWiki">InterWiki</a> prefixes.58 <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>55 1 番目の引数は、ファイル名を指定します。ファイルの指定は添付ファイルなど … 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> 60 60 }}} 61 61 etc. 62 62 }}} 63 63 64 == Available Macros ==64 == マクロ一覧 == #AvailableMacros 65 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].''66 ''Note: 以下に示すリストはマクロドキュメントを含むものだけです。 `-OO` による最適化や、 [wiki:TracModPython mod_python] での `PythonOptimize` オプションが設定されていると表示されません。'' 67 67 68 68 [[MacroList]] 69 69 70 == Macros from around the world ==70 == 世界のマクロを共有 == #Macrosfromaroundtheworld 71 71 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. 72 [http://trac-hacks.org/ Trac Hacks] というサイトは、コミュニティに寄稿されたマクロと [TracPlugins プラグイン] を収集し提供しています。新しいマクロを探している、共有したいマクロを作成した、などの場合は遠慮なく Trac Hacks のサイトを訪問してください。 73 73 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. 74 == カスタムマクロを開発する == #DevelopingCustomMacros 75 マクロは、 Trac 本体と同様 [http://python.org/ Python] で書かれています。そして TracPlugins の一種として開発します。 76 76 77 For more information about developing macros, see the [trac:TracDev development resources] on the main project site. 77 マクロの開発についての詳しい情報は [trac:TracDev リソースの開発] を参照してください。 78 78 79 79 80 Here are 2 simple examples showing how to create a Macro with Trac 0.11. 80 Trac 0.11 でマクロを作成する簡単な例を 2 つ紹介します。 81 81 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. 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 83 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. 84 === 引数なしのマクロ === #Macrowithoutarguments 85 下記のソースコードをテストするためには、このソースコードを `timestamp_sample.py` として保存し、 TracEnvironment の `plugins/` に配置しなければなりません。 86 86 {{{ 87 87 #!python … … 105 105 }}} 106 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. 107 === 引数付きのマクロ === #Macrowitharguments 108 下記のソースコードをテストするためには、このソースコードを `helloworld_sample.py` として保存し、 TracEnvironment の `plugins/` に配置しなければなりません。 109 109 {{{ 110 110 #!python … … 144 144 }}} 145 145 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'').146 Note: `expand_macro` は 第4パラメータに、 ''`args`'' を任意に取ることもできます。 このマクロが [WikiProcessors WikiProcessor] として呼ばれたとき、 `key=value` 形式の [WikiProcessors#UsingProcessors プロセッサパラメータ] を渡すことも可能です。もし、このパラメータを指定したとき、これらの値は、ディクショナリの中に保存され、 追加の `args` パラメータによって渡されます。一方で、マクロとして呼び出されたときは、 `args` パラメータは、 `None` として扱われます (''0.12 以降'') 。 147 147 148 For example, when writing:148 例として、このように記述した場合: 149 149 {{{ 150 {{{#!HelloWorld style="polite" 150 {{{#!HelloWorld style="polite" -silent verbose 151 151 <Hello World!> 152 152 }}} … … 158 158 [[HelloWorld(<Hello World!>)]] 159 159 }}} 160 One should get:160 結果はこのようになります: 161 161 {{{ 162 Hello World, text = <Hello World!> , args = {'style': u'polite' }162 Hello World, text = <Hello World!> , args = {'style': u'polite', 'silent': False, 'verbose': True} 163 163 Hello World, text = <Hello World!> , args = {} 164 164 Hello World, text = <Hello World!> , args = None 165 165 }}} 166 166 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`).167 Note: `expand_macro` が返す値は、 HTML がエスケープされて '''いない''' ことに注意して下さい。期待する戻り値によっては、あなた自身でエスケープする必要があります (`return Markup.escape(result)` を使用できます)。また、戻り値として HTML が返ってくると分かっているならば、結果を (`return Markup(result)`) という風に Genshi が提供している Markup (`from genshi.core import Markup`) オブジェクトでラップすることもできます。 168 168 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:169 また、`text` を Wiki としてマークアップする場合、 Wiki Formatter (`from trac.wiki import Formatter`) オブジェクトも再帰的に使用することができます。以下がサンプルです: 170 170 171 171 {{{
![(please configure the [header_logo] section in trac.ini)](/python/trac/mypz/chrome/common/trac_logo_mini.png)