Edited at

Dash の使い方

More than 3 years have passed since last update.

Dash は様々な API リファレンスを高速に検索できる Mac 用アプリケーション。

dash.jpg

特徴は


  • 主要なライブラリ、フレームワークの API リファレンスをまとめて検索・閲覧できる。

  • ドキュメントのダウンロードと更新が簡単。

  • 検索が非常に高速。

  • IDE 連携やショートカットなど、キー操作に最適化。

  • ダウンロードは無料だけど、アプリ内課金しないと使いものにならない(笑)

ちなみに時々値引きセールをやっているので、そのタイミングで購入するとお得。

最近はあまり値引きの話を聞かない...


基本設定

Dash-General


  • Launch Dash at login: ログイン時に Dash を起動。必ず ON にしましょう。

  • Global search shortcut: Dash の検索画面を呼び出すショートカット。お好みのキーを設定。

  • Search using selected text: 選択中のテキストを Dash で検索するショートカット。クリックするとシステム環境設定が起動するので、Look Up in Dash をチェックの上、お好みのキーを入力。


Search using selected text のショートカットを入力しても Dash の検索が行われない場合、以下を試してみる。


  • 利用したいアプリケーション上で、適当なテキストを選択

  • アプリケーションメニューにある サービス(Services) にマウスカーソルを当てる
    (サブメニューに Look Up in Dash の項目が表示されていればOK)


Dash-Service


Android Studio や RubyMine 等の Intelli J 系 IDE の場合、サービスメニューに Look Up in Dash が表示されない。

その代わりに Dash プラグインが提供されているので、これをインストールして IDE のショートカットを設定するとよい。



ドキュメントのダウンロードと設定

Preferences から各種設定を行う。


Downloads タブで使いたいドキュメントをダウンロード

Dash-Download


  • All Docsets: 各種プラットフォームやフレームワークのドキュメント一覧。

  • Cheat Sheets: [新機能]様々のチートシートの一覧。自作もできる。

  • Cocoa Docsets: CocoaDocs でドキュメントを検索してダウンロードできる。オープンソース系を探すのに便利。

  • Ruby Docsets: RubyGems にあるドキュメントを検索してダウンロードできる。

  • Java Docsets: (私は使ってませんので割愛)

  • Scala Docsets: (私は使ってませんので割愛)


Docsets タブで検索対象のドキュメントを選択

Dash-Docsets


このリストの 2 列目に書かれている "iphoneos:" といったキーワードは検索の絞り込みに利用できるので覚えておくとよい。

("iphoneos:" → "ios:"、"javascript:" → "js:" と短くしておいた方がさらに便利)


あとは General タブの global search shortcut を設定しておけばどこからでも呼び出せる。


検索とショートカットキー


  • 検索ボックスにキーワードを入力すると即座に候補と内容が表示される。

  • "iphoneos:nsobject" のように初めに docset のキーワードを入力すると対象ドキュメントを絞り込める。

  • "nsobject init" のようにスペース区切りでキーワードを入力すると、2 語目でページ内検索を行う。

その他、覚えておくと便利なショートカット

ショートカットキー
機能

↓ or ↑
検索候補の選択

Control+↓ or Control+↑
ページスクロール

ESC
入力キーワードのクリア

(2 語目を入れた状態で)Enter or Shift+Enter
次の検索結果、前の検索結果にジャンプ


スニペット


登録

Dash-Snippet


  • Dash のウィンドウを開く。

  • 左ペインにある {} アイコンを選択。


  • + アイコンをクリックして New snippet を選択。

  • 右ペインの Abbreviation にスニペットの挿入キーワードを入力。

  • 右ペインの中央にコードを入力。



    • __name__ のように記述すると、挿入時に入力を行うプレースホルダになる。

    • 日付や時間を挿入する @date@time のようなプレースホルダもある。




利用

まず Mac OS の設定を変更。


  • システム環境設定の「セキュリティとプライバシー」を開く。

  • 「プライバシー」タブの「アクセシビリティ」項目にある Dash にチェックを入れる。

Dash-Snippet-Setting

あとはテキストエディタで登録したスニペットのキーワードを入力すると、以下のように挿入内容が表示される。

Dash-Snippet-Insert


CheatSheet を自作する

https://github.com/Kapeli/cheatset#readme にほとんど説明されているが、


  • cheatset という gem をインストール。

  • エディタでチートシートを作成。

  • cheatset generate で docset を生成。

  • 生成した docset を Finder 上でダブルクリックしてインストール。

インストールするとこんな感じで閲覧できる。

Dash-CheatSheet