WikiProcessors のバージョン 1 とバージョン 2 との変更


以下の違いを無視:
日時:
2015/05/27 0:24:03 (11年前)
更新者:
trac
コメント:

--

凡例:

変更なし
追加
削除
更新

  • WikiProcessors

    v1 v2  
    1 = Wiki Processors =
    2 
    3 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''.
    4 
    5 Wiki processors can be used in any Wiki text throughout Trac,
    6 for various different purposes, like:
    7  - [#CodeHighlightingSupport syntax highlighting] or for rendering text verbatim,
    8  - rendering [#HTMLrelated Wiki markup inside a context],
    9    like inside <div> blocks or <span> or within <td> or <th> table cells,
    10  - using an alternative markup syntax, like [wiki:WikiHtml raw HTML] and
    11    [wiki:WikiRestructuredText Restructured Text],
    12    or [http://www.textism.com/tools/textile/ textile]
    13 
    14 
    15 == Using Processors ==
    16 
    17 To use a processor on a block of text, first delimit the lines using
    18 a Wiki ''code block'':
    19 {{{
    20 {{{
    21 The lines
    22 that should be processed...
    23 }}}
    24 }}}
    25 
    26 Immediately after the `{{{` or on the line just below,
    27 add `#!` followed by the ''processor name''.
    28 
    29 {{{
    30 {{{
    31 #!processorname
    32 The lines
    33 that should be processed...
    34 }}}
    35 }}}
    36 
    37 This is the "shebang" notation, familiar to most UNIX users.
    38 
    39 Besides their content, some Wiki processors can also accept ''parameters'',
    40 which are then given as `key=value` pairs after the processor name,
    41 on the same line. If `value` has to contain space, as it's often the case for
    42 the style parameter, a quoted string can be used (`key="value with space"`).
    43 
    44 As some processors are meant to process Wiki markup, it's quite possible to
    45 ''nest'' processor blocks.
    46 You may want to indent the content of nested blocks for increased clarity,
    47 this extra indentation will be ignored when processing the content.
    48 
    49 
    50 == Examples ==
    51 
    52 ||= Wiki Markup =||= Display =||
     1= Wiki プロセッサ = #WikiProcessors
     2
     3プロセッサは [WikiMacros Wiki マクロ] の一種です。 [TracWiki Trac Wiki エンジン] 以外のマークアップフォーマットを使用するために設計されています。プロセッサは ''ユーザが編集したテキストを処理するマクロ機能'' と考えることができます。
     4
     5Trac 内の全ての Wiki テキストにおいて、 Wiki プロセッサを使用することができます。
     6例えば、以下に述べる様々な用途で使用することができます:
     7 - [#CodeHighlightingSupport シンタックスハイライト] またはテキストを逐語的にレンダリングする
     8 -  <div> ブロックや <span> や <td>, <th> のテーブルのセルの内容など
     9   [#HTMLrelated コンテキスト内の Wiki のマークアップ] をレンダリングする
     10 - [wiki:WikiHtml HTML] や
     11   [wiki:WikiRestructuredText Restructured テキスト]
     12   または [http://www.textism.com/tools/textile/ textile] のシンタックスをマークアップの代替手段として使用する
     13
     14
     15== プロセッサを使用する == #UsingProcessors
     16
     17テキストブロック上に Wiki プロセッサを適用するには、
     18最初のデリミタとして Wiki の ''コードブロック'' を使用します:
     19{{{
     20{{{
     21これらの行は
     22処理されるでしょう...
     23}}}
     24}}}
     25
     26`{{{` のすぐ後または直後の行に,
     27`#!` に続けて ''プロセッサ名'' を追加します。
     28
     29{{{
     30{{{
     31#!プロセッサ名
     32これらの行は
     33処理されるでしょう...
     34}}}
     35}}}
     36
     37これはほとんどの UNIX ユーザにはおなじみである "shebang" を用いた表記法です。
     38
     39これらの内容に加えて、いくつかの Wiki プロセッサでは、
     40プロセッサ名に続けて同じ行に、 `key=value` のペアを書くことによって、
     41''パラメータ'' を許容するものがあります。もし、 `value` にスペースが含まれるケースがたびたび起こるようであれば、
     42クオテーションで囲んだ文字列を使用することができます (`key="スペースが含まれている文字列"`) 。
     43
     44いくつかのプロセッサは Wiki のマークアップを処理することを意味するので、
     45プロセッサのブロックを ''ネスト'' させることができます。
     46可読性を向上させるためにネストしたブロックの内容をインデントさせたいと思うかもしれません。
     47この種のインデントは中身を処理する際に無視されます。
     48
     49
     50== 例 ==
     51
     52||= Wiki マークアップ =||= 表示 =||
    5353{{{#!td colspan=2 align=center style="border: none"
    5454
    55                 __Example 1__: Inserting raw HTML
     55                __例 1__: HTML を挿入する
    5656}}}
    5757|-----------------------------------------------------------------
    … …  
    6060{{{
    6161#!html
    62 <h1 style="color: grey">This is raw HTML</h1>
     62<h1 style="color: grey">HTML テスト</h1>
    6363}}}
    6464}}}
    … …  
    6767{{{
    6868#!html
    69 <h1 style="color: grey">This is raw HTML</h1>
     69<h1 style="color: grey">HTML テスト</h1>
    7070}}}
    7171}}}
    … …  
    7373{{{#!td colspan=2 align=center style="border: none"
    7474
    75      __Example 2__: Highlighted Python code in a <div> block with custom style
     75     __例 2__: <div> ブロック内のカスタマイズしたスタイルシートでハイライトした Python のコード
    7676}}}
    7777|-----------------------------------------------------------------
    … …  
    8080  {{{#!div style="background: #ffd; border: 3px ridge"
    8181
    82   This is an example of embedded "code" block:
     82  これは 埋め込まれた "コード" ブロックの例です:
    8383
    8484    {{{
    … …  
    9494  {{{#!div style="background: #ffd; border: 3px ridge"
    9595
    96   This is an example of embedded "code" block:
     96  これは 埋め込まれた "コード" ブロックの例です:
    9797
    9898    {{{
    … …  
    107107{{{#!td colspan=2 align=center style="border: none"
    108108
    109      __Example 3__: Searching tickets from a wiki page, by keywords.
     109     __例 3__: Wiki ページでチケットのキーワード検索を行なう
    110110}}}
    111111|-----------------------------------------------------------------
    … …  
    116116  <form action="/query" method="get"><div>
    117117  <input type="text" name="keywords" value="~" size="30"/>
    118   <input type="submit" value="Search by Keywords"/>
     118  <input type="submit" value="キーワードで検索"/>
    119119  <!-- To control what fields show up use hidden fields
    120120  <input type="hidden" name="col" value="id"/>
    … …  
    136136  <form action="/query" method="get"><div>
    137137  <input type="text" name="keywords" value="~" size="30"/>
    138   <input type="submit" value="Search by Keywords"/>
     138  <input type="submit" value="キーワードで検索"/>
    139139  <!-- To control what fields show up use hidden fields
    140140  <input type="hidden" name="col" value="id"/>
    … …  
    150150  }}}
    151151}}}
    152 == Available Processors ==
    153 
    154 The following processors are included in the Trac distribution:
    155 
    156 || '''`#!default`''' || Present the text verbatim in a preformatted text block. This is the same as specifying ''no'' processor name (and no `#!`) ||
    157 || '''`#!comment`''' || Do not process the text in this section (i.e. contents exist only in the plain text - not in the rendered page). ||
    158 |||| ||
    159 ||||= '''HTML related''' =||
    160 || '''`#!html`''' || Insert custom HTML in a wiki page. ||
    161 || '''`#!htmlcomment`''' || Insert an HTML comment in a wiki page (''since 0.12''). ||
    162 || || Note that `#!html` blocks 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 the following processors for achieving a similar effect.  ||
    163 || '''`#!div`''' || Wrap an arbitrary Wiki content inside a <div> element (''since 0.11''). ||
    164 || '''`#!span`''' || Wrap an arbitrary Wiki content inside a <span> element (''since 0.11''). ||
    165 || '''`#!td`''' || Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'') ||
    166 || '''`#!th`''' || Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'') ||
    167 || '''`#!tr`''' || Can optionally be used for wrapping `#!td` and `#!th` blocks, either for specifying row attributes of better visual grouping (''since 0.12'') ||
    168 || || See WikiHtml for example usage and more details about these processors. ||
    169 |||| ||
    170 ||||= '''Other Markups''' =||
    171 || '''`#!rst`''' || Trac support for Restructured Text. See WikiRestructuredText. ||
    172 || '''`#!textile`''' || Supported if [http://cheeseshop.python.org/pypi/textile Textile] is installed. See [http://www.textism.com/tools/textile/ a Textile reference]. ||
    173 |||| ||
    174 ||||= '''Code Highlighting Support''' =||
    175 || '''`#!c`''' [[BR]] '''`#!cpp`''' (C++) [[BR]] '''`#!python`''' [[BR]] '''`#!perl`''' [[BR]] '''`#!ruby`''' [[BR]] '''`#!php`''' [[BR]] '''`#!asp`''' [[BR]] '''`#!java`''' [[BR]] '''`#!js`''' (Javascript) [[BR]] '''`#!sql`''' [[BR]] '''`#!xml`''' (XML or HTML) [[BR]] '''`#!sh`''' (!Bourne/Bash shell) [[BR]] '''etc.''' [[BR]] || Trac includes processors to provide inline syntax highlighting for source code in various languages. [[BR]] [[BR]] Trac relies on external software packages for syntax coloring, like [http://pygments.org Pygments]. [[BR]] [[BR]] See TracSyntaxColoring for information about which languages are supported and how to enable support for more languages. ||
    176 |||| ||
    177 ||||= '''MIME Type Processors''' =||
    178 |||| Using the MIME type as processor, it is possible to syntax-highlight the same languages that are supported when browsing source code. ||
     152== プロセッサ一覧 == #AvailableProcessors
     153
     154以下のプロセッサが Trac の配布に含まれています:
     155
     156|| '''`#!default`''' || フォーマット済みのテキストブロック内でテキストを逐語的に表示する。これはプロセッサ名を指定 ''しない'' のと同じです (さらに `#!` を指定しないのと同じです)。 ||
     157|| '''`#!comment`''' || このセクション内のテキストを処理しません (つまり、このセクションの内容はプレインテキスト内にのみ存在します - レンダリングしたページには表示されません)。 ||
     158|||| ||
     159||||= '''HTML 関連''' =||
     160|| '''`#!html`''' || Wiki ページにカスタムした HTML を挿入する。 ||
     161|| '''`#!htmlcomment`''' || Wiki ページに HTML のコメントを挿入する (''0.12 以降'') 。 ||
     162|| || `#!html` ブロックは ''自己完結型'' でなければなりません。つまり、1つ目のブロックである HTML 要素を開始し、後に記述する2つ目のブロックでその要素を閉じるということはできません。これに類似した効果を得るためには、下記に述べるプロセッサを使用して下さい。  ||
     163|| '''`#!div`''' || <div> 要素内の任意の Wiki の内容をラップする (''0.11 以降'') 。 ||
     164|| '''`#!span`''' || <span> 要素内の任意の Wiki の内容をラップする (''0.11 以降'') 。 ||
     165|| '''`#!td`''' || <td> 要素内の任意の Wiki の内容をラップする (''0.12 以降'') 。 ||
     166|| '''`#!th`''' || <th> 要素内の任意の Wiki の内容をラップする (''0.12 以降'') 。 ||
     167|| '''`#!tr`''' || `#!td` や `#!th` ブロックをラッピングしたり、グルーピングした列を見やすくするために属性を指定する際、オプションとして使用することができます (''0.12 以降'') 。 ||
     168|| || これらのプロセッサについての詳細と使用例については、 WikiHtml を参照して下さい。 ||
     169|||| ||
     170||||= '''その他のプロセッサ''' =||
     171|| '''`#!rst`''' || Trac における Restructured テキストのサポート。WikiRestructuredText 参照。 ||
     172|| '''`#!textile`''' || [http://cheeseshop.python.org/pypi/textile Textile] がインストールされている場合のサポート。 [http://www.textism.com/tools/textile/ a Textile リファレンス] 参照。 ||
     173|||| ||
     174||||= '''コードのハイライトのサポート''' =||
     175|| '''`#!c`''' [[BR]] '''`#!cpp`''' (C++) [[BR]] '''`#!python`''' [[BR]] '''`#!perl`''' [[BR]] '''`#!ruby`''' [[BR]] '''`#!php`''' [[BR]] '''`#!asp`''' [[BR]] '''`#!java`''' [[BR]] '''`#!js`''' (Javascript) [[BR]] '''`#!sql`''' [[BR]] '''`#!xml`''' (XML or HTML) [[BR]] '''`#!sh`''' (!Bourne/Bash shell) [[BR]] '''etc.''' [[BR]] || Trac は、さまざまなプログラミング言語のソースコードに対応するインラインのシンタックスハイライトを提供するプロセッサを同梱しています。[[BR]] [[BR]] Trac では、シンタックスのカラーリングについて外部のソフトウェア (例えば [http://pygments.org Pygments]) に依存しています。[[BR]] [[BR]] サポートしている言語の情報と他の言語のサポートを有効にする方法については TracSyntaxColoring を参照してください。 ||
     176|||| ||
     177||||= '''MIME タイププロセッサ''' =||
     178|||| プロセッサに MIME タイプを使用することによって、ソースコードをブラウズするとき、サポートしている言語に対してシンタックスハイライトを適用することが可能です。 ||
    179179{{{#!tr
    180180{{{#!td
    181 Some examples:
     181例:
    182182 {{{
    183183{{{
    184184#!text/html
    185 <h1>text</h1>
    186 }}}
    187  }}}
    188 }}}
    189 {{{#!td
    190 The result will be syntax highlighted HTML code:
     185<h1>テキスト</h1>
     186}}}
     187 }}}
     188}}}
     189{{{#!td
     190この結果はシンタックスハイライトされた HTML コードになります:
    191191 {{{
    192192#!text/html
    193 <h1>text</h1>
    194  }}}
    195 
    196 The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported].
     193<h1>テキスト</h1>
     194 }}}
     195
     196これは、すべての [TracSyntaxColoring#SyntaxColoringSupport 対応している MIME タイプ] に対して有効です。
    197197}}}
    198198}}}
    … …  
    220220}}}
    221221{{{#!td
    222 '''`#!diff`''' has a particularly nice renderer:
     222'''`#!diff`''' は細部までレンダリングします:
    223223 {{{
    224224#!diff
    … …  
    241241}}}
    242242
    243 For more processor macros developed and/or contributed by users, visit:
     243ユーザによるプロセッサマクロの開発やコントリビュート:
    244244 * [trac:ProcessorBazaar]
    245245 * [trac:MacroBazaar]
    246  * [http://trac-hacks.org Trac Hacks] community site
    247 
    248 Developing processors is no different from Wiki macros.
    249 In fact they work the same way, only the usage syntax differs.
    250 See WikiMacros#DevelopingCustomMacros for more information.
     246 * [http://trac-hacks.org/ Trac Hacks] コミュニティサイト
     247
     248プロセッサは Wiki マクロを開発するのと変わりはありません。
     249実際、開発方法は同じであり、シンタックスの使用方法のみが異なります。
     250詳細情報については、 [WikiMacros#DevelopingCustomMacros カスタムマクロを開発する] を参照して下さい。
    251251
    252252