はじめに
仕様書や設計書、手順書、マニュアル等作成時、誤字脱字、表現揺れなど修正、確認に手間かかりますよね。RedPenはそういった文書校正をするためのオープンソースのツールです。
WindowsでRedPenサーバー環境を構築した検証メモです。
環境作成方針
・OSはWindows10
・環境を汚したくないのでjavaはインストールせずに利用。
・環境変数はRedPen起動バッチに記述する
・RedPenフォルダを作成して、配下にJAVAとRedPenを設置する
・フォルダはC直下とする
手順
1.カレントディレクトリ作成 ※勿論、普通にUIで作成してもよい
mkdir c:\RedPen
2.JAVAのダウンロード
ここではopenjdkでバージョンはLTSでサポートの安定しそうな11で進めます
2-1以下サイトから取得
http://jdk.java.net/
・ファイル名：openjdk-11+28_windows-x64_bin.zip
2-2.ファイルを解凍してjdk-11フォルダをc:\RedPenに保存する
・解凍前のファイルは不要なので削除してよし
3.RedPenの配置
3-1.以下URLからファイルダウンロード ※2021/8/26現在の最新は1.10.4
https://github.com/redpen-cc/redpen/releases/
ファイル名：redpen-1.10.4.tar.gz
3-2.c:\RedPenに保存する
3-3.コマンドプロンプトを起動
3-4.カレントディレクトリ移動 ※tarコマンドはカレントディレクトリに解凍されるので
cd c:\RedPen
3-5.解凍する
tar xvzf C:\RedPen\redpen-1.10.4.tar.gz
・解凍前のファイルは不要なので削除してよし
3-6.フォルダ名「redpen-distribution-1.10.4」は長いので「redpen-1.10.4」にリネームする
4.RedPen設定
4-1.起動用バッチの修正
RedPen起動時にJAVAを認識するようにパス通す
・以下ファイルをテキストエディタで開く
C:\RedPen\redpen-distribution-1.10.4\bin\redpen-server.bat
4-2.ファイル先頭の6行目あたりに以下の3行を記載
set JAVA_HOME=C:\RedPen\jdk-11
set PATH=%JAVA_HOME%\bin
set CLASSPATH=%JAVA_HOME%\lib
以下の感じとなる
@echo off
rem
rem RedPen Server startup script
rem
set JAVA_HOME=C:\RedPen\jdk-11
set PATH=%JAVA_HOME%\bin
set CLASSPATH=$JAVA_HOME%\lib
rem Find RedPen home
set REDPEN_HOME=%~dp0\..
～以下省略～
★もし、別にTOMCAT等が起動している場合はポート番号も変更できる
以下のポート番号を修正。今回は50001とする
set REDPEN_PORT=50001
5.起動確認
5-1.redpen-server.batをダブルクリックする
以下のようになれば正常起動できたぞ
5-2.ブラウザで「http://localhost:50001/」を開こう。以下のように出るはずだ
6.カスタムファイルを読み込む
独自の構成ルールで利用するためconfファイルを編集して読み込むことも可能だ
6-1.C:\RedPen\redpen-1.10.4\conf\redpen-conf-ja.xmlをコピーして「redpen-conf-sv.xml」を作成する
※元のファイルを残すためコピーしておく
6-2.redpen-conf-sv.xmlをテキストエディタで開く
6-3.編集例としてSuggestExpressionを追加する。
これは独自の変換語句を指定するもの。ここでは「サーバー」を「サーバ」に指摘するように設定する
23行目に、以下の3行を追加する
<validator name="SuggestExpression">
<property name="map" value="{サーバ,サーバー}" />
</validator>
※xmlファイルの編集は文字コードに気を付けよう。コピペしたときに文字コードが違っているとファイルが壊れるぞ
6.4 redpen-server.batをテキストエディタで開く
作成したconfファイルを読み込むように指定する。
コメントアウトされているので有効にしてファイル名を編集する
◆変更前
rem set REDPEN_CONF_FILE=%REDPEN_HOME%\conf\redpen-conf-en.xml
◆変更後
set REDPEN_CONF_FILE=%REDPEN_HOME%\conf\redpen-conf-sv.xml
6-5.サーバ落とす（起動中のコマンドプロンプトを閉じる）
6-6.起動バッチを実行する
6-7.ブラウザを開こう。
作成したconfを読み込むために
Paserは「PLAN」を選択、Languageは「ja」を選択する。
これで作成した校正ファイルが反映される。
右下の「SuggestExpression」欄にはサーバ、サーバーが表示されているはずだ。
※現バージョンでは、初期値の変更ができないみたいです。
試しに左上のテキストエリアにサーバと入力しよう
左下欄にはサーバをサーバーにするようエラーが出る。
以上
参考サイト
redpen公式TOP
https://redpen.cc/
redpen公式マニュアル
http://redpen.cc/docs/latest/index_ja.html
PG本体
https://github.com/redpen-cc/redpen/releases/
作者のqiita
https://qiita.com/takahi-i
作者の記事：RedPenを使って技術文書を手軽に校正しよう
https://gihyo.jp/lifestyle/serial/01/redpen/0001?page=1
履歴
2021/8/26 作成