/DashDoc

Dash integration for Sublime Text 2

Primary LanguagePython

DashDoc provides integration of Dash into Sublime Text.

Usage

You can look up the word under the cursor or selected text in Dash using ctrl+h.

Installation

Use Sublime Package Control.

Options

As usual, you will find the associated settings under the Preferences / Package Settings / DashDoc menu. Personal settings should be made in Settings - User.

Syntax sensitivity

DashDoc can be made sensitive to the syntax used in the current view. Dash will then consult the docset that matches the current syntax. Example: a lookup for map in a Haskell buffer will instruct Dash to search in its haskell docset, a search for the same word in a Python buffer will consult the python2 docset instead.

Syntax-sensitive search may be invoked using ctrl+alt+h hotkey. You have an option to switch the default method of searching with config option syntax_sensitive_as_default, which defaults to false. If you set it to true, then ctrl+h becomes syntax-sensitive, and ctrl+alt+h becomes the insensetive option.

Choosing a Dash docset for a given syntax

For any Sublime Text syntax, DashDoc can search a docset of your choosing. Map entries below are of the form { <syntax> : <docset> }. For <docset>, use the lowercase docset prefixes that Dash indicates in its Preferences / Docsets pane.

"syntax_docset_map":
{
  "ActionScript"  : "actionscript",
  "C"             : "c",
  "C++"           : "cpp",
  "Clojure"       : "clojure",
  "CSS"           : "css",
  "Erlang"        : "erlang",
  "Groovy"        : "groovy",
  "Haskell"       : "haskell",
  "HTML"          : "html",
  "Java"          : "java7",
  "JavaScript"    : "javascript",
  "Lisp"          : "lisp",
  "Lua"           : "lua",
  "Perl"          : "perl",
  "PHP"           : "php",
  "Python"        : "python2",
  "Ruby on Rails" : "rails",
  "Ruby"          : "ruby",
  "Scala"         : "scala",
  "ShellScript"   : "manpages",
  "SQL"           : "psql",
  "TCL"           : "tcl"
}

More information on Dash docsets.

Credits