MediaWikiの書き方(Wikipediaで利用されている記法)

2023年08月14日(月) Markdown

社内のナレッジ共有・マニュアル作成を成功させるツール「NotePM」→無料で使ってみる【1分で登録完了】

こんにちは。マニュアル作成・ナレッジ共有ツール「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は次のように出力されます。

<dl>
<dt> 1</dt>
<dd> 1</dd>
<dt> 2</dt>
<dd> 2-1</dd>
<dd> 2-2</dd>
</dl>

インデント

インデントは行頭に : を書きます。 : の数によって深さが変わります。

:
::
:::::

HTMLは次のように出力されます。

<dl>
<dd>
<dl>
<dd>
<dl>
<dd>
<dl>
<dd>
<dl>
<dd></dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>
</dd>
</dl>

整形済みテキスト

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

この内容は次のように出力されます。

<table>
<tbody>
<tr>
<td>1980</td>
<td>Ultra Wave</td>
</tr>
<tr>
<td>1988</td>
<td>What's Bootsy Doin'?</td>
</tr>
<tr>
<td>1994</td>
<td>Blasters of the Universe</td>
</tr>
<tr>
<td>1994</td>
<td>Fresh Outta 'P' Uni</td>
</tr>
</tbody>
</table>

画像

MediaWikiでは次のようなフォーマットで画像を表示できます。

[[File:filename.extension|options|caption]]

なお、この方式はGitHubのREADME上では利用できないようです(via Mediawiki Pictures not shown in Github Wiki · Issue #193 · github/markup

まとめ

MediaWikiは一般的なWikiの記法を踏襲しつつ、テーブルのような表現力を高める工夫が行われています。HTMLも使えるので、足りない部分を補うこともできるでしょう。普段Wikiを使ってコンテンツを蓄積されている方にとっては馴染みやすいフォーマットかも知れません。

 

この資料でわかること

• 個人のノウハウを引き出す社内wikiとは?
• 社内wikiを導入し浸透させるために必要なこと
• 社内wikiツールの選び方

 

おすすめの情報共有ツール「NotePM」

NotePM

NotePM(ノートピーエム) は、Webで簡単にマニュアル作成できて、強力な検索機能でほしい情報をすぐに見つけられるサービスです。さまざまな業界業種に導入されている人気サービスで、大手IT製品レビューサイトでは、とくに『使いやすいさ・導入しやすさ』を高く評価されています。

NotePMの特徴

  • マニュアル作成、バージョン管理、社外メンバー共有
  • 強力な検索機能。PDFやExcelの中身も全文検索
  • 社内FAQ・質問箱・社内ポータルとしても活用できる
  • 銀行、大学も導入している高度なセキュリティ。安全に情報共有できる

URL: https://notepm.jp/

NotePMについて詳しく見る >