ユーザ用ツール

サイト用ツール


wiki:syntax

差分

この文書の現在のバージョンと選択したバージョンの差分を表示します。

この比較画面にリンクする

両方とも前のリビジョン 前のリビジョン
次のリビジョン
前のリビジョン
wiki:syntax [2012/05/11 23:35]
king [fontsizeプラグインの書式(追加)]
wiki:syntax [2018/09/08 19:56] (現在)
ライン 1: ライン 1:
 +====== Formatting Syntax ======
  
 +[[doku>​DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[playground:​playground|playground]] page. The simpler markup is easily accessible via [[doku>​toolbar|quickbuttons]],​ too.
  
-====== 整形記法 ======+===== Basic Text Formatting ​=====
  
-文章の整形を行うには、シンプルなマークアップ記法を用います。 +DokuWiki ​supports **bold**, ​//italic//, __underlined__ and ''​monospaced''​ texts. Of course you can **__//''​combine''//​__** all these.
-[[:​ja:​dokuwiki|DokuWiki]] の記法は、ソース自体もできるだけ読みやすくなるよう考慮されています。 +
-画面の上部か下部にある ​//編集// ボタンをクリックすると、ページのソースを見ることができます。 +
-このページでは、編集にあたって利用できる記法をすべて説明します。 +
-ためしに編集をしてみたい場合には、 [[playground:​playground|playground]] ページを使ってください。 +
-主な記法は、[[doku>​ja:​toolbar|クイックボタン]] からも利用できます。+
  
-===== 基本的なテキスト整形 =====+  DokuWiki supports **bold**, //italic//, __underlined__ and ''​monospaced''​ texts. 
 +  Of course you can **__//''​combine''//​__** all these.
  
-文字飾りとして **太字**、 ​//斜体//、 __下線__ 、''​等幅''​ を利用できます。\\ +You can use <​sub>​subscript<​/sub> and <​sup>​superscript<​/sup>, too.
-もちろん **__//''​組み合わせる''//​__** こともできます。+
  
-  ​文字飾りとして **太字**、 ​//斜体//、 __下線__ 、''​等幅''​ を利用できます。 +  ​You can use <​sub>​subscript<​/sub> and <​sup>​superscript<​/sup>, too.
-  もちろん **__//''​組み合わせる''//​__** こともできます。+
  
-さらに ​<sub>下付き</subと <​sup>​上付き</​sup>​ も使えます。+You can mark something as <del>deleted</delas well.
  
-  ​さらに ​<sub>下付き</subと <​sup>​上付き</​sup>​ も使えます+  ​You can mark something as <del>deleted</delas well.
  
-<​del>​取り消し線</​del>​ も利用できます。+**Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line.
  
-  <​del>​取り消し線</​del>​ も利用できます。+This is some text with some linebreaks\\ Note that the 
 +two backslashes are only recognized at the end of a line\\ 
 +or followed by\\ a whitespace \\this happens without it.
  
-空行をおくと、**段落** となります。 +  This is some text with some linebreaks\\ Note that the 
-段落内で **強制的に改行** するには、バックスラッシュ(日本語環境では円記号¥) +  two backslashes are only recognized at the end of a line\\ 
-を 2 つ連ねた後に空白文字を置くか改行します。+  or followed by\\ a whitespace \\this happens without it.
  
-この文は改行\\ を含んでいます。2 連バックスラッシュが +You should use forced newlines only if really needed.
-改行として処理されるのは、空白文字が続く\\ か行の最後\\ +
-にある場合だけで、\\それ以外はそのまま表示されます。+
  
-  この文は改行\\ を含んでいます。2 連バックスラッシュが +===== Links =====
-  改行として処理されるのは、空白文字が続く\\ か行の最後\\ +
-  にある場合だけで、\\それ以外はそのまま表示されます。+
  
-強制改行は、どうしても必要な場合だけ使ってください。+DokuWiki supports multiple ways of creating links.
  
-===== リンク =====+==== External ​====
  
-リンクの記述には様々な方法があります。+External links are recognized automagically:​ http://​www.google.com or simply www.google.com - You can set the link text as well: [[http://​www.google.com|This Link points to google]]. Email addresses like this one: <​andi@splitbrain.org>​ are recognized, too.
  
-==== 外部リンク ====+  DokuWiki supports multiple ways of creating links. External links are recognized 
 +  automagically:​ http://​www.google.com or simply www.google.com - You can set 
 +  link text as well: [[http://​www.google.com|This Link points to google]]. Email 
 +  addresses like this one: <​andi@splitbrain.org>​ are recognized, too.
  
-http://​www.google.com や、よりシンプルに www.google.com のように文書中の URL は、 +==== Internal ====
-外部リンクとして自動的に認識されます。表題を指定して、 +
-[[http://​www.google.com|googleへのリンク]] のようにもできます。 +
-メールアドレスも、不等号で括ると、 <​andi@splitbrain.org>​ のように自動的に認識されます。+
  
-  http://www.google.com や、よりシンプルに www.google.com のように文書中の URL は、 +Internal links are created by using square bracketsYou can either just give a [[pagename]] or use an additional [[pagename|link text]].
-  外部リンクとして自動的に認識されます。表題を指定して、 +
-  ​[[http://​www.google.com|googleへのリンク]] のようにもできます。 +
-  メールアドレスも、不等号で括ると、 <​andi@splitbrain.org> のように自動的に認識されます。+
  
-==== 内部リンク ====+  Internal links are created by using square brackets. You can either just give 
 +  a [[pagename]] or use an additional [[pagename|link text]].
  
-この DokuWiki 内のページへのリンクには 2 連角カッコを使います。ページ名そのままで  +[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically,​ special characters are not allowed.
-[[ja:​pagename]] とするか、[[ja:​pagename|表題]] を指定します。+
  
-  この DokuWiki 内のページへのリンクには 2 連角カッコを使います。ページ名そのままで  +You can use [[some:namespaces]] by using a colon in the pagename.
-  ​[[ja:pagename]] とするか、[[ja:​pagename|表題]] を指定します。+
  
-[[ja:pagename|ページ名]] は自動的に小文字に変換されます。特殊文字は使えません。+  You can use [[some:namespaces]] by using a colon in the pagename.
  
-ページ名をコロンで区切ると ​[[namespaces]](名前空間)を利用できます。+For details about namespaces see [[doku>namespaces]].
  
-  ページ名をコロンで区切ると ​[[namespaces]](名前空間)を利用できます。+Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax#​internal|this Section]].
  
-詳細は ​[[doku>​ja:​namespaces]] をご覧ください。+  This links to [[syntax#​internal|this Section]].
  
-ページ中の特定のセクションにリンクすることも可能です。ハッシュ記号(#​)に続けてセクション名を記述します。 +Notes:
-[[syntax#​内部リンク|このセクション]] へのリンクです。+
  
-  ​[[syntax#​内部リンク|このセクション]] へのリンクです。 +  * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. 
- +  * DokuWiki does not use [[wp>​CamelCase]] ​to automatically create links by default, but this behavior can be enabled in the [[doku>config]] file. Hint: If DokuWiki ​is a link, then it's enabled. 
-注: +  * When a section'​s heading is changed, its bookmark changes, too. So don't rely on section linking too much.
- +
-  ​* [[syntax|既存のページ]] へのリンクと ​[[存在しないページ]] へのリンクとは表示が異なります。 +
-  * デフォルト設定では ​[[wp>​CamelCase]] ​をリンクとして扱いません。config ​ファイルで変更できます。もし、「DokuWiki」 がリンクになっていれば有効になっています。 +
-  * セクションの見出しが変更されると、そこへのリンク名も変化します。セクションへのリンクは多用しないほうが良いでしょう。+
  
 ==== Interwiki ==== ==== Interwiki ====
  
-[[doku>ja:​interwiki|Interwiki]] ​リンクも利用できます。 +DokuWiki supports ​[[doku>​Interwiki]] ​links. These are quick links to other Wikis. For example this is a link to Wikipedia'​s page about Wikis: ​[[wp>​Wiki]].
-InterWikiは、他の Wiki に手軽にリンクを張るための方法です。たとえば、 +
-[[wp>​Wiki]] ​は Wikipedia のページへのリンクです。+
  
-  [[doku>ja:​interwiki|Interwiki]] ​リンクも利用できます。 +  ​DokuWiki supports ​[[doku>​Interwiki]] ​links. These are quick links to other Wikis. 
-  InterWikiは、他の Wiki に手軽にリンクを張るための方法です。たとえば、 +  ​For example this is a link to Wikipedia'​s page about Wikis: ​[[wp>​Wiki]].
-  [[wp>​Wiki]] ​は Wikipedia のページへのリンクです。+
  
-==== Windows共有フォルダ ​====+==== Windows ​Shares ​====
  
-Windows ​共有フォルダも ​[[\\server\share|this]] ​のように使えます。 +Windows ​shares like [[\\server\share|this]] ​are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate ​[[wp>​Intranet]].
-ただし、[[wp>​Intranet|イントラネット]] 内のように、仲間内でしか正常に使えませんので、注意してください。+
  
-  Windows ​共有フォルダも ​[[\\server\share|this]] ​のように使えます。+  Windows ​Shares like [[\\server\share|this]] ​are recognized, too.
  
-:+Notes:
  
-  * セキュリティ上、Windows 共有フォルダを直接ブラウズできるのは、デフォルトでは ​Microsoft Internet Explorer(の「ローカルゾーン」)のみに限られます。 +  * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer ​per default (and only in the "local zone"​). 
-  * Mozilla ​や Firefox ​では ​[[http://​kb.mozillazine.org/​Links_to_local_pages_don'​t_work|MozillaZine ​Knowledge Base]] ​にあるような対処を行うと有効にすることができます。+  * For Mozilla ​and Firefox ​it can be enabled through different workaround mentioned in the [[http://​kb.mozillazine.org/​Links_to_local_pages_do_not_work|Mozilla ​Knowledge Base]]. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in ''​conf/​lang/​en/​lang.php''​ (more details at [[doku>​localization#​changing_some_localized_texts_and_strings_in_your_installation|localization]]):​ <code - conf/​lang/​en/​lang.php>​ 
 +<?php 
 +/** 
 + * Customization of the english language file 
 + * Copy only the strings that needs to be modified 
 + */ 
 +$lang['​js'​]['​nosmblinks'​] = '';​ 
 +</​code>​
  
-==== 画像にリンク ​====+==== Image Links ====
  
-リンク記法と ​[[#画像やその他のファイル|画像]] (後述)を組み合わせると、 +You can also use an image to link to another internal or external page by combining the syntax for links and [[#images_and_other_files|images]] (see below) like this:
-次のように、画像に内外部へのリンクをつけることができます。+
  
-   [[http://www.php.net|{{wiki:​dokuwiki-128.png}}]]+  ​[[http://​php.net|{{wiki:​dokuwiki-128.png}}]]
  
-[[http://www.php.net|{{wiki:​dokuwiki-128.png}}]]+[[http://​php.net|{{wiki:​dokuwiki-128.png}}]]
  
-リンクの表題については、この画像以外の整形記法は使えません。 +Please noteThe image formatting is the only formatting syntax accepted in link names.
-[[#​画像やその他のファイル|画像]] と [[#​リンク|リンク]] の記法はすべてサポートされます +
-(画像のサイズ変更や、内外部イメージ、URL 指定や interwiki リンクなど)。+
  
-===== 脚注 =====+The whole [[#​images_and_other_files|image]] and [[#​links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
  
-脚注 ((これが脚注です)) には、2 連の丸カッコを用います。+===== Footnotes =====
  
-  脚注 ​((これが脚注です)) には、2 連の丸カッコを用います。+You can add footnotes ​((This is a footnote)) by using double parentheses.
  
-===== セクション見出し =====+  You can add footnotes ((This is a footnote)) by using double parentheses.
  
-最大 5 つのレベルまでの見出しを使って、文章の構造化を行えます。 +===== Sectioning =====
-3 つ以上の見出しを記述すると、目次が自動的に生成されます。 +
-文書中に ''<​nowiki>​~~NOTOC~~</​nowiki>''​ という文字列を書くと +
-目次の生成を止めることができます。+
  
-==== 第 3 見出し ==== +You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically -- this can be disabled by including the string ''<​nowiki>​~~NOTOC~~</​nowiki>''​ in the document.
-=== 第 4 見出し === +
-== 第 5 見出し ==+
  
-  ​==== 第 見出し ​==== +==== Headline Level 3 ==== 
-  === 第 見出し ​=== +=== Headline Level 4 === 
-  == 第 見出し ​==+== Headline Level 5 ==
  
-===== 水平線 ​=====+  ​==== Headline Level 3 ==== 
 +  === Headline Level 4 === 
 +  == Headline Level 5 ==
  
-ダッシュ (-) を四つ以上続けると、水平線が書けます。+By using four or more dashes, you can make a horizontal line:
  
 ---- ----
  
 +===== Media Files =====
  
-===== 画像やその他のファイル =====+You can include external and internal [[doku>​images|images,​ videos and audio files]] with curly brackets. Optionally you can specify the size of them.
  
-波カッコを使って、[[doku>​ja:images|画像]] を記述できます(画像ファイルが ​wiki 内部にあっても外部でもかまいません)。オプションで、画像サイズも指定できます。+Real size                       {{wiki:​dokuwiki-128.png}}
  
-実サイズ                  ​{{wiki:​dokuwiki-128.png}}+Resize to given width           {{wiki:​dokuwiki-128.png?50}}
  
-幅を変更                  ​{{wiki:​dokuwiki-128.png?​50}}+Resize to given width and height((when the aspect ratio of the given width and height doesn'​t match that of the image, it will be cropped to the new ratio before resizing)): {{wiki:​dokuwiki-128.png?​200x50}}
  
-幅と高さを変更((画像のアスペクト比と指定された幅と高さの比が異なる場合は、リサイズされる前に新しいアスペクト比に切り抜かれます。))            ​{{wiki:dokuwiki-128.png?200x50}}+Resized external image          ​{{http://php.net/​images/​php.gif?200x50}}
  
-外部イメージのサイズを変更: {{http://de3.php.net/​images/​php.gif?​200x50}}+  Real size                       ​{{wiki:​dokuwiki-128.png}} 
 +  Resize to given width: ​           {{wiki:​dokuwiki-128.png?​50}} 
 +  Resize to given width and height: {{wiki:​dokuwiki-128.png?​200x50}} 
 +  Resized external image: ​          {{http://​php.net/​images/​php.gif?​200x50}}
  
-  実サイズ: ​                  ​{{wiki:​dokuwiki-128.png}} 
-  幅を変更: ​                  ​{{wiki:​dokuwiki-128.png?​50}} 
-  幅と高さを変更: ​            ​{{wiki:​dokuwiki-128.png?​200x50}} 
-  外部イメージのサイズを変更:​ {{http://​de3.php.net/​images/​php.gif?​200x50}} 
  
-左右にスペース文字を記述すると、配置位置を指定できます。+By using left or right whitespaces you can choose the alignment.
  
 {{ wiki:​dokuwiki-128.png}} {{ wiki:​dokuwiki-128.png}}
ライン 175: ライン 157:
   {{ wiki:​dokuwiki-128.png }}   {{ wiki:​dokuwiki-128.png }}
  
-さらに、タイトルも指定できます(ほとんどのブラウザで、ツールチップで表示されます)。+Of course, you can add a title (displayed as a tooltip by most browsers), too.
  
-{{ wiki:​dokuwiki-128.png |キャプションです}}+{{ wiki:​dokuwiki-128.png |This is the caption}}
  
-  {{ wiki:​dokuwiki-128.png |キャプションです}}+  {{ wiki:​dokuwiki-128.png |This is the caption}}
  
-画像 (''​gif,​jpeg,​png''​) 以外のファイル名を指定すると(ファイルが内外部いずれでも)、そのファイルへのリンクとして表示されます。+For linking an image to another page see [[#Image Links]] above.
  
-画像を他のページへのリンクとするには、上記の [[#​画像にリンク]] をご覧ください。+==== Supported Media Formats ====
  
-===== リスト =====+DokuWiki can embed the following media formats directly.
  
-リスト(番号付き・番号無し)を利用できます。行頭にスペースを 2 つ連ねた後に、''​*'' ​(番号無し)または ​''​-'' ​(番号付き)を記述します。+| Image | ''​gif''​''​jpg''​, ''​png'' ​ | 
 +| Video | ''​webm'',​ ''​ogv'',​ ''​mp4''​ | 
 +| Audio | ''​ogg'',​ ''​mp3'',​ ''​wav'' ​ | 
 +| Flash | ''​swf'' ​                   |
  
-  * リストです +If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
-  * 2番目の要素です +
-    * 入れ子にもできます +
-  * 次の要素です+
  
-  ​番号付きリストです +By adding ''?​linkonly''​ you provide a link to the media without displaying it inline 
-  - 次の要素です + 
-    - 入れ子にするにはインデントを深くします +  {{wiki:​dokuwiki-128.png?​linkonly}} 
-  - 以上です+ 
 +{{wiki:​dokuwiki-128.png?​linkonly}} This is just a link to the image. 
 + 
 +==== Fallback Formats ==== 
 + 
 +Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility. 
 + 
 +For example consider this embedded mp4 video: 
 + 
 +  {{video.mp4|A funny video}} 
 + 
 +When you upload a ''​video.webm''​ and ''​video.ogv''​ next to the referenced ''​video.mp4'',​ DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser. 
 + 
 +Additionally DokuWiki supports a "​poster"​ image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''​video.jpg''​ file would work. 
 + 
 +===== Lists ===== 
 + 
 +Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''​*''​ for unordered lists or a ''​-''​ for ordered ones. 
 + 
 +  * This is a list 
 +  * The second item 
 +    * You may have different levels 
 +  * Another item 
 + 
 +  ​The same list but ordered 
 +  - Another item 
 +    - Just use indention for deeper levels 
 +  - That's it
  
 <​code>​ <​code>​
-  * リストです +  * This is a list 
-  * 2番目の要素です +  * The second item 
-    * 入れ子にもできます +    * You may have different levels 
-  * 次の要素です+  * Another item
  
-  - 番号付きリストです +  - The same list but ordered 
-  - 次の要素です +  - Another item 
-    - 入れ子にするにはインデントを深くします +    - Just use indention for deeper levels 
-  - 以上です+  - That's it
 </​code>​ </​code>​
  
-[[doku>ja:faq:lists|リストに関する ​FAQ]] も参照してください。+Also take a look at the [[doku>​faq:​lists|FAQ ​on list items]].
  
-===== テキストの変換 ​=====+===== Text Conversions ​=====
  
-DokuWiki ​は特定の文字や文字列を、画像や他のテキスト、HTML などに変換することができます。+DokuWiki ​can convert certain pre-defined characters or strings into images or other text or HTML.
  
-テキストから画像への変換機能は、主にスマイリーで使用されます。テキストから ​HTML への変換機能は記号の変換に使用されますが、他の ​HTML に変換するように設定することもできます。+The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements,​ but can be configured to use other HTML as well.
  
-==== テキストから画像への変換 ​====+==== Text to Image Conversions ​====
  
-DokuWiki ​は一般的に使用されている[[wp>empticon|顔文字]]を、同じような見た目を持つ画像に変換します。このような[[doku>ja:​smileys|スマイリー]]や他の画像は、独自の設定で拡張することもできます。標準で使用できるスマイリーは以下の通りです。+DokuWiki ​converts commonly used [[wp>emoticon]]s to their graphical equivalents. Those [[doku>Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
  
   * 8-) %%  8-)  %%   * 8-) %%  8-)  %%
ライン 244: ライン 253:
   * DELETEME %% DELETEME %%   * DELETEME %% DELETEME %%
  
-==== テキストから ​HTML への変換 ​====+==== Text to HTML Conversions ​====
  
-記号: [[DokuWiki]] ​は、特定の文字列を活字表記的に同等な文字に変換することができます。以下に認識される文字列の例を示します。+Typography: [[DokuWiki]] ​can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
  
 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
ライン 256: ライン 265:
 </​code>​ </​code>​
  
-同様にして、どのような ​HTML でも[[doku>ja:entities|パターンファイル]]を設定しておけば生成することができます。+The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>​entities|pattern file]].
  
-パターンファイル設定による変換には、3 つの例外があります。掛け算記号 ​(640x480)'シングルクォート' ​および ​"ダブルクォート" ​です。これらの変換は、[[doku>:ja:config:​typography|設定オプション]]からオフにすることができます。+There are three exceptions which do not come from that pattern file: multiplication entity ​(640x480)'single' ​and "double quotes". They can be turned off through a [[doku>​config:​typography|config option]].
  
-===== 引用 ​=====+===== Quoting ​=====
  
-ある文が、返信であったり、コメントであるということを表現したい場合もあります。その場合、次の記法を使います。+Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:
  
-  やった方が良いと思うけど。 +<code
-   +I think we should do it
-  ​いや、やるべきではない! +
-   +
-  >> まあ、やるべきでしょうね。 +
-   +
-  > ほんとに? +
-   +
-  >> 本気です! +
-   +
-  >>>​ では、やりましょう!+
  
-やった方が良いと思うけど。+> No we shouldn'​t
  
-いや、やるべきではない!+>> Well, I say we should
  
->> まあ、やるべきでしょうね。+Really?
  
-ほんとに?+>> Yes!
  
->> ​本気です!+>>> Then lets do it! 
 +</​code>​
  
->>>​ では、やりましょう!+I think we should do it
  
 +> No we shouldn'​t
  
-===== 表 =====+>> Well, I say we should
  
-簡単な記法で表を作成できます。+> Really?
  
-^ 見出し 1     ^ 見出し 2      ^ 見出し 3         ^ +>> Yes!
-| 行 1 列 1    | 行 1 列 2     | 行 1 列 3        | +
-| 行 2 列 1    | 列の結合 (後の縦線が2つであることに注意) || +
-| 行 3 列 1    | 行 3 列 2     | 行 3 列 3        |+
  
-表の各行は通常 ​ ''​|''​ (縦線)ではじめます。見出し行については、 ''​^''​ (ハット記号)ではじめます。+>>>​ Then lets do it!
  
-  ^ 見出し 1     ^ 見出し 2      ^ 見出し 3         ^ +===== Tables =====
-  | 行 1 列 1    | 行 1 列 2     | 行 1 列 3        | +
-  | 行 2 列 1    | 列の結合 (後の縦線が2つであることに注意) || +
-  | 行 3 列 1    | 行 3 列 2     | 行 3 列 3        |+
  
-セルを水平に結合するには、上記のように、後のセルの中身を完全に無しにします。 +DokuWiki supports a simple syntax to create tables.
-セルの区切りとなる縦線やハット記号は、どの行も同じ数だけ必要ですので注意してください。+
  
-列見出しも可能です。+^ Heading 1      ^ Heading 2       ^ Heading 3          ^ 
 +| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | 
 +| Row 2 Col 1    | some colspan (note the double pipe) || 
 +| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
  
-            ​見出し 1             ^ 見出し 2         ^ +Table rows have to start and end with a ''​|''​ for normal rows or a ''​^''​ for headers.
-^ 見出し 3    | 行 1 列 2            | 行 1 列 3        | +
-^ 見出し 4    | 列の結合は今回は無し |                  | +
-^ 見出し 5    | 行 2 列 2            | 行 2 列 3        |+
  
-つまり、セルの前にある区切りの記号によって、様式が変化します。+  ^ Heading 1      ^ Heading 2       ^ Heading 3          ^ 
 +  | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | 
 +  | Row 2 Col 1    | some colspan (note the double pipe) || 
 +  | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
  
-  |             ^ 見出し 1             ^ 見出し 2         ^ +To connect cells horizontally,​ just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!
-  ^ 見出し 3    | 行 1 列 2            | 行 1 列 3        | +
-  ^ 見出し 4    | 列の結合は今回は無し |                  | +
-  ^ 見出し 5    | 行 2 列 2            | 行 2 列 3        |+
  
-行を結合することもできます。行の結合をする場合は、結合対象セルの下のセルの中に '':::''​ という文字列を入力します。+Vertical tableheaders are possible, too.
  
-見出し ​    ​見出し ​    ​見出し ​    ^ +|              ​Heading ​           Heading ​         ^ 
-行 列 1    | 行の結合 ​    行 列    +Heading ​   Row Col 2          ​Row Col        
-| 行 2 列 1    ​| ​:::          ​行 2 列 3    ​+^ Heading 4    ​| ​no colspan this time                    
-| 行 3 列 1    ​| ​:::          ​| ​行 列    |+^ Heading 5    ​| ​Row 2 Col 2          ​| ​Row Col        |
  
-これらのセルに '':::''​ 以外の文字列を入力することはできません。+As you can see, it's the cell separator before a cell which decides about the formatting:
  
-  ^ 見出し ​    ​見出し ​    ^ 見出し 3     +  ​|              ​Heading ​           Heading ​         
-  | 行 列 1    | 行の結合 ​    行 列    +  ​^ Heading 3    ​Row Col 2          ​Row Col        
-  ​| 行 2 列 1    ​| ​:::          ​行 2 列 3    ​+  ​^ Heading 4    ​| ​no colspan this time                    
-  ​| 行 3 列 1    ​| ​:::          ​| ​行 列    |+  ​^ Heading 5    ​| ​Row 2 Col 2          ​| ​Row Col        |
  
-表の内容の配置を指定できます。2個以上のスペースをテキストの反対側に置きます。 +You can have rowspans (vertically connected cells) by adding ''​%%:::​%%''​ into the cells below the one to which they should connect.
-つまり、右揃えにするには左側に2個のスペースを、左揃えにするには右側に2個のスペースを置きます。 +
-中央揃えにするにはテキストの両側に2個以上のスペースを置きます。+
  
-             ​配置を指定した表 ​           ​^^^ +Heading 1      ​Heading 2                  ​Heading 3          ​
-           右|    ​中央 ​     |左            ​+Row 1 Col 1    ​this cell spans vertically | Row 1 Col 3        | 
-|左            ​           右|    ​中央 ​     ​|+| Row 2 Col 1    | :::                        | Row 2 Col 3        | 
 +| Row 3 Col 1    | :::                        | Row 2 Col 3        | 
 + 
 +Apart from the rowspan syntax those cells should not contain anything else. 
 + 
 +  ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ 
 +  ​Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        ​
 +  Row 2 Col 1    ​:::                        ​Row 2 Col 3        | 
 +  | Row 3 Col 1    | :::                        | Row 2 Col 3        | 
 + 
 +You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. 
 + 
 +^           Table with alignment ​          ^^^ 
 +|         ​right| ​   center ​   |left          | 
 +|left          |         ​right| ​   center ​   |
 | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
-上記のソースは次のようになります。+This is how it looks in the source:
  
-  ^              ​配置を指定した表 ​           ​^^^ +  ^           Table with alignment ​          ^^^ 
-  |            右|    ​中央 ​     ​|左            ​+  |         right|    ​center ​   ​|left          ​
-  |左            ​           右|    ​中央 ​     ​|+  |left          ​        right|    ​center ​   ​|
   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
-===== 整形の無効化 ​=====+Note: Vertical alignment is not supported. 
 + 
 +===== No Formatting ​=====
  
-もし入力した通りに ​(何も整形せずに表示する必要がある場合は、''​%%<​nowiki>​%%'' ​タグか、よりシンプルに 2 つの連続したパーセント記号 ​''<​nowiki>​%%</​nowiki>'' ​で挟みます。+If you need to display text exactly like it is typed (without any formatting), enclose the area either with ''​%%<​nowiki>​%%'' ​tags or even simpler, with double percent signs ''<​nowiki>​%%</​nowiki>''​.
  
 <​nowiki>​ <​nowiki>​
-このテキストには ​http://​www.splitbrain.org ​のようなアドレスや**整形記法**を含みますが、実際には何も整形されません。+This is some text which contains addresses like this: http://​www.splitbrain.org ​and **formatting**, but nothing is done with it.
 </​nowiki>​ </​nowiki>​
-同様に ​%%//__この__スマイリー付きの//テキスト ​;-)%% も整形されません。+The same is true for %%//__this__ text// with a smiley ​;-)%%.
  
   <​nowiki>​   <​nowiki>​
-  ​このテキストには ​http://​www.splitbrain.org ​のようなアドレスや**整形記法**を含みますが、実際には何も整形されません。+  ​This is some text which contains addresses like this: http://​www.splitbrain.org ​and **formatting**, but nothing is done with it.
   </​nowiki>​   </​nowiki>​
-  ​同様に ​%%//__この__スマイリー付きの//テキスト ​;-)%% も整形されません。+  ​The same is true for %%//__this__ text// with a smiley ​;-)%%.
  
-===== コードブロック ​=====+===== Code Blocks ​=====
  
-2 つ以上の半角スペースでインデントするか、''​%%<​code>​%%'' ​もしくは ​''​%%<​file>​%%'' ​タグを使用することにより、コードブロックを記述することができます。+You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags ''​%%<​code>​%%'' ​or ''​%%<​file>​%%''​.
  
-  ​このテキストは 2 つの半角スペースによってインデントされています。+  ​This is text is indented by two spaces.
  
 <​code>​ <​code>​
-整形済みのコードです。スペースの数が次のように保持されます。例、 ​                       ​<- ここ+This is preformatted code all spaces are preserved: like              ​<-this
 </​code>​ </​code>​
  
 <​file>​ <​file>​
-同様ですが、ファイルの内容を示すときに使います。+This is pretty much the same, but you could use it to show that you quoted a file.
 </​file>​ </​file>​
  
-上記のブロックは以下のようなソースから作成されています。+Those blocks were created by this source:
  
-    ​このテキストは 2 つの半角スペースによってインデントされています。+    ​This is text is indented by two spaces.
  
   <​code>​   <​code>​
-  ​整形済みのコードです。スペースの数が次のように保持されます。例、 ​                       ​<- ここ+  ​This is preformatted code all spaces are preserved: like              ​<-this
   </​code>​   </​code>​
  
   <​file>​   <​file>​
-  ​同様ですが、ファイルの内容を示すときに使います。+  ​This is pretty much the same, but you could use it to show that you quoted a file.
   </​file>​   </​file>​
  
-==== 構文のハイライト ​====+==== Syntax Highlighting ​====
  
-ソースコードの構文をハイライト表示して、読みやすくすることができます。[[http://​qbnz.com/​highlighter/​|GeSHi]] ​という汎用の構文ハイライトソフトを使用しており、GeSHi がサポートするすべての言語を扱うことができます。記法は、前述したコードブロックと同様ですが、言語の名称を ​''<​nowiki><​code java></​nowiki>'' ​や ''<​nowiki><​file java></​nowiki>'' ​のようにタグ内に記述します。+[[wiki:​DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://​qbnz.com/​highlighter/​|GeSHi]] ​Generic Syntax Highlighter -- so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<​nowiki><​code java></​nowiki>'' ​or ''<​nowiki><​file java></​nowiki>''​.
  
 <code java> <code java>
-/** +/**
  * The HelloWorldApp class implements an application that  * The HelloWorldApp class implements an application that
  * simply displays "Hello World!"​ to the standard output.  * simply displays "Hello World!"​ to the standard output.
ライン 408: ライン 417:
 </​code>​ </​code>​
  
-現在のところ、次の言語がサポートされています。//4csabapactionscript-french, actionscript,​ actionscript3, ​adaapacheapplescriptasmaspautohotkeyautoitavisynthawkbashbasic4glbfbibtexblitzbasicbnfboo, c, c_mac, ​caddclcadlispcfdgcfmcilclojurecmakecobolcppcpp-qtcsharpcsscuesheet, d, dcsdelphidiffdivdosdoteiffelemailerlangfofortranfreebasicfsharpgambas, genero, ​gdbglslgmlgnuplotgroovy, gettext, ​haskellhq9plushtmlidliniinnointercaliojava5javajavascriptjquerykixtartklonecklonecpplatexlisplocobasiclogtalklolcodelotusformulaslotusscriptlscriptlsl2luam68kmakemapbasicmatlabmirc, modula3, ​mmixmpasmmxmlmysqlnewlispnsisoberon2objcocaml-briefocamloobas, oracle8, ​oracle11pascal, perl, perl6perphp-briefphp, pike, pic16pixelbenderplsqlpovraypowerbuilderpowershellprogressprologpropertiesprovidexpurebasicpythonqbasicrailsrebolregrobotsrsplusrubysasscalaschemescilabsdlbasicsmalltalksmartysqlsystemverilogtclteratermtextthinbasictsqltyposcriptvbnetvbverilogvhdlvimvisualfoxprovisualprologwhitespace, winbatch, ​whoisxmlxorg_confxppz80//+The following language strings are currently recognized: ​//4cs 6502acme 6502kickass 6502tasm 68000devpac ​abap actionscript3 ​actionscript ada aimms algol68 ​apache applescript ​apt_sources arm asm asp asymptote autoconf ​autohotkey autoit avisynth awk bascomavr ​bash basic4gl ​batch bf biblatex ​bibtex blitzbasic bnf boo caddcl cadlisp ​ceylon ​cfdg cfm chaiscript chapel ​cil c_loadrunner ​clojure ​c_mac cmake cobol coffeescript c cpp cpp-qt ​cpp-winapi ​csharp css cuesheet ​c_winapi dart dcl dcpu16 ​dcs delphi diff div dos dot d ecmascript ​eiffel email epc e erlang ​euphoria ezt f1 falcon ​fo fortran freebasic ​freeswitch ​fsharp gambas gdb genero genie gettext ​glsl gml gnuplot ​go groovy ​gwbasic ​haskell ​haxe hicest ​hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel ​java5 java javascript ​jcl j jquery ​julia kixtart klonec klonecpp ​kotlin ​latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf ​make mapbasic ​mathematica ​matlab ​mercury metapost ​mirc mk-61 mmix modula2 modula3 ​mpasm mxml mysql nagios netrexx ​newlisp ​nginx nimrod ​nsis oberon2 objc objeck ​ocaml-brief ocaml octave ​oobas oorexx ​oracle11 ​oracle8 oxygene oz parasail parigp ​pascal ​pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender ​pli plsql postgresql postscript ​povray powerbuilder powershell ​proftpd ​progress prolog properties providex purebasic ​pycon pys60 python qbasic ​qml q racket ​rails rbs rebol reg rexx robots ​rpmspec ​rsplus ruby rust sas sass scala scheme scilab ​scl sdlbasic smalltalk smarty ​spark sparql ​sql standardml stonescript swift systemverilog ​tclegg ​tcl teraterm ​texgraph ​text thinbasic tsql twig typoscript ​unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch xbasic ​xml xojo xorg_conf xpp yaml z80 zxbasic//
  
-==== ダウンロード可能なコードブロック ====+There are additional [[doku>​syntax_highlighting|advanced options]] available for syntax highlighting,​ such as highlighting lines or adding line numbers.
  
-前述の ​''​%%<​code>​%%'' ​や ''​%%<​file>​%%'' ​タグを使用した場合、示されているコードをダウンロード可能にしたいと思われるかもしれません。以下のように言語名の後にファイル名を記入することで、そのコードをダウンロード可能にすることができます。+==== Downloadable Code Blocks ==== 
 + 
 +When you use the ''​%%<​code>​%%'' ​or ''​%%<​file>​%%'' ​syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:
  
 <​code>​ <​code>​
ライン 424: ライン 435:
 </​file>​ </​file>​
  
-構文のハイライトは不要だがダウンロードは可能にしたい場合は、''​%%<​code - myfile.foo>​%%'' ​のように言語の名称としてハイフンマイナス (''​-''​) を使用してください。+If you don't want any highlighting but want a downloadable file, specify a dash (''​-''​) as the language code: ''​%%<​code - myfile.foo>​%%''​.
  
-===== HTML や PHP の埋込み ===== 
  
-''​%%<​html>​%%''​ タグおよび ''​%%<​php>​%%''​ タグを使用することにより、HTML や PHP のコードを文書内に埋め込むことができます。ブロックレベルのコードを埋め込む場合は大文字のタグ (''​%%<​HTML>​%%''​ および ''​%%<​PHP>​%%''​) を使用してください。+===== Embedding ​HTML and PHP =====
  
-HTML の例:+You can embed raw HTML or PHP code into your documents by using the ''​%%<​html>​%%''​ or ''​%%<​php>​%%''​ tags. (Use uppercase tags if you need to enclose block level elements.) 
 + 
 +HTML example:
  
 <​code>​ <​code>​
 <​html>​ <​html>​
-これは ​<span style="​color:​red;​font-size:​150%;">​HTML ​インライン要素</​span>​です。+This is some <span style="​color:​red;​font-size:​150%;">​inline ​HTML</​span>​
 </​html>​ </​html>​
 <​HTML>​ <​HTML>​
-<p style="​border:​2px dashed red;">​これは ​HTML ブロックレベル要素です。</p>+<p style="​border:​2px dashed red;">​And this is some block HTML</​p>​
 </​HTML>​ </​HTML>​
 </​code>​ </​code>​
  
 <​html>​ <​html>​
-これは ​<span style="​color:​red;​font-size:​150%;">​HTML ​インライン要素</​span>​です。+This is some <span style="​color:​red;​font-size:​150%;">​inline ​HTML</​span>​
 </​html>​ </​html>​
 <​HTML>​ <​HTML>​
-<p style="​border:​2px dashed red;">​これは ​HTML ブロックレベル要素です。</p>+<p style="​border:​2px dashed red;">​And this is some block HTML</​p>​
 </​HTML>​ </​HTML>​
  
-PHP の例:+PHP example:
  
 <​code>​ <​code>​
 <php> <php>
-echo '​PHP ​によって生成されたロゴ:'; +echo 'The PHP version: '; 
-echo '<​img src="'​ . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '"​ alt="​PHP ロゴ"​ />'+echo phpversion(); 
-echo '​(HTML ​インライン要素を生成)';+echo ' (generated inline ​HTML)';​
 </​php>​ </​php>​
 <PHP> <PHP>
-echo '<​table class="​inline"><​tr><​td>​同様ですが、ブロックレベル要素の中にあります:</​td>';​ +echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​ 
-echo '<​td>​<img src="' . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '" alt="​PHP ロゴ"​ /></​td>';​+echo '<​td>'​.phpversion().'</​td>';​
 echo '</​tr></​table>';​ echo '</​tr></​table>';​
 </​PHP>​ </​PHP>​
ライン 464: ライン 476:
  
 <php> <php>
-echo '​PHP ​によって生成されたロゴ:'; +echo 'The PHP version: '; 
-echo '<​img src="'​ . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '"​ alt="​PHP ロゴ"​ />'+echo phpversion(); 
-echo '​(HTML ​インライン要素を生成)';+echo ' (inline ​HTML)';​
 </​php>​ </​php>​
 <PHP> <PHP>
-echo '<​table class="​inline"><​tr><​td>​同様ですが、ブロックレベル要素の中にあります:</​td>';​ +echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​ 
-echo '<​td>​<img src="' . $_SERVER['​PHP_SELF'​] . '?​='​ . php_logo_guid() . '" alt="​PHP ロゴ"​ /></​td>';​+echo '<​td>'​.phpversion().'</​td>';​
 echo '</​tr></​table>';​ echo '</​tr></​table>';​
 </​PHP>​ </​PHP>​
  
-****: HTML と PHP の埋込みはデフォルトの設定では無効になっています。無効のままですと、コードは実行されずにそのまま表示されます。+**Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. 
 + 
 +===== RSS/ATOM Feed Aggregation ===== 
 +[[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://​simplepie.org/​|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:​ 
 + 
 +^ Parameter ​ ^ Description ^ 
 +| any number | will be used as maximum number items to show, defaults to 8 | 
 +| reverse ​   | display the last items in the feed first | 
 +| author ​    | show item authors names | 
 +| date       | show item dates | 
 +| description| show the item description. If [[doku>​config:​htmlok|HTML]] is disabled all tags will be stripped | 
 +| nosort ​    | do not sort the items in the feed | 
 +| //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | 
 + 
 +The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki:​DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[wiki:​DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered.
  
-===== RSS/ATOM フィードの取り込み ===== +By default the feed will be sorted by date, newest items firstYou can sort it by oldest first using the ''​reverse''​ parameter, or display the feed as is with ''​nosort''​.
-[[DokuWiki]]は外部のXMLフィードからのデータを統合できます。XMLフィードの解析には [[http://​simplepie.org/​|SimplePie]] を使っています。DokuWikiではSimplePieが解釈可能な全てのフォーマットが利用できます。スペースで区切られた複数の引数で表示をカスタマイズできます: +
-^  パラメータ ​ ^    意 味    ^ +
-| 数字 ​        | 最大表示数。デフォルト8 | +
-reverse ​    | 表示順を逆にする。 | +
-| author ​     | 作者を表示する。 | +
-| date        | 日付を表示する。 | +
-| description | 概要を表示する。 含まれる全てのHTMLタグは無効になります。 | +
-| 数字[dhm] ​  | 更新間隔。数字の後の文字の意味は d=日、h=時間、m=分。(例 12h = 12時間) |+
  
-更新間隔のデフォルトは4時間です。10分未満の値は10分として扱われます。通常[[DokuWiki]]はページのキャッシュされたバージョンを提供しようとしますので、動的な外部の内容を含めるのは明らかに不適当です。このパラメータによって、ページが最後に描画されてから//​更新間隔//​以上経っていたら[[DokuWiki]]はキャッシュを破棄して再描画をします。+**Example:​**
  
-**例:**+  {{rss>​http://​slashdot.org/​index.rss 5 author date 1h }}
  
-  ​{{rss>​http://​slashdot.jp/slashdotjp.rss 5 author date 1h }}+{{rss>​http://​slashdot.org/index.rss 5 author date 1h }}
  
-{{rss>​http://​slashdot.jp/​slashdotjp.rss 5 author date 1h }} 
  
-===== 制御用のマクロ ​=====+===== Control Macros ​=====
  
-いくつかの構文は、それ自身は出力されないものの、DokuWiki ​の動作に影響を及ぼします。以下のような制御用のマクロが利用可能です。+Some syntax influences how DokuWiki ​renders a page without creating any output it self. The following control macros are availble:
  
-マクロ ​         ​説明 ​+Macro           Description ​
-| %%~~NOTOC~~%% ​  ​| ​このマクロがページ上にあった場合、目次が生成されなくなります。 ​+| %%~~NOTOC~~%% ​  ​| ​If this macro is found on the page, no table of contents will be created ​
-| %%~~NOCACHE~~%% | デフォルトでは、DokuWiki ​はすべての出力をキャッシュします。この動作は、場合によっては望まれないことがあります ​(%%<​php>​%% ​タグが使用されている場合など)。このマクロを追加することにより、DokuWiki ​に毎回強制的にページを再描画させることができます。 ​|+| %%~~NOCACHE~~%% | DokuWiki ​caches all output by default. Sometimes this might not be wanted ​(eg. when the %%<​php>​%% ​syntax above is used), adding this macro will force DokuWiki ​to rerender a page on every call |
  
-===== 記法のプラグイン ​=====+===== Syntax Plugins ​=====
  
-DokuWiki ​の記法は、 ​[[doku>ja:plugins|プラグイン]] を使って拡張することができます。各プラグインの使用方法は、各プラグインの解説ページにあります。この ​DokuWiki ​では、次の記法プラグインが使用可能となっています。+DokuWiki's syntax can be extended by [[doku>​plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular ​DokuWiki ​installation:​
  
 ~~INFO:​syntaxplugins~~ ~~INFO:​syntaxplugins~~
  
wiki/syntax.txt · 最終更新: 2018/09/08 19:56 (外部編集)