Context Navigation

Changes between Version 1 and Version 2 of WikiProcessors

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

Legend:

: Unmodified
: Added
: Removed
: Modified

WikiProcessors

-              v1
+              v2
+= Wiki プロセッサ =
+プロセッサは [TracWiki Trac Wiki エンジン] が、 Wiki 以外のフォーマットを提供するために設計された WikiMacros です。プロセッサは ''ユーザが編集したテキストを処理するマクロ機能'' と考えることができます。
+Trac 内の全ての Wiki テキストにおいて、 [wiki:WikiRestructuredText Restructured Text], [wiki:WikiHtml raw HTML] および [http://www.textism.com/tools/textile/ textile] をプロセッサとして使用することができます。
+== プロセッサを使用する ==
+テキストブロックでプロセッサを使うには、 Wiki のコードブロックを使用し、プロセッサの名前を (Unix 系 OS のスクリプトのように) ''shebang 行'' (#!) に続いて指定します。
+'''例1''' (''Wiki テキストに 生 HTML を挿入する''):
+= Wiki プロセッサ = #WikiProcessors
+プロセッサは [WikiMacros Wiki マクロ] の一種です。 [TracWiki Trac Wiki エンジン] 以外のマークアップフォーマットを使用するために設計されています。プロセッサは ''ユーザが編集したテキストを処理するマクロ機能'' と考えることができます。
+Trac 内の全ての Wiki テキストにおいて、 Wiki プロセッサを使用することができます。
+例えば、以下に述べる様々な用途で使用することができます:
+ - [#CodeHighlightingSupport シンタックスハイライト] またはテキストを逐語的にレンダリングする,
+ -  <div> ブロックや <span> や <td>, <th> のテーブルのセルの内容など
+   [#HTMLrelated コンテキスト内の Wiki のマークアップ]をレンダリングする,
+ - [wiki:WikiHtml HTML] や
+   [wiki:WikiRestructuredText Restructured テキスト]
+   または [http://www.textism.com/tools/textile/ textile] のシンタックスをマークアップの代替手段として使用する
+== プロセッサを使用する == #UsingProcessors
+テキストブロック上に Wiki プロセッサを適用するには、
+最初のデリミタとして Wiki の ''コードブロック'' を使用します:
+{{{
+{{{
+これらの行は
+処理されるでしょう...
+}}}
+}}}
+`{{{` のすぐ後または直後の行に,
+`#!` に続けて ''プロセッサ名'' を追加します。.
+{{{
+{{{
+#!プロセッサ名
+これらの行は
+処理されるでしょう...
+}}}
+}}}
+これはほとんどの UNIX ユーザにはおなじみである "shebang" を用いた表記法です。
+これらの内容に加えて、いくつかの Wiki プロセッサでは、
+プロセッサ名に続けて同じ行に、 `key=value` のペアを書くことによって、
+''パラメータ'' を許容するものがあります。もし、 `value` にスペースが含まれるケースがたびたび起こるようであれば、
+クオテーションで囲んだ文字列を使用することができます (`key="スペースが含まれている文字列"`) 。
+いくつかのプロセッサは Wiki のマークアップを処理することを意味するので、
+プロセッサのブロックを ''ネスト'' させることができます。
+可読性を向上させるためにネストしたブロックの内容をインデントさせたいと思うかもしれません。
+この種のインデントは中身を処理する際に無視されます。
+== 例 ==
+||= Wiki マークアップ =||= 表示 =||
+{{{#!td colspan=2 align=center style="border: none"
+                __例 1__: HTML を挿入する
+}}}
+|-----------------------------------------------------------------
+{{{#!td style="border: none"
+{{{
+{{{
+<h1 style="color: grey">HTML テスト</h1>
+}}}
+}}}
+}}}
+{{{#!td valign=top style="border: none; padding-left: 2em"
 {{{
 #!html
+<pre class="wiki">{{{
+#!html
+&lt;h1 style="color: orange"&gt;これは生 HTML です&lt;/h1&gt;
+}}}</pre>
+}}}
+'''結果、このように表示されます:'''
+{{{
+#!html
+<h1 style="color: orange">これは生 HTML です</h1>
+}}}
+----
+'''例2''' (''Wiki テキストに !ReStructured テキストを挿入する''):
+{{{
+#!html
+<pre class="wiki">{{{
+#!rst
+見出し
+------
+脚注 [*]_ 付きの **text** です。
+.. [*] ここは脚注。
+}}}</pre>
+}}}
+'''結果、このように表示されます:'''
+{{{
+#!rst
+見出し
+------
+脚注 [*]_ 付きの **text** です。
+.. [*] ここは脚注。
+}}}
+(訳注: !ReStructuredText は国際化が甘いので、使えないかもしれません)
+----
+'''例3''' (''Wiki テキストに C 言語ソースコードブロックを挿入する''):
+{{{
+#!html
+<pre class="wiki">{{{
+#!c
+int main(int argc, char *argv[])
+{
+  printf("Hello World\n");
+  return 0;
+}
+}}}</pre>
+}}}
+'''結果、このように表示されます:'''
+{{{
+#!c
+int main(int argc, char *argv[])
+{
+  printf("Hello World\n");
+  return 0;
+}
+}}}
+----
+== プロセッサ一覧 ==
+<h1 style="color: grey">HTML テスト</h1>
+}}}
+}}}
+|-----------------------------------------------------------------
+{{{#!td colspan=2 align=center style="border: none"
+     __例 2__: <div> ブロック内のカスタマイズしたスタイルシートでハイライトした Python のコード
+}}}
+|-----------------------------------------------------------------
+{{{#!td style="border: none"
+  {{{
+  {{{#!div style="background: #ffd; border: 3px ridge"
+  これは 埋め込まれた "コード" ブロックの例です:
+    {{{
+    #!python
+    def hello():
+        return "world"
+    }}}
+  }}}
+  }}}
+}}}
+{{{#!td valign=top style="border: none; padding: 1em"
+  {{{#!div style="background: #ffd; border: 3px ridge"
+  これは 埋め込まれた "コード" ブロックの例です:
+    {{{
+    #!python
+    def hello():
+        return "world"
+    }}}
+  }}}
+}}}
+|-----------------------------------------------------------------
+{{{#!td colspan=2 align=center style="border: none"
+     __例 3__: Wiki ページでチケットのキーワード検索を行なう
+}}}
+|-----------------------------------------------------------------
+{{{#!td style="border: none"
+  {{{
+  {{{
+  #!html
+  <form action="/query" method="get"><div>
+  <input type="text" name="keywords" value="~" size="30"/>
+  <input type="submit" value="キーワードで検索"/>
+  <!-- To control what fields show up use hidden fields
+  <input type="hidden" name="col" value="id"/>
+  <input type="hidden" name="col" value="summary"/>
+  <input type="hidden" name="col" value="status"/>
+  <input type="hidden" name="col" value="milestone"/>
+  <input type="hidden" name="col" value="version"/>
+  <input type="hidden" name="col" value="owner"/>
+  <input type="hidden" name="col" value="priority"/>
+  <input type="hidden" name="col" value="component"/>
+  -->
+  </div></form>
+  }}}
+  }}}
+}}}
+{{{#!td valign=top style="border: none; padding: 1em"
+  {{{
+  #!html
+  <form action="/query" method="get"><div>
+  <input type="text" name="keywords" value="~" size="30"/>
+  <input type="submit" value="キーワードで検索"/>
+  <!-- To control what fields show up use hidden fields
+  <input type="hidden" name="col" value="id"/>
+  <input type="hidden" name="col" value="summary"/>
+  <input type="hidden" name="col" value="status"/>
+  <input type="hidden" name="col" value="milestone"/>
+  <input type="hidden" name="col" value="version"/>
+  <input type="hidden" name="col" value="owner"/>
+  <input type="hidden" name="col" value="priority"/>
+  <input type="hidden" name="col" value="component"/>
+  -->
+  </div></form>
+  }}}
+}}}
+== プロセッサ一覧 == #AvailableProcessors
 以下のプロセッサが Trac の配布に含まれています:
+ * '''html''' -- Wiki ページにカスタム HTML を挿入する。 WikiHtml を参照してください。
+ * '''rst''' -- Restructured テキスト を Trac で利用可能にする。 WikiRestructuredText を参照してください。
+ * '''textile''' -- [http://dealmeida.net/projects/textile/ Textile] をインストールすれば利用可能です。 [http://hobix.com/textile/ a Textile reference] を参照。
+上記の Textile のリンクは切れています。 [http://www.textism.com/tools/textile/ このサイト] は動いていて、試しに使ってみることが可能です。
+=== ソースコードの強調表示対応 ===
+Trac では、以下のプログラミング言語でのインライン [wiki:TracSyntaxColoring シンタックスハイライト] を行うプロセッサが組み込まれています。
+ * '''c''' -- C
+ * '''cpp''' -- C++
+ * '''python''' -- Python
+ * '''perl''' -- Perl
+ * '''ruby''' -- Ruby
+ * '''php''' -- PHP
+ * '''asp''' --- ASP
+ * '''sql''' -- SQL
+ * '''xml''' -- XML
+'''Note:''' ''Trac はシンタックスの色付けを、外部のソフトウェアパッケージに依存しています。詳しくは TracSyntaxColoring をご覧下さい。''
+プロセッサとして mime-type が指定されると、ソースコードをブラウズするときと同じく、対応されている言語であれば、シンタックスハイライトを行うことができます。例えば、以下のように書くと:
+{{{
+ `#!default` :: フォーマット済みのテキストブロック内でテキストを逐語的に表示する。
+                これはプロセッサ名を指定 ''しない'' のと同じです。
+                (さらに `#!` を指定しないのと同じです)
+ `#!comment` :: このセクション内のテキストを処理しません(つまり、このセクションの内容は
+                プレインテキスト内にのみ存在します - レンダリングしたページには表示されません)。
+=== HTML 関連 === #HTMLrelated
+ `#!html`        :: Wiki ページにカスタムした HTML を挿入する。
+ `#!htmlcomment` :: Wiki ページに HTML のコメントを挿入する (''0.12 以降'') 。
+`#!html` ブロックは ''自己完結型'' でなければなりません。
+つまり、1つ目のブロックである HTML 要素を開始し、後に記述する2つ目のブロックでその要素を閉じるということはできません。これに類似した効果を得るためには、下記に述べるプロセッサを使用して下さい。
+  `#!div` :: <div> 要素内の任意の Wiki の内容をラップする
+             (''0.11 以降'').
+ `#!span` :: <span> 要素内の任意の Wiki の内容をラップする
+             (''0.11 以降'').
+ `#!td` :: <td> 要素内の任意の Wiki の内容をラップする (''0.12 以降'')
+ `#!th` :: <th> 要素内の任意の Wiki の内容をラップする (''0.12 以降'')
+ `#!tr` :: `#!td` や `#!th` ブロックをラッピングしたり、
+       グルーピングした列を見やすくするために属性を指定する際、オプションとして使用することができます。
+       (''0.12 以降'')
+これらのプロセッサについての詳細と使用例については、 WikiHtml を参照して下さい。
+=== その他のプロセッサ ===#OtherMarkups
+     `#!rst` :: Trac における Restructured テキストのサポート. WikiRestructuredText 参照。
+ `#!textile` :: [http://cheeseshop.python.org/pypi/textile Textile] がインストール
+                されている場合のサポート。
+                [http://www.textism.com/tools/textile/ a Textile リファレンス] 参照。
+=== コードのハイライトのサポート ===#CodeHighlightingSupport
+Trac はインラインのシンタックスハイライトを提供するプロセッサを同梱しています:
+ `#!c` (C), `#!cpp` (C++), `#!python` (Python), `#!perl` (Perl),
+ `#!ruby` (Ruby), `#!php` (PHP), `#!asp` (ASP), `#!java` (Java),
+ `#!js` (Javascript), `#!sql (SQL)`, `#!xml` (XML または HTML),
+ `#!sh` (!Bourne/Bash シェル), など。
+Trac では、シンタックスのカラーリングについて外部のソフトウェア
+例えば [http://pygments.org Pygments] に依存しています。
+TracSyntaxColoring にどの言語のシンタックスハイライトがサポートされているかについての情報と
+その他の言語のシンタックスハイライトのサポートを有効にする方法について書かれています。
+MIME タイプをプロセッサ名として使用することによって、ソースコードをブラウズするときに、サポートしている言語についてはシンタックスハイライトをすることが可能です。例えば、このように書くことができます:
+{{{
+{{{
+#!text/html
+<h1>テキスト</h1>
+}}}
+}}}
+この結果はシンタックスハイライトされた HTML コードになります:
 {{{
 #!text/html
 <h1>text</h1>
 }}}
+}}}
+この結果はシンタックスハイライトされた HTML コードになります。対応している全ての mime-type でも、これは同じく有効です。
+これは、対応しているすべての [TracSyntaxColoring#SyntaxColoringSupport 対応している MIME タイプ] に対して有効です。
 …
  * [http://trac.edgewall.org/wiki/ProcessorBazaar ProcessorBazaar]
  * [http://trac.edgewall.org/wiki/MacroBazaar MacroBazaar]
+== 上級トピック: プロセッサマクロを開発する ==
+プロセッサの開発は WikiMacros と違いはありません。事実、これらは同じような機能を持ち、シンタックスだけが異なります。詳しくは WikiMacros に記述します。
+'''例:''' (''Restructured テキストプロセッサ''):
+{{{
+#!python
+from docutils.core import publish_string
+def execute(hdf, text, env):
+    html = publish_string(text, writer_name = 'html')
+    return html[html.find('<body>')+6:html.find('</body>')].strip()
+}}}
+ * [http://trac-hacks.org/ Trac Hacks] コミュニティサイト
+プロセッサは Wiki マクロを開発するのと変わりはありません。
+実際、開発方法は同じであり、シンタックスの使用方法のみが異なります。
+詳細情報については、 [WikiMacros#DevelopingCustomMacros カスタムマクロを開発する] を参照して下さい。
 ----