以前のリビジョンの文書です

編集ヘルプ

本Wikiで採用しているDokuWikiでの書式、及び記事編集時によく使うであろうプラグインについて説明しています。
各ページのソースは、ページ右側の「文書の編集」（スマートフォンからはプルダウンで選択）から閲覧可能です。
編集の感触を確かめたい場合はプレイグラウンドページで練習して下さい。
一部の書式はクイックボタンからも挿入可能です。

このページの内容は、Wiki付属の英語版ページを元にしています。英語版ページも参照可能ですが、一部、本Wikiでカスタマイズした内容と合いません。

基本的なテキスト書式

**太字**　//斜体字//　__下線付き__　''等幅フォント''　　**__//''全部または一部を混ぜられます''//__**
**改行をまたいでも
へーきへーき！ まっかせてー！**

太字　斜体字　下線付き　等幅フォント　　全部または一部を混ぜられます
改行をまたいでも
へーきへーき！ まっかせてー！ 

<sub>下付き文字（subscript）</sub>と<sup>上付き文字（superscript）</sup>　<del>取り消し線</del>

下付き文字（subscript）と上付き文字（superscript）　取り消し線 

段落の途中で
改行出来ます。バックスラッシュ（一部環境からは円記号）2つを連ねて\\ 空白を置いても改行出来ます。行の途中で改行したい場合は\\ そうして下さい。
バックスラッシュの後にスペースを置かないと改行されません。\\ほらね。

空行を置くと改段落となります。



ただ改行するだけだと2行以上は空かないので、2行以上開けたい場合はバックスラッシュ×2×（開けたい行数）を置いて下さい。空白も忘れずに。\\ \\ \\
それはそうと私はコツメカワウソちゃんがすきです

段落の途中で
改行出来ます。バックスラッシュ（一部環境からは円記号）2つを連ねて
空白を置いても改行出来ます。行の途中で改行したい場合は
そうして下さい。
バックスラッシュの後にスペースを置かないと改行されません。\\ほらね。

空行を置くと改段落となります。

ただ改行するだけだと2行以上は空かないので、2行以上開けたい場合はバックスラッシュ×2×（開けたい行数）を行末に置いて下さい。空白も忘れずに。



それはそうと私はコツメカワウソちゃんがすきです

注釈：1)

リンク

一口に「リンク」と言っても色々あります。

外部リンク（このWikiの外のページ）

URLは「 http://www.google.co.jp 」「 www.google.co.jp 」のように自動認識されます。
当然、「[[http://www.google.co.jp|Google Japan]]」のようにリンクテキストも指定可能です。
一応、メールアドレスも <hogehoge@example.com> ってな感じで記載可能（このWikiでは多分いらない）。

URLは「 http://www.google.co.jp 」「 www.google.co.jp 」のように自動認識されます。
当然、「Google Japan」のようにリンクテキストも指定可能です。
一応、メールアドレスも hogehoge@example.com ってな感じで記載可能（このWikiでは多分いらない）。

内部リンク（このWikiの中のページ）

文字列を四角括弧2つで囲むと、それをページ名として内部リンクを張れます。[[:index]]
リンクテキストは、そのページで指定されたタイトルに自動で差し替わります。
「[[:index|全てが始まるページ]]」こんな感じで文字列指定も可能。

文字列を四角括弧2つで囲むと、それをページ名として内部リンクを張れます。index
リンクテキストは、そのページで指定されたタイトルに自動で差し替わります。
「全てが始まるページ」こんな感じで文字列指定も可能。

注釈：2)

DokuWikiでは、「名前空間」と呼ばれる物をコロン「:」で指定します（PukiWikiとかで言う所のスラッシュ「/」に当たる）。 

[[s:17-09-02-18-29]]といったページにも名前空間を利用しています。
[[index]]←トップページにリンクしたいのですが、これではいけません。
このヘルプページは「wiki」という名前空間に属していて、さっきの例だと「wiki:index」という存在しないページにリンクしようとしました（「相対パス」のため）。
[[:index]]←こうすれば大丈夫です（「絶対パス」）

17-09-02-18-29といったページにも名前空間を利用しています。
index←トップページにリンクしたいのですが、これではいけません。
このヘルプページは「wiki」という名前空間に属していて、さっきの例だと「wiki:index」という存在しないページにリンクしようとしました（「相対パス」のため）。
index←こうすれば大丈夫です（「絶対パス」）

注釈：3)

Interwiki

Interwikiは、他のWikiやサイトへのリンクを素早く作成出来る機能です。
通常ではわざわざURLを入力する必要がありますが、Interwikiによってそれを簡略化しています。
当Wikiでは、DokuWiki付属のInterwiki（上記のDokuWikiサイトリンク参照）の他、関連Wiki・関連サイトへのInterwikiも追加で利用可能です。 

「[[wp>Wiki]]」で、ウィキペディアに飛びます（ただし英語版なので、日本語がいい場合（殆どそうだろ）は「[[wp>ja:ウィキ]]」のようにして下さい）。[[google>ジャガーマンシリーズ|ググる]]事も出来ます（キーワードを元に無作為選出のページに飛ばされる）。

「Wiki」で、ウィキペディアに飛びます（ただし英語版なので、日本語がいい場合（殆どそうだろ）は「ja:ウィキ」のようにして下さい）。ググる事も出来ます（キーワードを元に無作為選出のページに飛ばされる）。 

[[nicovideo>sm31854709|ジャガーマン]]・[[nicouser>68325696|千賀さん]]・[[nicomylist>59812084|すまんマイリスト]]

ジャガーマン・千賀さん・すまんマイリスト 

[[jmswiki>FrontPage|あっちのトップページ]]・[[jmswiki>用語集|用語集で教えてもらうんだ！]]

あっちのトップページ・用語集で教えてもらうんだ！

画像リンク

当Wikiではあまり出番が無いかもしれませんが、Wikiにうpした画像（後述）を内部／外部リンクに使えます。 

[[http://php.net|{{wiki:dokuwiki-128.png}}]]

※リンクの表題については、この画像以外の整形記法は使えません。

画像とリンクの整形記法（画像については後述）は全てサポートされています（画像のリサイズ、内部／外部画像4)、URL、Interwikiリンク等）。

脚注

半角の丸括弧2つで囲むと、そこが脚注になります。 

文章((脚注のサンプルです。))文章の続き

文章5)文章の続き

見出し

5階層までの見出しを作れます。
当Wikiでは、1階層目の見出しをページタイトルとして最上部に設置しています。
なので本格的に使うのは2階層目からです。
上の「見出し」って大きく書いてあるのが2階層目の見出しです。
見出しが3つ以上ある場合、目次が自動生成されます。
ページ内容に~~NOTOC~~を含めると、そのページでは目次を生成しないようになります（当Wikiではほぼ使わないけど）。 

==== 見出しレベル3 ====
=== 見出しレベル4 ===
== 見出しレベル5 ==

見出しレベル3

見出しレベル4

見出しレベル5

水平線 

半角ダッシュ（マイナス）を4つ以上連ねると
----
水平線でぶった切られます。

半角ダッシュ（マイナス）を4つ以上連ねると

水平線でぶった切られます。

メディアファイル

文中に画像を使えます（他にも動画ファイルや音声ファイルを使えるらしい）。
波括弧2つでファイル名を囲って下さい。サイズ指定も可能です。 

サイズ変更無し:                        {{wiki:dokuwiki-128.png}}

幅サイズ指定:            {{wiki:dokuwiki-128.png?50}}

幅・高さサイズ指定: {{wiki:dokuwiki-128.png?200x50}}

外部画像（当Wikiでは非推奨）:           {{http://php.net/images/php.gif?200x50}}

サイズ変更無し:                      

幅サイズ指定:          

幅・高さサイズ指定:

外部画像（当Wikiでは非推奨）:          

注釈：6)

次のように半角スペースを挿入すると、画像の位置を指定出来ます。 

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}



画像にタイトルを指定出来ます（大体のブラウザではツールチップとして表示されます。画像の上にマウスポインタを置くと浮かび上がってくるアレです）。 

{{ wiki:dokuwiki-128.png |ここはキャプションだよ！ 私はサーバル！}}

ここはキャプションだよ！ 私はサーバル！

画像にハイパーリンクを張る方法は上述しています。

Supported Media Formats

DokuWiki can embed the following media formats directly.

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.

By adding ?linkonly you provide a link to the media without displaying it inline 

{{wiki:dokuwiki-128.png?linkonly}}

dokuwiki-128.png 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
  1. The same list but ordered
  2. Another item
    1. Just use indention for deeper levels
  3. That's it
  * 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

Also take a look at the FAQ on list items.

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, but can be configured to use other HTML as well.

Text to Image Conversions

DokuWiki converts commonly used emoticons to their graphical equivalents. Those Smileys and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • 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 © ™ ®
"He thought 'It's a man's world'…" 

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

The same can be done to produce any kind of HTML, it just needs to be added to the pattern file.

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 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: 

I think we should do it

> No we shouldn't

>> Well, I say we should

> Really?

>> Yes!

>>> Then lets do it!

I think we should do it

No we shouldn't
Well, I say we should
Really?
Yes!
Then lets do it!

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 | for normal rows or a ^ for headers. 

^ 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        |

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!

Vertical tableheaders are possible, too.

Heading 1 Heading 2
Heading 3 Row 1 Col 2 Row 1 Col 3
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 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

You can have rowspans (vertically connected cells) by adding ::: into the cells below the one to which they should connect.

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

This is how it looks in the source: 

^           Table with alignment           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| 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), enclose the area either with <nowiki> tags or even simpler, with double percent signs %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
The same is true for //__this__ text// with a smiley ;-). 

<nowiki>
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
</nowiki>
The same is true for %%//__this__ text// with a smiley ;-)%%.

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 <code> or <file>. 

This is text is indented by two spaces.
This is preformatted code all spaces are preserved: like              <-this
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: 

  This is text is indented by two spaces.
<code>
This is preformatted code all spaces are preserved: like              <-this
</code>
<file>
This is pretty much the same, but you could use it to show that you quoted a file.
</file>

Syntax Highlighting

DokuWiki can highlight sourcecode, which makes it easier to read. It uses the 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. <code java> or <file java>. 

/**
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

The following language strings are currently recognized: 4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, actionscript3, ada, algol68, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic

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: 

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>
myexample.php
<?php echo "hello world!"; ?>

If you don't want any highlighting but want a downloadable file, specify a dash (-) as the language code: <code - myfile.foo>.

Embedding HTML and PHP

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: 

<html>
This is some <span style="color:red;font-size:150%;">inline HTML</span>
</html>
<HTML>
<p style="border:2px dashed red;">And this is some block HTML</p>
</HTML>

This is some <span style="color:red;font-size:150%;">inline HTML</span> 

<p style="border:2px dashed red;">And this is some block HTML</p>

PHP example: 

<php>
echo 'The PHP version: ';
echo phpversion();
echo ' (generated inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td>'.phpversion().'</td>';
echo '</tr></table>';
</PHP>

echo 'The PHP version: '; echo phpversion(); echo ' (inline HTML)'; 

echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
echo '<td>'.phpversion().'</td>';
echo '</tr></table>';

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, 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 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. 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 DokuWiki to re-render the page if it is more than refresh period since the page was last rendered.

By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the reverse parameter, or display the feed as is with nosort.

Example: 

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

Control Macros

Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:

Macro Description
~~NOTOC~~ If this macro is found on the page, no table of contents will be created
~~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's syntax can be extended by 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:

1)
通常のDokuWiki記法では、改行の際に必ずバックスラッシュが必要です。本Wikiではxbrプラグインを導入する事で、ただ改行するだけでも反映されるようにしています。
2)
DokuWikiでのページ名には、当然、文字制限があります。こちらで解説されていますが、当Wikiでは、ページ作成のルールに従っていれば大丈夫なはずです。アルファベットの大文字が小文字に自動変換されますが、どうしようもないので服従しましょう。因みに、日本語も大丈夫です。
3)
当Wikiではあまり気にする必要はありませんが、詳細についてはこちらをご覧下さい。
4)
当Wikiでは、外部画像は非推奨としています。
5)
脚注のサンプルです。
6)
幅と高さ両方を指定した際、アスペクト比が元画像と合わない場合は、リサイズの前に新しいアスペクト比に切り落とされます。
  • wiki/syntax.1524306381.txt.gz
  • 最終更新: 2018/04/21 19:26
  • by 北海道ゆっくり放送（管理人）