XPressME Integration Kit

Trac

Version 1 から Version 2 における更新: WikiProcessors

差分発生行の前後
Ignore:
Timestamp:
Nov 29, 2010, 3:25:28 PM (10 years 前)
Author:
trac (IP: 127.0.0.1)
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • WikiProcessors

    v1 v2  
    1 = Wiki プロセッサ = #WikiProcessors 
    2  
    3 プロセッサは [WikiMacros Wiki マクロ] の一種です。 [TracWiki Trac Wiki エンジン] 以外のマークアップフォーマットを使用するために設計されています。プロセッサは ''ユーザが編集したテキストを処理するマクロ機能'' と考えることができます。 
    4  
    5 Trac 内の全ての Wiki テキストにおいて、 Wiki エンジンにプロセッサを使わせることによって [wiki:WikiRestructuredText Restructured Text], [wiki:WikiHtml raw HTML] および [http://www.textism.com/tools/textile/ textile] を使用することができます。 
    6  
    7  
    8 == プロセッサを使用する == #UsingProcessors 
    9  
    10 テキストブロックでプロセッサを使うには、 Wiki のコードブロックを使用し、プロセッサの名前を (Unix 系 OS のスクリプトのように) ''shebang 行'' (#!) に続いて指定します。 
    11  
    12 '''例1''' (''Wiki テキストに raw HTML を挿入する''): 
    13  
     1= Wiki Processors = 
     2 
     3Processors 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 
     5Wiki processors can be used in any Wiki text throughout Trac, 
     6for 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 
     17To use a processor on a block of text, first delimit the lines using 
     18a Wiki ''code block'': 
     19{{{ 
     20{{{ 
     21The lines 
     22that should be processed... 
     23}}} 
     24}}} 
     25 
     26Immediately after the `{{{` or on the line just below,  
     27add `#!` followed by the ''processor name''. 
     28 
     29{{{ 
     30{{{ 
     31#!processorname 
     32The lines 
     33that should be processed... 
     34}}} 
     35}}} 
     36 
     37This is the "shebang" notation, familiar to most UNIX users. 
     38 
     39Besides their content, some Wiki processors can also accept ''parameters'', 
     40which are then given as `key=value` pairs after the processor name,  
     41on the same line. If `value` has to contain space, as it's often the case for 
     42the style parameter, a quoted string can be used (`key="value with space"`). 
     43 
     44As some processors are meant to process Wiki markup, it's quite possible to 
     45''nest'' processor blocks. 
     46You may want to indent the content of nested blocks for increased clarity, 
     47this extra indentation will be ignored when processing the content. 
     48 
     49 
     50== Examples == 
     51 
     52||= Wiki Markup =||= Display =|| 
     53{{{#!td colspan=2 align=center style="border: none" 
     54 
     55                __Example 1__: Inserting raw HTML 
     56}}} 
     57|----------------------------------------------------------------- 
     58{{{#!td style="border: none" 
     59{{{ 
     60{{{ 
     61<h1 style="color: grey">This is raw HTML</h1> 
     62}}} 
     63}}} 
     64}}} 
     65{{{#!td valign=top style="border: none; padding-left: 2em" 
    1466{{{ 
    1567#!html 
    16 <pre class="wiki">{{{ 
    17 #!html 
    18 &lt;h1 style="color: orange"&gt;これは raw HTML です&lt;/h1&gt; 
    19 }}}</pre> 
    20 }}} 
    21  
    22 '''結果、このように表示されます:''' 
    23 {{{ 
    24 #!html 
    25 <h1 style="color: orange">これは raw HTML です</h1> 
    26 }}} 
    27  
    28 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). 
    29  
    30 ---- 
    31  
    32 '''例2''' (''Wiki テキストに !ReStructured テキストを挿入する''): 
    33  
    34 {{{ 
    35 #!html 
    36 <pre class="wiki">{{{ 
    37 #!rst 
    38 見出し 
    39 ------ 
    40 脚注 [*]_ 付きの **text** です。 
    41  
    42 .. [*] ここは脚注。 
    43 }}}</pre> 
    44 }}} 
    45  
    46 '''結果、このように表示されます:''' 
    47 {{{ 
    48 #!rst 
    49 見出し 
    50 ------ 
    51 脚注 [*]_ 付きの **text** です。 
    52  
    53 .. [*] ここは脚注。 
    54 }}} 
    55 ---- 
    56 '''例3''' (''Wiki テキストに C 言語ソースコードブロックを挿入する''): 
    57  
    58 {{{ 
    59 #!html 
    60 <pre class="wiki">{{{ 
    61 #!c 
    62 int main(int argc, char *argv[]) 
    63 { 
    64   printf("Hello World\n"); 
    65   return 0; 
    66 } 
    67 }}}</pre> 
    68 }}} 
    69  
    70 '''結果、このように表示されます:''' 
    71 {{{ 
    72 #!c 
    73 int main(int argc, char *argv[]) 
    74 { 
    75   printf("Hello World\n"); 
    76   return 0; 
    77 } 
    78 }}} 
    79  
    80 ---- 
    81  
    82 == プロセッサ一覧 == #AvailableProcessors 
    83 以下のプロセッサが Trac の配布に含まれています: 
    84  * '''html''' -- Wiki ページにカスタム HTML を挿入する。 WikiHtml を参照してください。 
    85  * '''div''' -- Wiki ページの内容を任意の <div> 要素でラップする (''0.11 以降'')。 WikiHtml を参照してください。 
    86  * '''span''' -- Wiki ページの内容を任意の <span> 要素でラップする (''0.11 以降'')。 WikiHtml を参照してください。 
    87  * '''rst''' -- Restructured テキスト を Trac で利用可能にする。 WikiRestructuredText を参照してください。 
    88  * '''textile''' -- [http://cheeseshop.python.org/pypi/textile Textile] をインストールすれば利用可能です。 [http://www.textism.com/tools/textile/ Textile リファレンス] を参照してください。 
    89  * '''comment''' -- セクション内のテキストを処理しません。(セクションの内容はレンダリングされた Wiki ページには出力されず、プレーンテキストにのみ保持されます。) 
    90  
    91 === ソースコードの強調表示対応 === #CodeHighlightingSupport 
    92 Trac では、以下のプログラミング言語でのインライン [wiki:TracSyntaxColoring シンタックスハイライト] を行うプロセッサが組み込まれています。 
    93  * '''c''' -- C 
    94  * '''cpp''' -- C++ 
    95  * '''python''' -- Python 
    96  * '''perl''' -- Perl 
    97  * '''ruby''' -- Ruby 
    98  * '''php''' -- PHP 
    99  * '''asp''' -- ASP 
    100  * '''java''' -- Java 
    101  * '''js''' -- Javascript 
    102  * '''sql''' -- SQL 
    103  * '''xml''' -- XML 
    104  * '''sh''' -- Bourne/Bash shell 
    105  
    106 '''Note:''' ''Trac はシンタックスの色付けを、外部のソフトウェアパッケージに依存しています。詳しくは TracSyntaxColoring をご覧下さい。'' 
    107  
    108 プロセッサとして mime-type が指定されると、ソースコードをブラウズするときと同じく、対応されている言語であれば、シンタックスハイライトを行うことができます。例えば、以下のように書くと: 
     68<h1 style="color: grey">This is raw HTML</h1> 
     69}}} 
     70}}} 
     71|----------------------------------------------------------------- 
     72{{{#!td colspan=2 align=center style="border: none" 
     73 
     74     __Example 2__: Highlighted Python code in a <div> block with custom style 
     75}}} 
     76|----------------------------------------------------------------- 
     77{{{#!td style="border: none" 
     78  {{{ 
     79  {{{#!div style="background: #ffd; border: 3px ridge" 
     80 
     81  This is an example of embedded "code" block: 
     82 
     83    {{{ 
     84    #!python 
     85    def hello(): 
     86        return "world" 
     87    }}} 
     88 
     89  }}} 
     90  }}} 
     91}}} 
     92{{{#!td valign=top style="border: none; padding: 1em" 
     93  {{{#!div style="background: #ffd; border: 3px ridge" 
     94 
     95  This is an example of embedded "code" block: 
     96 
     97    {{{ 
     98    #!python 
     99    def hello(): 
     100        return "world" 
     101    }}} 
     102 
     103  }}} 
     104}}} 
     105|----------------------------------------------------------------- 
     106{{{#!td colspan=2 align=center style="border: none" 
     107 
     108     __Example 3__: Searching tickets from a wiki page, by keywords. 
     109}}} 
     110|----------------------------------------------------------------- 
     111{{{#!td style="border: none" 
     112  {{{ 
     113  {{{ 
     114  #!html 
     115  <form action="/query" method="get"> 
     116  <input type="text" name="keywords" value="~" size="30"> 
     117  <input type="submit" value="Search by Keywords"> 
     118  <!-- To control what fields show up use hidden fields 
     119  <input type="hidden" name="col" value="id"> 
     120  <input type="hidden" name="col" value="summary"> 
     121  <input type="hidden" name="col" value="status"> 
     122  <input type="hidden" name="col" value="milestone"> 
     123  <input type="hidden" name="col" value="version"> 
     124  <input type="hidden" name="col" value="owner"> 
     125  <input type="hidden" name="col" value="priority"> 
     126  <input type="hidden" name="col" value="component"> 
     127  --> 
     128  </form> 
     129  }}} 
     130  }}} 
     131}}} 
     132{{{#!td valign=top style="border: none; padding: 1em" 
     133  {{{ 
     134  #!html 
     135  <form action="/query" method="get"> 
     136  <input type="text" name="keywords" value="~" size="30"> 
     137  <input type="submit" value="Search by Keywords"> 
     138  <!-- To control what fields show up use hidden fields 
     139  <input type="hidden" name="col" value="id"> 
     140  <input type="hidden" name="col" value="summary"> 
     141  <input type="hidden" name="col" value="status"> 
     142  <input type="hidden" name="col" value="milestone"> 
     143  <input type="hidden" name="col" value="version"> 
     144  <input type="hidden" name="col" value="owner"> 
     145  <input type="hidden" name="col" value="priority"> 
     146  <input type="hidden" name="col" value="component"> 
     147  --> 
     148  </form> 
     149  }}} 
     150}}} 
     151== Available Processors == 
     152 
     153The following processors are included in the Trac distribution: 
     154 
     155 `#!default` :: Present the text verbatim in a preformatted text block.  
     156                This is the same as specifying ''no'' processor name 
     157                (and no `#!`) 
     158 `#!comment` :: Do not process the text in this section (i.e. contents exist 
     159                only in the plain text - not in the rendered page). 
     160 
     161=== HTML related === 
     162 
     163 `#!html`        :: Insert custom HTML in a wiki page. 
     164 `#!htmlcomment` :: Insert an HTML comment in a wiki page (''since 0.12''). 
     165 
     166Note that `#!html` blocks have to be ''self-contained'', 
     167i.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.  
     168 
     169  `#!div` :: Wrap an arbitrary Wiki content inside a <div> element 
     170             (''since 0.11''). 
     171 `#!span` :: Wrap an arbitrary Wiki content inside a <span> element  
     172             (''since 0.11'').  
     173 
     174 `#!td` :: Wrap an arbitrary Wiki content inside a <td> element (''since 0.12'') 
     175 `#!th` :: Wrap an arbitrary Wiki content inside a <th> element (''since 0.12'')  
     176 `#!tr` :: Can optionally be used for wrapping `#!td` and `#!th` blocks, 
     177       either for specifying row attributes of better visual grouping 
     178       (''since 0.12'') 
     179 
     180See WikiHtml for example usage and more details about these processors. 
     181 
     182=== Other Markups === 
     183 
     184     `#!rst` :: Trac support for Restructured Text. See WikiRestructuredText. 
     185 `#!textile` :: Supported if [http://cheeseshop.python.org/pypi/textile Textile]  
     186                is installed.  
     187                See [http://www.textism.com/tools/textile/ a Textile reference]. 
     188 
     189 
     190=== Code Highlighting Support === 
     191 
     192Trac includes processors to provide inline syntax highlighting: 
     193 `#!c` (C), `#!cpp` (C++), `#!python` (Python), `#!perl` (Perl),  
     194 `#!ruby` (Ruby), `#!php` (PHP), `#!asp` (ASP), `#!java` (Java),  
     195 `#!js` (Javascript), `#!sql (SQL)`, `#!xml` (XML or HTML), 
     196 `#!sh` (!Bourne/Bash shell), etc. 
     197 
     198Trac relies on external software packages for syntax coloring, 
     199like [http://pygments.org Pygments].  
     200 
     201See TracSyntaxColoring for information about which languages 
     202are supported and how to enable support for more languages. 
     203 
     204Note also that 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: 
    109205{{{ 
    110206{{{ 
     
    114210}}} 
    115211 
    116 この結果はシンタックスハイライトされた HTML コードになります: 
     212The result will be syntax highlighted HTML code: 
    117213{{{ 
    118214#!text/html 
     
    120216}}} 
    121217 
    122 対応している全ての mime-type でも、これは同じく有効です。 
    123  
    124  
    125 ユーザによるプロセッサマクロの開発やコントリビュート: 
    126  * [http://trac.edgewall.org/wiki/ProcessorBazaar ProcessorBazaar] 
    127  * [http://trac.edgewall.org/wiki/MacroBazaar MacroBazaar] 
    128  * [http://trac-hacks.org/ Trac Hacks] コミュニティサイト 
    129  
    130  
    131 == 上級トピック: プロセッサマクロを開発する == #AdvancedTopics:DevelopingProcessorMacros 
    132 プロセッサの開発は Wiki マクロと違いはありません。事実、これらは同じような機能を持ち、シンタックスだけが異なります。詳しくは WikiMacros を参照してください。 
     218The same is valid for all other [TracSyntaxColoring#SyntaxColoringSupport mime types supported]. 
     219 
     220 
     221For more processor macros developed and/or contributed by users, visit:  
     222 * [trac:ProcessorBazaar] 
     223 * [trac:MacroBazaar] 
     224 * [th:WikiStart Trac Hacks] community site 
     225 
     226Developing processors is no different from Wiki macros.  
     227In fact they work the same way, only the usage syntax differs.  
     228See WikiMacros#DevelopingCustomMacros for more information. 
    133229 
    134230 
    135231---- 
    136232See also: WikiMacros, WikiHtml, WikiRestructuredText, TracSyntaxColoring, WikiFormatting, TracGuide 
     233