OpenJDK | ||||
インストール | ||||
yum install java-1.8.0-openjdk | ||||
環境変数Path設定 | ||||
export JAVA_HOME=/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.302.b08-0.el8_4.x86_64 | ||||
export PATH=$PATH:$JAVA_HOME/bin | ||||
export CLASSPATH=.:$JAVA_HOME/jre/lib:$JAVA_HOME/lib:$JAVA_HOME/lib/tools.jar | ||||
Redpen | ||||
redpen-1.10.4.tar.gz 本体を以下URLからダウンロード | ||||
https://github.com/redpen-cc/redpen/releases/ | ||||
解凍 | ||||
tar xvf redpen-1.10.4.tar.gz | ||||
PGのディレクトリを作成 | ||||
mkdir -p /usr/local/redpen | ||||
ファイルを移動 | ||||
mv redpen-distribution-1.10.4 /usr/local/redpen | ||||
環境変数追加 | ||||
export PATH=$PATH:/usr/local/redpen/bin | ||||
動作確認 サンプルWebサーバ起動 | ||||
Webサーバ起動 | ||||
redpen-server start | ||||
以下でも起動可能。 | ||||
java -jar /usr/local/redpen/bin/redpen-server.war | ||||
停止 | ||||
redpen-server stop | ||||
ブラウザからアクセス | ||||
http://localhost:8080/ | ||||
http://192.168.126.129:8080/ | ||||
動作確認 コマンドライン | ||||
基本コマンド | ||||
redpen -c 設定ファイル 検査対象テキストファイル | ||||
テストファイル準備 | ||||
vi等で作成 | ||||
ここでは「 /usr/local/redpen/test.txt」に保存する | ||||
実行 | ||||
redpen -c /usr/local/redpen/conf/redpen-conf-ja.xml /usr/local/redpen/test.txt | ||||
専用辞書の設定 | ||||
辞書ファイル準備 | ||||
タブ区切りで作成する | ||||
例:「サーバー」を「サーバ」とする場合 | ||||
サーバー サーバ | ||||
ここでは「/usr/local/redpen/conf」に保存する | ||||
conf設定:コメントアウトされているので有効にして保存先パス記載 | ||||
<validator name="SuggestExpression"> | ||||
<property name="dict" value="/expressions.txt" /> | ||||
</validator> | ||||
confに追加するケース | ||||
<validator name="SuggestExpression"> | ||||
<property name="map" value="{更に,さらに}" /> | ||||
</validator> | ||||
参考 | ||||
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 | ||||
その他 | ||||
RedPenとPandocでドキュメント作りの手間を省こう | ||||
https://qiita.com/t_nakayama0714/items/ddac69c4a29d45392961 | ||||
東北ギーク | ||||
http://tech.respect-pal.jp/try-redpen/ | ||||
https://blog.amedama.jp/entry/2017/12/31/185734 |
■設定できるパラメータ
No | パラメータ | 説明 | 対応言語 | 設定候補 |
1 | SentenceLength | 最大文字超 | - | |
2 | InvalidExpression | 入力に不正な表現(単語や句)が存在するか検査 | - | |
3 | InvalidWord | InvalidWord は入力文に不正な単語が存在するかを検査します。 | ヨーロッパ系 | |
4 | CommaNumber | 一文(センテンス)で利用されるコンマの数 | - | |
5 | WordNumber | 一文内の単語数 | ヨーロッパ系 | |
6 | SuggestExpression | 入力に不正な表現(単語や句)が存在する場合に正しい表現を表示 | - | |
7 | InvalidSymbol | シンボルによっては代替のシンボルが存在します。 たとえばクエスチョンマーク ?(0x003F) は代替のシンボル ?(0xFF1F) が Unicode に登録されています。 InvalidSymbol は入力文で不正なシンボルが利用されているとエラーを出力します。 |
||
8 | SymbolWithSpace | シンボルによっては前もしくは後にスペースが必要です。 たとえば、左括弧 "(" の前には、かならず半角スペースを置くという規約がありえます。 | ||
9 | KatakanaEndHyphen | カタカナ単語の語尾が規約(JIS Z8301 、G.6.2.2 b 、G.3.)に従っているかを検査します。 具体的には以下のルールが適用されます。 a: 単語が三文字もしくはそれ以上の場合には、ハイフンで単語は終わらない。 b: 単語が二文字もしくはそれ以下の場合には、単語はハイフンで終わってもよい。 c: 単語が複合語の場合には各々の部分単語について条件が適用される。 d: a から c のルールにおいて、拗音をのぞきハイフンは一文字としてカウントされます。 |
不要 | |
10 | KatakanaSpellCheck | カタカナ単語のスペリングを検査します。 対象となるカタカナ単語に類似する単語が存在した場合、エラーを出力します。 たとえば、"インデックス"と"インデクス"が同一文書で利用されているときにエラーを出力します。 | ON | |
11 | SectionLength | 節で利用できる単語の数を指定します。 | info | |
12 | ParagraphNumber | 節の中に存在してよいパラグラフの最大数を指定します。 | ||
13 | ParagraphStartWith | パラグラフの開始部分が指定された規約に従っているかを検査します。 | ||
14 | SpaceBetweenAlphabeticalWord | アルファベット単語の前後に空白が存在するかを検査します。 単語が空白によって区切られない言語(日本語、中国語など)で執筆するときに使用します。 | 不要 | |
15 | Contraction | 入力文書で省略表現が利用されたときにエラーを出力します。英語のみ | 英語のみ | |
16 | Spelling | 文書内でスペルミスが起こった時にエラーを出力します。英語のみ | 英語のみ | |
17 | DoubledWord | 一文内で二回以上、同一の単語が使用されたときにエラーを出力します。 たとえば、以下の文では良いが二回使われているので、エラーを出力します。 この良い本は良いね。 |
||
18 | SuccessiveWord | 同一の単語が連続して使用されたときにエラーを出力します。 例:日本語はいい言語言語だ。 |
ON | |
19 | DuplicatedSection | 文書中に著しく類似する節が存在すると、エラーを出力します。 類似度はコサイン距離によって計算されます。 | ON | |
20 | JapaneseStyle | ですます調とである調が混在して利用された場合、エラーを出力します。 | ON | |
21 | DoubleNegative | 入力文書に二重否定が使用されているとエラーを出力します。 | ON | |
22 | FrequentSentenceStart | 多くの文が同一表現から開始されているときにエラーを出力します。 | ||
23 | UnexpandedAcronym | 省略形で書かれている単語の正式表記が文中に存在するかを検査します。英語のみ | 英語のみ | |
24 | WordFrequency | 文中で使用されている単語が一般的な単語の頻度とくらべ異なる際にエラーを出力します。英語のみ | 英語のみ | |
25 | Hyphenation | 文中の数値表現が一般的な記法に従っているかを検査します。英語のみ | 英語のみ | |
26 | NumberFormat | 文中の数値表現が一般的な記法に従っているかを検査します。 | ヨーロッパ系 | |
27 | ParenthesizedSentence | 括弧に関する規約を検査します。 検査するポイントは以下の3つです。 ・一文内で使用される括弧の使用頻度 ・ネストされた括弧が存在するか ・括弧の開始位置から終了位置までの長さ |
||
28 | WeakExpression | 書内で Weak Expression と呼ばれる表現が使用された場合、エラーを出力します。 ※弱い表現。 |
英語のみ | |
29 | DoubledJoshi | 同一の助詞が一文で二回以上、利用されているとエラーを出力します。 | 日本語 | ON |
30 | HankakuKana | 半角カナ文字が利用されているとエラーを出力します。 | OFF | |
31 | Okurigana | 送りがなの使い方が正しくない場合にエラーを出力します。 | ||
32 | StartWithCapitalLetter | 文が小文字から始まっている場合にエラーを出力します。 | 英語、ラテン系の言語 | |
33 | EmptySection | 節に段落や文が1つも含まれていない場合にエラーを出力します。 | ||
34 | GappedSection | GappedSection は節(章)の大きさにギャップがあるとエラーを出力します。 たとえば、以下のテキストでは 1 節の直下に 1.1.1 節があります。 つまり 1 節と 1.1.1 節の間にギャップが存在します。 ギャップを埋めるためには、1.1.1 節の前に 1.1 節が存在するべきです。 # 1 節 ... ### 1.1.1 節 ### 1.1.2 節 ... |
||
35 | LongKanjiChain | 長すぎる熟語(漢字の連続)を検出し、エラーを出力します。 | OFF | |
36 | SectionLevel | 深すぎる節を検出しエラーを出力します。 | ||
37 | JapaneseAmbiguousNounConjunction | 日本語文に含まれる、曖昧な名詞接続のパターンを検出しエラーを出力します。 ここで、曖昧な名詞接続のパターンとは、格助詞の "の" + 名詞連続 + 各助詞の "の" です。 たとえば以下の文は、曖昧な名詞接続を含んでいます。 弊社の経営方針の説明を受けた。 |
日本語 | |
38 | JapaneseExpressionVariation | 表記ゆれの可能性を検知します。 この機能は KatakanaSpellCheck と同様です。両者違いは JapaneseExpressionVariation がカタカナ単語だけでなるあらゆる種類の単語を対象に表記ゆれを検知する点です。 | 日本語 | info |
39 | JapaneseNumberExpression | 日本語文において、計数表現のスタイルが一貫していない箇所を検出しエラーを出力します。 | 日本語 | |
40 | JapaneseAnchorExpression | 章節の参照が一貫したスタイルになっているか検査します。 | 日本語 | |
41 | SuccessiveSentence | 同一の文が二回連続で使用されるとエラーを出力します。 たとえば入力文書に以下のパラグラフが含まれていると、エラーを出力します。 例:いつも感じるのです。日本語はよい言語だ。日本語はよい言語だ。 |
||
42 | DoubledConjunctiveParticleGa | 一文に二回以上、接続助詞の が が出現するとエラーを出力します。 例:今日は早朝から出発したが、定刻通りではなかったが、無事会場に到着した。 |
日本語 | |
43 | ListLevel | 入力文書内に含まれるリスト項目の階層を検査します。 リスト項目の階層が指定された最大値よりも深い場合、エラーを出力します。 | OFFOFF |