Changes between Version 2 and Version 3 of WikiFormatting


Ignore:
Timestamp:
Dec 31, 2005, 4:43:10 PM (18 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • WikiFormatting

    v2 v3  
    1 = Wiki 文法 =
    2 
    3 Wiki マークアップは Trac のコアとなる機能です。他のパーツと緊密に統合することによって、Trac をフレキシブルかつ強力にしています。
    4 
    5 Trac は小さく強力な Wiki レンダリングエンジンをビルトインしています。この Wiki エンジンは、他のポピュラーな Wiki (特に [http://moin.sf.net/ MoinWiki])からのコマンドの強化サブセットを実装しています。
    6 
    7 このページは、 WikiFormatting でフォーマットできる文法の文例集です。
    8 
    9 == フォントスタイル ==
    10 
    11 Trac の Wiki は以下のフォントスタイルをサポートしています: '''ボールド''', ''イタリック'',
    12 __アンダーライン__ and ~~取り消し線~~。
    13 
    14 {{{
    15 Trac の Wiki は以下のフォントスタイルをサポートしています: '''ボールド''', ''イタリック'',
    16 __アンダーライン__ and ~~取り消し線~~。
    17 }}}
    18 
    19 
    20 == 見出し ==
    21 
    22 1文字から5文字の「イコール '='」を行頭に置き、1文字のスペースに続けてタイトルを置くと、
    23 見出しになります。見出しの行末は1文字のスペースに続けて、行頭と同じ数の ''イコール (=)''を
    24 置きます。
    25 
    26 ''Note: 見出しの箇所は、 TracLinks の対象になりません。''
    27 
    28 === 例: ===
    29 {{{
    30 = 見出し(第1レベル) =
    31 == 見出し(第2レベル) ==
    32 }}}
    33 
    34 
    35 == 改行 ==
    36 
    37 2つのテキストブロックの間に1行以上の空行がある場合、新しい段落として改行を行います。
    38 (訳注: HTMLでは、p要素になります)
    39 
    40 強制的に改行だけを行いたい場合、このように書いてください:
    41 {{{
    42 1行目[[BR]]2行目
    43 }}}
    44 以下のように表示されます:
    45 
    46 1行目[[BR]]2行目
    47 
    48   2文字以上のスペースで行が始まる場合、段落と認識されます。(訳注: この場合、空白の数に応じてネストします。)
    49 
    50 == リスト ==
    51 番号付きリストと番号無しリストの両方をサポートします。
    52 
    53 例:
     1= WikiFormatting =
     2[[TracGuideToc]]
     3
     4Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
     5
     6Trac has a built in small and powerful wiki rendering engine. This wiki engine implements an ever growing subset of the commands from other popular Wikis,
     7especially [http://moinmoin.wikiwikiweb.de/ MoinMoin].
     8
     9
     10This page demonstrates the formatting syntax available anywhere WikiFormatting is allowed.
     11
     12
     13== Font Styles ==
     14
     15The Trac wiki supports the following font styles:
     16{{{
     17 * '''bold'''
     18 * ''italic''
     19 * '''''bold italic'''''
     20 * __underline__
     21 * {{{monospace}}} or `monospace`
     22 * ~~strike-through~~
     23 * ^superscript^
     24 * ,,subscript,,
     25}}}
     26
     27Display:
     28 * '''bold'''
     29 * ''italic''
     30 * '''''bold italic'''''
     31 * __underline__
     32 * {{{monospace}}} or `monospace`
     33 * ~~strike-through~~
     34 * ^superscript^
     35 * ,,subscript,,
     36
     37Note that the `{{{...}}}` and {{{`...`}}} commands not only select a monospace font, but also treat their content as verbatim text, meaning that no further wiki processing is done on this text.
     38
     39== Headings ==
     40
     41You can create heading by starting a line with one up to five ''equal'' characters ("=")
     42followed by a single space and the headline text. The line should end with a space
     43followed by the same number of ''='' characters.
     44
     45Example:
     46{{{
     47= Heading =
     48== Subheading ==
     49=== About ''this'' ===
     50}}}
     51
     52Display:
     53= Heading =
     54== Subheading ==
     55=== About ''this'' ===
     56
     57
     58== Paragraphs ==
     59
     60A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
     61
     62A forced line break can also be inserted, using:
     63{{{
     64Line 1[[BR]]Line 2
     65}}}
     66Display:
     67
     68Line 1[[BR]]Line 2
     69
     70
     71== Lists ==
     72
     73The wiki supports both ordered/numbered and unordered lists.
     74
     75Example:
    5476{{{
    5577 * Item 1
    … …  
    6183 1. Item 2
    6284}}}
    63 表示内容:
     85
     86Display:
    6487 * Item 1
    6588   * Item 1.1
    … …  
    7093 1. Item 2
    7194
    72 == 整形済みテキスト ==
    73 引用ブロック(block quote)、整形済みテキストは、ソースコードの一部や、ノート、例示に適しています。引用ブロックとしたいテキストの前後を、3つの ''ブレース (curly braces)'' で括ってください。
     95Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.
     96
     97
     98== Definition Lists ==
     99
     100The wiki also supports definition lists.
     101
     102Example:
     103{{{
     104 llama::
     105   some kind of mammal, with hair
     106 ppython::
     107   some kind of reptile, without hair
     108   (can you spot the typo?)
     109}}}
     110
     111Display:
     112 llama::
     113   some kind of mammal, with hair
     114 ppython::
     115   some kind of reptile, without hair
     116   (can you spot the typo?)
     117
     118Note that you need a space in front of the defined term.
     119
     120
     121== Preformatted Text ==
     122
     123Block containing preformatted text are suitable for source code snippets, notes and examples. Use three ''curly braces'' wrapped around the text to define a block quote. The curly braces need to be on a separate line.
    74124 
    75 例:
     125Example:
    76126{{{
    77127 {{{
    78   def HelloWorld()
     128  def HelloWorld():
    79129      print "Hello World"
    80130 }}}
    81131}}}
    82132
    83 表示内容:
    84 {{{
    85  def HelloWorld()
     133Display:
     134{{{
     135 def HelloWorld():
    86136     print "Hello World"
    87137}}}
    88138
    89 == 表 ==
    90 
    91 簡単なテーブルはこのように記述します:
     139
     140== Blockquotes ==
     141
     142In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
     143
     144Example:
     145{{{
     146  This text is a quote from someone else.
     147}}}
     148
     149Display:
     150  This text is a quote from someone else.
     151
     152== Tables ==
     153
     154Simple tables can be created like this:
    92155{{{
    93156||Cell 1||Cell 2||Cell 3||
    94157||Cell 4||Cell 5||Cell 6||
    95158}}}
    96 以下の通り表示されます:
     159
     160Display:
    97161||Cell 1||Cell 2||Cell 3||
    98162||Cell 4||Cell 5||Cell 6||
    99163
    100 == リンク ==
    101 
    102 WikiPageNames や URL は自動的にハイパーリンクされます。 !WikiPageLinks を無効化したい場合、
    103  {{{!WikiPageLink}}} のように、エクラメーションマーク (!) を語頭に置きます。
    104 
    105 例:
    106 
    107  TitleIndex, http://www.edgewall.com/.
    108 
    109 リンク先そのものでなくリンク先の内容説明やタイトルを表示させたい場合、
    110 角括弧 (square bracket) で括り、リンクに続いて1文字の空白を開けて記述します:
     164Note that more complex tables can be created using
     165[wiki:WikiRestructuredText#BiggerReSTExample reStructuredText].
     166
     167
     168== Links ==
     169
     170Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
     171
     172Example:
     173{{{
     174 TitleIndex, http://www.edgewall.com/, !NotAlink
     175}}}
     176
     177Display:
     178 TitleIndex, http://www.edgewall.com/, !NotAlink
     179
     180Links can be given a more descriptive title by writing the link followed by a space and a title and all this inside square brackets.  If the descriptive title is omitted, then the explicit prefix is disguarded, unless the link is an external link. This can be useful for wiki pages not adhering to the WikiPageNames convention.
     181
     182Example:
    111183{{{
    112184 * [http://www.edgewall.com/ Edgewall Software]
    113185 * [wiki:TitleIndex Title Index]
    114 }}}
    115 以下のように表示されます:
    116 
     186 * [wiki:ISO9000]
     187}}}
     188
     189Display:
    117190 * [http://www.edgewall.com/ Edgewall Software]
    118191 * [wiki:TitleIndex Title Index]
    119 
    120 === Trac リンク ===
    121 
    122 Wiki ページでは Trac の他のコンポーネントに直接リンクできます。
    123 チケット、レポート、チェンジセット、マイルストーン、ソースファイル、
    124 他の Wiki ページへは以下のようにリンクを記述します:
    125  * チケット: '''!#1''' もしくは '''!ticket:1'''
    126  * レポート: '''!{1}''' もしくは '''!report:1'''
    127  * チェンジセット: '''![1]''' もしくは '''!changeset:1'''
    128  * Wiki ページ: '''CamelCase''' もしくは '''!wiki:CamelCase'''
    129  * マイルストーン: '''!milestone:1.0'''
    130  * ファイル: '''!source:trunk/COPYING'''
    131  * 特定リビジョンのファイル: '''!source:/trunk/COPYING#200'''
    132 以下のように表示されます:
    133  * チケット: #1 もしくは ticket:1
    134  * レポート: {1} もしくは report:1
    135  * チェンジセット: [1] もしくは changeset:1
    136  * Wiki ページ: CamelCase もしくは wiki:CamelCase
    137  * マイルストーン: milestone:1.0
    138  * ファイル: source:trunk/COPYING
    139  * 特定リビジョンのファイル: source:/trunk/COPYING#200
    140 
    141 より深い情報は TracLinks に記述されています。
    142 
    143 == リンクの無効化 ==
    144 エクラメーションマーク(!)を語頭に付与することで、 TracLinks が出力するハイパーリンクを無効化できます。
    145 
     192 * [wiki:ISO9000]
     193
     194
     195=== Trac Links ===
     196
     197Wiki pages can link directly to other parts of the Trac system. Pages can refer to tickets, reports, changesets, milestones, source files and other Wiki pages using the following notations:
     198{{{
     199 * Tickets: #1 or ticket:1
     200 * Reports: {1} or report:1
     201 * Changesets: r1, [1] or changeset:1
     202 * Revision Logs: r1:3, [1:3] or log:branches/0.8-stable#1:3
     203 * Wiki pages: CamelCase or wiki:CamelCase
     204 * Milestones: milestone:1.0 or milestone:"End-of-days Release"
     205 * Files: source:trunk/COPYING
     206 * Attachments: attachment:"file name.doc"
     207 * A specific file revision: source:/trunk/COPYING#200
     208 * A filename with embedded space: source:"/trunk/README FIRST"
     209}}}
     210
     211Display:
     212 * Tickets: #1 or ticket:1
     213 * Reports: {1} or report:1
     214 * Changesets: r1, [1] or changeset:1
     215 * Revision Logs: r1:3, [1:3] or log:branches/0.8-stable#1:3
     216 * Wiki pages: CamelCase or wiki:CamelCase
     217 * Milestones: milestone:1.0 or milestone:"End-of-days Release"
     218 * Files: source:trunk/COPYING
     219 * Attachments: attachment:"file name.doc"
     220 * A specific file revision: source:/trunk/COPYING#200
     221 * A filename with embedded space: source:"/trunk/README FIRST"
     222
     223See TracLinks for more in-depth information.
     224
     225
     226== Escaping Links and WikiPageNames ==
     227
     228You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
     229
     230Example:
    146231{{{
    147232 !NoHyperLink
    148  !#42 はリンクではありません。
    149 }}}
    150 
    151 表示内容:
     233 !#42 is not a link
     234}}}
     235
     236Display:
    152237 !NoHyperLink
    153  !#42 はリンクではありません。
    154 
    155 == 画像 ==
    156 
    157 URL が .png, .gif, .jpg で終わっている場合、自動的にイメージへのリンクとみなされ、 img タグに変換されます。
    158 
    159 例:
     238 !#42 is not a link
     239
     240
     241== Images ==
     242
     243Urls ending with `.png`, `.gif` or `.jpg` are automatically interpreted as image links, and converted to `<img>` tags.
     244
     245Example:
    160246{{{
    161247http://www.edgewall.com/gfx/trac_example_image.png
    162248}}}
    163 表示内容:
     249
     250Display:
    164251
    165252http://www.edgewall.com/gfx/trac_example_image.png
    166253
    167 == マクロ ==
    168 マクロは、動的コンテンツを Wiki ページに挿入するための ''カスタム関数'' です。使用方法は WikiMacros に記述されています。
    169 
    170 例:
     254However, this doesn't give much control over the display mode. This way of inserting images is deprecated in favor of the more powerful `Image` macro (see WikiMacros).
     255
     256
     257== Macros ==
     258
     259Macros are ''custom functions'' to insert dynamic content in a page.
     260
     261Example:
    171262{{{
    172263 [[Timestamp]]
    173264}}}
    174 表示内容:
     265
     266Display:
    175267 [[Timestamp]]
    176268
    177 == プロセッサ ==
    178 Trac は WikiProcessors の機能によって、 Wiki 以外のマークアップもサポートしています。例えば、プロセッサとしてページの描画に [wiki:WikiRestructuredText reStructuredText] や [wiki:WikiHtml HTML] を使用することができます。
    179 
    180 より詳細な情報は WikiProcessors に記載されています。
    181 
    182 '''例1:'''
     269See WikiMacros for more information, and a list of installed macros.
     270
     271
     272== Processors ==
     273
     274Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in
     275[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML].
     276
     277Example 1:
    183278{{{
    184279#!html
    185280<pre class="wiki">{{{
    186281#!html
    187 &lt;h1 style="text-align: right; color: blue"&gt;HTMLテキスト&lt;/h1&gt;
     282&lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt;
    188283}}}</pre>
    189284}}}
    190 表示内容:
     285
     286Display:
    191287{{{
    192288#!html
    193 <h1 style="text-align: right; color: blue">HTMLテキスト</h1>
    194 }}}
    195 
    196 '''例2:'''
     289<h1 style="text-align: right; color: blue">HTML Test</h1>
     290}}}
     291
     292Example:
    197293{{{
    198294#!html
    … …  
    206302}}}</pre>
    207303}}}
    208 表示内容:
     304
     305Display:
    209306{{{
    210307#!python
    … …  
    216313}}}
    217314
    218 == その他 ==
    219 
    220 4文字以上のハイフン (-) は水平ライン (<hr>) に置き換えられます。
    221 
     315Perl:
     316{{{
     317#!perl
     318my ($test) = 0;
     319if ($test > 0) {
     320echo "hello";
     321}
     322}}}
     323
     324See WikiProcessors for more information.
     325
     326
     327== Miscellaneous ==
     328
     329Four or more dashes will be replaced by a horizontal line (<HR>)
     330
     331Example:
    222332{{{
    223333 ----
    224334}}}
    225335
    226 表示例:
     336Display:
    227337----
    228338
    229339
    230340----
    231 参考: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.
    232 
     341See also: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring.