sXMLBook XSLT パラメータ リファレンス
編集中
XSLTパラメータは主に include/params.xsl に集約されています。sxmlbook-book.xsl / sxmlbook-book-app.xsl / sxmlbook-book-bs5.xsl などの各出力用XSLTは新規パラメータを定義せず、これらの既定値を上書き(プリセット)しているだけです。そのため本リファレンスはファイル毎に分けず一括して記載します。
既定値の {html.dir} などは他パラメータの値を参照して展開されます。
| 概要 | 引数名 | 既定値 | 説明 |
|---|---|---|---|
| 出力ルートディレクトリ | html.dir | ./ | HTML出力のルートディレクトリ。CSS/JS/画像など各ディレクトリの基点になります。 |
| ベースURL | html.base | ./ | ページの基準となるベースURL。 |
| CSSディレクトリ | css.dir | {html.dir}css/ | CSSファイルの配置ディレクトリ。 |
| テーマディレクトリ | theme.dir | {html.dir}theme/ | テーマCSSの配置ディレクトリ。 |
| JavaScriptディレクトリ | js.dir | {html.dir}js/ | JavaScriptの配置ディレクトリ。 |
| 画像ディレクトリ(images) | images.dir | {html.dir}images/ | images 配下の画像ディレクトリ。 |
| 画像ディレクトリ(img) | image.dir | {html.dir}img/ | img 配下の画像ディレクトリ。 |
| noimage画像 | noimage | index/noimage.png | appeal等で画像が無い場合に使う代替画像(image.dir相対)。 |
| HTML表示モード | html.mode | normal | HTML全体の表示モード。 |
| ヘッダモード | header.mode | onmenu | ヘッダの表示スタイル。 |
| フッタモード | footer.mode | normal | フッタの表示スタイル。 |
| ブックモード | html.book | (なし＝通常) | 1でブック(冊子)表示。sxmlbook-book/app/bs5出力では1にプリセット。 |
| 印刷モード | html.print | (なし) | 1で印刷向け表示。 |
| ローディング表示 | html.loading | 1 | 1でローディング画面を表示。 |
| Bootstrap CSS | css.bootstrap | bootstrap.min.css | 読み込むBootstrap本体CSS。 |
| テーマCSS | css.theme | bootstrap5/sxb.min.css | テーマCSS。bs5出力ではbootstrap5/bootstrap5.min.cssにプリセット。 |
| フォントCSS | css.fonts | fonts.min.css | WebフォントのCSS。 |
| プラグインCSS | css.plugins | plugins.min.css | プラグイン群のCSS。 |
| pokan(sXMLBook)CSS | css.pokan_sxmlbook | pokan/pokan.sxb.css | pokanテーマのsXMLBook用CSS。app出力ではmin版にプリセット。 |
| pokan CSS | css.pokan | pokan/pokan.css | pokanテーマ本体CSS。app出力ではmin版にプリセット。 |
| umbrella.js | js.umbrella | umbrella.min.js | umbrella.js本体。 |
| Bootstrap JS | js.bootstrap | bootstrap.bundle.min.js | Bootstrap本体JS(bundle)。 |
| プラグインJS | js.plugins | plugins.min.js | プラグイン群のJS。 |
| pokan(sXMLBook)JS | js.pokan_sxmlbook | pokan/pokan.sxb.js | pokanテーマのsXMLBook用JS。app出力ではmin版にプリセット。 |
| pokan JS | js.pokan | pokan/pokan.js | pokanテーマ本体JS。app出力ではmin版にプリセット。 |
| Mermaid JS | js.mermaid | mermaid.min.js | Mermaid図表描画用JS。 |
| バナー表示 | banner.show | 0 | 1で項目バナーを表示。 |
| タイトルアイコン | title.icon | fa fa-book | 項目タイトル先頭に表示するアイコン(webfont)。 |
| アイコン色クラス | icon.class | text-primary | アイコンに付与するBootstrapの文字色クラス。 |
| リンクターゲット | html.target | _self | リンクのtarget属性値。 |
| イメージクリック動作 | image.click | 1 | 0:無効 1:クリックで画像を拡大表示。 |
| タイトル番号付与 | item.prefix | 0 | 0:無し 1:番号付きタイトル。 |
| 目次見出し | text.indexes | 目次 | 目次の見出し文言。 |
| 目次ツリー表示 | tree.indexes | 1 | 1で目次をツリー表示。 |
| 目次トップ固定 | top.indexes | 0 | 1で目次をトップに固定表示。 |
| 目次ワイド表示 | wide.indexes | 0 | 1で目次をワイド表示。 |
| 目次展開階層 | deep.indexes | 1 | 目次を展開する階層数。 |
| トップ戻りマーク | top.mark | 1 | 0:無し 1:トップへ戻るリンクを表示。 |
| ヘッダタイプ | header.type | title | ヘッダの表示種別。 |
| 表示言語 | lang | ja | 多言語リソース(resource.xml)の言語切替(en/ja/vi)。コマンドライン等で上書き可。 |
| ローディング文言 | text.loading | ページを読みこみ中・・・ | ローディング画面のテキスト。 |
| ドキュメント情報ラベル | text.docinfo | ドキュメント情報 | ドキュメント情報欄の見出し。 |
| 著作権ラベル | text.copyright | 著作権 | 著作権表記の見出し。 |
| 日付ラベル | text.date | 日付 | 日付の見出し。 |
| 版数ラベル | text.release | 版数 | リリース(版数)の見出し。 |
| バージョンラベル | text.version | バージョン | バージョンの見出し。 |
| 関連項目ラベル | text.related | 関連項目 | 関連項目リンクの見出し。 |
| 関連用語ラベル | text.terms | 関連用語 | 関連用語リンクの見出し。 |
| NEWバッジ | text.new | NEWバッジ(HTML) | new属性の項目に表示するバッジ。HTMLで指定。 |
| UPDATEバッジ | text.update | UPDATEバッジ(HTML) | update属性の項目に表示するバッジ。HTMLで指定。 |
| MAKEバッジ | text.make | MAKEバッジ(HTML) | make(自動生成)項目に表示するバッジ。HTMLで指定。 |
| 非推奨バッジ | text.deprecate | DEPRECATEバッジ(HTML) | deprecate(非推奨)項目に表示するバッジ。HTMLで指定。 |
| CLOSEバッジ | text.close | CLOSEバッジ(HTML) | close項目に表示するバッジ。HTMLで指定。 |