wiki記法ヘルプ/基礎

Last-modified: 2022-03-12 (土) 02:06:29

段落


他のブロック要素を明示しない限り、段落となります。新たなブロック要素が現われるまで継続します。
行頭で ~ を指定した場合も段落になります。行頭書式の文字(~、-、+、:、>、|、#、//)を通常の文字として段落の先頭に書きたい場合は、行頭に~を記述して書くことができます。

text
~ text
【表示例】

【表示例】
text
text

text

text

 

見出し


行頭で * を記述すると、見出しになります。見出しは *、**、*** の3段階あります。
自動的にアンカーが設定され、部分編集へのリンクを作成します。見出し以外の場所にアンカーを設定するには アンカーの設定 を参照してください。

* 見出し

行頭が #shadowheader で始まる行は目次に表示されない見出しになります。

#shadowheader(1,見出し)
【表示例】

【表示例】

見出し1

見出し2

見出し3

 

目次


行頭で #contents を記述すると、見出しに基づいて目次を作成します。一般的に #contents はページの最初のほうに記述します。

#contents
|#contents|

行頭で #contentsx を記述すると、見出しに基づいて目次を作成します。Wiki本体機能である #contents をプラグイン化したものです。詳細は contentsx.inc.php を参照してください。

#contentsx(オプション)
 

文字列


通常は入力した文章がそのまま出力されます。
HTMLのタグは効果がありません。書かれた文章はそのまま表示されます。
段落と段落の区切りには空行をはさんで下さい。空行をはさまず、連続している複数の行は同じ段落と解釈されます。

text
【表示例】

【表示例】
text
text
text

 

強調


文字を '' ではさむと、 強調表示 になります。

''text text text text text''
【表示例】

【表示例】
text text text text text

 

斜体


文字を ''' ではさむと、 斜体表示 になります。

'''text text text text text'''
【表示例】

【表示例】
text text text text text

 

取消線


文字を %% ではさむと、 取消線 が付きます。

%%text text text text text%%
【表示例】

【表示例】
text text text text text

 

下線


文字を %%% ではさむと、 下線 が付きます。

%%%text text text text text%%%
【表示例】

【表示例】
text text text text text

 

文字サイズ


文字サイズを指定することができます。サイズはピクセル単位(px)で指定します。

#size(サイズ){{
text
text
}}
&size(サイズ){text};
【表示例】

【表示例】

ここは
サイズ12pxです。

5px 10px 15px 20px 25px 30px


文字サイズを相対指定することができます。サイズは数字で指定します。

サイズ対応表

サイズ対応表

サイズHTML classfont-size
1size1xx-small
2size2x-small
3size3small
4size4medium
5size5large
6size6x-large
7size7xx-large
#sizex(サイズ){{
text
text
}}
&sizex(サイズ){text};
【表示例】

【表示例】

ここは
size5です。

size1 size2 size3 size4 size5 size6 size7

 

文字色


文字色と背景色を指定することができます。背景色は省略できます。
色の指定は、次のいずれかの形式で行ないます。

#color(foreground[,background]){{
text
}}
&color(foreground[,background]){text};
COLOR(色):
【表示例】

【表示例】

ここは
背景色black、文字色whiteです。

text text text text text
fffeeedddcccbbbaaa999888777666555444333222111000

 

フォント


フォントファミリーを指定することができます。*1

#font(<sans-serif | sans-serif-tight | serif | monospace | legacy-ui-gothic>){{
text
}}
&font(<sans-serif | sans-serif-tight | serif | monospace | legacy-ui-gothic>){text};
【表示例】

【表示例】

sans-serifゴシック体abc ABC 012 あいう アイウ 安以宇 012
sans-serif-tightタイトなゴシック書体abc ABC 012 あいう アイウ 安以宇 012
serif明朝体abc ABC 012 あいう アイウ 安以宇 012
monospace等幅abc ABC 012 あいう アイウ 安以宇 012
legacy-ui-gothic機種依存ゴシック書体abc ABC 012 あいう アイウ 安以宇 012
 

ふりがな(ルビ構造)


行中で &ruby を書くとルビをふることができます。ルビに対応していないブラウザではルビが本文中に ( と ) に囲まれて表示されます。

&ruby(ルビ){ruby};
【表示例】

【表示例】
ruby(ルビ)

 

ツールチップ


ツールチップを設定することができます。マウスカーソルを単語に合わせると、説明が出現します。

  • term にマウスカーソルを合わせると、ツールチップとして説明が出現する。
  • term が存在するページ名だった場合には、そのページへのリンクになる。
  • definition が有れば使用。
  • definition がなく、実在するページの名前だった場合は、そのページの最初の見出しを使用(99行分探索)。
  • definition の中に&br;(改行)と&t;(タブ)を含めることが出来る。

Wiki 全体にツールチップを設定するには Glossary を参照してください。

&tooltip(term){definition};
【表示例】

【表示例】
term
Glossary

 

伏せ字


ネタバレなどの記事やコメントを隠します。クリックで表示できます。

#ntbr(説明,マスク色,説明文字色){{
隠し文字
}}
&ntbr(マスク色){隠し文字};
&ntbr{隠し文字};
【表示例】

【表示例】

 
セル内をインラインで全て囲むとセルにマスクがかかります。
セル内をインラインで全て囲むとセルにマスクがかかります。
 

隠し文字
隠し文字

 

流れる文字


marqueeを表示します。表示するブラウザによっては正しく表示されないことがあります。

#marquee(文字列 ,[behavior] ,[loop] ,[bgcolor] ,[color] ,[size])

【表示例】

★彡 ★彡 ★彡
 

左・中・右寄せ


行頭で LEFT:、 CENTER:、 RIGHT: を記述すると左寄せ、センタリング、右寄せされます。

LEFT:LEFT
CENTER:CENTER
RIGHT:RIGHT
【表示例】

【表示例】

LEFT
CENTER
RIGHT
 

水平線・区切り線


行頭で4つ以上の - を書くと水平線になります。
行頭で #hr を記述すると、区切り線になります。

  • 区切り線は上位のブロック要素の幅の60%の長さの水平線がセンタリングされて引かれます。
----
#hr
【表示例】

【表示例】







 

改行・行間


行末に~を書くと行末改行になります。行末改行はブロック要素内での改行になります。
行末改行の次の行の行頭書式は無効になり、文字列として扱われます。

text~
【表示例】

【表示例】
text

text

text


改行、行間を開けることができます。

  • #brは、行末改行と違って、次の行の行頭書式を無効にはしません。
  • &br;は、行末改行と違って、定義リストの定義語や表組の要素、# で始まるブロック要素のパラメタの中でも使用できます。
#br
&br;
【表示例】

【表示例】

 

text

 

text


text

 

引用文


行頭で > を指定すると、引用文になります。引用文は >、>>、>>> の3レベルあります。

> 引用文 レベル1
>> 引用文 レベル2
>>> 引用文 レベル3
<<< 引用文 レベル2
<< 引用文 レベル1
【表示例】

【表示例】

引用文 レベル1

引用文 レベル2

引用文 レベル3

引用文 レベル2

引用文 レベル1

 

注釈


行中でインライン要素を (( と )) ではさむと、注釈が作成され、行中に注釈へのリンクが貼られます。

text((注釈))
【表示例】

【表示例】
text*2

 

整形済みテキスト


行頭が半角空白で始まる行は整形済みテキストとなります。

 text
【表示例】

【表示例】

text

行頭がシャープ半角空白(# )で始まる行はインライン要素が展開される整形済みテキストとなります。

# &color(green){text}; &huh;
【表示例】

【表示例】

text  [huh]

行頭が#preで始まる行は整形済みテキストとなります。

#pre{{
text
text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text
}}
【表示例】

【表示例】

text
text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text text

行頭が#codeで始まる行はシンタックスハイライトされた整形済みテキストとなります。

対応している言語一覧*4

対応している言語一覧

aabap, actionscript, ada, apacheconf, apl, applescript, arff, asciidoc, asm6502, aspnet, autohotkey, autoit
bbash, basic, batch, brainfuck, bro
cc, clojure, coffeescript, cpp, csharp, csp, css-extras
dd, dart, diff, django, docker
eeiffel, elixir, elm, erb, erlang
fflow, fortran, fsharp
ggedcom, gherkin, git, glsl, go, graphql, groovy
hhaml, handlebars, haskell, haxe, hpkp, hsts, http
iichigojam, icon, inform7, ini, io
jj, java, jolie, json, jsx, julia
kkeyman, kotlin
llatex, less, liquid, lisp, livescript, lolcode, lua
mmakefile, markdown, markup-templating, matlab, mel, mizar, monkey
nn4js, nasm, nginx, nim, nix, nsis
oobjectivec, ocaml, opencl, oz
pparigp, parser, pascal, perl, php, php-extras, powershell, processing, prolog, properties, protobuf, pug, puppet, pure, python
qq, qore
rr, reason, renpy, rest, rip, roboconf, ruby, rust
ssas, sass, scala, scheme, scss, smalltalk, smarty, soy, sql, stylus, swift
ttap, tcl, textile, tsx, tt2, twig, typescript
vvbnet, velocity, verilog, vhdl, vim, visual-basic
wwasm, wiki
xxeora, xojo, xquery
yyaml
#code(Language){{
code...
}}
【表示例】

【表示例】

  • Go
    package main
    import "fmt"
    
    func greet(lang string) {
    	fmt.Printf("Hello, %s!\n", lang)
    }
    func main() {
    	greet("Go")
    }
  • JavaScript
    void function () {
    	const greet = lang=>console.log(`Hello, ${lang}!`)
    	greet("JavaScript")
    }()
  • Nim
    import strformat
    
    proc greet (lang: string) =
      echo fmt"Hello, {lang}!"
    when isMainModule:
      greet("Nim")
  • Pyhton
    #!/usr/bin/env python
    def greet (lang):
        print('Hello, %s!' % lang)
    if __name__ == '__main__':
        greet('Python')
  • Rust
    fn greet(lang: &str) {
        println!("Hello, {}!", lang)
    }
    fn main() {
        greet("Rust")
    }

行頭が#aaで始まる行は整形済みテキストとなります。

#aa{{
    _  _
   '´   ヽト、       / ̄ ̄ ̄ ̄ ̄
  i iノリノ))))┘    |
  !_(li ゚ ー゚ノ!|      < なにカナ? なにカナ?
    ⊂l卯つ        |
    く>ェ1        \_____
    し'ノ
}}
【表示例】

【表示例】

    _  _
   '´   ヽト、       / ̄ ̄ ̄ ̄ ̄
  i iノリノ))))┘    |
  !_(li ゚ ー゚ノ!|      < なにカナ? なにカナ?
    ⊂l卯つ        |
    く>ェ1        \_____
    し'ノ
 

コメント


行頭で // を指定すると、コメント行になります。コメント行は出力されない行です。

// コメント

コメントを指定することができます。

#null{{
これは
複数行の
コメントです。
}}
text&null{行中にコメントを記述できます。};text
|te&null{テーブル内にコメントを記述できます。};xt|
|&null{テーブル内に};abc&null{コメントを};def&null{記述できます。};|
【表示例】

【表示例】

texttext

text
abcdef
 

リンク

行中に直接、URLを記述した場合は自動的にそのURLに対するリンクが貼られます。

https://example.com/
【表示例】

【表示例】
https://example.com/


行中に InterWiki形式 [[リンク名:URL]]、 エイリアス形式 [[リンク名>URL]] を記述すると、そのリンク名でURLに対するリンクを貼ることができます。

[[リンク名:URL]]
[[リンク名>URL]]
 

ページ名


[[ と ]] で囲まれた文字列はページ名へのリンクになります。

  • ページ名の中には、全角文字、記号、数字、半角空白文字を含めることができます。
  • ページ名の中には、"#&<> を含めることはできません。
  • すでに存在するページであればそのページへのリンクが自動的に貼られます。存在しない場合はページ名の後ろに?が自動的に付き、そのページを新規作成するためのリンクが貼られます。
  • ページ名にアンカー名をつけることもできます。
[[ページ名]]
[[ページ名#アンカー名]]
【表示例】

【表示例】
FrontPage
ページ名?
ページ名#anchor?

 

InterWiki


行中のページ名形式の文字列の中で、: で2つの文字列を区切るとInterWikiになります。
ページ名の後ろにアンカー名をつけることもできます。

[[InterWikiName:ページ名]]
[[InterWikiName:ページ名#アンカー名]]
 

エイリアス


行中のページ名形式の文字列の中で、> で2つの文字列を区切るとエイリアスになります。

  • エイリアスはページ名の別名で、指定したページへのリンクを貼ります。
  • カレントページのアンカーへリンクを貼る場合はページ名を省略することができます。
  • エイリアスをURLやInterWikiと組み合わせることもできます。
[[エイリアス名>ページ名]]
[[エイリアス名>#アンカー名]]
[[エイリアス名>ページ名#アンカー名]]
[[example.edu>https://example.edu/]]
[[Example.comとは>WikiPedia:Example.com]]
 

アンカーの設定


リンクのアンカーを設定することができます。リンクの飛び先にしたい位置に記述します。
半角アルファベットから始まる半角アルファベット・数字・ハイフン・アンダースコアからなる文字列を指定します。全角文字や半角空白文字、半角記号を含めることはできません。
見出し には自動的にアンカーが設定されます。

#aname(アンカー名)
&aname(アンカー名);
&aname(アンカー名){text};
 

添付ファイル・画像の貼り付け


ページの添付ファイルの一覧を表示し、ファイル添付のための入力フォームを設置します。

#attach([nolist][,noform])
【表示例】

【表示例】

JavaScript を有効にしてください

添付ファイルまたは指定されたURLにあるファイルへのリンクを貼り付けることができます。ファイルが画像ファイルの場合は、その画像を表示します。

#ref([pagename/]attached-file-name[,parameters, ... ][,sizing option][,title])
&ref([pagename/]attached-file-name[,parameters, ... ][,sizing option][,title]);
【表示例】

【表示例】

point.png
代替文字

添付(#attach)とその場への参照(&ref(...);)を同時に行えます。

#attachref([pagename/]attached-file-name[,parameters, ... ][,sizing option][,title])
&attachref([pagename/]attached-file-name[,parameters, ... ][,sizing option][,title]);
【表示例】
 

テキストの回り込みの解除


#ref で指定したテキストの回り込みを解除します。指定をしなくても、記事の末尾でテキストの回り込みが自動的に解除されます。

#clear
#img(,clear)
【表示例】

【表示例】

point.png

回り込み
回り込み

回り込み解除

point.png

回り込み
回り込み

回り込み解除

 

リスト構造

番号付きリスト


行頭で + を指定すると、番号付きリストになります。番号付きリストは +、++、+++ の3レベルあります。

+ レベル1
++ レベル2
+++ レベル3
++ レベル2
+ レベル1
【表示例】

【表示例】

  1. レベル1
    1. レベル2
      1. レベル3
    2. レベル2
  2. レベル1
 

番号なしリスト


行頭で - を指定すると、番号なしリストになります。番号なしリストは -、--、--- の3レベルあります。

- レベル1
-- レベル2
--- レベル3
-- レベル2
- レベル1
【表示例】

【表示例】

  • レベル1
    • レベル2
      • レベル3
    • レベル2
  • レベル1
 

定義リスト


行頭を : で始め、| 記号で区切ると、定義リストになります。定義リストは :、::、::: の3段階あります。定義リストの定義語、説明文は省略することができます。複数の連続した定義リストを記述し、2つ目以降の定義語を省略することで1つの定義語に対する複数の説明文を記述することができます。

:定義語|説明文
::定義語|説明文
:::定義語|説明文
::定義語|説明文
:定義語|説明文
【表示例】

【表示例】

定義語
説明文
定義語
説明文
定義語
説明文
定義語
説明文
定義語
説明文
 

表組み


行頭を | で始め、| 記号で区切ると、表組みになります。

  • 行末に c を記述すると、書式指定行となります。
  • 行末に h を記述すると、ヘッダ行になります。(thead)
  • 行末に f を記述すると、フッタ行になります。(tfoot)
  • セル内の先頭に ~ を記述すると、ヘッダになります。(th)
  • セル内に > を単独で記述すると右のセルと連結します。(colspan)。
  • セル内に ~ を単独で記述すると上のセルと連結します。(rowspan)。

書式指定行、各要素の先頭では、次の記述子が指定できます。

text-alignLEFT:CENTER:RIGHT:
vertical-alignTOP:MIDDLE:BOTTOM:
background-colorBGCOLOR(色):
colorCOLOR(色):
font-sizeSIZE(サイズ):
  • 要素の表示位置及び背景色・文字色・文字サイズ(px単位)を指定します。デフォルトは左寄せ、中央寄せになります。
  • 書式指定行では、記述子の後ろに数値を記述すると、セル幅がpx単位で指定できます。
| text | text |
【表示例】

【表示例】

texttext
 
theadtheadthead
tfoottfoottfoot


thcolspan


rowspanth
SIZE(5)
cell
BGCLOR(pink)


cell
COLOR(green)
th




 

CSV形式の表組み


行頭でカンマ(,)を記述し、インライン要素をカンマ区切りで記述すると表組みになります。

  • インライン要素はダブルクォーテーション(")で囲むことができます。ダブルクォーテーションで囲むことで、カンマ(,)を含むインライン要素を記述できます。
  • ダブルクォーテーション(")で囲んだデータの中で、ダブルクォーテーションを2つ("")続けることで、ダブルクォーテーション(")を含むインライン要素を記述できます。
  • インライン要素の代わりにイコールを2つ(==)記述すると、colspanを意味します。
  • インライン要素の左に1つ以上の半角空白文字を記述すると右寄せに、インライン要素の左右に1つ以上の半角空白文字を記述するとセンタリングになります。
,text,text,…
【表示例】

【表示例】

texttext
 

表組みの並べ替え


表を並べ替えることができます。複雑な表組には対応しておりません。
表は必ずhヘッダ行(thead)を記述してください。

#tablesort{{
表
}}
【表示例】

【表示例】

NumberCharacterSymbol/None
PaddingFloat
5000010.1d
4000100.01b
3001000.05e
2010000.1001a
1100001.1c
 

編集可能テーブル


表の編集が簡単に出来るようになるプラグイン
1ページに4つまで設置できます。

#table_edit(表ページの名前,ソート文字列)
 

*1 文字のレイアウトが崩れる: https://zawazawa.jp/wikiwiki/topic/25
*2 注釈*3
*3 注釈の注釈
*4 CodeMirror:Language Modes