viewdoc-任意のドキュメントへの便利なアクセス

さまざまな外部ドキュメント(man / perldoc / pydoc /など)を表示するために、Vimには多くのプラグインとレシピがあります。 問題は、それらのいくつかは私にとって便利な方法でドキュメントでウィンドウを開くように構成されていないこと、他はドキュメントの新しいソースをサポートするように拡張されていないこと、バグがあり、あまりにも曲がりすぎて修正し、作者にパッチを比較的簡単に送信できることです。 先日、この状況でようやく私が得られ、これらの問題をすべて解決するviewdocプラグインを作成しました。

内部はシンプルで使いやすく、ドキュメント(組み込み:helpを含む)を操作するための単一のユーザーインターフェイスを提供し、コンテキストによって必要なドキュメントを決定でき、柔軟にカスタマイズでき、非常に簡単に拡張できます(外部プラグインまたは〜/ .vimrcで直接)新しいドキュメントソースを追加します。 主な欠点は、Linuxでのみテストされていて、他の* nixで動作することであり、Windowsでは動作しないことです。

  1. ドキュメントにアクセスするためのボタン/コマンドを設定できます。 デフォルトでは、viewdocは標準のKを置き換え、 :help plusは<F1>とコマンド:man :perldoc :doc :perldocを追加します。
  2. ドキュメントを開く場所(バッファ/ウィンドウ/タブ)を構成できます。 新しいドキュメントは、ドキュメントがある既存のウィンドウ( K )または新しいウィンドウ( <F1> )で開くことができます。 可能なすべてのウィンドウスタイルがサポートされています。
    • フルスクリーン(タブなし、1つのウィンドウ、追加ファイル/ドキュメントが非表示のバッファーで開く);
    • ウィンドウ(タブなし、追加のファイル/ドキュメントがある多くのウィンドウ);
    • タブ付きのフルスクリーン(多くのタブ、それぞれ1つのウィンドウ、追加のファイル/ドキュメントが新しいタブで開きます);
    • タブ付き(多くのタブ、タブ内の多くのウィンドウ、追加ファイル/ドキュメントはどこでも開く:))。
  3. すべての種類のドキュメント(組み込み:helpを含む)は同じ方法で表示されます。
  4. すべてのタイプのドキュメント(および:helpだけでなく)は、タグ( <C-]>および<CT>加えて代替<CR>および<BS> )の内部ナビゲーションをサポートするようになりました。
  5. ドキュメントでバッファ/ウィンドウ/タブを閉じることも簡単になり( q )、よりスマートになりました(オプションで次の代わりに前のタブに遷移し、最後のバッファを閉じるときにVimを終了します)! :)
  6. あいまいな解釈では、コンテキストに応じて必要なドキュメントを決定できます(現在の単語とその周囲の文字を強調する構文の名前を使用)。
    • 例1:〜/ .vimrcを編集するときに、単語 "highlight"で<F1>を押します-オプション "&highlight"またはコマンド ":highglight"のドキュメントを表示する必要がありますか?
    • 例2:perlスクリプトを編集する場合、「$ _ [2]」で<F1>を押します-変数「@_」のドキュメントが表示されます。
  7. :manおよび:perldocについては、フル:perldocオートコンプリートが実装されており、 :helpデフォルトより悪くありません。
  8. すぐに使えるドキュメントの種類をサポート:
    • Vimビルトインドキュメント
    • Vimヘルプ形式で記述された追加ドキュメント(例: CSS2.1
    • perldoc
    • pydoc
  9. 新しいタイプのドキュメントのサポートは、プラグインコードを変更することなく、ユーザーが簡単に追加できます。
  10. 1つのタイプのファイル(たとえば、ローカルファイルとインターネットからダウンロードしたファイル)に対して複数のドキュメントソースを定義し、それらを簡単に切り替えることができます。
  11. コンソールから直接マンページを表示するために使用できます。
  12. 病原体と互換性があり、十分に文書化されています。

ダウンロード ソースとバグトラッカー


Source: https://habr.com/ru/post/J136665/


All Articles