Changes between Version 5 and Version 6 of WikiFormatting

Timestamp:

01/28/10 04:25:37 (3 years ago)

Author:

trac

Comment:

--

WikiFormatting

@@ -1 @@
-= Wiki 文法 =
+= WikiFormatting =
 [[TracGuideToc]]
 
-Wiki マークアップは Trac のコアとなる機能です。他のパーツと緊密に統合することによって、 Trac をフレキシブルかつ強力にしています。
-
-Trac は小さく強力な Wiki レンダリングエンジンを内蔵しています。この Wiki エンジンは、他のポピュラーな Wiki からのコマンドの強化サブセットを実装しています。
-(特に [http://moinmoin.wikiwikiweb.de/ MoinMoin])
-
-
-このページは、 WikiFormatting でフォーマットできる文法の文例集です。
-
-
-== フォント書式 ==
-
-Trac の Wiki は以下のフォント書式に対応しています:
-{{{
- * '''ボールド''', '''!''' ボールドにできます''' そして '''! '''
- * ''イタリック''
- * '''''ボールドイタリック'''''
- * __アンダーライン__
- * {{{モノスペース}}} or `モノスペース`
- * ~~取り消し線~~
- * ^上付き文字^ 
- * ,,下付き文字,,
-}}}
-
-表示内容:
- * '''ボールド''', '''!''' ボールドにできます''' そして '''! '''
- * ''イタリック''
- * '''''ボールドイタリック'''''
- * __アンダーライン__
- * {{{モノスペース}}} or `モノスペース`
- * ~~取り消し線~~
- * ^上付き文字^ 
- * ,,下付き文字,,
+Wiki markup is a core feature in Trac, tightly integrating all the other parts of Trac into a flexible and powerful whole.
+
+Trac 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,
+especially [http://moinmoin.wikiwikiweb.de/ MoinMoin]. 
+
+
+This page demonstrates the formatting syntax available anywhere WikiFormatting is allowed.
+
+
+== Font Styles ==
+
+The Trac wiki supports the following font styles:
+{{{
+ * '''bold''', '''!''' can be bold too''', and '''! '''
+ * ''italic''
+ * '''''bold italic'''''
+ * __underline__
+ * {{{monospace}}} or `monospace`
+ * ~~strike-through~~
+ * ^superscript^ 
+ * ,,subscript,,
+}}}
+
+Display:
+ * '''bold''', '''!''' can be bold too''', and '''! '''
+ * ''italic''
+ * '''''bold italic'''''
+ * __underline__
+ * {{{monospace}}} or `monospace`
+ * ~~strike-through~~
+ * ^superscript^ 
+ * ,,subscript,,
 
 Notes:
- * `{{{...}}}`と {{{`...`}}} コマンドは表示を等角フォントにするだけではなく、内容を整形済みテキストとして扱います。つまりテキストに対して、どのような Wiki 処理も行いません。
- * {{{ ! }}} は wiki パーサに wiki フォーマットとして解釈しないように伝えます。なので、 ! の後ろにスペースを置くことに注意して下さい。例えば、太字で行が終わるようなときです。
-
-== 見出し ==
-
-1 文字から 5 文字の「イコール '='」を行頭に置き、 1 文字のスペースに続けてタイトルを置くと、
-見出しになります。見出しの行末は1文字のスペースに続けて、行頭と同じ数の ''イコール (=)'' を
-置きます。
-見出しに続いて id 属性を明示的に付与することが出来ます。付与しない場合、暗黙の読み取り可能な id 属性が生成されます。
-'''(訳注: 明示的に付与する id 属性では日本語は使用できないようです。)'''
-
-例:
-{{{
-= 見出し (第1レベル) =
-== 見出し (第2レベル) ==
-=== 見出し (第3レベル) ===
-=== 明示的な id === #using-explicit-id-in-heading
-}}}
-
-表示内容:
-= 見出し (第1レベル) =
-== 見出し (第2レベル) ==
-=== 見出し (第3レベル) ===
-=== 明示的な id === #using-explicit-id-in-heading
-
-== 改行 ==
-
-2 つのテキストブロックの間に 1 行以上の空行がある場合、新しい段落として改行を行います。
-
-強制的に改行だけを行いたい場合、このように書いてください:
-{{{
-1行目[[BR]]2行目
-}}}
-以下のように表示されます:
-
-1行目[[BR]]2行目
-
-
-== リスト ==
-
-番号付きリストと番号無しリストの両方があります。
-
-例:
+ * `{{{...}}}` 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.
+ * {{{ ! }}} tells wiki parser to not take the following characters as wiki format, so pay attention to put a space after !, e.g. when ending bold.
+
+== Headings ==
+
+You can create heading by starting a line with one up to five ''equal'' characters ("=")
+followed by a single space and the headline text. The line should end with a space 
+followed by the same number of ''='' characters.
+The heading might optionally be followed by an explicit id. If not, an implicit but nevertheless readable id will be generated.
+
+Example:
+{{{
+= Heading =
+== Subheading ==
+=== About ''this'' ===
+=== Explicit id === #using-explicit-id-in-heading
+}}}
+
+Display:
+= Heading =
+== Subheading ==
+=== About ''this'' ===
+=== Explicit id === #using-explicit-id-in-heading
+
+== Paragraphs ==
+
+A new text paragraph is created whenever two blocks of text are separated by one or more empty lines.
+
+A forced line break can also be inserted, using:
+{{{
+Line 1[[BR]]Line 2
+}}}
+Display:
+
+Line 1[[BR]]Line 2
+
+
+== Lists ==
+
+The wiki supports both ordered/numbered and unordered lists.
+
+Example:
 {{{
  * Item 1
    * Item 1.1
+      * Item 1.1.1   
+      * Item 1.1.2
+      * Item 1.1.3
+   * Item 1.2
  * Item 2
 
@@ -90 +93 @@
       i. Item 1.b.ii
  1. Item 2
-番号付きリストでは、番号を指定することもできます:
+And numbered lists can also be given an explicit number:
  3. Item 3
 }}}
 
-表示内容:
+Display:
  * Item 1
    * Item 1.1
+      * Item 1.1.1
+      * Item 1.1.2
+      * Item 1.1.3
+   * Item 1.2
  * Item 2
 
@@ -105 +112 @@
       i. Item 1.b.ii
  1. Item 2
-番号付きリストでは、番号を指定することもできます:
+And numbered lists can also be given an explicit number:
  3. Item 3
 
-リストマーカーの前にスペースを一つ以上置かなければなりません。スペースがない場合、通常のパラグラフとして扱われます。
-
-
-== 用語定義リスト ==
-
-
-Wikiは用語定義リストも作成できます。
-
-例:
+Note that there must be one or more spaces preceding the list item markers, otherwise the list will be treated as a normal paragraph.
+
+
+== Definition Lists ==
+
+
+The wiki also supports definition lists.
+
+Example:
 {{{
  llama::
-   毛の生えた哺乳類の一種。
+   some kind of mammal, with hair
  ppython::
-   毛がない爬虫類の一種。
-   (typoを見つけたかい?)
-}}}
-
-表示内容:
+   some kind of reptile, without hair
+   (can you spot the typo?)
+}}}
+
+Display:
  llama::
-   毛の生えた哺乳類の一種。
+   some kind of mammal, with hair
  ppython::
-   毛がない爬虫類の一種。
-   (typoを見つけたかい?)
-
-定義する用語の前にスペースが一つ必要なことを忘れないで下さい。
-
-
-== 整形済みテキスト ==
-
-整形済みテキストを含むブロックは、ソースコードの一部や、ノート、例示に適しています。引用ブロックとしたいテキストの前後を、 3 つの ''ブレース (curly braces)'' で括ってください。ブレースは独立した行に置かなければいけません。
+   some kind of reptile, without hair
+   (can you spot the typo?)
+
+Note that you need a space in front of the defined term.
+
+
+== Preformatted Text ==
+
+Block 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.
   
-例:
+Example:
 {{{
  {{{
@@ -147 +154 @@
 }}}
 
-表示内容:
+Display:
 {{{
  def HelloWorld():
@@ -154 +161 @@
 
 
-== 引用ブロック ==
-
-段落を引用ブロックとしてマークするには、段落を 2 個のスペースでインデントします。
-
-例:
+== Blockquotes ==
+
+In order to mark a paragraph as blockquote, indent that paragraph with two spaces.
+
+Example:
 {{{
   This text is a quote from someone else.
 }}}
 
-表示内容:
+Display:
   This text is a quote from someone else.
 
-== 引用 ==
-
-進行中の議題のスレッド、チケットのコメントエリアなどで引用を表すために、メールライクな引用マーク (">", ">>" など) が使用できます。
-
-例:
+== Discussion Citations ==
+
+To delineate a citation in an ongoing discussion thread, such as the ticket comment area, e-mail-like citation marks (">", ">>", etc.) may be used.  
+
+Example:
 {{{
 >> Someone's original text
@@ -177 +184 @@
 }}}
 
-表示内容:
+Display:
 >> Someone's original text
 > Someone else's reply text
 My reply text
 
-''Note: いくつかの WikiFormatting の要素、 表やあらかじめ整形されたテキストは引用エリアでは整形が崩れてしまいます。きれいな引用を作るには再整形が必要になるでしょう。''
-
-== 表 ==
-
-簡単なテーブルはこのように記述します:
+''Note: Some WikiFormatting elements, such as lists and preformatted text, are  lost in the citation area.  Some reformatting may be necessary to create a clear citation.''
+
+== Tables ==
+
+Simple tables can be created like this:
 {{{
 ||Cell 1||Cell 2||Cell 3||
@@ -192 +199 @@
 }}}
 
-表示内容:
+Display:
 ||Cell 1||Cell 2||Cell 3||
 ||Cell 4||Cell 5||Cell 6||
 
-より複雑なテーブルは [wiki:WikiRestructuredText#より大きいReSTの例 reStructuredText] 
-を使用して書くことができます。
-
-
-== リンク ==
-
-WikiPageNames や URL は自動的にハイパーリンクされます。 !WikiPageLinks を無効化したい場合、 {{{!WikiPageLink}}} のように、エクスクラメーションマーク (!) を語頭に置きます。
-
-例:
+Note that more complex tables can be created using
+[wiki:WikiRestructuredText#BiggerReSTExample reStructuredText].
+
+
+== Links ==
+
+Hyperlinks are automatically created for WikiPageNames and URLs. !WikiPageLinks can be disabled by prepending an exclamation mark "!" character, such as {{{!WikiPageLink}}}.
+
+Example:
 {{{
  TitleIndex, http://www.edgewall.com/, !NotAlink
 }}}
 
-表示内容:
+Display:
  TitleIndex, http://www.edgewall.com/, !NotAlink
 
-リンク先そのものでなくリンク先の内容説明やタイトルを表示させたい場合、角括弧 (square bracket) で括り、リンクに続いて 1 文字の空白を開けて記述します。もし説明のタイトルが省略された場合、そして明確なプレフィックスが記述されなかったとき、外部へのリンクにはなりません。これは WikiPageNames の仕様に準拠できない Wiki ページを使いたい場合に役に立ちます。
-
-例:
+Links 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 discarded, unless the link is an external link. This can be useful for wiki pages not adhering to the WikiPageNames convention.
+
+Example:
 {{{
  * [http://www.edgewall.com/ Edgewall Software]
@@ -221 +228 @@
 }}}
 
-表示内容:
+Display:
  * [http://www.edgewall.com/ Edgewall Software]
  * [wiki:TitleIndex Title Index]
  * [wiki:ISO9000]
 
-
-=== Trac リンク ===
-
-Wiki ページでは Trac の他のコンポーネントに直接リンクできます。チケット、レポート、チェンジセット、マイルストーン、ソースファイル、他の Wiki ページへは以下のようにリンクを記述します:
-{{{
- * チケット: #1 もしくは ticket:1
- * レポート: {1} もしくは report:1
- * チェンジセット: [1] もしくは changeset:1
+== Trac Links ==
+
+Wiki 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:
+{{{
+ * Tickets: #1 or ticket:1
+ * Reports: {1} or report:1
+ * Changesets: r1, [1] or changeset:1
  * ...
 }}}
 
-表示内容:
- * チケット: #1 もしくは ticket:1
- * レポート: {1} もしくは report:1
- * チェンジセット: [1] もしくは changeset:1
+Display:
+ * Tickets: #1 or ticket:1
+ * Reports: {1} or report:1
+ * Changesets: r1, [1] or changeset:1
  * ... 
 
-より深い情報は TracLinks に記述されています。
-
-
-== リンクの無効化 ==
-
-エクスクラメーションマーク (!) を語頭に付与することで、 TracLinks が出力するハイパーリンクを無効化できます。
-
-例:
+There are many more flavors of Trac links, see TracLinks for more in-depth information.
+
+
+== Escaping Links and WikiPageNames ==
+
+You may avoid making hyperlinks out of TracLinks by preceding an expression with a single "!" (exclamation mark).
+
+Example:
 {{{
  !NoHyperLink
- !#42 はリンクではありません。
-}}}
-
-表示内容:
+ !#42 is not a link
+}}}
+
+Display:
  !NoHyperLink
- !#42 はリンクではありません。
-
-
-== 画像 ==
-
-URL が `.png`, `.gif` or `.jpg` で終わっている場合、自動的にイメージへのリンクとはならずに `<img>` タグに変換されます。
-
-![[Image]] マクロを使用しなければなりません (以下参照) 。
-
-
-== マクロ ==
-
-マクロは、動的コンテンツを Wiki ページに挿入するための ''カスタム関数'' です。
-
-例:
-{{{
- [[Timestamp]]
-}}}
-
-表示内容:
- [[Timestamp]]
-
-使用方法とインストールされているマクロの一覧は WikiMacros に記述されています。
-
-
-== プロセッサ ==
-
-Trac は WikiProcessors の機能によって、 Wiki 以外のマークアップにも対応しています。例えば、プロセッサとしてページの描画に 
-[wiki:WikiRestructuredText reStructuredText] や [wiki:WikiHtml HTML] を使用することができます。
-
-例1:
+ !#42 is not a link
+
+
+== Images ==
+
+Urls ending with `.png`, `.gif` or `.jpg` are no longer automatically interpreted as image links, and converted to `<img>` tags.
+
+You now have to use the ![[Image]] macro. The simplest way to include an image is to upload it as attachment to the current page, and put the filename in a macro call like `[[Image(picture.gif)]]`.
+
+In addition to the current page, it is possible to refer to other resources:
+ * `[[Image(wiki:WikiFormatting:picture.gif)]]` (referring to attachment on another page)
+ * `[[Image(ticket:1:picture.gif)]]` (file attached to a ticket)
+ * `[[Image(htdocs:picture.gif)]]` (referring to a file inside project htdocs)
+ * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (a file in repository)
+
+Example display: [[Image(htdocs:../common/trac_logo_mini.png)]]
+
+
+See WikiMacros for further documentation on the `[[Image()]]` macro.
+
+
+== Macros ==
+
+Macros are ''custom functions'' to insert dynamic content in a page.
+
+Example:
+{{{
+ [[RecentChanges(Trac,3)]]
+}}}
+
+Display:
+ [[RecentChanges(Trac,3)]]
+
+See WikiMacros for more information, and a list of installed macros.
+
+
+== Processors ==
+
+Trac supports alternative markup formats using WikiProcessors. For example, processors are used to write pages in 
+[wiki:WikiRestructuredText reStructuredText] or [wiki:WikiHtml HTML]. 
+
+Example 1:
 {{{
 #!html
 <pre class="wiki">{{{
 #!html
-&lt;h1 style="text-align: right; color: blue"&gt;HTMLテスト&lt;/h1&gt;
+&lt;h1 style="text-align: right; color: blue"&gt;HTML Test&lt;/h1&gt;
 }}}</pre>
 }}}
 
-表示内容:
+Display:
 {{{
 #!html
-<h1 style="text-align: right; color: blue">HTMLテスト</h1>
-}}}
-
-例:
+<h1 style="text-align: right; color: blue">HTML Test</h1>
+}}}
+
+Example:
 {{{
 #!html
@@ -317 +334 @@
 }}}
 
-表示内容:
+Display:
 {{{
 #!python
@@ -336 +353 @@
 }}}
 
-より詳細な情報は WikiProcessors に記載されています。
-
-
-== その他 ==
-
-4 文字以上のハイフン (-) は水平ライン (<hr>) に置き換えられます。
-
-例:
+See WikiProcessors for more information.
+
+
+== Comments ==
+
+Comments can be added to the plain text. These will not be rendered and will not display in any other format than plain text.
+{{{
+{{{
+#!comment
+Your comment here
+}}}
+}}}
+
+
+== Miscellaneous ==
+
+Four or more dashes will be replaced by a horizontal line (<HR>)
+
+Example:
 {{{
  ----
 }}}
 
-表示内容:
+Display:
 ----
+