プログラム言語やIDE、その他アプリなどの仕様やヘルプドキュメントをローカルで高速に検索できる便利ソフト『Dash』。
スニペットツールとしても有名です。
今回はこの『Dash』のドキュメント検索をちょっと便利にしてみましょう。
Dashの検索ドキュメント対象を絞ってみよう
プログラムのドキュメントの場合、複数の言語で似たようなクラスやメソッドがたくさんあります。
しかし、例えばWordPressサイトを作成している時に検索の対象にしたいのは、PHPやWordPressの仕様、後は場合によりjavascript、jQery、SASS、Bootstrapのドキュメントだけだと思います。
今回は、検索窓に特定のキーワード(例えばw:)を入力した場合、あらかじめセットしたドキュメントのみが検索対象になるように設定してみます。
設定してみる
この、検索対象の設定は「Search Profiles」と呼ばれます。
詳細はhttps://kapeli.com/dash_guide#searchProfilesを確認してください。
はじめに、設定作業中はDashのPreferences→Generalから、「Dismiss main window when I activate different app」のチェックを外しておいたほうが良いかもしれません。
これにチェックが入っていると、DashのWindowが選択状態から外れるとすぐに閉じるため、(普段使いには便利ですが)Dash自体の設定のときは開き直すのが面倒だからです。
まず、Dash起動後にサーチボックスの虫眼鏡アイコンをクリックします。
サーチプロファイルの追加
プロファイルを追加します。下の+ボタンをクリックします。
プロファイルの名前をつけます。「Web制作」や「WordPress」のような感じで良いでしょう。今回は「WordPress」で設定してみます。
ちなみにアイコンの設定も可能です。
キーワードの設定
「Activate this profile when:」の+ボタンをクリックします。
「Search Keyword」を選択します。
ショートカットキーや特定のアプリを起動している場合、ナビゲーターの挙動による検索対象の変更も可能です。
キーワードは「w」としておきます。これで検索ボックスに「w:」と入力した場合、下でで設定するドキュメントセットが検索対象となります。
サーチ対処のドキュメントを選択
検索対象のドキュメントを選びます。
「Search these docsets:」の+ボタンをクリックします。
こんな感じに選んでみます。
自作スニペットを検索対象に含めるかどうかのチェックボックスです。
使ってみる
Dashを起動、サーチボックスに「w:」を入力すると、「WordPress」サーチプロファイルに切り替わり、検索対象が先程選んだドキュメントのみになります!
通常状態(全てのドキュメントが検索対象)に戻すのが面倒なので、デフォルトにも「d:」のような感じでキーワードを設定しておきます。
他にも設定してみる
Unityにも設定してみました。
私の場合、WEB制作作業中は、ついドキュメント検索よりも身近なWEB検索に頼ってしまい(もちろん有用な場合も多いですが)、回り道になることがあります。
「公式ドキュメント見たくない」の一心で色々とネットを回った結果、公式のサンプルコードが一番分かりやすかった、ということは非常に多いです。
公式ドキュメントを参照することに慣れる為にも、意識的にDashを使ってみたいと思います。