RedPenを使って技術文書を手軽に校正しよう

第4回 RedPenの利用方法

この記事を読むのに必要な時間:およそ 3 分

Herokuボタン

さらにRedPenサーバはHerokuボタンから立ち上げられます。Heroku上にRedPenが立ち上がることで,ユーザ環境でサーバを管理する手間がなくなります。

Herokuボタン

画像

Herokuボタンをクリックすると,次の画面に遷移します。

Herokuデプロイ

画像

画面内の"Deploy for Free"と書かれたボタンをクリックすると,Heroku環境でRedPenサーバの配備がはじまります。

Atomからの利用

AtomはGitHubが公開したエディタです。Atomの特徴のひとつに豊富なパッケージ(機能拡張)群があります。

パッケージの中には他のエディタを利用する人が乗り換えやすいようにキーバインドをシミュレートするものが存在します。私は長年Emacsで文書を書いていたのですが,Emacsのキーバインドをシミュレートするパッケージを利用することで比較的簡単に乗り換えられました。

先日@griffin_stewieさんがAtomのRedPenパッケージを作成しました。詳しい使い方は@griffin_stewieさんのRedPen パッケージについてのブログ記事に説明があるのでそちらを参照してください。

実はこの原稿をAtom Editorで書きRedPenパッケージでチェックしています。コマンドラインと違って,リアルタイムに検査結果が表示されるので大変便利です。次図はAtom Editorでの作業の様子です。

Atom Editor での執筆

画像

Homebrew対応

@kozo2さんがRedPenのHombebrew用のforumlaを記述してプルリクエストを送っています。もうしばらくするとマージされるのではないかと思います。HomeBrew対応によりRedPenをインストールするコストがさらに低減されることが期待できます。

Rubyバインディング

RedPen自体はJavaで記述されていますが,RubyからRedPenを簡単に呼び出すためのGem@akinomurasameさんが公開しました。普段Rubyを利用される方は,文書執筆する際に是非いちど試してみてください。

ノート:二次利用に関して

先日RedPenの二次利用は問題ないかという質問をいただきました。我々はRedPenを簡単に利用する上でRedPen本体の開発がまだ充分でないと感じています。

そのため手が回らない,他言語対応などのRedPenの二次利用は非常にありがたいです。公開した場合には,RedPenのホームページよりリンクを張りたいと考えているため,そのURLを私に知らせていただければ幸いです。

また執筆に必要な機能などありましたら,気軽にIssueやプルリクエストを追加してください。

まとめ

今回はRedPenを多様な状況で利用する方法について解説しました。前半ではRedPenがサポートしていない多様なフォーマットで書かれた文書にRedPenを適用する方法について述べました。後半では,RedPenが提供するコマンド以外での利用方法について解説しました。

著者プロフィール

伊藤敬彦(いとうたかひこ)

ソフトウェアエンジニア。専門はデータマイニングと情報検索だが,他にも色々やってみたいと感じている。