こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
Markdownが開発者の間では有名ですが、他にも記法は存在します。今回はその中の一つ、MediaWikiの書き方を紹介します。MediaWikiは世界で最も有名なWikiサイトであるWikipediaで利用されている記法になります。
記法はHelp:書式整形 – MediaWikiに記載されている内容に沿って紹介します。
目次
文字装飾
MediaWiki記法でサポートされている文字装飾記法は次の通りです。
MediaWiki | 内容 |
---|---|
''斜体'' |
iタグ |
'''太字''' |
bタグ |
'''''太字の斜体''''' |
iタグとbタグ |
適用外
MediaWiki記法を適用したくない場合は nowiki
タグを使います。
<nowiki>[[ウィキ]]''マークアップ''なし</nowiki>
見出し
見出しは =
で文字を囲みます。Wikipediaではh1タグは使えませんが、その他で利用する場合には = 見出し1 =
から利用できます。
== レベル 2 ======== レベル 6 ======
水平線
水平線は -
を4つつなげます。
----
リスト
リストは番号なし、番号あり、そして定義リストの3つが用意されています。
番号なしリスト
* リスト1** リスト1-1** リスト1-2** リスト2** リスト2-1** リスト2-2
番号ありリスト
# リスト1## リスト1-2## リスト2# リスト2-1## リスト2-2
定義リスト
;項目 1: 定義 1;項目 2: 定義 2-1: 定義 2-2
HTMLは次のように出力されます。
項目 1定義 1項目 2定義 2-1定義 2-2
インデント
インデントは行頭に :
を書きます。 :
の数によって深さが変わります。
: 一個のインデント:: 二個のインデント::::: 多数のインデント
HTMLは次のように出力されます。
一個のインデント二個のインデント多数のインデント
整形済みテキスト
preタグを使った表示は行頭に空白を入れて行います。
行頭に空白を挿入。テキストが'''整形済み'''になり''マークアップ''も'''''可能'''''。
利用できるHTMLタグ
上記の他、いくつかのHTMLタグの利用が許容されています。
- ins
- u
- s
- del
- code
- blockquote
- q
- pre
- br
コメントも利用できます。
<!--これは表示されません-->
リンク
MediaWikiはWikiエンジンなので、一般的なWikiのようにブラケット [[]]
を使ったサイト内リンク作成が可能です。
[[リンク]]
外部の場合は [URL タイトル]
という形式で記述します。
[https://notepm.jp/ NotePM]
テーブル
表組みは以下のように各行ずつ、縦に並べて書いていくのが特徴です。
{|| 1980| Ultra Wave|-| 1988| What's Bootsy Doin'?|-| 1994| Blasters of the Universe|-| 1994| Fresh Outta 'P' Uni|}
この内容は次のように出力されます。
1980Ultra Wave1988What's Bootsy Doin'?1994Blasters of the Universe1994Fresh Outta 'P' Uni
画像
MediaWikiでは次のようなフォーマットで画像を表示できます。
[[File:filename.extension|options|caption]]
なお、この方式はGitHubのREADME上では利用できないようです(via Mediawiki Pictures not shown in Github Wiki · Issue #193 · github/markup)
まとめ
MediaWikiは一般的なWikiの記法を踏襲しつつ、テーブルのような表現力を高める工夫が行われています。HTMLも使えるので、足りない部分を補うこともできるでしょう。普段Wikiを使ってコンテンツを蓄積されている方にとっては馴染みやすいフォーマットかも知れません。
NotePM(ノートピーエム) は、Webで簡単にマニュアル作成できて、強力な検索機能でほしい情報をすぐに見つけられるサービスです。さまざまな業界業種に導入されている人気サービスで、大手IT製品レビューサイトでは、とくに『使いやすいさ・導入しやすさ』を高く評価されています。
NotePMの特徴
- マニュアル作成、バージョン管理、社外メンバー共有
- 強力な検索機能。PDFやExcelの中身も全文検索
- 社内FAQ・質問箱・社内ポータルとしても活用できる
- 銀行、大学も導入している高度なセキュリティ。安全に情報共有できる
URL: https://notepm.jp/