galaxy9est
Museのマークアップ規則

日本語での情報が少ないと思われる部分から書いていくつもりです。オリジナルサイトでのEmacs Muse version 3.12(2014/09/25現在)のマニュアルベースです。

publish
原文ではPDF/HTMLなどのファイルを生成することをpublishと読んでいます。出版/発行/発刊という意味です。このサイトでは「HTMLを生成する」という表現を用いようと思います。うまく表現できないときは、「publishする」、と表現します。

段落

見出し

muse自体は見出しレベルがいくつでもpublishができるようです。生成する文書(HTMLやPDFなど)のスタイルによるけれど、ほとんどの文書スタイルではレベル4まで生成できるそうです。HTMLファイル生成ではいくつまで対応しているか確認していませんが、レベル4までを使うのが無難だと思います。

* 一番大きな見出し
** 2番目のレベル
*** 3番目のレベル
**** 4番目のレベル

museドキュメント先頭に記述するディレクティブ

#title タイトル
  ドキュメントのタイトルです。HTMLでの<title>に相当します。
  このディレクティブがないと、ファイル名(.museというサフィックスを除いた部分)がタイトルになります。

テキストの強調、イタリック、下線など

脚注

どうも日本人であるせいか、私にはこの「詩」というのがどのようなときに使うべきなのか、よくわかりません。

恐らく、ですが、muse本家のクイックスタート日本語版の訳は誤っているように思います。

「空白文字は保持されるが、等幅文字は使用しない」

ではないかと思います。例の出力でも、そうなっているように見えます。

リスト

ネストされたリスト

ネストされたリスト(リストの項目内にさらにリストが存在すること)も記述することができます。リストの”レベル”は、行先頭の空白の数で決ります(ちなみに行先頭に空白がないのが通常のテキスト)。

以下の例では、通常のテキスト、レベル1に番号のない箇条書き、レベル2に番号付き箇条書き、レベル3に定義リストが記述されています。

通常のテキスト

 - レベル1、箇条書きその1
  1. レベル2、番号付き箇条書きその1
  2. レベル2、番号付き箇条書きその2
 - レベル1、箇条書きその2
  1. レベル2、番号付き箇条書きその3
  2. レベル2、番号付き箇条書きその4
   項目 :: 項目の定義

リスト項目の区切り

項目を改行し一行空行の次の行に同じリストレベルからリスト識別し無しで行を開始することで行えます。

試したところ、期待した(?)HTMLファイルを生成することができませんでした。このため、私のサイトではこの機能を使用していません。この機能の動作が確認できた方は、galaxy_at_black-hole.squares.netまで連絡くださるとありがたいです(_at_は実際には「@」で、メールアドレスです)。その時は、この部分をその内容で更新するつもりです。

 - レベル1、箇条書きその1の1行目

 レベル1、箇条書きその1の2行目
  1. レベル2、番号付き箇条書きその1
   - レベル3、箇条書きその1
 - レベル1、箇条書きその2

ハイパーリンクと電子メールアドレス

直接書いたURL、WikiName、InterWikiのリンク

画像の出版と表示

画像リンク

Muse modeでの画像の表示

単なる画像表示

キャプション付き画像

水平線とアンカー

Emacs Lisp

引用

HTMLドキュメントでは使用しないようです。

コメント

「;」(半角セミコロン)で始まる行は、HTMLファイルには出力されません。以下の例は全角セミコロンを使用していますが、実際には半角です。

; Comment text goes here.

Museが認識するタグ

museは、HTMLと似た記述フォーマットのタグを認識します。

文法

引数を持たず、かつタグでテキストを囲む必要が無いときは以下のように記述します。

<tagname>

タグが引数を持つときは、以下のように記述します。

<tagname arg1="string1" arg2="string2">

タグは、XHTML文書風に記述することもできます。

<tagname arg1="string1" arg2="string2" />

タグがテキストを囲んでいる場合は以下のように記述します。

<tagname>テキスト</tagname>

長い文章を囲みたいときは以下のように記述します。

<tagname>
テキスト。
さらにテキスト。
</tagname>

使用できるタグ一覧

'<br>'
改行です。HTMLでの改行タグと同じです。
'<cite>'
引用。
'<class>'
HTML文書専用。HTMLでのclassタグを出力します。これで囲まれたテキストは、生成されたHTMLファイルでは<span>タグで囲まれます。name引数が<span>でのclass属性となります。

例えば、

<class name="hogehoge">cssを利用して装飾できます</class>

は、HTMLでは以下のように出力されます。

<span class="hogehoge">cssを利用して装飾できます</span>
'<code>'
code
'<command>'
command
'<comment>'
comment
'<contents>'
contents
'<div>'
div
'<example>'
example
'<include>'
異なるmuseファイルのインクルード(挿入)。
'<lisp>'
lisp
'<literal>'
literal
'<markup>'
markup
'<perl>'
perl
'<python>'
python
'<quote>'
quote
'<ruby>'
ruby
'<src>'
src
'<verbatim>'
verbatim
'<verse>'
verse