差分
このページの2つのバージョン間の差分を表示します。
両方とも前のリビジョン 前のリビジョン 次のリビジョン | 前のリビジョン | ||
wiki:syntax [2009/02/01 03:50] – ともやん | wiki:syntax [2025/02/28 02:41] (現在) – 外部編集 非ログインユーザー | ||
---|---|---|---|
行 1: | 行 1: | ||
- | ====== | + | ====== |
- | 文章の整形を行うには、シンプルなマークアップ記法を用います。 | + | |
- | [[DokuWiki]] の記法は、ソース自体もできるだけ読みやすくなるよう考慮されています。 | + | |
- | 画面の上部か下部にある //編集// ボタンをクリックすると、ページのソースを見ることができます。 | + | |
- | このページでは、編集にあたって利用できる記法をすべて説明します。 | + | |
- | ためしに編集をしてみたい場合には、 [[playground: | + | |
- | 主な記法は、[[doku> | + | |
- | rafael | + | [[doku> |
- | ===== 基本的なテキスト整形 | + | ===== Basic Text Formatting |
- | 文字飾りとして | + | DokuWiki supports |
- | もちろん | + | |
- | | + | |
- | | + | |
- | さらに | + | You can use <sub>subscript</ |
- | | + | |
- | <del>取り消し線</ | + | You can mark something as <del>deleted</ |
- | <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. |
- | 段落内で | + | |
- | を 2 つ連ねた後に空白文字を置くか改行します。 | + | |
- | この文は改行\\ を含んでいます。2 連バックスラッシュが | + | 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 |
- | | + | |
- | | + | |
- | | + | |
- | 強制改行は、どうしても必要な場合だけ使ってください。 | + | You should use forced newlines only if really needed. |
- | ===== リンク | + | ===== Links ===== |
- | リンクの記述には様々な方法があります。 | + | DokuWiki supports multiple ways of creating links. |
- | ==== 外部リンク | + | ==== External |
- | http:// | + | External links are recognized automagically: |
- | 外部リンクとして自動的に認識されます。表題を指定して、 | + | |
- | [[http:// | + | |
- | メールアドレスも、不等号で括ると、 | + | |
- | http:// | + | |
- | 外部リンクとして自動的に認識されます。表題を指定して、 | + | automagically: |
- | [[http:// | + | |
- | | + | |
- | ==== 内部リンク | + | ==== Internal |
- | この DokuWiki 内のページへのリンクには 2 連角カッコを使います。ページ名そのままで | + | Internal links are created by using square brackets. You can either just give a [[pagename]] |
- | [[doku>pagename]] | + | |
- | ページ名は自動的に小文字に変換されます。特殊文字は使えません。 | + | |
- | | + | |
- | [[doku>pagename]] | + | |
- | ページ名は自動的に小文字に変換されます。特殊文字は使えません。 | + | |
- | ページ名をコロンで区切ると | + | [[doku> |
- | ページ名をコロンで区切ると | + | You can use [[some:namespaces]] |
- | 詳細は | + | You can use [[some:namespaces]] |
- | ページ中の特定のセクションにリンクすることも可能です。ハッシュ記号(# | + | For details about namespaces see [[doku> |
- | [[syntax# | + | |
- | | + | 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]]. |
- | 注: | + | This links to [[syntax# |
- | | + | Notes: |
- | * デフォルト設定では | + | |
- | * セクションの見出しが変更されると、そこへのリンク名も変化します。セクションへのリンクは多用しないほうが良いでしょう。 | + | |
+ | * DokuWiki does not use [[wp> | ||
+ | * When a section' | ||
==== Interwiki ==== | ==== Interwiki ==== | ||
- | [[doku>interwiki|Interwiki]] | + | DokuWiki supports |
- | InterWikiは、他の Wiki に手軽にリンクを張るための方法です。たとえば、 | + | |
- | [[wp> | + | |
- | [[doku>interwiki|Interwiki]] | + | |
- | InterWikiは、他の Wiki に手軽にリンクを張るための方法です。たとえば、 | + | |
- | [[wp> | + | |
- | ==== Windows共有フォルダ | + | ==== Windows |
- | Windows | + | Windows |
- | ただし、[[wp> | + | |
- | Windows | + | Windows |
- | 注: | + | Notes: |
- | * セキュリティ上、Windows 共有フォルダを直接ブラウズできるのは、デフォルトでは | + | * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer |
- | * 推奨はしませんが、Mozilla | + | * For Mozilla |
- | * 詳しくは | + | <?php |
+ | /** | ||
+ | * Customization of the english language file | ||
+ | * Copy only the strings that needs to be modified | ||
+ | */ | ||
+ | $lang[' | ||
+ | </ | ||
+ | ==== Image Links ==== | ||
+ | You can also use an image to link to another internal or external page by combining the syntax for links and [[# | ||
- | ==== 画像にリンク ==== | + | [[http:// |
- | リンク記法と | + | [[http:// |
- | 次のように、画像に内外部へのリンクをつけることができます。 | + | |
- | | + | Please note: The image formatting is the only formatting syntax accepted in link names. |
- | [[http:// | + | The whole [[# |
- | 注: リンクの表題については、この画像以外の整形記法は使えません。 | + | ===== Footnotes ===== |
- | [[# | + | |
- | (画像のサイズ変更や、内外部イメージ、URL 指定や interwiki リンクなど)。 | + | |
- | ===== 脚注 ===== | + | You can add footnotes ((This is a footnote)) by using double parentheses. |
- | 脚注 | + | You can add footnotes |
- | 脚注 ((これが脚注です)) には、2 連の丸カッコを用います。 | + | ===== Sectioning ===== |
- | ===== セクション見出し ===== | + | 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 ''< |
- | 最大 5 つのレベルまでの見出しを使って、文章の構造化を行えます。 | + | ==== Headline Level 3 ==== |
- | 3 つ以上の見出しを記述すると、目次が自動的に生成されます。 | + | === Headline Level 4 === |
- | 文書中に ''< | + | == Headline Level 5 == |
- | 目次の生成を止めることができます。 | + | |
- | ==== 第 3 見出し | + | |
- | === 第 4 見出し | + | === Headline Level 4 === |
- | == 第 5 見出し | + | == Headline Level 5 == |
- | ==== 第 3 見出し ==== | + | By using four or more dashes, you can make a horizontal line: |
- | === 第 4 見出し === | + | |
- | == 第 5 見出し == | + | |
- | + | ||
- | ダッシュ (-) を四つ以上続けると、水平線が書けます。 | + | |
---- | ---- | ||
+ | ===== Media Files ===== | ||
- | ===== 画像やその他のファイル ===== | + | You can include external and internal |
- | + | ||
- | 波カッコを使って、[[doku> | + | |
- | 実サイズ: {{wiki: | + | Real size: {{wiki: |
- | 幅を変更: {{wiki: | + | Resize to given width: {{wiki: |
- | 幅と高さを変更: {{wiki: | + | Resize to given width and height((when the aspect ratio of the given width and height doesn' |
- | 外部イメージのサイズを変更: | + | Resized external image: {{https://www.php.net/ |
- | | + | |
- | | + | |
- | | + | |
- | | + | |
- | 左右にスペース文字を記述すると、配置位置を指定できます。 | + | By using left or right whitespaces you can choose the alignment. |
{{ wiki: | {{ wiki: | ||
行 176: | 行 157: | ||
{{ wiki: | {{ wiki: | ||
- | さらに、タイトルも指定できます(ほとんどのブラウザで、ツールチップで表示されます)。 | + | Of course, you can add a title (displayed as a tooltip by most browsers), too. |
- | {{ wiki: | + | {{ wiki: |
- | {{ wiki: | + | {{ wiki: |
- | 画像 ('' | + | For linking an image to another page see [[#Image Links]] above. |
- | 画像を他のページへのリンクとするには、上記の [[# | + | ==== Supported Media Formats ==== |
- | ===== リスト ===== | + | DokuWiki can embed the following media formats directly. |
- | リスト(番号付き・番号無し)を利用できます。行頭にスペースを 2 つ連ねた後に、'' | + | | Image | '' |
+ | | Video | '' | ||
+ | | Audio | '' | ||
+ | | Flash | '' | ||
- | * リストです | + | If you specify a filename that is not a supported media format, then it will be displayed as a link instead. |
- | * 2番目の要素です | + | |
- | * 入れ子にもできます | + | |
- | * 次の要素です | + | |
- | | + | By adding ''? |
- | - 次の要素です | + | |
- | - 入れ子にするにはインデントを深くします | + | {{wiki: |
- | - 以上です | + | |
+ | {{wiki: | ||
+ | |||
+ | ==== 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 '' | ||
+ | |||
+ | Additionally DokuWiki supports a " | ||
+ | |||
+ | ===== Lists ===== | ||
+ | |||
+ | Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a '' | ||
+ | |||
+ | * This is a list | ||
+ | * The second item | ||
+ | * You may have different levels | ||
+ | * Another item | ||
+ | |||
+ | | ||
+ | - Another item | ||
+ | - Just use indention for deeper levels | ||
+ | - That's it | ||
< | < | ||
- | * リストです | + | * 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 |
</ | </ | ||
- | ===== スマイリー | + | Also take a look at the [[doku> |
+ | |||
+ | ===== Text Conversions | ||
+ | |||
+ | DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML. | ||
+ | |||
+ | The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, | ||
+ | |||
+ | ==== Text to Image Conversions | ||
- | [[wp> | + | DokuWiki converts commonly used [[wp> |
- | 使用できるスマイリーは次のとおりです。 | + | |
* 8-) %% 8-) %% | * 8-) %% 8-) %% | ||
行 232: | 行 247: | ||
* ;-) %% ;-) %% | * ;-) %% ;-) %% | ||
* ^_^ %% ^_^ %% | * ^_^ %% ^_^ %% | ||
+ | * m( %% m( %% | ||
* :?: %% :?: %% | * :?: %% :?: %% | ||
* :!: %% :!: %% | * :!: %% :!: %% | ||
行 238: | 行 254: | ||
* DELETEME %% DELETEME %% | * DELETEME %% DELETEME %% | ||
- | ===== 記号===== | + | ==== Text to HTML Conversions |
- | 記号を、普通の文字の組み合わせで記述することができます。認識される記号の例を次に示します。 | + | 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) | ||
行 250: | 行 266: | ||
</ | </ | ||
- | 注: [[doku> | + | The same can be done to produce any kind of HTML, it just needs to be added to the [[doku> |
- | ===== 引用 ===== | + | There are three exceptions which do not come from that pattern file: multiplication entity (640x480), ' |
- | ある文が、返信であったり、コメントであるということを表現したい場合もあります。その場合、次の記法を使います。 | + | ===== Quoting ===== |
- | やった方が良いと思うけど。 | + | Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: |
- | + | ||
- | > いや、やるべきではない! | + | |
- | + | ||
- | >> まあ、やるべきでしょうね。 | + | |
- | + | ||
- | > ほんとに? | + | |
- | + | ||
- | >> 本気です! | + | |
- | + | ||
- | >>> | + | |
- | やった方が良いと思うけど。 | + | < |
+ | I think we should do it | ||
- | > いや、やるべきではない! | + | > No we shouldn' |
- | >> | + | >> |
- | > ほんとに? | + | > Really? |
- | >> | + | >> |
- | >>> | + | >>> |
+ | </ | ||
+ | I think we should do it | ||
- | ===== 表 ===== | + | > No we shouldn' |
- | 簡単な記法で表を作成できます。 | + | >> Well, I say we should |
- | ^ 見出し 1 ^ 見出し 2 ^ 見出し 3 ^ | + | > Really? |
- | | 行 1 列 1 | 行 1 列 2 | 行 1 列 3 | | + | |
- | | 行 2 列 1 | 列の結合 (後の縦線が2つであることに注意) || | + | |
- | | 行 3 列 1 | 行 2 列 2 | 行 2 列 3 | | + | |
- | 表の各行は通常 | + | >> Yes! |
- | ^ 見出し 1 ^ 見出し 2 ^ 見出し 3 ^ | + | >>> |
- | | 行 1 列 1 | 行 1 列 2 | 行 1 列 3 | | + | |
- | | 行 2 列 1 | 列の結合 (後の縦線が2つであることに注意) || | + | |
- | | 行 3 列 1 | 行 2 列 2 | 行 2 列 3 | | + | |
- | セルを水平に結合するには、上記のように、後のセルの中身を完全に無しにします。 | + | ===== Tables ===== |
- | セルの区切りとなる縦線やハット記号は、どの行も同じ数だけ必要ですので注意してください。 | + | |
- | 列見出しも可能です。 | + | 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 | | ||
- | | | + | Table rows have to start and end with a '' |
- | ^ 見出し 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, |
- | ^ 見出し 3 | 行 1 列 2 | 行 1 列 3 | | + | |
- | ^ 見出し 4 | 列の結合は今回は無し | | | + | |
- | ^ 見出し 5 | 行 2 列 2 | 行 2 列 3 | | + | |
- | 注: 縦方向の結合 (行の結合) はできません。 | + | Vertical tableheaders are possible, too. |
- | 表の内容の配置を指定できます。2個以上のスペースをテキストの反対側に置きます。 | + | | ^ Heading 1 ^ Heading |
- | つまり、右揃えにするには左側に2個のスペースを、左揃えにするには右側に2個のスペースを置きます。 | + | ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | |
- | 中央揃えにするにはテキストの両側に2個以上のスペースを置きます。 | + | ^ Heading 4 | no colspan this time | | |
+ | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
- | ^ 配置を指定した表 | + | As you can see, it's the cell separator before a cell which decides about the formatting: |
- | | 右| | + | |
- | |左 | + | | ^ Heading 1 |
+ | | ||
+ | ^ Heading 4 | ||
+ | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 | | ||
+ | |||
+ | You can have rowspans (vertically connected cells) by adding '' | ||
+ | |||
+ | ^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | ||
+ | | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | ||
+ | | Row 2 Col 1 | ||
+ | | 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 | ||
+ | | | ||
+ | |left | | ||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | 上記のソースは次のようになります。 | + | This is how it looks in the source: |
- | ^ | + | ^ Table with alignment |
- | | 右| | + | | right| |
- | |左 | + | |left |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | ===== 整形されないブロック | + | Note: Vertical alignment is not supported. |
+ | |||
+ | ===== No Formatting | ||
+ | |||
+ | If you need to display text exactly like it is typed (without any formatting), | ||
+ | |||
+ | < | ||
+ | This is some text which contains addresses like this: http:// | ||
+ | </ | ||
+ | The same is true for %%// | ||
+ | |||
+ | < | ||
+ | This is some text which contains addresses like this: http:// | ||
+ | </ | ||
+ | The same is true for %%// | ||
+ | |||
+ | ===== Code Blocks ===== | ||
+ | |||
+ | 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 '' | ||
- | 整形が行われないブロックを記述することができます。2 つ以上のスペースでインデントする(前記の例を参照)か、'' | + | This is text is indented by two spaces. |
< | < | ||
- | 整形済みのコードです。スペースの数が次のように保持されます。例、 <- ここ | + | This is preformatted code all spaces are preserved: like |
</ | </ | ||
< | < | ||
- | 同様ですが、ファイルの内容を示すときに使います。 | + | This is pretty much the same, but you could use it to show that you quoted a file. |
</ | </ | ||
- | ある範囲に対して整形を完全に行わないようにするには、その範囲を '' | + | Those blocks were created by this source: |
- | <nowiki> | + | This is text is indented by two spaces. |
- | たとえば、アドレスを http:// | + | |
- | </nowiki> | + | |
+ | This is preformatted code all spaces are preserved: like <-this | ||
+ | </code> | ||
- | これらのブロックの使用については、このページのソースを見ると良いでしょう。 | + | < |
+ | This is pretty much the same, but you could use it to show that you quoted a file. | ||
+ | </ | ||
- | ===== 構文のハイライト ===== | + | ==== Syntax Highlighting |
- | ソースコードの構文をハイライト表示して、読みやすくすることができます。[[http:// | + | [[wiki: |
<code java> | <code java> | ||
- | /** | + | /** |
* The HelloWorldApp class implements an application that | * The HelloWorldApp class implements an application that | ||
* simply displays "Hello World!" | * simply displays "Hello World!" | ||
行 369: | 行 418: | ||
</ | </ | ||
- | 現在のところ、次の言語がサポートされています。// | + | The following language strings are currently recognized: |
- | ===== RSS/ATOM フィードの取り込み ===== | + | There are additional |
- | [[DokuWiki]]は外部のXMLフィードからのデータを統合できます。XMLフィードの解析には [[http:// | + | |
- | ^ パラメータ | + | |
- | | 数字 | + | |
- | | reverse | + | |
- | | author | + | |
- | | date | 日付を表示する。 | | + | |
- | | description | 概要を表示する。 含まれる全てのHTMLタグは無効になります。 | | + | |
- | | 数字[dhm] | + | |
- | 更新間隔のデフォルトは4時間です。10分未満の値は10分として扱われます。通常[[DokuWiki]]はページのキャッシュされたバージョンを提供しようとしますので、動的な外部の内容を含めるのは明らかに不適当です。ページが最後に描画されてから// | + | ==== Downloadable Code Blocks ==== |
- | **例:** | + | When you use the '' |
- | {{rss>http:// | + | <code> |
+ | <file php myexample.php> | ||
+ | <?php echo "hello world!"; | ||
+ | </file> | ||
+ | </ | ||
- | {{rss>http:// | + | <file php myexample.php> |
+ | <?php echo "hello world!"; | ||
+ | </file> | ||
+ | If you don't want any highlighting but want a downloadable file, specify a dash ('' | ||
- | ===== HTML や PHP の埋込み | + | ===== RSS/ATOM Feed Aggregation |
+ | [[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http:// | ||
- | HTML や PHP のコードを文書内に埋め込むことができます。'' | + | ^ Parameter |
- | < | + | | any number | will be used as maximum number items to show, defaults to 8 | |
- | < | + | | reverse |
- | This is some <font color=" | + | | author |
- | </ | + | | date | show item dates | |
- | </code> | + | | description| show the item description. All HTML tags will be stripped | |
+ | | nosort | ||
+ | | //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: |
- | This is some <font color=" | + | |
- | </html> | + | |
- | < | + | By default the feed will be sorted |
- | < | + | |
- | echo 'A logo generated | + | |
- | echo '<img src="' | + | |
- | </ | + | |
- | </ | + | |
- | < | + | **Example:** |
- | echo 'A logo generated by PHP:'; | + | |
- | echo '< | + | |
- | </ | + | |
- | **注**: HTML と PHP の埋込みは、デフォルトの設定では無効になっており、コードは実行されず、そのまま表示されます。 | + | {{rss> |
- | ===== 記法のプラグイン ===== | + | {{rss> |
- | DokuWiki の記法は、 [[doku> | ||
+ | ===== Control Macros ===== | ||
- | ~~INFO:syntaxplugins~~ | + | Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: |
+ | ^ Macro ^ Description | | ||
+ | | %%~~NOTOC~~%% | ||
+ | | %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%< | ||
+ | |||
+ | ===== Syntax Plugins ===== | ||
+ | |||
+ | DokuWiki' | ||
+ | |||
+ | ~~INFO: | ||