トップ | バージョン2 最新版 | バージョン3 β版

初期バージョン から バージョン 1 における更新: WikiFormatting

差分発生行の前後
無視リスト:
更新日時:
2009/01/08 04:02:11 (12 年 前)
更新者:
trac (IP アドレス: 127.0.0.1)
コメント:

--

凡例:

変更なし
追加
削除
変更
  • WikiFormatting

    v1 v1  
     1= Wiki 文法 = #WikiFormatting 
     2[[TracGuideToc]] 
     3 
     4Wiki マークアップは Trac のコアとなる機能です。他のパーツと緊密に統合することによって、 Trac をフレキシブルかつ強力にしています。 
     5 
     6Trac は小さく強力な Wiki レンダリングエンジンを内蔵しています。この Wiki エンジンは、他のポピュラーな Wiki からのコマンドの強化サブセットを実装しています。 
     7(特に [http://moinmoin.wikiwikiweb.de/ MoinMoin]) 
     8 
     9 
     10このページは、 WikiFormatting でフォーマットできる文法の文例集です。 
     11 
     12 
     13== フォント書式 == #FontStyles 
     14 
     15Trac の Wiki は以下のフォント書式に対応しています: 
     16{{{ 
     17 * '''ボールド''', '''!''' この箇所もボールドになります''', '''! ''' 
     18 * ''イタリック'' 
     19 * '''''ボールドイタリック''''' 
     20 * __アンダーライン__ 
     21 * {{{モノスペース}}} or `モノスペース` 
     22 * ~~取り消し線~~ 
     23 * ^上付き文字^  
     24 * ,,下付き文字,, 
     25}}} 
     26 
     27表示内容: 
     28 * '''ボールド''', '''!''' この箇所もボールドになります''', '''! ''' 
     29 * ''イタリック'' 
     30 * '''''ボールドイタリック''''' 
     31 * __アンダーライン__ 
     32 * {{{モノスペース}}} or `モノスペース` 
     33 * ~~取り消し線~~ 
     34 * ^上付き文字^  
     35 * ,,下付き文字,, 
     36 
     37Notes: 
     38 * `{{{...}}}`と {{{`...`}}} コマンドは表示を等角フォントにするだけではなく、内容を整形済みテキストとして扱います。つまりテキストに対して、どのような Wiki 処理も行いません。 
     39 * {{{ ! }}} は wiki パーサに wiki フォーマットとして解釈しないように伝えます。なので、 ! の後ろにスペースを置くことに注意して下さい。例えば、太字で行が終わるようなときです。 
     40 
     41== 見出し == #Headings 
     42 
     431 文字から 5 文字の「イコール '='」を行頭に置き、 1 文字のスペースに続けてタイトルを置くと、 
     44見出しになります。見出しの行末は1文字のスペースに続けて、行頭と同じ数の ''イコール (=)'' を 
     45置きます。 
     46見出しに続いて id 属性を明示的に付与することが出来ます。付与しない場合、暗黙の読み取り可能な id 属性が生成されます。 
     47'''(訳注: 明示的に付与する id 属性では日本語は使用できないようです。)''' 
     48 
     49例: 
     50{{{ 
     51= 見出し (第1レベル) = 
     52== 見出し (第2レベル) == 
     53=== 見出し (第3レベル) === 
     54=== 明示的な id === #using-explicit-id-in-heading 
     55}}} 
     56 
     57表示内容: 
     58= 見出し (第1レベル) = 
     59== 見出し (第2レベル) == 
     60=== 見出し (第3レベル) === 
     61=== 明示的な id === #using-explicit-id-in-heading 
     62 
     63== 改行 == #Paragraphs 
     64 
     652 つのテキストブロックの間に 1 行以上の空行がある場合、新しい段落として改行を行います。 
     66 
     67強制的に改行だけを行いたい場合、このように書いてください: 
     68{{{ 
     691行目[[BR]]2行目 
     70}}} 
     71以下のように表示されます: 
     72 
     731行目[[BR]]2行目 
     74 
     75 
     76== リスト == #Lists 
     77 
     78番号付きリストと番号無しリストの両方があります。 
     79 
     80例: 
     81{{{ 
     82 * Item 1 
     83   * Item 1.1 
     84      * Item 1.1.1    
     85      * Item 1.1.2 
     86      * Item 1.1.3 
     87   * Item 1.2 
     88 * Item 2 
     89 
     90 1. Item 1 
     91   a. Item 1.a 
     92   a. Item 1.b 
     93      i. Item 1.b.i 
     94      i. Item 1.b.ii 
     95 1. Item 2 
     96番号付きリストでは、番号を指定することもできます: 
     97 3. Item 3 
     98}}} 
     99 
     100表示内容: 
     101 * Item 1 
     102   * Item 1.1 
     103      * Item 1.1.1 
     104      * Item 1.1.2 
     105      * Item 1.1.3 
     106   * Item 1.2 
     107 * Item 2 
     108 
     109 1. Item 1 
     110   a. Item 1.a 
     111   a. Item 1.b 
     112      i. Item 1.b.i 
     113      i. Item 1.b.ii 
     114 1. Item 2 
     115番号付きリストでは、番号を指定することもできます: 
     116 3. Item 3 
     117 
     118リストマーカーの前にスペースを一つ以上置かなければなりません。スペースがない場合、通常のパラグラフとして扱われます。 
     119 
     120 
     121== 用語定義リスト == #DefinitionLists 
     122 
     123 
     124Wikiは用語定義リストも作成できます。 
     125 
     126例: 
     127{{{ 
     128 llama:: 
     129   毛の生えた哺乳類の一種。 
     130 ppython:: 
     131   毛がない爬虫類の一種。 
     132   (typoを見つけたかい?) 
     133}}} 
     134 
     135表示内容: 
     136 llama:: 
     137   毛の生えた哺乳類の一種。 
     138 ppython:: 
     139   毛がない爬虫類の一種。 
     140   (typoを見つけたかい?) 
     141 
     142定義する用語の前にスペースが一つ必要なことを忘れないで下さい。 
     143 
     144 
     145== 整形済みテキスト == #PreformattedText 
     146 
     147整形済みテキストを含むブロックは、ソースコードの一部や、ノート、例示に適しています。引用ブロックとしたいテキストの前後を、 3 つの ''ブレース (curly braces)'' で括ってください。ブレースは独立した行に置かなければいけません。 
     148   
     149例: 
     150{{{ 
     151 {{{ 
     152  def HelloWorld(): 
     153      print "Hello World" 
     154 }}} 
     155}}} 
     156 
     157表示内容: 
     158{{{ 
     159 def HelloWorld(): 
     160     print "Hello World" 
     161}}} 
     162 
     163 
     164== 引用ブロック == #Blockquotes 
     165 
     166段落を引用ブロックとしてマークするには、段落を 2 個のスペースでインデントします。 
     167 
     168例: 
     169{{{ 
     170  This text is a quote from someone else. 
     171}}} 
     172 
     173表示内容: 
     174  This text is a quote from someone else. 
     175 
     176== 引用 == #DiscussionCitations 
     177 
     178進行中の議題のスレッド、チケットのコメントエリアなどで引用を表すために、メールライクな引用マーク (">", ">>" など) が使用できます。 
     179 
     180例: 
     181{{{ 
     182>> Someone's original text 
     183> Someone else's reply text 
     184My reply text 
     185}}} 
     186 
     187表示内容: 
     188>> Someone's original text 
     189> Someone else's reply text 
     190My reply text 
     191 
     192''Note: いくつかの WikiFormatting の要素、 表やあらかじめ整形されたテキストは引用エリアでは整形が崩れてしまいます。きれいな引用を作るには再整形が必要になるでしょう。'' 
     193 
     194== 表 == #Tables 
     195 
     196簡単なテーブルはこのように記述します: 
     197{{{ 
     198||Cell 1||Cell 2||Cell 3|| 
     199||Cell 4||Cell 5||Cell 6|| 
     200}}} 
     201 
     202表示内容: 
     203||Cell 1||Cell 2||Cell 3|| 
     204||Cell 4||Cell 5||Cell 6|| 
     205 
     206より複雑なテーブルは [wiki:WikiRestructuredText#より大きいReSTの例 reStructuredText]  
     207を使用して書くことができます。 
     208 
     209 
     210== リンク == #Links 
     211 
     212WikiPageNames や URL は自動的にハイパーリンクされます。 !WikiPageLinks を無効化したい場合、 {{{!WikiPageLink}}} のように、エクスクラメーションマーク (!) を語頭に置きます。 
     213 
     214例: 
     215{{{ 
     216 TitleIndex, http://www.edgewall.com/, !NotAlink 
     217}}} 
     218 
     219表示内容: 
     220 TitleIndex, http://www.edgewall.com/, !NotAlink 
     221 
     222リンク先そのものでなくリンク先の内容説明やタイトルを表示させたい場合、角括弧 (square bracket) で括り、リンクに続いて 1 文字の空白を開けて記述します。もし説明のタイトルが省略された場合、そして明確なプレフィックスが記述されなかったとき、外部へのリンクにはなりません。これは WikiPageNames の仕様に準拠できない Wiki ページを使いたい場合に役に立ちます。 
     223 
     224例: 
     225{{{ 
     226 * [http://www.edgewall.com/ Edgewall Software] 
     227 * [wiki:TitleIndex Title Index] 
     228 * [wiki:ISO9000] 
     229}}} 
     230 
     231表示内容: 
     232 * [http://www.edgewall.com/ Edgewall Software] 
     233 * [wiki:TitleIndex Title Index] 
     234 * [wiki:ISO9000] 
     235 
     236== Trac リンク == #TracLinks 
     237 
     238Wiki ページでは Trac の他のコンポーネントに直接リンクできます。チケット、レポート、チェンジセット、マイルストーン、ソースファイル、他の Wiki ページへは以下のようにリンクを記述します: 
     239{{{ 
     240 * チケット: #1 もしくは ticket:1 
     241 * レポート: {1} もしくは report:1 
     242 * チェンジセット: r1, [1] もしくは changeset:1 
     243 * ... 
     244}}} 
     245 
     246表示内容: 
     247 * チケット: #1 もしくは ticket:1 
     248 * レポート: {1} もしくは report:1 
     249 * チェンジセット: r1, [1] もしくは changeset:1 
     250 * ...  
     251 
     252Trac は他にも多くの種類のリンクを使用することができます。より詳しい情報は TracLinks を参照してください。 
     253 
     254 
     255== リンクの無効化 == #EscapingLinksandWikiPageNames 
     256 
     257エクスクラメーションマーク (!) を語頭に付与することで、 TracLinks が出力するハイパーリンクを無効化できます。 
     258 
     259例: 
     260{{{ 
     261 !NoHyperLink 
     262 !#42 はリンクではありません。 
     263}}} 
     264 
     265表示内容: 
     266 !NoHyperLink 
     267 !#42 はリンクではありません。 
     268 
     269 
     270== 画像 == #Images 
     271 
     272URL が `.png`, `.gif` or `.jpg` で終わっている場合、自動的にイメージへのリンクとはならずに `<img>` タグに変換されます。 
     273 
     274現在では `[[Image]]` マクロを使用しなければなりません。画像を表示する最も簡単な方法は、現在のページへの添付ファイルとして画像をアップロードし、 `[[Image(picture.gif)]]` のようにファイル名を指定してマクロを呼び出す方法です。 
     275 
     276現在のページに加えて、他のリソースを参照することも可能です。 
     277 * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page) 
     278 * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket) 
     279 * `[[Image(htdocs:picture.gif)]]` (referring to a file inside project htdocs) 
     280 * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository) 
     281 
     282表示例: [[Image(htdocs:../common/trac_logo_mini.png)]] 
     283 
     284 
     285`[[Image()]]` マクロに関するより詳しい情報は WikiMacros に記載されています。 
     286 
     287 
     288== マクロ == #Macros 
     289 
     290マクロは、動的コンテンツを Wiki ページに挿入するための ''カスタム関数'' です。 
     291 
     292例: 
     293{{{ 
     294 [[RecentChanges(Trac,3)]] 
     295}}} 
     296 
     297表示内容: 
     298 [[RecentChanges(Trac,3)]] 
     299 
     300使用方法とインストールされているマクロの一覧は WikiMacros に記述されています。 
     301 
     302 
     303== プロセッサ == #Processors 
     304 
     305Trac は WikiProcessors の機能によって、 Wiki 以外のマークアップにも対応しています。例えば、プロセッサとしてページの描画に  
     306[wiki:WikiRestructuredText reStructuredText] や [wiki:WikiHtml HTML] を使用することができます。 
     307 
     308例1: 
     309{{{ 
     310#!html 
     311<pre class="wiki">{{{ 
     312#!html 
     313&lt;h1 style="text-align: right; color: blue"&gt;HTMLテスト&lt;/h1&gt; 
     314}}}</pre> 
     315}}} 
     316 
     317表示内容: 
     318{{{ 
     319#!html 
     320<h1 style="text-align: right; color: blue">HTMLテスト</h1> 
     321}}} 
     322 
     323例: 
     324{{{ 
     325#!html 
     326<pre class="wiki">{{{ 
     327#!python 
     328class Test: 
     329 
     330    def __init__(self): 
     331        print "Hello World" 
     332if __name__ == '__main__': 
     333   Test() 
     334}}}</pre> 
     335}}} 
     336 
     337表示内容: 
     338{{{ 
     339#!python 
     340class Test: 
     341    def __init__(self): 
     342        print "Hello World" 
     343if __name__ == '__main__': 
     344   Test() 
     345}}} 
     346 
     347Perl: 
     348{{{ 
     349#!perl 
     350my ($test) = 0; 
     351if ($test > 0) { 
     352    print "hello"; 
     353} 
     354}}} 
     355 
     356より詳細な情報は WikiProcessors に記載されています。 
     357 
     358 
     359== コメント == #Comments 
     360 
     361コメントをプレーンテキストに追加することができます。コメントはレンダリングされず、プレーンテキスト形式でのみ表示されます。 
     362{{{ 
     363{{{ 
     364#!comment 
     365Your comment here 
     366}}} 
     367}}} 
     368 
     369 
     370== その他 == #Miscellaneous 
     371 
     3724 文字以上のハイフン (-) は水平ライン (<hr>) に置き換えられます。 
     373 
     374例: 
     375{{{ 
     376 ---- 
     377}}} 
     378 
     379表示内容: 
     380---- 
     381 
     382 
     383 
     384---- 
     385See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.