RubiMorph 使用ガイド

RubiMorphは、Web小説投稿サイトごとに異なるルビ・傍点・注記の記法を変換するWindows用ソフトです。

テキストの貼り付け、単一ファイル、複数ファイル、フォルダ単位の変換に対応しています。 変換処理はPC上で行い、原稿本文を外部サーバーへ送信しません。

詳細な手順は 操作マニュアル、 カスタム形式の試用ファイルは サンプルZIP から確認できます。

ダウンロード

Windowsインストーラー版とポータブル版には、実行に必要なPythonランタイムが含まれています。 Pythonを別途インストールする必要はありません。

インストール方法

Windowsインストーラー版

  1. 「Windowsインストーラー版」から最新版のインストーラーをダウンロードします。
  2. ダウンロードしたインストーラーを実行します。
  3. 画面の案内に従ってインストールします。
  4. インストール後、スタートメニューの「RubiMorph」から起動します。

ポータブル版

  1. 「ポータブル版」から最新版のZIPファイルをダウンロードします。
  2. ZIPファイルを任意のフォルダへ展開します。
  3. 展開したフォルダ内の RubiMorphGUI.exe を実行します。

実行ファイルと同梱フォルダを分離しないでください。 必要なファイルが同じフォルダ構成で収録されています。

Windows SmartScreenが表示された場合

現在の配布物はコード署名されていないため、 「WindowsによってPCが保護されました」または「不明な発行元」と表示される場合があります。

  1. このページまたは公式GitHub Releasesから取得したファイルであることを確認します。
  2. 必要に応じて、Releaseに含まれるSHA-256チェックサムと照合します。
  3. 内容を確認したうえで実行します。

GUIの使い方

本文を貼り付けて変換する

  1. 「変換元」で、現在の原稿が使っている記法を選びます。
  2. 「変換先」で、投稿先または出力形式を選びます。
  3. 変換先がプレーンテキストの場合は、「ルビ出力」でルビの扱いを選びます。
  4. 「テキスト変換」タブを開きます。
  5. 「入力テキスト」に本文を貼り付けます。
  6. 「変換」を押します。
  7. 右側の「変換結果」とステータスバーの警告件数を確認します。
  8. 問題がなければ、変換結果欄の「コピー」を押し、投稿先へ貼り付けます。

ルビ出力

ルビを削除
親文字だけを残し、ルビを削除します。
親文字(ルビ)で残す
親文字の後ろに、ルビを丸括弧で残します。

単一ファイルを変換する

  1. 「ファイル変換」タブを開きます。
  2. 処理単位で「単一ファイル」を選びます。
  3. 「入力ファイル」の「参照...」からUTF-8の .txt または .md を選びます。
  4. 「出力先」の「参照...」から保存先ファイルを指定します。
  5. 変換元、変換先、ルビ出力を確認し、「変換開始」を押します。
  6. ステータスバーと「詳細...」でログ・警告を確認します。

複数ファイルを変換する

  1. 「ファイル変換」タブを開きます。
  2. 処理単位で「複数ファイル」を選びます。
  3. 変換する .txt または .md ファイルを複数選択します。
  4. 「出力フォルダ」の「参照...」から保存先を選びます。
  5. 変換元、変換先、ルビ出力の設定を確認します。
  6. 「変換開始」を押します。
  7. ステータスバーの成功件数、エラー件数、警告件数を確認します。
  8. 必要に応じて「詳細...」を開き、ログと警告を確認します。

フォルダを変換する

  1. 「ファイル変換」タブを開きます。
  2. 処理単位で「フォルダ一括」を選びます。
  3. 「入力フォルダ」の「参照...」から原稿の入ったフォルダを選びます。
  4. 「出力フォルダ」の「参照...」から保存先を選びます。
  5. 変換元、変換先、ルビ出力の設定を確認します。
  6. 「変換開始」を押します。
  7. ステータスバーと「詳細...」でログ・警告を確認します。

対象は .txt.md です。 入力フォルダ内のサブフォルダ構成は、出力先でも維持されます。

ファイル出力時の動作

  • 入力ファイルは上書きしません。
  • 入力先と出力先が同じファイルになる場合は、ファイル名に _converted を付けます。
  • 変換結果はUTF-8で保存します。

ログと警告

メイン画面下部のステータスバーに、準備完了、変換完了、成功件数、警告件数などが表示されます。

詳しいログと警告は「詳細...」から確認できます。内容は選択してコピーできます。 投稿前に変換結果と警告を確認してください。

ヘルプメニュー

  1. 上部メニューの「ヘルプ」を開きます。
  2. 「操作マニュアルを開く」「使用ガイドを開く」「公式サイトを開く」「最新版とRelease」からWebページを開けます。
  3. 「RubiMorphについて」で、バージョンと開発者リンクを確認できます。
  4. 「OSSライセンス」で、第三者OSSの通知文とRubiMorph本体のライセンスを確認できます。

カスタム形式プロファイル

カスタム形式プロファイルは、独自の入力形式や出力形式を定義するUTF-8 JSONファイルです。 拡張子は .rubimorph-profile.json を推奨します。 任意のコード、外部プログラム、シェルコマンドは実行しません。

管理画面を開く

  1. 上部メニューの「カスタム形式」から「カスタム形式を管理...」を選びます。
  2. 一覧で、プロファイル名、プロファイルID、入力対応、出力対応、有効状態、検証状態、保存場所、最終更新日時を確認します。

新規作成と基本情報

  1. 管理画面で「新規作成」を押します。
  2. 「基本情報」で、表示名、プロファイルID、説明を入力します。
  3. 入力形式として使う場合は「入力形式として使用」を有効にします。
  4. 出力形式として使う場合は「出力形式として使用」を有効にします。
  5. 変換元・変換先へ表示する場合は「登録状態を有効にする」を有効にします。

プロファイルIDは英数字で始め、英数字、ハイフン、アンダースコアを使用します。 同じ登録領域に、同じプロファイルIDの有効なプロファイルを複数登録できません。

入力規則

「入力規則」では、正規表現で独自記法をルビまたは傍点として解析します。 「規則追加」「規則編集」「規則削除」「規則複製」「上へ移動」「下へ移動」を使用できます。

ルビ
kindruby。名前付きグループ basereading が必要です。
傍点
kindemphasis。名前付きグループ text が必要です。
\[\[ruby:(?P<base>.+?)\|(?P<reading>.+?)\]\]
\[\[em:(?P<text>.+?)\]\]

複数規則が一致する場合は、一致開始位置、priority、一致範囲の長さ、定義順で決定します。 一致しない文字列は通常のテキストとして保持します。

出力テンプレート

「出力テンプレート」では、内部要素を文字列として出力する形式を指定します。

ルビ
{base}{reading} を使用できます。
傍点
{text} を使用できます。
[[ruby:{base}|{reading}]]
[[em:{text}]]

波括弧そのものを出力する場合は {{}} を使います。 属性アクセス、配列アクセス、関数呼び出し、式評価は使用できません。

前処理と後処理

「前処理」は解析前に実行する置換規則です。 「後処理」は出力生成後に実行する置換規則です。 どちらも一覧の上から順に実行します。

置換種別は literalregex です。 literal は単純な文字列置換、regex は正規表現置換です。

検証とテスト

  1. 「検証」を押すと、保存前にプロファイルを確認します。
  2. 「検証とテスト」でテスト入力を入れ、「テスト実行」を押します。
  3. 入力対応プロファイルでは、解析結果と内部要素の簡易表示を確認できます。
  4. 出力対応プロファイルでは、テスト出力を確認できます。
  5. 入力・出力の両方に対応するプロファイルでは、同じプロファイルで解析と出力を確認できます。

エラーがあるプロファイルは変換元・変換先として表示しません。 不正なプロファイルが保存領域にあっても、RubiMorph全体は起動します。

保存、インポート、エクスポート

  • 「保存」は登録済みの保存場所へ保存します。
  • 「名前を付けて保存」は任意の場所へJSONファイルとして保存します。
  • 「インポート」は外部のプロファイルファイルを登録領域へ取り込みます。
  • 「エクスポート」は登録済みプロファイルを任意の場所へ書き出します。
  • 「複製」は選択中のプロファイルをコピーして別IDとして保存します。
  • 「登録」は有効状態にします。「登録解除」は無効状態にします。
  • 「削除」は確認後、登録済みファイルを削除します。

登録済みプロファイルは、インストールフォルダではなくユーザー設定領域へ保存します。

%APPDATA%\RubiMorph\profiles

変換元・変換先での選択

検証済みで有効な入力対応プロファイルは、変換元に カスタム: 表示名 と表示されます。 出力対応プロファイルは、変換先に同じ形式で表示されます。

カスタム形式は、貼り付けテキスト、単一ファイル、複数ファイル、フォルダ一括変換で使用できます。

正規表現の注意

カスタム形式を含む変換は、正規表現による長時間停止を避けるため、タイムアウト付きの子プロセスで実行します。 プロファイルファイルサイズ、規則数、正規表現パターン長、テンプレート長、置換文字列長にも上限があります。

対応形式

形式 対応状況
カクヨム 対応
小説家になろう 対応
エブリスタ 対応
pixiv小説 対応
青空文庫 対応
HTML ruby 対応
Markdown 簡略出力
プレーンテキスト 対応
note 一部対応
ノベルアップ+ 一部対応

GUIの選択肢は、対応または一部対応の形式です。 CLIでは --list-platforms で、研究中や対応予定のprofileも含めた一覧を確認できます。

主な入力記法

CLIの使い方

CLIを使用する場合は、インストール先またはポータブル版のフォルダにある RubiMorph.exe をPowerShellまたはコマンドプロンプトから実行します。

ヘルプ

RubiMorph.exe --help

バージョン確認

RubiMorph.exe --version

対応形式の一覧

RubiMorph.exe --list-platforms

変換対応表

RubiMorph.exe --matrix

文字列を直接変換する

RubiMorph.exe --from kakuyomu --to pixiv --text "これは|禁猟の園《きんりょうのその》です。"

単一ファイルを変換する

RubiMorph.exe --from kakuyomu --to html --input input.txt --output output.txt

フォルダを一括変換する

RubiMorph.exe --from kakuyomu --to narou --input-dir input_texts --output-dir converted_texts

書き込みを行わずに確認する

RubiMorph.exe --from kakuyomu --to pixiv --input-dir input_texts --output-dir converted_texts --dry-run

診断レポートを出力する

RubiMorph.exe --from kakuyomu --to pixiv --input input.txt --output output.txt --report report.json

プレーンテキスト出力でルビを丸括弧にする

RubiMorph.exe --from kakuyomu --to plain --plain-ruby-mode parentheses --input input.txt --output output.txt

カスタム形式プロファイルを検証する

RubiMorph.exe --validate-profile examples\custom-profiles\example-bracket-format.rubimorph-profile.json

カスタム形式を変換元にする

RubiMorph.exe --from-profile source.rubimorph-profile.json --to kakuyomu --input input.txt --output output.txt

カスタム形式を変換先にする

RubiMorph.exe --from kakuyomu --to-profile target.rubimorph-profile.json --input input.txt --output output.txt

カスタム形式同士で変換する

RubiMorph.exe --from-profile source.rubimorph-profile.json --to-profile target.rubimorph-profile.json --input input.txt --output output.txt

注意事項

関連リンク