• redmineのwikiでTOC(目次)の位置を固定する

    経緯

    redmineのwikiで、ページ内のh1.h2.等見出しをまとめたページ内リンクを作ってくれる{{toc}}マクロがある。
    ※大体、右肩に表示したいことが多く{{>toc}}を用いている

    しかし、長いページをスクロールさせると目次がスクロールアウトして見えなくなり、ページ内リンクをクリックできなくて不便だと思っていた。 例えば何かの手順を流れに沿って並べてあるような場合に説明(セクション)を行ったり来たりしたい。
    見出しでセクション分けしていた内容を独立した別ページにするなどしてみたものの、数が多いと面倒だしリンク集部分を自前でメンテするのも大変。

    ということで、tocマクロによる目次をページがスクロールしても画面内に留めるredmine_wiki_fix_tocプラグイン。 https://github.com/tckz/redmine_wiki_fix_toc

    Feature

    • ページ内に右寄せのTOC{{>toc}}がある場合に、同TOCが元々表示されていた位置よりも下にスクロールしたとき、表示位置を固定(position: fixed)する。
      • 左寄せのTOCを画面内にfixすると文章にかぶってしまうので右寄せ限定
    スクロール前
    ↓↓↓ スクロールさせる ↓↓↓
    スクロール後

    補足

    • すべてのページにプラグイン独自のhtmlを差し込むためにview_layouts_base_body_bottomフックを用いる

      class ViewListener < Redmine::Hook::ViewListener
        def view_layouts_base_body_bottom(context)
          context[:controller].send(:render_to_string,
            :template => 'wiki_fix_toc/body_bottom',
            :layout => false,
            :locals => {:context => context})
        end
      end
      
    • 後はplugins/redmine_wiki_fix_toc/app/views/wiki_fix_toc/body_bottom.html.erbでTOCを見つけてイベントを貼り付けるコードを書く。

    環境

    • CentOS 7.1 x64
      • ruby 2.2.0p0 x64
        • redmine 3.1.1
    • Windows 10 Enterprise x64
      • Firefox Developer Edition 43.0a2 x64
  • redmineの プラグインを 2.0から 2.1に移行する

    前回と似たような話。

    自分ところのプラグインでredmine 2.1向けに影響があったのは以下のとおり。

    1. prototype/script.aculo.us→ jQuery
    2. wikiマクロ出力の変化

    1はなんというか地道にjQuery向けに書きなおした。

    2。今まではwikiマクロからStringを返すとhtml(を表す文字列)だったけど、HTMLエスケープされるように変わった。htmlとして出力してという表明が必要になった。といってもhtml_safeメソッドを呼んであげるだけ。
    wikiマクロの中から例外を飛ばしてエラーメッセージを出したい時に、例外オブジェクトに与えるmesageをhtmlエスケープしてあげないといけない不自然さがなくなったのはよかった。

         macro  :graphviz_me do |wiki_content_obj, args|
    m = WikiGraphvizHelper::Macro.new(self, wiki_content_obj)
    m.graphviz_me(args, params[:id]).html_safe
    end

    https://github.com/tckz/redmine-wiki_graphviz_plugin
    https://github.com/tckz/redmine_wiki_preview_ext
    https://github.com/tckz/redmine_wiki_astah

    redmine 2.1におけるwikiマクロに関する最も大きな変化は、マクロの引数に複数行テキストを使用できるようになったことだなー。

    #3061 Let macros optionally match over multiple lines and ignore single curly braces

    今までredmine本体に手を入れないといけなかったWiki External Filter Pluginがそのまま動くようにできるから、対応図種が豊富なこれでいいやん、て。

  • redmineの プラグインを 2.0用に移行する

    Redmineによるタスクマネジメント実践技法

    redmine 2.0がリリースされて一ヶ月ちょい。
    新featureが出てくる前に自作のプラグインも移行しておかないとなーと思いつつ放置してたんだけど、やっと手をつけた。

    以下のURLを参考にした。

    Redmine 2.0.xにプラグインを移植する
    Redmine2.0へのプラグインのマイグレーションについて


    自分のところでひっかかったこと。

    • RAILS_ROOTが使えない
       → Rails.root
    • RAILS_DEFAULT_LOGGERが使えない
       →Rails.logger
    • RAILS_ROOT/vendor/plugin/が変更された
       →RAILS_ROOT/plugin/
    • routesの定義の仕方
       →ActionController::Routing::Routes.draw からRedmineApp::Application.routes.drawに
      RedmineApp::Application.routes.draw do
        match 'projects/:project_id/wiki/:id/graphviz', :to => 'wiki_graphviz#graphviz'
      end
      
    • テンプレートのファイル名が変わった
       →*.rhtml から *.html.erbに
    • テスト用webサーバ他のコマンドが変わった
       →./script/sever から ./script/rails server に
       →./script/runner から ./script/rails runner に
    • ActionController::Base.cache_configured? がprivateになった
       →意図が違うが ActionController::Base.perform_caching で代替


    ここからはredmine 2.0への移行じゃなくて、ruby 1.8から1.9に変えたことでひっかかったこと。

    • String#eachがなくなった
       →String#each_line とか
    • proc+ブロックで得たProcオブジェクトのブロック内でreturnしたら呼び出し元メソッドがreturnした
      これを知らなくてすごく悩んだ。
      Redmineのviewフック内でコントローラにrender_to_stringをsendしている。
      テンプレート内でクロージャ(proc由来のProcオブジェクト)を使ってtrue/falseを返しているつもりだったのだけど、viewフックメソッドからtrueが返る状態になってしまった。
      lambdaに変更した。


    それぞれremdine-2.0ブランチ
    https://github.com/tckz/redmine-wiki_graphviz_plugin
    https://github.com/tckz/redmine_wiki_preview_ext
    https://github.com/tckz/redmine_wiki_astah


    でも、redmine 2.0系のfeatureが増えてくるまでは、運用環境は1.4系のままかな。

  • redmineの wikiのプレビュー表示を移動可能にする

    ss.png redmineの wikiマクロで graphviz その4で編集中の内容で画像を描画できるようになった。
    だけど、プレビュー表示領域は編集領域の下方にあるため、dotをちょっと直して→画像確認→ちょっと直す、ということを繰り返そうと思うと都度上下に行ったり来たりしないといけないので面倒。

    プレビュー領域をドラッグして見やすい位置に移動したい。右側とか。

    ということで、wikiページ編集のプレビュー表示をドラッグ可能にするwiki_preview_extプラグイン
    https://github.com/tckz/redmine_wiki_preview_ext


    viewのフックを使って所定のコントローラ×アクションの場合に、javascriptコードを差し込んでドラッグ可能にする。
        class ViewListener < Redmine::Hook::ViewListener
    def view_layouts_base_body_bottom(context)
    context[:controller].send(:render_to_string,
    :template => 'wiki_preview_ext/body_bottom',
    :layout => false,
    :locals => {:context => context})
    end
    end
    redmine 1.3はscript.aculo.usを使っているのでこれをそのまま使わせてもらい、Draggableでdiv#previewをまるごと移動できるようにした。
        new Draggable(preview, {scroll: window});
    preview.setStyle({cursor: "move"});
    ノブを付けたかったけど、プレビュー機能がdiv配下をAjax.Updaterで更新しているのと、当該要素周辺の構造は変えないようにしたかったのでdiv全体にDraggable適用した。

    wikにオートプレビュー機能を追加するプラグインは既にあって、編集と同時にプレビュー更新することができる。
    既存のオートプレビュープラグインと併用するか、wiki_preview_extプラグインのオートプレビュー機能をプラグイン設定画面で有効にする。


  • redmineの wikiマクロで graphviz その4

    その3」を書いたのが3年以上前なのか。
    redmineのwikiにgraphvizを使った画像を埋め込めるようにするマクロ。
    https://github.com/tckz/redmine-wiki_graphviz_plugin

    graphviz_meマクロは、このマクロが埋め込まれているwikiページ全体をdotとみなして画像描画する。
    wiki編集中のプレビューの際に、wikiマクロに渡ってくるモデル(WIkiContent)が保存済のもののため、今現在編集している内容で描画できていなかった。(一旦保存する必要があった)
    よくよく考えてみれば、wikiマクロが呼び出されたときのselfがviewを指しているのでリクエストのパラメータも取得できるのだった。
    マクロの挙動がformの構造に依存するのはイヤだと思いつつも、保存しないでプレビューできたほうがマシか。

    編集中テキストのプレビューの場合は画像をdataスキームでimg@srcに直接入れちゃうことにした。

    <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUg・・・TkSuQmCC">
    古いブラウザだと表示できないけど。
    画像部分の通信サイズが大きくなるけどレスポンス一回で画像もHTMLも返せると、取得した編集中テキストをまるごと受け取って画像を返すactionを新設しなくていい。


    環境:
    CentOS 6.2 x64
    ruby-1.8.7-p352
    mysql-server-5.1.61
    graphviz-2.26.0
    redmine-1.3.0