PDF5-ML-Template

Size: px

Start display at page:

Download "PDF5-ML-Template"

みがねことじ
5 years ago
Views:

1 実践!PDF5-ML プラグイン牧田敏彦

6 PDF プラグインに必要とされる機能言語によるスタイルとリテラルの変更典型的には font-family によって切り替え出力タイプによる動的なスタイル割り当てカラー印刷用には CMYK カラースペースモノクロ印刷用にはグレースケールカラースペース WEB 用には RGB カラースペースなどフレキシブルなスタイル定義スタイルをロジック ( テンプレート ) から独立させて定義スタイルの継承重複した記述の排除 6 Copyright 2015 Antenna House, Inc.

7 PDF5 でやりたかったことスタイルとロジックを分離したい! DITA から XSL-FO に変換するには XSLT スタイルシートを書きます. XSLT 勧告の xsl:attribute-set を使用するとスタイルの中にロジックを書かない限り多言語や動的なスタイルの変更が実現できません. その結果スタイルシートは大抵メンテナンス不能の代物になります. 外部の XML にスタイルを定義すれば XSLT 勧告に縛られない自由なスタイル記述が可能になります. 一つのプラグインで多言語の PDF を作成したい. ここで一個の PDF は一言語に対応するものと考えます. 言語毎にプラグインを作る訳にはゆきません. 英語ベースのスタイル定義を作り他言語はそこからの差分だけのスタイル定義という方法が取れないか? と考えました. 7 Copyright 2015 Antenna House, Inc.

8 PDF5 の到達点スタイルとロジックの分離 xsl:attribute-set を使用せずスタイルは外部のスタイル定義ファイルに記述. (config/default_style.xml) 言語別のスタイルは config/[language-tag]_style.xml に記述. XSLT ライクな attribute-set/attribute, variable を導入スタイル記述の簡略化を実現. 単一言語の PDF 生成を実現ルートのを文書の言語とみなす動的に default_style.xml と [language-tag]_style.xml を合成言語別のスタイルを優先して XSL-FO( PDF) を生成する. 8 Copyright 2015 Antenna House, Inc.

10 PDF5-ML でやりたかったこと 1 つの文書で多言語の混在を実現する! PDF5 はあくまで一文書は一言語でした. 緊急避難的に ah-dita を使えば特定の箇所に map/@xml:lang を尊重してなるべく PDF5 と互換を取りながらその言語のスタイルを割り当てるアルゴリズムを研究しました. 条件付きの変数とスタイル定義を実現したい! 多くの出力条件をすべてロジックで吸収しているとコードが複雑化し書くのが嫌になってきます. 主要な出力条件をスタイルの側で条件付き変数とスタイルで実現すればテンプレート側のコードの負担を劇的に減らすことができます. 10 Copyright 2015 Antenna House, Inc.

13 世界のこんにちはで試してみましょう <p>we say "Hello" in English.</p> <p>we say "<ph xml:lang="ja-jp"> こんにちは </ph>" in Japanese.</p> <p>we say "<ph xml:lang="zh-cn"> 你好 </ph>" in Chinese.</p> <p>we say "<ph xml:lang="ko-kr"> 안녕하세요 </ph>" in Korean.</p> <p>we say "<ph xml:lang="th-th">สวสดครบ</ ph> " in Thai.</p> <p>we say "<ph xml:lang="hi-in">नमस त</ph>" in Hindi.</p> 13 Copyright 2015 Antenna House, Inc.

17 組版結果の考察 PDF5-ML ではすべてのグリフは PDF に問題なく出力されます. 組版エラーは報告されません. PDF2 では非ラテン文字は PDF で豆腐マーク ( グリフ無し ) になってしまいます. 組版では多くのエラーが報告されます.PDF2 に基づいてフォントが選択されていないためです多言語組版を必要としているなら PDF5-ML がベターな選択でしょう. 17 Copyright 2015 Antenna House, Inc.

18 条件付き変数とスタイル定義出力タイプ ( 既定値 : 文書タイプ ( 自由定義ペーパーサイズ ( 既定値 : Letter) これらの属性を使用することにより. 条件付き変数スタイルをスタイル定義ファイルに定義できます. 条件付きの定義はスタイルシートのテンプレートをこれらの条件から透過にし複雑なコーディングをなくすことができます. 18 Copyright 2015 Antenna House, Inc.

19 @output-type によるアイコンの定義  <variable name="note_icon" output-type="web">url(note.svg)</variable>  <variable name="note_icon" output-type="print-color">url(note.pdf)</variable>  <variable name="note_icon" output-type="print-mono">url(note-mono.pdf)</variable> 19 Copyright 2015 Antenna House, Inc.

20 テンプレートのコード ahf:getvarvalue の値は xsl:param で外部から与えます. に対し透過的に記述できます.  <xsl:template topic/note ')] > <fo:external-graphic> <xsl:attribute name="src select="ahf:getvarvalue('note_icon') /> </fo:external-graphic> </xsl:template> 20 Copyright 2015 Antenna House, Inc.

21 フリーフォーマットの表紙そもそも表紙のデータ構造は DITA の topic の概念とはマッチしません. プラグインの開発では表紙を作るために多くの工数を費やしています. もしくは簡単で固定的な表紙に留めています. PDF5-ML は XSL-FO のプロパティをオーサリングレベルで書けるようにすることで実際的なソリューションを提供します. 21 Copyright 2015 Antenna House, Inc.

22 表紙のオーサリングサンプル  <conbodydiv fo:prop="position:absolute;top:40mm;right:10mm; width:40%;height:130mm;">  <section> <p fo:prop="font-family:franklin Gothic Demi Cond;font-size:24pt;"> Antenna House</p> <p fo:prop="font-family:arial;font-weight:bold; font-size:32pt;">pdf5-<i fo:prop="color:deeppink;">ml</i> <ph fo:prop="font-size:28pt;">plug-in</ph></p> <p fo:prop="font-family:times New Roman;font-weight:bold; font-size:28pt;">user's Guide</p> </section> </conbodydiv> 22 Copyright 2015 Antenna House, Inc.

24 表紙を作る条件表紙の topic にはマップのに covern を指定します. topic では bodydiv から fo:block-container を生成する前提でオーサリングします. XSL-FO のプロパティを fo:prop 属性に CSS の記法で指定します. fo:prop は ah-dita の特殊化で使うことができます Copyright 2015 Antenna House, Inc.

25 このようなアーキテクチャの利点ユーザーレベルで自由に表紙を設計できます. ただし最初の雛形は開発者に作ってもらう必要があるでしょう. ユーザーは表紙の修正 / メンテナンスにお金をかけずに済みます. 自分たちで大抵のことはできてしまうからです. 開発者は表紙の作成のためにその都度コードを書かずに済みます. 表紙のスタイルはすべてオーサリング側が保持しているためです. 25 Copyright 2015 Antenna House, Inc.

26 おまけ :DITA を使用してフィルタリングすればさらにフレキシブルな表紙を作れます. により color( 文字色 ) を設定します --> <p fo:prop="font-family:arial;font-weight:bold;font-size:32pt;">pdf5-<i fo:prop="color:deeppink;" deliverytarget="pdf-web">ml</i><i fo:prop="color:rgb-icc(#cmyk,0%,92%,42%,0%);" deliverytarget="pdf-print-color">ml</i><i deliverytarget="pdf-printmono">ml</i> <ph fo:prop="font-size:28pt;">plug-in</ph> </p> このサンプルは GitHub にあります. cover 26 Copyright 2015 Antenna House, Inc.

32 付録 xsl:attribute-set の限界と PDF5 のアイディア言語別スタイル定義ファイル PDF5-ML の制限事項 DITA によるスタイル切り替え PDF5-ML のテンプレートの作法 PDF5-ML をカスタマイズする方法フォントのフォールバックの禁止言語別にスタイルを変える必要があるか? コードポイントからのフォントマッピング 32 Copyright 2015 Antenna House, Inc.

33 書いてはいけないコード  <xsl:template topic/p ')]"> <fo:block> <xsl:attribute name="space-before">0.5em</xsl:attribute> <xsl:apply-templates/> </fo:block> </xsl:template> p 要素 ( 段落 ) のテンプレートです. XSL-FO の fo:block を生成するというロジックと space-before に 0.5em を設定するというスタイル設定が混在しています. この方法でスタイルシートを構築すると極めてメンテナンス性の悪いものになります. 33 Copyright 2015 Antenna House, Inc.

34 xsl:attribute-set の限界  <xsl:attribute-set name="atsp"> <xsl:attribute name="space-before">0.5em</xsl:attribute> </xsl:attribute-set>  <xsl:template topic/p ')]"> <fo:block xsl:use-attribute-sets="atsp"> <xsl:apply-templates/> </fo:block> </xsl:template> xsl:use-attribute-sets 属性でしか xsl:attribute-set は参照できません. attribute()* を返します. xsl:variable と違い参照される都度評価されます. 34 Copyright 2015 Antenna House, Inc.

35 スタイルの中でのロジックの記述 <xsl:attribute-set name="atsp"> <xsl:attribute name="space-before"> <xsl:choose> <xsl:when topic/entry ')]">0.2em</xsl:when> <xsl:otherwise>0.5em</xsl:otherwise> </xsl:choose> </xsl:attribute> </xsl:attribute-set> ロジックは子の xsl:attribute の中だけに書くことができます. 結果としてロジックがテンプレートとスタイル定義の両方に分散して存在することとなります. これが XSLT 勧告で素直にコーディングした場合の限界です. 35 Copyright 2015 Antenna House, Inc.

36 PDF5 のアイディア  <style-definition mlns=" <attribute-set name="atsp"> <sttribute-set name="space-before">0.5em</sttribute-set> </attribute-set> <attribute-set name="atspintable"> <sttribute-set name="space-before">0.2em</sttribute-set> </attribute-set> </style-definition> スタイルはロジックと分離して記述します.  <xsl:template topic/p ')]"> <fo:block> <xsl:copy-of select="ahf:getatttributeset ("if topic/entry ')]) then 'atspinentry' else 'atsp'"/> <xsl:apply-templates/> </fo:block> </xsl:template> 36 Copyright 2015 Antenna House, Inc.

37 PDF5 のアイディア  <style-definition mlns=" <attribute-set name="atsp"> <sttribute-set name="space-before">0.5em</sttribute-set> </attribute-set> <attribute-set name="atspintable"> <sttribute-set name="space-before">0.2em</sttribute-set> </attribute-set> </style-definition> スタイルはロジックと分離して記述します.  <xsl:template topic/p ')]"> <fo:block> <xsl:copy-of select="ahf:getatttributeset ("if topic/entry ')]) then 'atspinentry' else 'atsp'"/> <xsl:apply-templates/> </fo:block> </xsl:template> スタイルは動的にロジックの中で選択できます. 37 Copyright 2015 Antenna House, Inc.

38 ahf:getattributeset 関数 ahf:getattributesets はスタイル定義ファイルを参照して attribute()* を返します. XSLT 勧告の xsl:use-attribute-set よりはるかに融通性があります.  <xsl:template topic/p ')]"> <fo:block> <xsl:copy-of select="ahf:getatttributeset ("if topic/entry ')]) then 'atspinentry' else 'atsp'"/> <xsl:apply-templates/> </fo:block> スタイルは動的にロジックの中で選択できます. </xsl:template> 38 Copyright 2015 Antenna House, Inc.

39 スタイル定義のなかの変数 (1) 変数は XSLT の xsl:variable ライクな記法で書かれます. 変数は名前に $ をつけることで参照できます. この参照の記法は XSLT 勧告よりはるかに簡単です. <style-definition xmlns="  <variable name="general_serif_font">serif</variable> 変数定義 <variable name="general_sans_serif_font">sans-serif</variable> <variable name="general_monospace_font">monospace</variable>  <variable name="general_text_font">$general_serif_font</variable> <variable name="general_title_font">$general_sans_serif_font</variable> </style-definition> 変数参照 39 Copyright 2015 Antenna House, Inc.

40 スタイル定義のなかの変数 (2) 変数はスタイル定義 (attribute) の中からも参照できます. 変数の利用で重複した値の定義を回避できます.  <attribute-set name="atsroot" use-attribute-sets="atsbasefontsize atsbaselineheight"> <attribute name="xml:lang">en</attribute> serif で置換されます. <attribute name="font-family">$general_text_font</attribute> <attribute name="line-stacking-strategy">line-height</attribute> <attribute name="text-align">start</attribute> </attribute-set>  sans-serif で置換されます. <attribute-set name="atstitle"> <attribute name="font-family">$general_title_font</attribute> </attribute-set> 40 Copyright 2015 Antenna House, Inc.

41 言語別スタイル定義ファイル (1) 既定スタイルは英語を想定して config/ default_style.xml に記述します. 言語別スタイル定義ファイルは config/ [language_tag]_style.xml に記述します. PDF5 の場合ある文書の言語タグはから取得します. 2 つのファイルは default_style.xml に対して言語別スタイル定義ファイルに優先度を与えてマージされます. 41 Copyright 2015 Antenna House, Inc.

42 言語別スタイル定義ファイル (2) variable attribute-set attribute-set variable defult_style.xml attribute-set variable attribute-set variable attribute-set variable 日本語用のスタイルと変数定義 ja_style.xml 変数は最後に定義されたものが有効です. スタイルは重ね合わせです. 42 Copyright 2015 Antenna House, Inc.

43 言語別スタイル定義ファイル (3) 次の例の場合 ja ならば ja_style.xml に書かれた変数値が有効となります.  <variable name="general_serif_font">serif</variable> <variable name="general_sans_serif_font">sans-serif</variable> <variable name="general_monospace_font">monospace</variable> <variable name="general_text_font">$general_serif_font</variable> <variable name="general_title_font">$general_sans_serif_font</variable>  <variable name="general_serif_font">times New Roman,MS 明朝 </variable> <variable name="general_sans_serif_font">arial,ms ゴシック </variable> <variable name="general_monospace_font">courier New,MS ゴシック </variable> 43 Copyright 2015 Antenna House, Inc.

44 言語別スタイル定義ファイル (4) 次の例の場合スタイルは合成され font-weight = normal になります.  <attribute-set name="atsb"> <attribute name="font-weight">bold</attribute> </attribute-set>  <attribute-set name="atsb"> <attribute name="font-weight">normal</attribute> </attribute-set> 44 Copyright 2015 Antenna House, Inc.

46 言語別スタイル定義ファイル (2) attribute-set variable defult_style.xml attribute-set variable ja_style.xml attribute-set variable attribute-set variable attribute-set variable attribute-set variable attribute-set variable ko_style.xml 日本語用のスタイルと変数定義韓国語用のスタイルと変数定義あくまで概念的な図です. 46 Copyright 2015 Antenna House, Inc.

47 PDF5-ML の制限事項索引ページは日英 2 言語のサポートのみです. PDFへの変換はAH Formatterしか想定していません. mapから入れ子のtopicへの参照はサポートされません. <fn> からはXSL-FOの <fo:footnote> を生成しません. <image> の絶対パス指定はサポートしていません. 47 Copyright 2015 Antenna House, Inc.

48 DITA の仕様と現状は要素内容の言語を指定します. map や topic を指定すべきです. topic に指定しないと DITA-OT は en-us を付けてしまいます. は map から topic へは継承しません. PDF5-ML 以外ではの実装はされてきませんでした.PDF2 ではに合わせて出せるくらいです. 言語別のスタイル適用は夢のまた夢でしょう. 48 Copyright 2015 Antenna House, Inc.

50 スタイル切り替えの例 (1) DITA-OT の中間ファイル PDF に publish する際 TopicMerge というモジュールで作り出されます. bookmap と topic が一つのファイルにマージされます. ルート要素に dita-merge が生成されます. この例では英文の文書の topic のタイトルに合気道という日本語の ph 要素が含まれています. <dita-merge> (bookmapと同じxml:langとします.) <bookmap xml:lang= en-us > <topicref> <topicref> <topicref> <topic xml:lang= en-us > <title>the technique of <ph xml:lang= ja > 合気道 </ph></title> <topic> <topic> <reltable> 各 topic の related-links に展開済み 50 Copyright 2015 Antenna House, Inc.

51 スタイル切り替えの例 (2) 合気道の ph を調べる ja en-us en-us の順となります. ja en-us なので言語が切り替えられていると判定します. 適用するスタイルを求めます. ルートから順に ja のスタイル (attribute()*) を取得します. 1 dita-merge のスタイル (fo:root 用たいてい明朝体を使用します ) 2 topic のスタイル ( たぶん何もなし ) 3 title のスタイル ( たいていゴシック体を使用します ). 4 ph のスタイル (ph は汎用のインラインなので何もなし ) これを合成することによりタイトル用の日本語のスタイルが合気道に適用されます.( 例えば MS ゴシック ) 51 Copyright 2015 Antenna House, Inc.

52 テンプレートの作法 (1) PDF5 とは作法が変わります. PDF5 は単に名前指定 (atsp) でスタイルを取得しているだけでした.  <xsl:template match="*[contains(@class, ' topic/p ')]"> <fo:block> <xsl:copy-of select="ahf:getattributeset('atsp')"/> <xsl:call-template name="ahf:getunivatts"/> <xsl:copy-of select="ahf:getfostyleandproperty(.)"/> <xsl:apply-templates/> </fo:block> </xsl:template> 52 Copyright 2015 Antenna House, Inc.

53 テンプレートの作法 (2) PDF5-ML ではスタイル名を取得するテンプレートを分離します. これにより目的の要素から先祖に遡ってスタイルを取得ことが可能になります.  <xsl:template match="*[contains(@class, ' topic/p ')]" mode="mode_get_style" as="xs:string*"> <xsl:sequence select="'atsp'"/> </xsl:template> <xsl:template match="*[contains(@class, ' topic/p ')]"> <fo:block> <xsl:call-template name="getattributesetwithlang"/> <xsl:call-template name="ahf:getunivatts"/> <xsl:copy-of select="ahf:getfostyleandproperty(.)"/> <xsl:apply-templates/> </fo:block> </xsl:template> 53 Copyright 2015 Antenna House, Inc.

54 PDF5-ML カスタマイズの方法プラグインに customization フォルダがあります. ここに自分専用のカスタマイズコードを書くこともできますがあまりお勧めではありません. config フォルダのスタイル定義のカスタマイズに難がありまた複数の用途に使えないためです. お勧めは自分用のプラグインを作ることです. 自分のプラグインから PDF5-ML のテンプレートやスタイルを import します. 1 テンプレートは xsl:import する側がプライオリティ (import precedence) を持ちます. 2 スタイルは include 要素で PDF5-ML の定義をインポートしその後にカスタマイズしたスタイルを書きます. 順番が後のものが優先されます. この例は GitHub にあります Copyright 2015 Antenna House, Inc.

55 フォントのフォールバックの禁止実は PDF2 でもフォールバックを許容すればたいていの文字は出てしまいます. AH Formatter がスクリプト毎に既定のフォント指定を持っているためです. 特に Windows( 10) はフォントが豊富なのでエラーメッセージさえ気にしなければ豆腐マークは消えます. 商業出版物から見てそれで良いのでしょうか? フォールバックの発生原因はたいてい 1 オーサリングの誤りか 2 スタイルシートのフォント指定の誤りです. 従ってプロダクション用途にはフォールバックを禁止するのが本来でしょう. 55 Copyright 2015 Antenna House, Inc.

57 コードポイントからのフォントマッピング逸 Simplified Chinese (Sim Sun) 逸 Korean (Batang) U+9038 Meaning: Escape 逸 Japanese (MS-Mincho) 逸 Traditional Chinese (MingLiu) グリフは言語毎のフォントにより異なります. フォントは xml:lang により選択されるべきでしょう. つまりコードポイントから単純に一意のフォントは求められません. 57 Copyright 2015 Antenna House, Inc.

本日のテーマ Formatter って何? Formatter や XSL-FO 関連の話 DITA Open Toolkit って何? DITA OT がやってくれることカスタマイズの話 Formatter って何? Formatter は XSL-FO のレンダリングエンジンです XSL-FO

美味しい DITA の作り方セミナー 10/12/20 1 AH Formatter で DITA を自動組版してみようアンテナハウス株式会社 : 小林具典 10/12/20 2 本日のテーマ Formatter って何? Formatter や XSL-FO 関連の話 DITA Open Toolkit って何? DITA OT がやってくれることカスタマイズの話 Formatter って何?