├── DashDoc.py ├── DashDoc.sublime-settings ├── Default.sublime-commands ├── LICENSE ├── Main.sublime-menu ├── README.md ├── messages.json ├── messages ├── 1.4.0.txt ├── 1.6.0.txt ├── 2.0.0.txt ├── 2.2.0.txt └── 2.5.0.txt └── packages.json /DashDoc.py: -------------------------------------------------------------------------------- 1 | import sublime, sublime_plugin 2 | 3 | import os 4 | import subprocess 5 | import platform 6 | 7 | try: 8 | from urllib import quote # Python 2 9 | except ImportError: 10 | from urllib.parse import quote # Python 3 11 | 12 | 13 | def syntax_name(view): 14 | syntax = os.path.basename(view.settings().get('syntax')) 15 | syntax = os.path.splitext(syntax)[0] 16 | return syntax 17 | 18 | 19 | def docset_keys(view, syntax_docset_map): 20 | syntax = syntax_name(view) 21 | 22 | try: 23 | return syntax_docset_map[syntax] 24 | except KeyError: 25 | return [] 26 | 27 | 28 | def open_dash(query, keys, run_in_background): 29 | # background 30 | background_string = '&prevent_activation=true' if run_in_background else '' 31 | 32 | if platform.system() == 'Windows': 33 | # sending keys= confuses some Windows doc viewers 34 | if keys: 35 | # ampersand must be escaped and ^ is the Windows shell escape char 36 | url = 'dash-plugin://keys=%s^&query=%s%s' % (','.join(keys), quote(query), background_string) 37 | else: 38 | url = 'dash-plugin://query=%s%s' % (quote(query), background_string) 39 | subprocess.call(['start', url], shell=True) 40 | elif platform.system() == 'Linux': 41 | if keys: 42 | subprocess.call([ 43 | '/usr/bin/xdg-open', 44 | 'dash-plugin:keys=%s&query=%s%s' % (','.join(keys), quote(query), background_string) 45 | ]) 46 | else: 47 | subprocess.call([ 48 | '/usr/bin/xdg-open', 49 | 'dash-plugin:query=%s%s' % (quote(query), background_string) 50 | ]) 51 | else: 52 | if keys: 53 | subprocess.call([ 54 | '/usr/bin/open', '-g', 55 | 'dash-plugin://keys=%s&query=%s%s' % (','.join(keys), quote(query), background_string) 56 | ]) 57 | else: 58 | subprocess.call([ 59 | '/usr/bin/open', '-g', 60 | 'dash-plugin://query=%s%s' % (quote(query), background_string) 61 | ]) 62 | 63 | 64 | class DashDocCommand(sublime_plugin.TextCommand): 65 | def run(self, edit, flip_syntax_sensitive=False, run_in_background=False): 66 | # read global and (project-specific) local settings 67 | global_settings = sublime.load_settings('DashDoc.sublime-settings') 68 | settings = self.view.settings() 69 | 70 | # syntax sensitivity is the default 71 | syntax_sensitive_as_default = \ 72 | settings.get('syntax_sensitive_as_default', 73 | global_settings.get('syntax_sensitive_as_default', True)); 74 | 75 | # assemble docset mapping from global settings and project-specific 76 | # local settings (which take precedence) 77 | syntax_docset_map = dict(list(global_settings.get('syntax_docset_map', {}).items()) + 78 | list( settings.get('syntax_docset_map', {}).items())) 79 | 80 | # query 81 | selection = self.view.sel()[0] 82 | if len(selection) == 0: 83 | selection = self.view.word(selection) 84 | query = self.view.substr(selection) 85 | 86 | # keys 87 | syntax_sensitive = flip_syntax_sensitive ^ syntax_sensitive_as_default 88 | keys = docset_keys(self.view, syntax_docset_map) if syntax_sensitive else [] 89 | 90 | open_dash(query, keys, run_in_background) 91 | 92 | 93 | class DashDocSearchCommand(sublime_plugin.WindowCommand): 94 | def run(self): 95 | self.window.show_input_panel('Topic?', '', self.on_done, self.on_change, self.on_cancel) 96 | 97 | def on_change(self, name): 98 | pass 99 | 100 | def on_cancel(self, name): 101 | pass 102 | 103 | def on_done(self, topic): 104 | open_dash(topic, [], False) 105 | -------------------------------------------------------------------------------- /DashDoc.sublime-settings: -------------------------------------------------------------------------------- 1 | { 2 | "syntax_sensitive_as_default": true, 3 | "syntax_docset_map": 4 | { 5 | "ActionScript" : ["actionscript"], 6 | "Boo" : ["unity3d"], 7 | "C" : ["c", "glib", "gl2", "gl3", "gl4", "manpages"], 8 | "C99" : ["c", "glib", "gl2", "gl3", "gl4", "manpages"], 9 | "C++" : ["cpp", "net", "boost", "qt", "cvcpp", "cocos2dx", "c", "manpages"], 10 | "C++11" : ["cpp", "net", "boost", "qt", "cvcpp", "cocos2dx", "c", "manpages"], 11 | "Clojure" : ["clojure"], 12 | "CoffeeScript" : ["coffee"], 13 | "ColdFusion" : ["cf"], 14 | "CSS" : ["css", "bootstrap", "foundation", "less", "awesome", "cordova", "phonegap"], 15 | "Dart" : ["dartlang", "polymerdart", "angulardart"], 16 | "Elixir" : ["elixir"], 17 | "Erlang" : ["erlang"], 18 | "Go" : ["go", "godoc"], 19 | "GoSublime" : ["go", "godoc"], 20 | "GoSublime-Go" : ["go", "godoc"], 21 | "Groovy" : ["groovy"], 22 | "Haskell" : ["haskell"], 23 | "Haskell-SublimeHaskell": ["haskell"], 24 | "Literate Haskell" : ["haskell"], 25 | "HTML" : ["html", "svg", "css", "bootstrap", "foundation", "awesome", "statamic", "javascript", "jquery", "jqueryui", "jquerym", "angularjs", "backbone", "marionette", "meteor", "moo", "prototype", "ember", "lodash", "underscore", "sencha", "extjs", "knockout", "zepto", "cordova", "phonegap", "yui"], 26 | "Jade" : ["jade"], 27 | "Java" : ["java", "javafx", "grails", "groovy", "playjava", "spring", "cvj", "processing", "javadoc"], 28 | "JavaScript" : ["javascript", "jquery", "jqueryui", "jquerym", "angularjs", "backbone", "marionette", "meteor", "sproutcore", "moo", "prototype", "bootstrap", "foundation", "lodash", "underscore", "ember", "sencha", "extjs", "knockout", "zepto", "yui", "d3", "svg", "dojo", "coffee", "nodejs", "express", "mongoose", "moment", "require", "awsjs", "jasmine", "sinon", "grunt", "chai", "html", "css", "cordova", "phonegap", "unity3d", "titanium"], 29 | "Kotlin" : ["kotlin"], 30 | "Less" : ["less"], 31 | "Lisp" : ["lisp"], 32 | "Lua" : ["lua", "corona"], 33 | "Markdown" : ["markdown"], 34 | "MultiMarkdown" : ["markdown"], 35 | "Objective-C" : ["iphoneos", "macosx", "appledoc", "cocos2d", "cocos3d", "kobold2d", "sparrow", "cocoapods", "c", "manpages"], 36 | "Objective-C++" : ["cpp", "iphoneos", "macosx", "appledoc", "cocos2d", "cocos2dx", "cocos3d", "kobold2d", "sparrow", "cocoapods", "c", "manpages"], 37 | "Objective-J" : ["cappucino"], 38 | "OCaml" : ["ocaml"], 39 | "Perl" : ["perl", "manpages"], 40 | "PHP" : ["php", "wordpress", "drupal", "zend", "laravel", "yii", "joomla", "ee", "codeigniter", "cakephp", "phpunit", "symfony", "typo3", "twig", "smarty", "phpp", "html", "statamic", "mysql", "sqlite", "mongodb", "psql", "redis"], 41 | "Processing" : ["processing"], 42 | "Puppet" : ["puppet"], 43 | "Python" : ["python", "django", "twisted", "sphinx", "flask", "tornado", "sqlalchemy", "numpy", "scipy", "salt", "cvp"], 44 | "R" : ["r"], 45 | "Ruby" : ["ruby", "rubygems", "rails"], 46 | "Ruby on Rails" : ["ruby", "rubygems", "rails"], 47 | "(HTML) Rails" : ["ruby", "rubygems", "rails", "html", "svg", "css", "bootstrap", "foundation", "awesome", "statamic", "javascript", "jquery", "jqueryui", "jquerym", "angularjs", "backbone", "marionette", "meteor", "moo", "prototype", "ember", "lodash", "underscore", "sencha", "extjs", "knockout", "zepto", "cordova", "phonegap", "yui"], 48 | "(JavaScript) Rails" : ["ruby", "rubygems", "rails", "javascript", "jquery", "jqueryui", "jquerym", "angularjs", "backbone", "marionette", "meteor", "sproutcore", "moo", "prototype", "bootstrap", "foundation", "lodash", "underscore", "ember", "sencha", "extjs", "knockout", "zepto", "yui", "d3", "svg", "dojo", "coffee", "nodejs", "express", "mongoose", "moment", "require", "awsjs", "jasmine", "sinon", "grunt", "chai", "html", "css", "cordova", "phonegap", "unity3d"], 49 | "(SQL) Rails" : ["ruby", "rubygems", "rails"], 50 | "Ruby Haml" : ["haml"], 51 | "Rust" : ["rust"], 52 | "Sass" : ["sass", "compass", "bourbon", "neat", "css"], 53 | "Scala" : ["scala", "akka", "playscala", "scaladoc"], 54 | "Shell-Unix-Generic" : ["bash", "manpages"], 55 | "SQL" : ["mysql", "sqlite", "psql"], 56 | "TCL" : ["tcl"], 57 | "TSS" : ["titanium"], 58 | "TypeScript" : ["typescript", "javascript", "react", "nodejs", "jquery", "jqueryui", "jquerym", "angularjs", "backbone", "marionette", "meteor", "sproutcore", "moo", "prototype", "bootstrap", "foundation", "lodash", "underscore", "ember", "sencha", "extjs", "knockout", "zepto", "yui", "d3", "svg", "dojo", "express", "mongoose", "moment", "require", "awsjs", "jasmine", "sinon", "grunt", "chai", "html", "css", "cordova", "phonegap", "unity3d", "titanium"], 59 | "YAML" : ["yaml"], 60 | "XML" : ["xml", "titanium"] 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /Default.sublime-commands: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "caption": "DashDoc: invoke Dash with selected word", 4 | "command": "dash_doc", 5 | "args": { 6 | "flip_syntax_sensitive": false 7 | } 8 | }, 9 | { 10 | "caption": "DashDoc: invoke Dash with selected word (flip syntax sensitivity)", 11 | "command": "dash_doc", 12 | "args": { 13 | "flip_syntax_sensitive": true 14 | } 15 | }, 16 | { 17 | "caption": "DashDoc: invoke Dash in background with selected word", 18 | "command": "dash_doc", 19 | "args": { 20 | "flip_syntax_sensitive": false, 21 | "run_in_background": true 22 | } 23 | }, 24 | { 25 | "caption": "DashDoc: invoke Dash in background with selected word (flip syntax sensitivity)", 26 | "command": "dash_doc", 27 | "args": { 28 | "flip_syntax_sensitive": true, 29 | "run_in_background": true 30 | } 31 | }, 32 | { 33 | "caption": "DashDoc: search any topic", 34 | "command": "dash_doc_search" 35 | } 36 | ] 37 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /Main.sublime-menu: -------------------------------------------------------------------------------- 1 | [ 2 | { 3 | "id": "preferences", 4 | "children": 5 | [ 6 | { 7 | "caption": "Package Settings", 8 | "mnemomic": "P", 9 | "id": "package-settings", 10 | "children": 11 | [ 12 | { 13 | "caption": "DashDoc", 14 | "children": 15 | [ 16 | { 17 | "command": "open_file", "args": 18 | { 19 | "file": "${packages}/DashDoc/DashDoc.sublime-settings" 20 | }, 21 | "caption": "Settings - Default" 22 | }, 23 | { 24 | "command": "open_file", "args": 25 | { 26 | "file": "${packages}/User/DashDoc.sublime-settings" 27 | }, 28 | "caption": "Settings - User" 29 | }, 30 | { "caption": "-" }, 31 | { 32 | "command": "open_file", "args": 33 | { 34 | "file": "${packages}/DashDoc/Default (OSX).sublime-keymap", 35 | "platform": "OSX" 36 | }, 37 | "caption": "Key Bindings - Default" 38 | }, 39 | { 40 | "command": "open_file", "args": 41 | { 42 | "file": "${packages}/User/Default (OSX).sublime-keymap", 43 | "platform": "OSX" 44 | }, 45 | "caption": "Key Bindings - User" 46 | }, 47 | { 48 | "command": "open_file", "args": 49 | { 50 | "file": "${packages}/DashDoc/Default (Windows).sublime-keymap", 51 | "platform": "Windows" 52 | }, 53 | "caption": "Key Bindings - Default" 54 | }, 55 | { 56 | "command": "open_file", "args": 57 | { 58 | "file": "${packages}/User/Default (Windows).sublime-keymap", 59 | "platform": "Windows" 60 | }, 61 | "caption": "Key Bindings - User" 62 | } 63 | ] 64 | } 65 | ] 66 | } 67 | ] 68 | } 69 | ] 70 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | DashDoc provides integration of [Dash][1] (on OS X), [Zeal][7] (on Linux) and [Zeal][7] or [Velocity][8] (on Windows) into Sublime Text. 2 | 3 | ## If the package is not available in the install list 4 | 5 | You need to be on OS X, Windows or Linux to use DashDoc. You might have installed it already. If nothing helps, please check package control [troubleshooting](https://packagecontrol.io/docs/troubleshooting) page or fill a bug against [package control](https://packagecontrol.io/docs/issues). 6 | 7 | ## Usage 8 | 9 | You can look up the word under the cursor or selected text in Dash using `ctrl+h`. 10 | 11 | ## Installation 12 | 13 | 1. Install the [Sublime Package Control][6] package. 14 | 2. Use Package Control to install this package (DashDoc) 15 | 16 | ### Hotkey configuration 17 | 18 | DashDoc no longer comes with a default hotkey. 19 | 20 | To set up the hotkey for dash open the Preferences > Key Bindings from the menu 21 | and add a new entry that looks like this: 22 | 23 | [{ "keys": ["YOUR HOTKEY"], "command": "dash_doc"}] 24 | 25 | for the default mode 26 | 27 | [{ "keys": ["YOUR HOTKEY"], "command": "dash_doc", 28 | "args": { "flip_syntax_sensitive": true } }] 29 | 30 | for the flipped case sensitive mode. 31 | 32 | ### Dependencies 33 | 34 | [xdg-utils][9] on Linux. 35 | 36 | 37 | ## Options 38 | 39 | As usual, you will find the associated settings under the *Preferences / Package Settings / DashDoc* menu. Personal settings should be made in *Settings - User*. 40 | 41 | ### Search any topic 42 | 43 | DashDoc also includes a command to search any topic right from Sublime's command palette. 44 | 45 | ### Syntax sensitivity 46 | 47 | By default, DashDoc is 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 `python` docset instead. 48 | 49 | Syntax-insensitive search may be invoked using the `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 true. If you set it to false, then `ctrl+h` becomes syntax-insensitive, and `ctrl+alt+h` becomes the sensitive option. 50 | 51 | ### Choosing a Dash docset for a given syntax 52 | 53 | For any Sublime Text syntax, DashDoc can search a number of docsets of your choosing. Use map entries of the form `{ : [ , , ... ] }`. For ``, use the lowercase docset prefixes that Dash indicates in its *Preferences / Docsets* pane. Dash searches the list of docsets in the given order. 54 | 55 | For particular projects, you can override individual syntax-to-docsets mappings in the `settings` of the project's `.sublime-project` file, for example: 56 | 57 | "settings": { 58 | "syntax_docset_map": { 59 | "Objective-C": ["iphoneos", "cocos2d"] 60 | } 61 | } 62 | 63 | Mappings that are not overridden this way default to what is found in the `DashDoc.sublime-settings` file. The default mapping, derived from [Dash's suggestion][3], is: 64 | 65 | "syntax_docset_map": 66 | { 67 | "ActionScript" : ["actionscript"], 68 | "Boo" : ["unity3d"], 69 | "C" : ["c", "glib", "gl2", "gl3", "gl4", "manpages"], 70 | "C99" : ["c", "glib", "gl2", "gl3", "gl4", "manpages"], 71 | "C++" : ["cpp", "net", "boost", "qt", "cvcpp", "cocos2dx", "c", "manpages"], 72 | "C++11" : ["cpp", "net", "boost", "qt", "cvcpp", "cocos2dx", "c", "manpages"], 73 | "Clojure" : ["clojure"], 74 | "CoffeeScript" : ["coffee"], 75 | "ColdFusion" : ["cf"], 76 | "CSS" : ["css", "bootstrap", "foundation", "less", "awesome", "cordova", "phonegap"], 77 | "Dart" : ["dartlang", "polymerdart", "angulardart"], 78 | "Elixir" : ["elixir"], 79 | "Erlang" : ["erlang"], 80 | "Go" : ["go", "godoc"], 81 | "GoSublime" : ["go", "godoc"], 82 | "GoSublime-Go" : ["go", "godoc"], 83 | "Groovy" : ["groovy"], 84 | "Haskell" : ["haskell"], 85 | "Haskell-SublimeHaskell": ["haskell"], 86 | "Literate Haskell" : ["haskell"], 87 | "HTML" : ["html", "svg", "css", "bootstrap", "foundation", "awesome", "statamic", "javascript", "jquery", "jqueryui", "jquerym", "angularjs", "backbone", "marionette", "meteor", "moo", "prototype", "ember", "lodash", "underscore", "sencha", "extjs", "knockout", "zepto", "cordova", "phonegap", "yui"], 88 | "Jade" : ["jade"], 89 | "Java" : ["java", "javafx", "grails", "groovy", "playjava", "spring", "cvj", "processing", "javadoc"], 90 | "JavaScript" : ["javascript", "jquery", "jqueryui", "jquerym", "angularjs", "backbone", "marionette", "meteor", "sproutcore", "moo", "prototype", "bootstrap", "foundation", "lodash", "underscore", "ember", "sencha", "extjs", "knockout", "zepto", "yui", "d3", "svg", "dojo", "coffee", "nodejs", "express", "mongoose", "moment", "require", "awsjs", "jasmine", "sinon", "grunt", "chai", "html", "css", "cordova", "phonegap", "unity3d", "titanium"], 91 | "Kotlin" : ["kotlin"], 92 | "Less" : ["less"], 93 | "Lisp" : ["lisp"], 94 | "Lua" : ["lua", "corona"], 95 | "Markdown" : ["markdown"], 96 | "MultiMarkdown" : ["markdown"], 97 | "Objective-C" : ["iphoneos", "macosx", "appledoc", "cocos2d", "cocos3d", "kobold2d", "sparrow", "cocoapods", "c", "manpages"], 98 | "Objective-C++" : ["cpp", "iphoneos", "macosx", "appledoc", "cocos2d", "cocos2dx", "cocos3d", "kobold2d", "sparrow", "cocoapods", "c", "manpages"], 99 | "Objective-J" : ["cappucino"], 100 | "OCaml" : ["ocaml"], 101 | "Perl" : ["perl", "manpages"], 102 | "PHP" : ["php", "wordpress", "drupal", "zend", "laravel", "yii", "joomla", "ee", "codeigniter", "cakephp", "phpunit", "symfony", "typo3", "twig", "smarty", "phpp", "html", "statamic", "mysql", "sqlite", "mongodb", "psql", "redis"], 103 | "Processing" : ["processing"], 104 | "Puppet" : ["puppet"], 105 | "Python" : ["python", "django", "twisted", "sphinx", "flask", "tornado", "sqlalchemy", "numpy", "scipy", "salt", "cvp"], 106 | "R" : ["r"], 107 | "Ruby" : ["ruby", "rubygems", "rails"], 108 | "Ruby on Rails" : ["ruby", "rubygems", "rails"], 109 | "(HTML) Rails" : ["ruby", "rubygems", "rails", "html", "svg", "css", "bootstrap", "foundation", "awesome", "statamic", "javascript", "jquery", "jqueryui", "jquerym", "angularjs", "backbone", "marionette", "meteor", "moo", "prototype", "ember", "lodash", "underscore", "sencha", "extjs", "knockout", "zepto", "cordova", "phonegap", "yui"], 110 | "(JavaScript) Rails" : ["ruby", "rubygems", "rails", "javascript", "jquery", "jqueryui", "jquerym", "angularjs", "backbone", "marionette", "meteor", "sproutcore", "moo", "prototype", "bootstrap", "foundation", "lodash", "underscore", "ember", "sencha", "extjs", "knockout", "zepto", "yui", "d3", "svg", "dojo", "coffee", "nodejs", "express", "mongoose", "moment", "require", "awsjs", "jasmine", "sinon", "grunt", "chai", "html", "css", "cordova", "phonegap", "unity3d"], 111 | "(SQL) Rails" : ["ruby", "rubygems", "rails"], 112 | "Ruby Haml" : ["haml"], 113 | "Rust" : ["rust"], 114 | "Sass" : ["sass", "compass", "bourbon", "neat", "css"], 115 | "Scala" : ["scala", "akka", "playscala", "scaladoc"], 116 | "Shell-Unix-Generic" : ["bash", "manpages"], 117 | "SQL" : ["mysql", "sqlite", "psql"], 118 | "TCL" : ["tcl"], 119 | "TSS" : ["titanium"], 120 | "TypeScript" : ["typescript", "javascript", "react", "nodejs", "jquery", "jqueryui", "jquerym", "angularjs", "backbone", "marionette", "meteor", "sproutcore", "moo", "prototype", "bootstrap", "foundation", "lodash", "underscore", "ember", "sencha", "extjs", "knockout", "zepto", "yui", "d3", "svg", "dojo", "express", "mongoose", "moment", "require", "awsjs", "jasmine", "sinon", "grunt", "chai", "html", "css", "cordova", "phonegap", "unity3d", "titanium"], 121 | "YAML" : ["yaml"], 122 | "XML" : ["xml", "titanium"] 123 | } 124 | 125 | More information on [Dash docsets][2]. 126 | 127 | ## Credits 128 | 129 | * Original idea and code by [Vladimir Pouzanov][4] 130 | * Syntax sensitivity added by [Torsten Grust][5] 131 | 132 | [1]: http://kapeli.com/dash 133 | [2]: http://kapeli.com/docsets/ 134 | [3]: http://kapeli.com/dash_plugins 135 | [4]: http://farcaller.net/ 136 | [5]: http://db.inf.uni-tuebingen.de/team/grust/ 137 | [6]: https://packagecontrol.io/installation 138 | [7]: https://zealdocs.org/ 139 | [8]: https://velocity.silverlakesoftware.com/ 140 | [9]: https://www.freedesktop.org/wiki/Software/xdg-utils/ 141 | -------------------------------------------------------------------------------- /messages.json: -------------------------------------------------------------------------------- 1 | { 2 | "1.4.0": "messages/1.4.0.txt", 3 | "1.6.0": "messages/1.6.0.txt", 4 | "2.0": "messages/2.0.txt", 5 | "2.2": "messages/2.2.txt" 6 | } 7 | -------------------------------------------------------------------------------- /messages/1.4.0.txt: -------------------------------------------------------------------------------- 1 | DashDoc 1.4.0 is a major update (all credit goes @Teggy who made this possible). 2 | 3 | This version requires Dash 1.9.3 or newer to work. Also, the default browsing 4 | mode is syntax sensetive now (you might be interested in updating 5 | syntax_sensitive_as_default property value if you have overrided it to false 6 | for some reason). 7 | 8 | The Dash proposed syntax mapping is in place, however you can override it on in 9 | project settings or globally like this: 10 | 11 | "settings": { 12 | "syntax_docset_map": { 13 | "Objective-C": ["iphoneos", "cocos2d"] 14 | } 15 | } 16 | 17 | -------------------------------------------------------------------------------- /messages/1.6.0.txt: -------------------------------------------------------------------------------- 1 | This version adds support for Windows, when using Dash-compatible viewers. It 2 | has been tested against Zeal (https://zealdocs.org/) and Velocity 3 | (https://velocity.silverlakesoftware.com/). 4 | -------------------------------------------------------------------------------- /messages/2.0.0.txt: -------------------------------------------------------------------------------- 1 | # Warning, breaking change! 2 | 3 | After a long discussion in https://github.com/farcaller/DashDoc/issues/29 4 | I came to decision to change the default hotkeys (ctrl+h and ctrl+alt+h). 5 | Given there are no good alternatives, this version REMOVES the default hotkey, 6 | leaving the choice to the user. 7 | 8 | You can always use the command palette too. 9 | 10 | To set up the hotkey for dash open the Preferences > Key Bindings from the menu 11 | and add a new entry that looks like this: 12 | 13 | { "keys": ["YOUR HOTKEY"], "command": "dash_doc"} 14 | 15 | for the default mode 16 | 17 | { "keys": ["YOUR HOTKEY"], "command": "dash_doc", 18 | "args": { "flip_syntax_sensitive": true } } 19 | 20 | for the flipped case sensitive mode. 21 | -------------------------------------------------------------------------------- /messages/2.2.0.txt: -------------------------------------------------------------------------------- 1 | # Added support for linux 2 | 3 | DashDoc can now be used on linux, with the help of xdg-utils tool. 4 | -------------------------------------------------------------------------------- /messages/2.5.0.txt: -------------------------------------------------------------------------------- 1 | This release of DashDoc changes how URLs are handled in linux and might be a 2 | breaking change. If you use this plugin, run linux, and DashDoc suddenly stopped 3 | working, please report back to this ticket: 4 | 5 | https://github.com/farcaller/DashDoc/issues/54 6 | -------------------------------------------------------------------------------- /packages.json: -------------------------------------------------------------------------------- 1 | { 2 | "schema_version": "2.0", 3 | "packages": [ 4 | { 5 | "name": "DashDoc", 6 | "description": "Open the selected text or text under cursor in Dash documentation browser", 7 | "details": "https://github.com/farcaller/DashDoc", 8 | "releases": [ 9 | { 10 | "sublime_text": "*", 11 | "platforms": ["osx", "windows", "linux"], 12 | "details": "https://github.com/farcaller/DashDoc/tags" 13 | } 14 | ] 15 | } 16 | ] 17 | } 18 | --------------------------------------------------------------------------------