メインコンテンツまでスキップ
version: v1.0

旧バージョンからの移行

alpha13からの移行

yagisan-reports開発ツール群の更新

yagisan-reports開発ツール群をインストールします。

npm install @yagisan-reports/sdk
npm install -D https://github.com/DenkiYagi/yagisan-reports-devtool

XMLエディタの準備(推奨)

v1.0からXML Schema (XSD 1.0) を提供するようになったため、対応するXMLエディタの使用を推奨します。 Visual Studio Code では、次の拡張が動作することを確認しています。

レイアウトXMLのマイグレーション

alpha13のレイアウトXMLをv1.0(2025.1)の形式に変換するには、以下のようにマイグレーションツールを実行します。

npx github:DenkiYagi/yrt-migrate --from alpha13 path/to/input.xml

基本的には自動的に変換されますが、以下のような警告が出て手動での修正や表示確認が必要になる場合があります。 メッセージに従い、レイアウトXMLを修正してください。

[WARNING] 30行13列目: <Image>
Image要素にwidth属性が導入されました。
必須属性であり、自動処理では値を設定できません。
レイアウトXMLを手動で修正し、width属性を追加してください。
sample04.xml:30:13

yrtファイルの作成

npx yagisan yrt pack コマンドを使用して、マイグレーション後のレイアウトXMLからyrtファイルを作成します。

npx yagisan yrt pack <xml...>

Create a YRT file from XML files and any assets

Positionals:
xml XML file (usage: `/path/to/xml` or `/path/to/xml@name`)
[array] [required] [default: []]

Options:
--help Show help [boolean]
--version Show version number [boolean]
-A, --asset Append asset file (usage: `--asset /path/to/asset@name`)[array]
-S, --style Append style xml file (usage: `--style /path/to/style`)[string]
-O, --out Set output file path [string] [required]

.glyphdata ファイルの差し替え

v1.0での異体字サポートの追加に伴い、 .glyphdata ファイルのフォーマットが変更されました。 自分で .glyphdata ファイルをホストしている場合は、npmパッケージに同梱されている .glyphdata ファイルに差し替えてください。

v1.0移行期間中におけるalpha13での開発

alpha13のサポート期間

v1.0のリリースに伴い、原則としてalpha13(およびそれ以前のバージョン)はサポート終了となります。

ただし、アーリーアクセス版を有償契約されているお客様に限り、2026年5月31日まで不具合修正に対応いたします。

alpha13のドキュメント

Webサイトのリニューアルに伴い、v1.0より前のバージョンの情報はWebサイト上で参照できなくなりました。 旧バージョンのドキュメントが必要な方は、以下からダウンロードしてください。

alpha13形式のyrtファイルの作成

最新バージョンの yagisan-reports-devtool でも、alpha13形式のyrtファイルを作成できます。

npx yagisan yrt pack-alpha コマンドを使用してください。

npx yagisan yrt pack-alpha <xml>

Create a YRT file from an XML file and any assets (legacy format for <= v1.0.0-alpha.13)

Positionals:
xml XML file path [string] [required]

Options:
--help Show help [boolean]
--version Show version number [boolean]
-A, --asset Append asset (usage: `--asset /path/to/aseet@id`) [array]
-O, --out Set output file path [string]