redpen-paragraph.el の紹介

マニュアルを書く機会があったので redpen-paragrah.el という Emacs Lisp パッケージを作ってみた．これによって Emacs から RedPen をいい感じに使うことができる．この elisp は作ってから1年位使っていて，せっかくなので今回の記事を起こした．

RedPen の紹介

RedPen より引用．

RedPen はプログラマや記者が規約にしたがって文書 (マニュアルやソフトウェアドキュメント) を記述するのをサポートします。
RedPen は自然言語で記述された入力文書のチェックを自動化します。

RedPen には入力文書のフォーマットがいくつかあって，Markdown や AsciiDoc ， LaTex 等サポートされてる．Pull Request や Issue もいい感じに対応してくれる．
Issues · redpen-cc/redpen · GitHub
ArchLinux ユーザは AUR (en) - redpen を使っておくと systemd から使えるので良かったらどうぞ．

クイックスタートガイド

どこかのキーに redpen-paragraph を割り当てて任意の文章上で起動．C-u 付きで起動すればファイル単位を校正できる．

  (define-key global-map (kbd "C-c C-r") 'redpen-paragraph)

redpen-paragraph.el をなぜ作ったか？

Emacs で org-mode に対して校正したかったから．それと RedPen は org-mode に対応していなかったから．org-mode のフォーマットは *基本的には* 複雑なものじゃない．
org-mode の 正規表現をコピペすればそこそこ実用的なものは作れると思う．だけど細かい変更に追従できる気がしない．それならファイルの部分ごと，文章単位で校正できれば org-mode 以外にも使えるんじゃないだろうか？ （例： ソースコードのコメント）

以上の理由から redpen-paragraph.el を作った．