増井ラボノート コロンブス日和

第17回 Scrapbox(2)

この記事を読むのに必要な時間:およそ 3 分

Scrapboxの記法

前回では,シンプルで強力なWikiシステム「Scrapbox」の概要を紹介しましたが,今回はScrapboxの機能についてより詳しく紹介したいと思います。

Scrapboxでは,簡潔なマークアップ記法により,他のページへのリンクを張ったり,外部Webページへのリンクを張ったり,画像や動画を表示したり,文字修飾を行ったりすることができます。現在広く利用されているHTMLは「HyperTextMarkup Language」の略であり,テキストの装飾やリンクなどを指定するために<b><a>のような各種のマークアップ(タグ)が利用されています。

HTMLはあらゆるブラウザで利用できるので便利ですが,仕様が巨大で覚えるのが大変ですし,単に文字を太くするだけのために<b></b>のような記述をしなければならないのは面倒です。このため最近は「Markdown」のような簡易マークアップ言語が人気があるようです。MarkdownはHTMLに比べると記述が簡潔ですしリスト1)⁠GitHubなど多くのサービスで利用できるので便利です。

リスト1 Markdownの記述例

# Gyaim

* [MacRuby](http://www.macruby.org/)で作ったMac用のIMEです。
* 数百行のRubyで実用レベルのIMEを作れることを示すものです
* 単純な変換しかできませんがそれなりに使えます
* 見栄えはInterfaceBuilderで簡単に変更できます
* 変換アルゴリズムやIMEの動作はRubyで簡単に変更できます
* 自前のIMEをいろいろ作りましょう!
* 変換手法はSlimeと同じです
* 予測機能はありません
## インストール

一方,Markdownで画像やリンクを表現するための言語仕様は,かなり複雑なため覚えるのが困難です。たとえば,リスト1の[タイトル](URL)のような記法は私にはなかなか覚えられません。実際にマークアップはHTMLを併用して使われていることもあるようなので,Markdownの存在価値を私は疑問に感じています。

Scrapboxのマークアップ

Scrapboxでは極力簡単に目的を達成できるような簡単で強力なマークアップ記法を採用しています。基本的には,

  • あらゆるマークアップは角カッコ・([ ... ])で表現する
  • 記述の制約をできるだけ緩くする

という方針に基づいています。

内部リンク

テキスト内の文字列を[]で囲むと,囲んだ部分がその名前のページへのリンクになります。たとえばScrapboxの文中で[増井]と記述すると「増井」というページへのリンクになります。

外部リンク

外部のWebページにリンクを張りたいときは,[URLタイトル]のように記述します。これは<a href="URL">タイトル</a>のようなHTMLに変換されます。[タイトル URL]のようにURLとタイトルを逆順に書いても同じ結果になるので,順番について気にする必要はありません。

画像や動画の埋め込み

テキスト中に[画像URL]と書くと,その場所に画像が表示されます。また[画像URL リンクURL]と書くとURLへのリンクを持つ画像が表示されます。この場合も,URLの順番は逆でも大丈夫です。画像URLの代わりにYouTubeやVimeoのURLを書くとページに動画が埋め込まれます。

文字修飾

[* ... ]のような記法で太字や斜体を表現できます。[* abc]と書くとabcのように太字になり,[/ abc]と書くとabcのように斜体になり,[/* abc]と書くとabcのように太字の斜体になります。

アイコン記法

図1 [増井.icon]の表示結果

図1

[増井.icon]と書くと,⁠増井」というページの代表画像が,アイコンのように行の中に表示されるようになっています図1)⁠

図2 [増井.icon*10]の表示結果

図2

アイコンをたくさん並べることもできます。たとえば[増井.icon*10]と記述すると,アイコンが10個並びます図2)⁠

図3 Scrapboxページへの適用結果

図3 Scrapboxページへの適用結果

このような「アイコン記法」を利用すると,Scrapboxページを絵文字のように利用できて便利です図3)⁠

Wikiページ上で複数の人が編集を行った場合,誰がどの部分を書いたのかわからなくなって困ることがありますが,このようなアイコンを常に書く習慣をつけておけば,そういう問題が起きにくくなります。

コード記法

ちょっとしたプログラムをWeb上で公開したいとき,Gistのようなサービスにプログラムの断片を貼ることがありますが,Scrapboxページの中にコードを記述できます図4)⁠

図4 コード記法

図4 コード記法

コード記法したデータは「https://scrapbox.io/api/code/prog-exercises/モンテカルロ法で円周率を求める/pi.js」のようなURLでアクセスすることができます。

著者プロフィール

増井俊之(ますいとしゆき)

1959年生まれ。慶應義塾大学環境情報学部教授。ユーザーインターフェースの研究者。東京大学大学院を修了後,富士通半導体事業部に入社。以後,シャープ,米カーネギーメロン大学,ソニーコンピュータサイエンス研究所,産業技術総合研究所,Appleなどで働く。2009年より現職。携帯電話に搭載される日本語予測変換システム『POBox』や,iPhoneの日本語入力システムの開発者として知られる。近著に『スマホに満足してますか? ユーザインターフェースの心理学』。

コメント

コメントの記入