物置き

RedmineのWikiを編集するVimプラグインを作成

久々の更新。
題名の通り、RedmineWikiVim上で編集するためのプラグインを作ってみました。
同様の機能のものはすでにあるとは思うけど、自分が作ったのはPukiVimのような使用感のもの。

GitHubに置いてますのでご利用ください。
https://github.com/ampmmn/vim-redmine-wiki

使い方

インストールすると、RedmineWikiBookmarkというコマンドが使えるようになります。
このコマンドを実行すると、ブックマークページが表示されます。
このブックマークページに編集したいWikiページのあるRedmineプロジェクトへのURLを記述します。

↓ こんな感じ

このブックマークページを編集して、よくアクセスするRedmineWikiページへのURLを記載し、保存してください。


URLの上にカーソルをおき、Enterキーを押すと、Wikiページのソースをバッファ上に表示します。
バッファを編集し保存すると、変更がWiki側に反映されます。

Wikiページへのリンクを上でEnterキーを押すと、リンク先ページを表示・編集することができます。

・・・という感じのPukiVimのRedmineWiki版です。

できること

  • Wikiページの閲覧・編集
  • ページ作成
  • ページ削除
  • ページ一覧表示

必要なもの

上記のほかに、openbrowser.vimが入っていれば、
現在表示しているWikiページをブラウザで開くことができます。

(上の[OpenBrowser]上でEnterキーを押すか、gxキーを押す。

あと、vim-syntax-redminewikiを入れとくと、
Wikiページに対してシンタックスハイライトが行われます。
Textile記法です。Markdown記法は知りません。

その他メモ

  • 初回アクセス時にAPIキーをプロンプトで入力しますが、ここで入力キーは「.vim/redminewiki/apikeys.json」に保存します。
    • g:redminewiki_datadir変数で設定保存先ディレクトリを変更できます
  • Windowsでしか動作確認してません

既知の問題

  • Redmineプロジェクト側のWikiページがまったく存在しない場合にエラーがでます。(修正)
  • このプラグインで新規作成したページは、すべてルートページとなります。
    • (2015/6/14時点では、REST API経由で作成するページの親ページを指定することができないため)