【Serialization / シリアライゼーション】XSLT 2.0/XSL Transformations Version2.0/Extensible Stylesheet Language Transformations Version2.0

20 シリアライゼーション

プロセッサは、オクテットのシーケンスとして最終結果ツリーを出力する場合がありますが、 そうする事が出来る事を要求されるわけではありません(参照：21 一致)。 スタイルシート作者は、結果ツリーをどのようにシリアライズしたいのかを明記する為の xsl:output 宣言の利用が可能です。 もし、プロセッサが、最終結果ツリーをシリアライズする場合には、それは、これらの宣言によって記述したようにそうしなければいけません。

シリアライザーの出力を管理する規則は、[XSLT と XQuery シリアライゼーション]で定義されます。 シリアライゼーションは、シリアライゼーションパラメータの番号を利用して操作されます。 これらのシリアライゼーションパラメータの値は、 xsl:output 、 xsl:result-document 、 xsl:character-map 宣言を利用してスタイルシート内で設定される場合があります。

<!-- カテゴリ：宣言 -->
<xsl:output
  name? = qname
  method? = "xml" | "html" | "xhtml" | "text" | qname-but-not-ncname
  byte-order-mark? = "yes" | "no"
  cdata-section-elements? = qnames
  doctype-public? = string
  doctype-system? = string
  encoding? = string
  escape-uri-attributes? = "yes" | "no"
  include-content-type? = "yes" | "no"
  indent? = "yes" | "no"
  media-type? = string
  normalization-form? = "NFC" | "NFD" | "NFKC" |
"NFKD" | "fully-normalized" | "none" | nmtoken
  omit-xml-declaration? = "yes" | "no"
  standalone? = "yes" | "no" | "omit"
  undeclare-prefixes? = "yes" | "no"
  use-character-maps? = qnames
  version? = nmtoken />

xsl:output 宣言は、オプションです； もし、利用した場合には、それは、常にスタイルシートモジュール内で top-level 要素として現れなければいけません。

スタイルシートは、多種多様な xsl:output 宣言を含む場合、 そしてまた、 xsl:output 宣言をも含むスタイルシートモジュールを含むか、または、取り込む場合があります。 xsl:output 宣言の名前は、もしあれば、その name 属性の値です。

[定義：  スタイルシートにある全ての xsl:output 宣言は、名前付き出力定義にまとめられる同じ名前を共有します； 存在しない名前を持つそれらは、単独の名無し出力定義にまとめられます。 ]

スタイルシートは、常に、名無し出力定義を含みます； 名無し xsl:output 宣言の欠如では、もし、スタイルシートが、 存在しない属性を持っている xsl:output 宣言を含んだ場合には、 名無し出力定義は、利用されるであろうそれと同等です。

名前付き出力定義は、 その名前が、 xsl:result-document 要素の中で利用した format 属性とマッチする際に利用されます。 名無し出力定義は、 xsl:result-document 要素が、 format 属性を省略する際に利用されます。 それはまた、暗黙の xsl:result-document 要素の欠如の中で暗黙のうちに作成される 最終結果ツリーをシリアライズする際に利用されます。

出力定義を作り上げる全ての xsl:output 要素は、有効にマージされます。 値が、 namespace-sensitive であるそれらの属性において、マージは、語彙的なQNameが、 拡張QNameに変換された後に行われます。 cdata-section-elements 属性においては、その出力定義は、 xsl:output 宣言を構成する全てから得られる値の結合を利用します。 use-character-maps 属性においては、その出力定義は、取り込み優先度、 または、 いくつかが同じ取り込み優先度を持つ場合には、宣言指定内で増加の命令にあるそれらを受け取っている xsl:output 宣言を構成する全てから得られる拡張QName 値のシーケンスの結合を利用します。 他の属性においては、その出力定義は、 最も高い取り込み優先度を伴う xsl:output 宣言から得られる属性の値を利用します。

[ERR XTSE1560] もし、出力定義にある2つの xsl:output 宣言が、 より高い取り込み優先度と同じ属性において明快な値を記述する同じ出力定義内に その他の xsl:output 宣言がある場合を除き、 同等ではない属性の値を伴う( cdata-section-elements と use-character-maps ではない)同じ属性において明快な値を明記する場合には、 それは、静的エラーです。

もし、固有の属性における値を明記する 出力定義内に xsl:output 宣言がない場合には、 その一致しているシリアライゼーションパラメータは、既定値を受け取ります。 既定値は、選んだ出力メソッドに依存します。

いくつかのシリアライゼーションパラメータがあり、いくつかの出力メソッドに適用しますが、他には(適用)しません。 例えば、 indent 属性は、 text 出力メソッドにおいては効果がありません。 もし、値が、出力メソッドに適用できない属性を提供される場合には、その値は、シリアライザーを通過されません。 プロセッサは、このような属性の値を妥当性検証する場合がありますが、そうする事を要求されるわけではありません。

手法は、変換を操作するAPIを利用して、優先される xsl:output 宣言の属性、または、変更される既定値を許容する場合があります。

シリアライズされる最終結果ツリーへの位置(格納ファイル内、または、別の場所かどうか)は、 implementation-definedです。 (慣例においては、 implementation-defined APIを利用して操作されるという意味である場合があります)。 しかしながら、これらの位置は、2つの最終結果ツリーが、 両方が共に xsl:result-document 命令の href 属性にある相対URIを利用して (暗黙のうちに、または、明示的に)作成される場合には、これらの相対URIは、その他の1つのツリーから参照を構築する為に利用される場合があり、 そしてまた、このような参照は、両方の結果ツリーがシリアライズされる際には、妥当なままでなければならないという制約を満たさなければいけません。

xsl:output 要素における method 属性は、 出力となる最終結果ツリーにおいて利用される為にある全般的なメソッドを識別します。

[ERR XTSE1570] その値は、(もし、存在する場合には、)妥当なQNameにしなければいけません。 もし、そのQNameが、前置詞を持っていない場合には、 それは、[XSLT と XQuery シリアライゼーション]で記述したメソッドを識別し、そしてまた、 xml 、 html 、 xhtml 、または、 text の1つにしなければいけません。 もし、QNameが前置詞を持つ場合には、QNameは、 5.1 適格な名前で記述したように、拡張QNameに拡張されます； その拡張QNameは、出力メソッドを識別します；このケースにおける振る舞いはこの文書によって記述されるわけではありません。

method 属性における既定は、シリアライズされているツリーの内容に依存し、そしてまた、次に続くように選ばれます。 もし、最終結果ツリーの文書ノードが、子要素を持つ場合、そしてまた、 ホワイトスペース文字列だけを含む結果ツリーの文書ノードの最初の子要素に先行しているいくつかのテキストノードを持つ場合には、(以下列挙)：

• もし、この最初の子要素の拡張QNameが、(小文字においては、)ローカル部分 html と 名前空間 URI http://www.w3.org/1999/xhtml を持つ場合には、その既定出力メソッドは、普通は、 xhtml です。 しかしながら、もし、主要なスタイルシートモジュールの xsl:stylesheet 要素の version 属性が、値 1.0 を持つ場合、そしてまた、 もし、その結果ツリーが、( xsl:result-document 命令によって明快にではなく)暗黙のうちに生成される場合には、 このシチュエーションにある既定出力メソッドは、 xml です。

• もし、この最初の子要素の拡張QNameが、(大文字・小文字のいくつかの組み合わせでは、) ローカル部分 html とNullの名前空間 URIを持つ場合には、その既定出力メソッドは、 html です。

他の全てのケースではその既定出力メソッドは、 xml です。

もし、選択した出力定義が、 method 属性を含んでいない場合には、その既定出力メソッドが利用されます。

xsl:output における他の属性は、出力メソッドにおけるパラメータを提供します。 次に続く属性は、(以下を)許容されます：

• encoding 属性の値は、シリアライゼーションメソッドに encoding パラメータの値を提供します。 その既定値は、implementation-definedですが、 xml と xhtml メソッドのケースでは、それは、 UTF-8 、または、 UTF-16 のいずれかにしなければいけません。

• byte-order-mark 属性は、ファイルの開始位置で[ byte order mark ](バイトオーダーマーク)が書かれるかどうかを定義します。 もし、その値 yes が記述される場合には、[ byte order mark ]が書かれます； もし、 no が記述される場合には、[ byte order mark ]が書かれません。 その既定値は、利用したエンコード方式に依存します。 もし、そのエンコード方式が UTF-16 である場合には、その既定は yes です； UTF-8 においては、それは、implementation-definedであり、そしてまた、 他の全てのエンコード方式においては、それは no です。 [ byte order mark ]の値は、高い[ order byte ]が、低い[ order byte ]の前後いずれに書かれるかを示します； 実際に利用した[ byte order ]は、選択したエンコード方式によって定義される場合を除き、implementation-dependentです。

• cdata-section-elements 属性は、QNameのホワイトスペースで区切られたリストです。 その既定値は、カラのリストです。 それらが現れる xsl:output 宣言におけるスコープ内名前空間宣言を利用してこれらの名前として拡張した後、 この名前のリストは、シリアライゼーションメソッドに cdata-section-elements パラメータの値を提供します。 前置詞なしの名前のケースでは、( xmlns="uri" を利用して宣言した名前空間である)その既定名前空間が利用されます。

  注釈：

  これは、スタイルシートの中で利用した他のほとんどのQNameにおける規則とは異なります。 その理由は、これらの名前が、結果文書にある要素を参照するということであり、それゆえに、次に続くリテラル結果要素の名前の時と同じ変換、または、 xsl:element の name 属性の時と同じ変換であるからです。

• doctype-system 属性の値は、シリアライゼーションメソッドに doctype-system パラメータの値を提供します。 既定によって、そのパラメータが提供されるわけではありません。

• doctype-public 属性の値は、シリアライゼーションメソッドに doctype-public パラメータの値を提供します。 既定によって、そのパラメータが提供されるわけではありません。

• escape-uri-attributes 属性の値は、シリアライゼーションメソッドに escape-uri-attributes パラメータの値を提供します。 その既定値は、 yes です。

• include-content-type 属性の値は、シリアライゼーションメソッドに include-content-type パラメータの値を提供します。 その既定値は、 yes です。

• indent 属性の値は、シリアライゼーションメソッドに indent パラメータの値を提供します。 その既定値は、 html と xhtml 出力メソッドのケースでは、 yes であり、 xml 出力メソッドのケースでは、 no です。

• media-type 属性の値は、シリアライゼーションメソッドに media-type パラメータの値を提供します。 その既定値は、 xml 出力メソッドのケースでは、 text/xml 、 html と xhtml 出力メソッドのケースでは、 text/html そして、 text 出力メソッドのケースでは、 text/plain です。

• normalization-form 属性の値は、シリアライゼーションメソッドに normalization-form パラメータの値を提供します。 値が、[implementation-defined]標準形式を明記する normalization-form 属性において一つ一つ列挙されたそれらの内の1つではなく、 NMTOKEN である； このケースにおける振る舞いは、この文書によって記述されるわけではありません。 その既定値は、 none です。

• omit-xml-declaration 属性の値は、シリアライゼーションメソッドに omit-xml-declaration パラメータの値を提供します。 その既定値は、 no です。

• standalone 属性の値は、シリアライゼーションメソッドに standalone パラメータの値を提供します。 その既定値は、 omit です; これが意味するところは、それは、存在しない standalone 属性が、XML 宣言に含まれるということです。

• undeclare-prefixes 属性は、生成が、 method="xml" と version="1.1" (または、後者)を伴い出力される際に限り、関連します。 それは、子要素が、その親要素の名前空間ノードと同じ(名前空間前置詞の)名前を伴う存在しない名前空間ノードを持つ際に、 (形式 xmlns:foo="" の)宣言していない名前空間が、出力されるべきかどうかを定義します。. その既定値は、 no です：これが意味するところは、その名前空間未宣言は、結果となるXMLが再度解析される際にその効果を持つそれは出力されず、 新しいツリーが、シリアライゼーション前のオリジナルツリーに存在していなかった子要素上に名前空間ノードを含む場合があるという事です。

• use-character-maps 属性は、この出力定義を結合する中で利用される名前付き文字列マップのリストを提供します。 この属性が利用される方法は、20.1 文字列マップで記述されます。 その既定値は、カラのリストです。

• version 属性の値は、シリアライゼーションメソッドに version パラメータの値を提供します。 許容した値のセットと既定値は、implementation-definedです。 シリアライゼーションエラーは、もし、要求したバージョンが手法によってサポートされない場合に報告されるでしょう。

もし、プロセッサがシリアライゼーションを実行する場合には、それは、出現するいくつかの回復不能なシリアライゼーションエラーをシグナル出力しなければいけません。 これらは、回復されない動的エラーと同じ効果を持ちます： それは、プロセッサは、エラーを出力しなければならず、変換が成功していたかのように終了してはいけないという事です。

<jsp:setProperty name="user" property="id" value='<%= "id" + idValue %>'/>

<xsl:character-map name="jsp">
	<xsl:output-character character="≪" 文字列="&lt;%"/>	 
	<xsl:output-character character="≫" 文字列="%&gt;"/>
	<xsl:output-character character="§" 文字列='"'/>
</xsl:character-map>

<jsp:setProperty name="user" property="id" value='≪= §id§ + idValue ≫'/>

<xsl:output name="htmlDoc" use-character-maps="htmlDoc" />
<xsl:character-map name="htmlDoc"
	use-character-maps="html-chars doc-entities windows-format" />
	
<xsl:character-map name="html-chars"
	use-character-maps="latin1 ..." />
<xsl:character-map name="latin1">
	<xsl:output-character character="&#160;" string="&amp;nbsp;" />
	<xsl:output-character character="&#161;" string="&amp;iexcl;" />
	...
</xsl:character-map>
<xsl:character-map name="doc-entities">
	<xsl:output-character character="&#xE400;" string="&amp;t-and-c;" />
	<xsl:output-character character="&#xE401;" string="&amp;chap1;" />
	<xsl:output-character character="&#xE402;" string="&amp;chap2;" />
	...
</xsl:character-map>
<xsl:character-map name="windows-format">
	<!-- newlines as CRLF -->
	<xsl:output-character character="&#xA;" string="&#xD;&#xA;" />
	<!-- tabs as three spaces -->
	<xsl:output-character character="&#x9;" string="	 " />
	<!-- images for special characters -->
	<xsl:output-character character="&#xF001;"
		文字列="&lt;img src='special1.gif' /&gt;" />
	<xsl:output-character character="&#xF002;"
		文字列="&lt;img src='special2.gif' /&gt;" />
	...
</xsl:character-map>

<xsl:text disable-output-escaping="yes">&lt;</xsl:text>

<title>
	<xsl:text disable-output-escaping="yes">
		This is not &lt;hr/&gt; good coding practice
	</xsl:text>
</title>

<title><![CDATA[This is not ]]><hr/><![CDATA[ good coding practice]]></title>