Changes between Version 5 and Version 6 of WikiProcessors

Timestamp:

01/28/10 04:25:37 (8 months ago)

Author:

trac (IP: 127.0.0.1)

Comment:

--

WikiProcessors

@@ -1 @@
-= Wiki プロセッサ =
+= Wiki Processors =
 
-プロセッサは [TracWiki Trac Wiki エンジン] が、 Wiki 以外のフォーマットを提供するために設計された WikiMacros です。プロセッサは ''ユーザが編集したテキストを処理するマクロ機能'' と考えることができます。
+Processors are WikiMacros designed to provide alternative markup formats for the [TracWiki Wiki engine]. Processors can be thought of as ''macro functions to process user-edited text''. 
 
-Trac 内の全ての Wiki テキストにおいて、 [wiki:WikiRestructuredText Restructured Text], [wiki:WikiHtml raw HTML] および [http://www.textism.com/tools/textile/ textile] をプロセッサとして使用することができます。
+The Wiki engine uses processors to allow using [wiki:WikiRestructuredText Restructured Text], [wiki:WikiHtml raw HTML] and [http://www.textism.com/tools/textile/ textile] in any Wiki text throughout Trac.
 
-== プロセッサを使用する ==
 
-テキストブロックでプロセッサを使うには、 Wiki のコードブロックを使用し、プロセッサの名前を (Unix 系 OS のスクリプトのように) ''shebang 行'' (#!) に続いて指定します。
+== Using Processors ==
 
-'''例1''' (''Wiki テキストに 生 HTML を挿入する''):
+To use a processor on a block of text, use a Wiki code block, selecting a processor by name using ''shebang notation'' (#!), familiar to most UNIX users from scripts.
+
+'''Example 1''' (''inserting raw HTML in a wiki text''):
 
 {{{
@@ -15 +16 @@
 <pre class="wiki">{{{
 #!html
-&lt;h1 style="color: orange"&gt;これは生 HTML です&lt;/h1&gt;
+&lt;h1 style="color: orange"&gt;This is raw HTML&lt;/h1&gt;
 }}}</pre>
 }}}
 
-'''結果、このように表示されます:'''
+'''Results in:'''
 {{{
 #!html
-<h1 style="color: orange">これは生 HTML です</h1>
+<h1 style="color: orange">This is raw HTML</h1>
 }}}
+
+Note that since 0.11, such blocks of HTML have to be self-contained, i.e. you can't start an HTML element in one block and close it later in a second block. Use div or span processors for achieving similar effect (see WikiHtml).
 
 ----
 
-'''例2''' (''Wiki テキストに !ReStructured テキストを挿入する''):
+'''Example 2''' (''inserting Restructured Text in wiki text''):
 
 {{{
@@ -33 +36 @@
 <pre class="wiki">{{{
 #!rst
-見出し
-------
-脚注 [*]_ 付きの **text** です。
+A header
+--------
+This is some **text** with a footnote [*]_.
 
-.. [*] ここは脚注。
+.. [*] This is the footnote.
 }}}</pre>
 }}}
 
-'''結果、このように表示されます:'''
+'''Results in:'''
 {{{
 #!rst
-見出し
-------
-脚注 [*]_ 付きの **text** です。
+A header
+--------
+This is some **text** with a footnote [*]_.
 
-.. [*] ここは脚注。
+.. [*] This is the footnote.
 }}}
-(訳注: !ReStructuredText は国際化が甘いので、使えないかもしれません)
 ----
-'''例3''' (''Wiki テキストに C 言語ソースコードブロックを挿入する''):
+'''Example 3''' (''inserting a block of C source code in wiki text''):
 
 {{{
@@ -66 +68 @@
 }}}
 
-'''結果、このように表示されます:'''
+'''Results in:'''
 {{{
 #!c
@@ -78 +80 @@
 ----
 
-== プロセッサ一覧 ==
-以下のプロセッサが Trac の配布に含まれています:
- * '''html''' -- Wiki ページにカスタム HTML を挿入する。 WikiHtml を参照してください。
- * '''rst''' -- Restructured テキスト を Trac で利用可能にする。 WikiRestructuredText を参照してください。
- * '''textile''' -- [http://dealmeida.net/projects/textile/ Textile] をインストールすれば利用可能です。 [http://hobix.com/textile/ a Textile reference] を参照。
+== Available Processors ==
+The following processors are included in the Trac distribution:
+ * '''html''' -- Insert custom HTML in a wiki page. See WikiHtml.
+ * '''div''' -- Wrap an arbitrary Wiki content in a <div> element (''since 0.11''). See WikiHtml.
+ * '''span''' -- Wrap an arbitrary Wiki content in a <span> element (''since 0.11''). See also WikiHtml.
+ * '''rst''' -- Trac support for Restructured Text. See WikiRestructuredText.
+ * '''textile''' -- Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference].
+ * '''comment''' -- Do not process the text in this section (i.e. contents exist only in the plain text - not in the rendered page).
 
-上記の Textile のリンクは切れています。 [http://www.textism.com/tools/textile/ このサイト] は動いていて、試しに使ってみることが可能です。
-
-=== ソースコードの強調表示対応 ===
-Trac では、以下のプログラミング言語でのインライン [wiki:TracSyntaxColoring シンタックスハイライト] を行うプロセッサが組み込まれています。
+=== Code Highlighting Support ===
+Trac includes processors to provide inline [wiki:TracSyntaxColoring syntax highlighting] for the following languages:
  * '''c''' -- C
  * '''cpp''' -- C++
@@ -94 +97 @@
  * '''ruby''' -- Ruby
  * '''php''' -- PHP
- * '''asp''' --- ASP
+ * '''asp''' -- ASP
+ * '''java''' -- Java
+ * '''js''' -- Javascript
  * '''sql''' -- SQL
  * '''xml''' -- XML
-'''Note:''' ''Trac はシンタックスの色付けを、外部のソフトウェアパッケージに依存しています。詳しくは TracSyntaxColoring をご覧下さい。''
+ * '''sh''' -- Bourne/Bash shell
 
-プロセッサとして mime-type が指定されると、ソースコードをブラウズするときと同じく、対応されている言語であれば、シンタックスハイライトを行うことができます。例えば、以下のように書くと:
+'''Note:''' ''Trac relies on external software packages for syntax coloring. See TracSyntaxColoring for more info.''
+
+By using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code. For example, you can write:
 {{{
 {{{
@@ -107 +114 @@
 }}}
 
-この結果はシンタックスハイライトされた HTML コードになります。対応している全ての mime-type でも、これは同じく有効です。
+The result will be syntax highlighted HTML code:
+{{{
+#!text/html
+<h1>text</h1>
+}}}
+
+The same is valid for all other mime types supported.
 
 
-ユーザによるプロセッサマクロの開発やコントリビュート:
- * [http://trac.edgewall.org/wiki/ProcessorBazaar ProcessorBazaar]
- * [http://trac.edgewall.org/wiki/MacroBazaar MacroBazaar]
+For more processor macros developed and/or contributed by users, visit: 
+ * [trac:ProcessorBazaar]
+ * [trac:MacroBazaar]
+ * [th:WikiStart Trac Hacks] community site
 
 
-== 上級トピック: プロセッサマクロを開発する ==
-プロセッサの開発は WikiMacros と違いはありません。事実、これらは同じような機能を持ち、シンタックスだけが異なります。詳しくは WikiMacros に記述します。
+== Advanced Topics: Developing Processor Macros ==
+Developing processors is no different from Wiki macros. In fact they work the same way, only the usage syntax differs. See WikiMacros for more information.
 
-'''例:''' (''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()
-}}}
 
 ----