xml-mode簡易ガイド

目次

概要

xyzzyでXMLファイルを編集するためのモードです。YMTZさんのhtml+-modeをベースにXMLには不要と思われる機能を削除し、XMLに最低限必要な機能を追加しました。

追加した機能は以下の通りです。

空エレメント対応

<... />という形のタグに対応して、インデントや、状況判断を行います。

CDATA対応

<![CDATA[...]]>のなかはインデントや各種処理対象からはずします('や"の扱いにバグがあります)。

ドキュメントタイプによるキーワードの切り替え

ネームスペース対応

各ドキュメントタイプのキーワードをネームスペースを指定して複数読み込むことができます。

スタイルシートの適用

MSXSLまたはXTコマンドによりXML文書にスタイルシートを適用し、結果を別バッファに返します。

コマンド実行

ファイルの種類ごとに定められたコマンドを実行。デフォルトはブラウザで表示。

ダウンロード

NetInstallerを使うか手作業でインストールする方法のどちらかを選んでください。

• http://chez-sugi.net/xyzzy/packages.l←このURLをサイト一覧に追加してください。
• http://chez-sugi.net/xyzzy/xml-mode-2_091.lzh←手動インストール用

インストール

NetInstallerでインストールする方法はそちらのドキュメントを参照してください。ここでは手動による方法を説明します。

1. 解凍したファイルをそのままのディレクトリ構成でxyzzyをインストールしたディレクトリにコピーまたは移動します。
2. ~/.xyzzyやsiteinit.lに以下のコードを追加します。
   ~/.xyzzyに追加する場合

   (require "xml/xml-mode")
   (use-package 'xml)
   	  
   

3. 各ドキュメントタイプごとのキーワード色づけ、補完、コマンド実行などの機能を利用するには、さらにそれら用のファイルをrequireしてください。
4. 上記の設定を反映させるために、xyzzyを再起動します。

起動

M-x xml-modeと手動で実行すればカレントバッファがxml-modeになります。

また.xmlという拡張子のファイルを開くと自動でxml-modeになります。各ドキュメントタイプごとのファイルをロードすれば、それらの所定の拡張子のファイルを開くと、自動でxml-modeになります(2.08より*auto-mode-alist*の設定は不要になりました）。

さらに、文書中に<!-- -*- xml -*- -->というコメントを挿入しておくことにより、拡張子に関係なくopen時にxml-modeにすることもできます（xyzzyの機能）。このコメントはxml-insert-something(C-x C-i)コマンドにより挿入することができます。

ドキュメントタイプ

xml-modeでは各ドキュメントタイプごとにキーワードの色づけ・補完をしたり、そのドキュメントタイプ固有のコマンドを実行したりすることができます。これらの機能を利用するには、各ドキュメントタイプごとのファイルをロードする必要があります。現状サポートしているドキュメントタイプは以下の通りです。

必要なものだけ選んでロードしてください。

(require "xml/xhtml")	    
(require "xml/svg")	    
(require "xml/xslt")	    
(require "xml/xsl-fo")	    
(require "xml/mathml")	 	    
(require "xml/xlink")  	    	    
(require "xml/relaxng")
(require "xml/smartdoc")	    
(require "xml/xyzref")	    	    
(require "xml/xi")
(require "xml/xtemplate")
	  

キーバインド

ToDo

• ドキュメントタイプにjakarta-ant等を追加
• 状況に応じて補完の候補が絞りこまれるようにする
• わかりやすいドキュメントの作成
• msxsl.exeを使わないXSLT変換(実はxml::ole-xsl-transformでこっそり実装済み)
• そのほか募集中

履歴

2.06 - Thu, 23 Oct 2003 03:03:43 +0900

• CDATAの中に'や"が奇数個あるとCDATA以降が文字列として解釈されてしまうバグへの対応。ちょっと荒療治だが'や"を特別扱いするのをやめた。多分文字列の色付けができないほかは悪影響はないはず。
• NetInstaller対応。

2.05 - Thu, 29 May 2003 02:54:42 +0900

• *xml-indent-tabs-mode*という変数により、インデントにタブを使うかどうかを指定できるようにした。デフォルトはtでタブを使う。（西原さんのご提案）
• ハイライトした範囲にCDATAセクションが含まれていると、その部分のtext-attributeが消えてしまうバグの修正

2.04a - Sun, 02 Mar 2003 14:10:05 +0900

• xhtml.lの公開識別子、システム識別子がまちがっているという指摘があったので修正。

2.04 - Mon, 24 Feb 2003 04:28:06 +0900

• xml-entity-to-character, xml-character-to-entityのキーバインドをそれぞれESC C-c, ESC C-eに変更。
• xml-sanitizeをxml-sanitize-regionという関数名に変更。
• *xml-set-encoding-on-save*という変数をnilにすることにより保存時にxml宣言のencoding属性をみてencodingを変更するという機能をOFFにできるようにした。

2.03 - Thu, 20 Feb 2003 01:23:15 +0900

• xml的にはBOMつきのutf-8よりutf-8nで保存した方が無難なので、エンコーディングにutf-8が指定された場合はutf-8nで保存するようにした。この挙動は*xml-use-utf8n-encoding*という変数の値をnilにすることにより抑制できる。

2.02 - Fri, 14 Feb 2003 01:44:19 +0900

• 拙作のhtml-support.lの文字と文字実体参照の間の相互変換機能を取り込み。
• IEが&apos;をサポートしないので（というよりxhtmlをHTMLとしてしかみてくれないので）、xml-sanitizeで“'”は&#39;に変換するようにした。
• stylesheet宣言の挿入でtypeを選択させるようにした。

2.01 - Tue, 11 Feb 2003 01:29:37 +0900

• C-c sで",',&,<,>を変換する機能を追加。
• 文字列の中で"="を入力すると後ろに""が入力されてしまう場合があるのを修正。
• prefixなしの属性が補完候補に含まれなかったのを修正。
• XTemplateのキーワードを0.50相当に。

2.00 - Fri, 31 Jan 2003 00:40:56 +0900

• 誤って2.00RC4として修正途中のものを公開してしまった。本来2.00RC4として公開されるはずだったものを2.00正式版としてリリース。

2.00RC4 - Thu, 30 Jan 2003 01:29:10 +0900

• 補完候補に同じキーワードがいくつも追加されてしまうバグを修正。
• ハイライトの範囲を少しまともにした。

2.00RC3 - Wed, 29 Jan 2003 02:04:58 +0900

• XTemplate対応
• トップレベルのタグのxmlns属性をみて自動的にネームスペースを追加するようにした。
• それに伴い、拡張子を見てデフォルト以外のネームスペースを自動で追加する機能は廃止
• ドキュメントタイプの優先順位はDOCTYPE宣言→デフォルトネームスペース→拡張子
• ?の入力でその次の>を補完する機能の廃止。かわりにxml-insert-somethingでprocessing instructionを挿入できるようにした
• xml-insert-somethingでmode-comment(xyzzyがxml-modeにしてくれる魔法の呪文)を追加できるようにした

2.00RC2 - Tue, 28 Jan 2003 00:22:49 +0900

• RELAX NG, MathML対応
• 各ドキュメントタイプに関するいくつかの致命的なバグの修正
• このドキュメントの修正

2.00RC1 - Mon, 27 Jan 2003 02:24:51 +0900

• ディレクトリ階層をxmlの下に移動
• 違う階層で同じ要素名が使われたときにおかしくなるバグを修正
• xml宣言がないときには保存時の文字コード強制変更をやめた
• processing instructionの中で'?'が入力されたときは'>'を補うようにした
• xml-check-match-tagの処理を1.13より前に戻した
• DOCTYPEの定義を各タイプごとのファイルに分割した
• 日本語のタグも扱えるようにしたつもり
• 各DOCTYPEのキーワードをキーワードファイルから、リストで指定する方式に変更
• キーワードにxml:base追加
• DOCTYPEにXLink追加
• DOCTYPEからRelax削除(RelaxNGに置き換える予定)
• SmartDocへの対応を若干改善
• マークがない状態でコメントアウトしようとするとエラーになるバグを修正
• 文字実体参照の補完は&を入力してから働くようにした

1.13 - Sun, 22 Dec 2002 04:30:42 +0900

• Version Numberをつけるようにした。定数*xml-mode-version*に設定。
• 保存時にxml宣言のencodingの値を見てfileio-encodingを指定するようにした。
• '/', '='入力時にすでにその位置に'>', '"'がある場合には補完しないようにした。
• 開始タグだけでなく対象となる範囲全体をハイライトするようにした。
• xml-check-match-tagの処理を「現在位置からバッファを遡って最初に見つかった上位タグまでの整合性を調べる」というものから。より直感的に「現在のタグレベルの中の整合性を調べる」に変更。
• タグの中でxml-toggle-commentを実行した場合そのタグレベル全体をコメントアウトするようにした。
• DOCTYPEの定義をxml-doctypes.lに分離。

Sat, 16 Feb 2002 21:54:27 +0900

• xyzref形式（xyzzy reference,最新版はここ）に対応。

Sat, 16 Feb 2002 04:18:17 +0900

• RELAXとSmartDocに対応

Fri, 08 Feb 2002 01:22:42 +0900

• C-;でリージョンをコメントアウト/イン

Sun, 03 Feb 2002 02:15:08 +0900

• xml-runでコマンドが実行された結果をブラウザで表示しようとしてエラーになるバグを修正（ブラウザで表示しようとするのがバグです）

Thu, 31 Jan 2002 01:41:06 +0900

• *xml-run-command-hook*というフックをコマンド実行後に評価するようにした。

Tue, 29 Jan 2002 22:53:46 +0900

• typoの修正
• xml-insert-namespaceで出力する順番を逆にした

Mon, 28 Jan 2002 23:09:18 +0900

• Xi対応（Hoshino Hisashiさんのご協力による）
• xml-run機能
• スタイルシート適用にXTも利用可に。キーバインドをC-x C-mからC-c tに変更。

Fri, 25 Jan 2002 01:22:04 +0900

• xml-transformが実行できなくなっていたのを修正

Tue, 22 Jan 2002 03:36:07 +0900

• ちょっとバグフィックス

Tue, 22 Jan 2002 01:07:33 +0900

• バッファのファイル名の拡張子から自動的にDOCTYPEを判断するようにした。*xml-auto-doctype-alist*という変数を参照します。

Wed, 16 Jan 2002 22:24:52 +0900

• またまた情けないバグの修正
• キーワードの属性はprefix付とprefixなしを両方登録するようにした
• Entityは最後の";"まで含めてキーワードとして扱うようにした

Wed, 16 Jan 2002 00:33:34 +0900

• バグフィックスとキーワード追加処理の効率化

Mon, 14 Jan 2002 21:35:36 +0900

• ベータ公開

詳細

コマンド実行

カレントバッファのXML文書の種別に応じて、コマンドを起動する機能です。たとえば*.foではfop.batが起動され、*.xiではxi.exeが起動されます。

オプションは標準では各コマンドごとに変数の値が参照されます。たとえば、fop.batならば*fop-options*、xi.exeなら*xi-options*、msxsl.exeなら*msxsl-options*、xt.exeなら*xt-options*です。ただし、C-u C-c xというようにprefix引数付で起動すると、これらの変数ではなくミニバッファから読み込んだ値が使用されるようになります。下記のスタイルシート適用機能も同様です。

特にこれらのコマンドが指定されない場合、ブラウザでxmlファイルを表示しようとします。表示するためにはs.oowadaさんのbrowser.dll（必須）とohkuboさんのbrowserex(旧browser-wrap)（推奨）を組み込んでください。また、*xml-navigate-function*という変数に、自前で定義してたブラウザ起動の関数を設定することもできます。

起動するコマンドはC-c cで手動で切り替えることもできます。

スタイルシート適用機能について

現在のバッファのXMLファイルに指定したスタイルシートを適用して変換し、結果を"*XML Command output*"というバッファに出力します。なお、この機能を利用するにはmsxsl.exeまたはxt.exeが必要です。

標準ではmsxsl.exeが利用されます。以下の式を評価すると、xt.exeが利用されるようになります。msxsl.exeに戻すには*xsl-xt*の代わりに*xsl-msxsl*を指定してください。

(setq *xsl-transform-command* *xsl-xt*)
	

msxsl.exeは標準ではインストールされていません。同様にMicrosoftのページからダウンロードしてc:\windows\system32等PATHの通ったディレクトリにおいてください。

http://msdn.microsoft.com/downloads/default.asp?URL=/downloads/sample.asp?url=/MSDN-FILES/027/001/485/msdncompositedoc.xml

msxsl.exeを利用するにはMSXML3.0が必要です。MSXML3.0はIE6以降であれば標準でインストールされていますが、それ以前のバージョンをお使いの場合、以下のMicrosoftのページからダウンロードしてsetupを行ってください。

http://msdn.microsoft.com/downloads/default.asp?url=/downloads/sample.asp?url=/msdn-files/027/001/772/msdncompositedoc.xml

xt.exeは以下のページからダウンロードできます。PATHの通ったディレクトリに置いてください。

http://www.jclark.com/xml/xt.html

ネームスペースについて

ちょっとわかりにくいので簡単な説明を書きます。

まずC-c dキーに割り当てているxml-set-default-namespaceですが、これでDOCTYPEを指定すると、そのDOCTYPEのキーワードがprefixなしで利用できるようになります。たとえばXHTML1.1を指定すると"h1"というタグが補完できたり、色付けされます。ただし、指定できるDOCTYPEは1つだけです。

次にC-c aキーに割り当てているxml-add-namespaceですが、こちらはprefixつきで指定したDOCTYPEのキーワードが追加されます。たとえばXHTML1.1を"html"というprefixで追加すると、"html:h1"というタグが補完できたり、色付けすることができます。複数のDOCTYPEを追加できます。

C-a rキーに割り当てているxml-remove-namespaceはxml-add-namespaceで追加したDOCTYPEを削除します。

ドキュメントタイプの定義

新しいタイプを定義するには以下のようにします。

DOCTYPEの定義(必須)

*xml-doctypes*に以下のようにリストを追加します。

(pushnew
 '("名前"
   "ルートエレメント"
   "PUBLIC識別子"
   "DTDのURL"
   "ネームスペースプレフィックスのデフォルト"
   "ネームスペースのURL"
   キーワード定義
   推測リスト
   )
 *xml-doctypes* :test #'equal)
	    

キーワード定義には2つの方法があります。

• キーワードファイル名の場合は、その中から名前を条件としてフィルタリングされたものがキーワードとして登録されます。(非推奨)

• キーワードをリストにして指定することもできます(推奨)。

  (
    (タグ1 "キーワード1" "キーワード2" ...)
    (タグ2 "キーワード3" "キーワード4" ...)		  		  
    ...
  )
  		
  

  各キーワードのうち“@”からはじまるのは属性とみなされ、“&”からはじまるのは文字実体参照、それ以外が要素名としてみなされます。現状リスト先頭のタグは単に無視されますので、タグごとに分割する意味はありません。

拡張子ごとにDOCTYPEを自動的にセットする(任意)

*xml-auto-doctype-alist*に以下のようにリストを追加

(pushnew '("ファイル名の正規表現" コマンド実行のタグ "DOCTYPEの名前")
	 *xml-auto-doctype-alist* :test #'equal)
	    

コマンド定義(任意)

*xml-command-alist*に以下のリストを追加

(push '(コマンド実行のタグ
	"テンプレート"
	引数1
	引数2
	...)
      *xml-command-alist*)
	    

テンプレートと各引数は評価されて(format nil ...)の引数として渡され、その結果が実行するコマンド行になります。

具体的な例はsite-lisp/xmlディレクトリの下の各ドキュメントタイプ定義ファイルを参照してください。

制限事項・問題点

• 本来、ネームスペースはエレメントの各階層ごとに指定できるものですが、xml-modeではファイル全体（トップレベルのエレメント）に対して指定することしかできません。ネームスペースを階層ごとに切り替える文書（たとえばRELAXの場合、RELAX CoreとRELAX Namaspaceをデフォルトネームスペースで切り替えるのが一般的なようです）の場合、めんどうですがその都度xml-mode上でもネームスペースを切り替えて使ってください。
• CDATAセクションの中で'や"を使うと通常の文字列として扱われてしまいます。したがって奇数個あらわわれた場合は、CDATA以降のインデント、補完などがおかしくなります。偶数個出てくるようにしてください…なんて無理ですよね。対応方法を考慮中ですが、xyzzy側に機能を追加してもらわないと無理そうです。

このドキュメントの最新

http://chez-sugi.net/xyzzy/xml-mode.html