威沙（朱鷺魅）設定ファイル講座

はじめに

威沙にて出力プロファイルを定義するために設定ファイルを用いていますが、この設定ファイルを変更したいと思っても、「ドキュメントが無いためよく分からない」という方がいらっしゃいました。

確かにちゃんとしたドキュメントが無かったことは間違いないのですが、そもそもこれまでは変更する必要が無い前提で開発していた経緯があります。 （以前は別の出力フォーマットの設定もあったため、説明しにくいという面もありましたが）

とはいえ、１ページの行数や行長を変えたいということも多いでしょうから、ここで解説を作成しようと考え、作成したのがこのドキュメントです。


なお、この中で説明しない定義もありますが、大抵は未実装になっている定義です。

（実装する予定で書いたものの放置になっているものがちらほら……）

定義ファイルフォーマット

設定セクション

『[]』

『[]』に囲まれた名称が定義セクションのはじまりを表し、この単位で一つのプロファイルとなっています。

次に『[]』が現れるまで、その名称での設定が行われていることになります。

定義

『定義名="定義内容"』

定義に対し、設定を行います。

クオティーションで囲わなくても動作しますが、念のため囲ってください。

（数値系は問題無いと思いますが）

コメントアウト

『#コメントコメント』

『#』記号以降はコメントとして扱われます。

設定ファイル処理の実装が中途半端なため、現状では定義の中に#が混じっているとそれ以降がコメントアウトと扱われてしまいます。

……そのうち直したいところです……

プロファイル種別

デフォルトプロファイルセクション

デフォルトプロファイルセクション『[default]』は、以降に定義されるセクションの基本設定値となる定義です。

この定義は基本的に変更・削除しないでください。


定義を変更する場合は、新しいセクションを作ってそちらに必要な設定を記述してください。


なお、このデフォルトプロファイルセクションは、威沙のプロファイル選択には出てこないようになっています。

（00_A6_TWOPAGEプロファイルがデフォルトと等価のプロファイルになっています）

拡張プロファイルセクション

『[default]』以降に定義されているプロファイルが実際に使用できるプロファイルです。

予め基本的なプロファイルは用意していますが、これ以外にも設定を変えたい場合は、前述の通り、新しいプロファイルセクションを作成してください。


定義設定は、デフォルトプロファイルにて設定されていた値を、拡張プロファイルにて設定した値で上書きする形になります。


例 
[default]
    Profile="デフォルトプロファイル"        # プロファイル名称
    BaseSize_X=297                          # １ページの横幅
    BaseSize_Y=419                          # １ページの縦幅

[88_DUMMY_PROFILE]
    Profile="ダミープロファイル"            # プロファイル名称

[99_TEST_PROFILE]
    Profile="テストプロファイル"            # プロファイル名称
    BaseSize_X=419                          # １ページの横幅
    BaseSize_Y=297                          # １ページの縦幅

などと設定された場合、『ダミープロファイル』を選ぶと、BaseSize_Xは定義されていませんので、デフォルトプロファイルの値が使用されますが、 『テストプロファイル』を選んだ場合は、BaseSize_Xが定義されていますので、419という値が使用されることになります。

（拡張プロファイルで定義していないものはすべてデフォルトの値が使用されます）

プロファイル名称

『[]』に定義するプロファイル名称は、半角英数文字ならば自由に付けることが出来ます。

ただし、同じ名称が被らないようにしてください。


なお、威沙上で表示されるプロファイルの順番は、このプロファイル名称を昇順ソートした順になります。

定義一覧

実際に使用している定義を以下に示します。


定義定義名概要詳細
Profileプロファイル名称プロファイル名称を定義します。プロファイル名称を定義しており、威沙上で表示される名称となります。
この定義は必須です。
Explanationプロファイル説明プロファイルの説明を定義します。プロファイルについての説明を記述します。
威沙上のステータスバーに説明書きが表示されます
省略するとデフォルトプロファイルの説明が出てしまうので、設定は必須です。
Mode出力ファイル形式出力フォーマットを変更します。変更しないようにお願いいたします。
(過去との互換性のために残っているだけなので、弄ると不幸になります)
OutputType出力形式出力形式を定義します。見開き型、1ページ単位などの出力形式を定義します。
この定義に連動し、威沙上での出力形式の表示が変わります。
N：見開き方
1：1ページ単位方
S：1枚の用紙に両面で8ページを配置する方
P：1枚の用紙に両面で2ページ・4冊分を配置する方
N2：1枚の用紙で平綴じを行う方
N4：1枚の用紙で2冊分の平綴じを行う方
SA5：1枚の用紙に両面で4ページを配置する方式
BaseSize_X1ページ横サイズページの横サイズを指定します。ページの横サイズを指定する定義です。
指定単位はポイントとなっています
デフォルト値は297、A6横サイズを指定しています。
BaseSize_Y1ページ縦サイズページの縦サイズを指定します。ページの縦サイズを指定する定義です。
指定単位はポイントとなっています
デフォルト値は419、A6縦サイズを指定しています。
PaperSize_X紙面横サイズ出力紙面縦サイズを指定します。実際に出力する紙面の大きさを指定します。
トンボ出力が指定された場合、こちらの大きさが使用されます
デフォルト値は1676、A4横サイズを指定しています。
PaperSize_Y紙面縦サイズ出力紙面横サイズを指定します。実際に出力する紙面の大きさを指定します。
トンボ出力が指定された場合、こちらの大きさが使用されます。
デフォルト値は1188、A4横サイズを指定しています。

Head_M『天』のサイズ文章の上の余白サイズを指定します。ページ上の上辺と文章との距離を指定します。
指定単位はポイントとなっています。
なお、この間にページ番号・タイトルが入りますので、それらのサイズ及び位置が収まる大きさを指定する必要があります。
Koguchi『小口』のサイズ文章の右側の余白サイズを指定します。ページ上の右辺と文章との距離を指定します。
指定単位はポイントとなっています。
ページ横幅-小口＋文章範囲=ノドのサイズとなりますので、注意して設定してください。
FontSizeフォントサイズ文字の標準サイズを指定します。本文のフォントサイズを指定します。
このフォントサイズと行間サイズを元に改行処理が行われます。
（途中でフォントサイズを変更しても改行幅は一定になります。
デフォルト値は、8.5が指定されています。
RubyFontSizeルビフォントサイズルビのフォントサイズを指定します。ルビのフォントサイズを指定します。
通常、ルビはベース文字列のフォントサイズの半分と規定されていますので、ベースの半分4.25となっています。
RubyPointルビ位置ルビ位置を指定します。ベース文字とルビ文字との距離を指定します。
指定単位はポイントです。
最低ルビサイズ以上を指定してください。
デフォルト値は、4.3となっています。
CharcterNum1行の文字数文字数を指定します。一行の文字数を指定します。
デフォルトでは、42文字としております。
LineNum1ページの行数行数を指定します。1ページ当たりの行数を指定します。
改行幅変更が行われない限り、1ページ単位の行数は変わりません。
なお、設定データの範囲チェックはしていませんので、ちゃんと確認しないとはみ出たりします。
デフォルト値は、17行となっています。
NextM行間サイズ行間サイズを指定します。次行との幅を指定します。
ルビサイズ以上がないとルビがつぶれますので、注意です。
デフォルト値は、5.5としています。




FontTypeフォントファイル名フォントファイルを指定します。本文で使用するフォントファイルを指定します。
フォントはPDFに組み込まれますので、フォントのライセンスには注意してください
指定できる形式はTTFですが、一部読み込めないTTFがあります。（PDF出力に使用しているライブラリが古いので）
FontType_a欧文フォントファイル名欧文フォントファイルを指定します。本文中で使用する欧文フォントを指定します。
フォントはPDFに組み込まれますので、フォントのライセンスには注意してください
指定できる形式はTTFですが、一部読み込めないTTFがあります。（PDF出力に使用しているライブラリが古いので）




PageNumber_Xページ番号横位置ページ番号の横位置を指定します。ページ番号の横位置を指定します。
右ページを基準に指定しますので、右辺からどれだけ離れるかを指定してください。
PageNumber_Yページ番号縦位置ページ番号の縦位置を指定します。ページ番号の縦位置を指定します。
上辺からどれだけ離れるかを指定してください。
PageFontページ番号フォントページ番号のフォントを指定します。ページ番号で使用するフォントを指定します。
フォントはPDFに組み込まれますので、フォントのライセンスには注意してください
指定できる形式はTTFですが、一部読み込めないTTFがあります。（PDF出力に使用しているライブラリが古いので）
PageFontSizeページフォントサイズページ番号のフォントサイズを指定します。ページ番号で使用するフォントサイズを指定します。
なお、ページ上に付与されるページタイトルもこの値が使用されます。




Colorデフォルト文字色文字色を指定します。文字のデフォルト色を指定できます。
グレースケールならば0〜1、カラーの場合は、*000000〜*FFFFFFを指定します。
（本来は*ではなく、#なのですが、設定ファイルの実装上こうなっています。
デフォルトでは、0（黒）としています。
BGColor背景色背景色を指定します。背景の色を指定します。
グレースケールならば0〜1、カラーの場合は、*000000〜*FFFFFFを指定します。
（本来は*ではなく、#なのですが、設定ファイルの実装上こうなっています。
デフォルトでは、1（白）としています。
Steps段組用命令段組設定を行います。このタグが指定された場合、段組処理を実施します。
例えば、『2,25』と設定すると、二段組み・上下文章間隔25ポイントとなります。
実装上は何段でも可能ですが、紙面サイズオーバーをチェックしていませんので、注意してください。
なお、段組指定された場合、1行の文字数は1段分の文字数、1ページの行数は1段分の行数となります。




T2N_Strong強調サイズ強調文字のサイズを指定します。PreTNF→TNF又は青空→TNFにて強調指定された箇所のサイズを指定します。
T2N_PageTitleページタイトルサイズページタイトルサイズPreTNF→TNF又は青空→TNFにてページタイトルとして指定された文字列のフォントサイズを指定します。
T2N_RubyMapONルビマッピング機能ON/OFFルビマッピングの有効無効PreTNF→TNF又は青空→TNFにてrubymapタグによるマッピング処理を行うかの指定を行います。
T2N_DashChangeONダッシュのタグ変換機能ON/OFF取消線への置き換え有効無効PreTNF→TNF又は青空→TNFにてダッシュ文字『―』を空白への取消線で置き換える処理を有効・無効指定します
この機能はフォントによってはダッシュ文字の隙間が空いてしまうことへの対処です。