September 18, 2005

Abstract

LoveVector の、2005 年 09 月 18 日の記事一覧です。

prev
September 7, 2005
next
October 17, 2005

XML の整形手法あれこれ

URI
http://okowa.org/vector/2005/09/18/formatting-xml
Created
2005-09-18T20:58:31+09:00

さてトートツですが,XML を整形することを考えてみます。「機械が処理するにゃあそんなに問題ないけど,人間にとっての可読性を上げることによる利は考えられるよねぇ。」というわけで,このサイトにおいてある XHTML であるとか XML/RDF であるとかをキレーに出力したいという欲があってもよいものでしょう。

というわけで,ツール探しです。ざっと見たところ,いくつかありそうです。

まずはよく見るやりかた。libxml2 についてくる xmllint というツールを利用します。これは元々は XML の検証を行うツールなのですが,ついでに整形も行うことができるというわけ。

整形を行うには,--format オプションをつければよく,別途 XMLLINT_INDENT 環境変数を与えることによりインデント文字を指定することもできます(デフォルトは二文字のスペース)。

% cat in.xml | env XMLLINT_INDENT='    ' xmllint --format - > out.xml

また,xmlpretty というツールも利用できそうです。これは,XML::Handler::YAWriter という CPAN モジュールの整形機能を利用するためのラッパースクリプトのようですね。

% cat in.xml | xmlpretty [options...] > out.xml

設定はいろいろあるので詳しくは POD を。

また,C 言語の整形ツールである indent に慣れているのであれば,XML Indent があります。indent ほど大量のオプションはありませんが,普通に -i 4(インデント幅4)とかが利きますね。

% cat in.xml | xmlindent -i 4 > out.xml

さて,しかしながらこれら手法だとすべての要素を一律に整形することしかできないのですね。たとえば,xml:space の値によって空白を壊すか否かを制御することは(たぶん)できないし,「HTML の body 要素は内容がデカくなることが多いからインデントしないでくれ」とかそういう要望にも応えられないわけです。

そこで,そういった細かい制御ができるようなプログラムも開発されてるみたいで,たとえば xmlformat があります。これは,どの XML 要素に対してインデントをどれだけするかとか,改行をいくつ入れるとか,インライン要素のように改行を入れないとか,内側の空白を保つとか,とても細かく指定することができます。

% cat in.xml | xmlformat --config-file=my.conf > out.xml

この my.conf にひたすら指定を入れればいいというわけ。指定の入れ方は本家参照。

ただ,それでも,まだやや不満があるんですね。たとえば HTML の ins/del 要素とかは,ブロック要素としてもインライン要素としても振舞う怪しげな要素で,整形結果もそれが存在する構造上の位置に応じて変えてくれると嬉しいなぁとか思ったりするのですよねぇ。

こういった利用には XPath とマッチングで宣言的に設定が書ける実装があると幸せになれるかもしれません。というわけで,XSL 変換 を用いた解決策を探してみる価値はありそうです。以下のようなメリットが考えられそうですので。

まず前知識。XSLT には出力を整形する仕様がある(indent="yes"を用いる)のですが,これは変換で新しく生成した要素ノードの間に空白を埋めるためのもので必ずしも出力が綺麗にならなかったり,また,細かい制御ができない等の問題があったりします。実装の独自拡張を探してみたりすると,Saxon という実装では,インデント幅の調整ができるようです(saxon:indent-spaces 属性を用いる)。しかしながらこれらは,前述の要素ごとの整形ができない等の問題があるため,やはりこれだけでは物足りなさそう。

そこで,スタイルシートにより要素ごとに差異を持たせ整形をする試みがやっぱりあります。XSLTで効率的にインデントする方法では,空白を取り払ったノード群に改行やスペースを自前で挿入することにより再整形を実現しています。

しかしながら,いくらか改善の余地がありそうです。

というわけで,再発明してみる価値を見出したのでした。XML を XSLT で整形するへつづく。

XSLT で XML を整形する

URI
http://okowa.org/vector/2005/09/18/formatxsl
Created
2005-09-18T20:59:22+09:00

XML の整形手法あれこれを受けて作ってみました。

XML を通すと整形します。たとえばプロセッサとして xsltproc を使うと,以下のような感じ:

% cat in.xml | xsltproc \
    --stringparam doctype-public '-//W3C//DTD XHTML 1.0 Strict//EN' \
    --stringparam doctype-system 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd' \
    format.xsl - > out.xml

いくつかめんどくさげな注意をあげておくと:

まだ出力にいくらか気に食わないところはあって改善の余地アリアリなのですが,とりあえずアウトプットということで。ちなみにこのスクリプトは現在のこの weblog にも使ってたりします。

Topic Path

  1. okowa.org
  2. LoveVector
  3. 2005
  4. Sep
  5. 18
Last-Modified
2012-03-15T21:51:10+09:00
Feeds
Recent Updates (RSS 1.0)
Powered by
XML::LibXSLT / format.xsl / Movable Type 5.13-ja
LoveVector: klm <klm at okowa dot org>