omz/dash-plugin-for-xcode

Plugin for Xcode to integrate the Dash documentation viewer app

dash-plugin-for-xcode's Issues

Dash intercepts links to header files of application classes.

Steps to reproduce:

1. With the plugin in "Replace Reference" mode, option-click on a custom class to bring up the Quick Help popup.

   

2. Click on the header file link after "Declared In".

Expected result: Xcode opens the header file.

Actual result: Dash searches for the header file.

For some reason, Dash only intercepts links to headers of application classes (vs. classes of system frameworks).

No Dash Integration menu in latest Xcode beta

I cannot integrate Dash with the latest Xcode beta.

The plug-in is installed at ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins/OMQuickHelp.xcplugin, but Xcode doesn't recognize it.

There is no Dash Integration menu in latest Xcode beta.

alcatraz install

please!

Quick help link to guide does not work properly

If one brings up the "quick help" inspector in Xcode, it presents help text as well as three links at the bottom: a) a declared in link, b) a link to reference of the relevant class and c) a link to a guide document. For example the quick help text on NSUserDefaults displays:
Declared in: NSUserDefaults.h
Reference: NSUserDefaults Class Reference
Guides: Preferences and settings programming guide.

Clicking the first link shows the header file in Xcode, the second the class definition in Dash. The Guides link however does not link to a guide. Instead, it brings up Dash with the same information as for the reference link - the NSUserDefaults class in this case.

Could not replace the standard Documentation in Xcode7?

Hi,

I installed Xcode7 and this plugin from Alcatraz today, but when I open my project, I found Dash can not replace the standard Documentation even I have configured in Help->Dash integration.

Thanks for answer.

Problem with XCode 7.0 and umlaut in group name

Hi,

we're getting an error in building the plugin. The group name "domänen-benutzer" is probably the reason. Could you tell where we could comment out the owner change, since the owner and group are actually correct. Thanks.

Using commit f1e71df

Bind docsets to Xcode instead of substitute help panel

It would be nice if the docsets could be bound to Xcode, and open them in the default reader window instead of substituting the reader window with Dash. I have another app, Docs for Xcode that binds the documents directly into Xcode (I haven't figured out how it does it yet), and docsets installed by Docs for Xcode continues to show, even after Xcode have been updated.

A simple copy of the docsets to the location Docs for Xcode uses did not install them, so there must be some .plist or some other resource taking care of this

Dash looses filter on search

When I set a scope in Dash (ios: for example) and option+click a symbol in Xcode, Dash opens but the scope is gone. This is annoying because some symbols also exist in other docsets so the result list is unnecessarily long and cluttered.

Replace Reference

when I select the Replace Reference option in the dans menu and I alt-double-click on a class name it goes directly to Dash but always as NSObject, never for the class it was clicked on.
If I chose the default option it will open Dash at the correct Class.

Seems to not be working in XCode 5.1

I tried grabbing the latest source, rebuilding, option clicking does not launch dash.
Using the latest Dash too... I updated today.

Xcode 9 Beta 5 release note mentions Editor Extension bug fixes

Xcode Source Editor Extensions will once again receive multiple selection information from the
source editor, and can once again specify multiple selections in their response. (30746247)

Does that mean this plugin can be installed on Xcode 9 beta 5 ?

Link

Disabling Quick Help integration also disabling Search integration

I'm trying to use Xcode's built-in quick help documentation (single option-click help window) while using Dash for the more in-depth search documentation (double option-click help window). In previous versions of Xcode and Dash, I was able to have this setup by disabling Quick Help integration but leaving Search Documentation enable, like in the screenshot below.

The behavior now is that the Xcode quick help pops up, but when I double option-click, instead of showing Dash, Xcode's own documentation pops up. Is this intended behavior, or a bug? I really liked being able to use the quick help popup within Xcode for quick checks but jumping into Dash when I needed more info.

Syntax Coloring submenu on Editing menu disappeared

After installing this plugin, the Syntax Coloring submenu is empty. I work with several projects that have non-detecting filenames or languages, and are now no longer able to set language for syntax colouring.

Rename plugin from 'OMQuickHelp' to 'OMDashHelp' on Alcatraz

It's impossible to remember and/or find it on Alcatraz without having to Google for it.

"Replace Search Documentation" doesn't work in Xcode 7

After installing plugin I found that setting "Replace Quick Help" works fine, but I prefer having native quick help, and dash to replace searching in documentation. This setting doesn't work anymore (while "Replace Search Documentation" active, standard documentation is opening instead of Dash).

OS X 10.11.1
Dash 2.2.6
Xcode 7.1

Only load if current application is Xcode

open opendiff(FileMerge) should not load Dash-Plugin

• Xcode-Plugin-Template/NSObject_Extension.m
• alcatraz/Alcatraz#50
• Alcatraz/Alcatraz.m

Cannot integrate Dash with Xcode 5.1

I cannot integrate Dash with Xcode 5.1.

The plug-in is installed at ~/Library/Application Support/Developer/Shared/Xcode/Plug-ins/OMQuickHelp.xcplugin, but Xcode doesn't recognize it.

There is no Dash Integration menu in Xcode.

I have deleted everything, rebuilt the plugin, quit Xcode, and rebooted. No luck so far.

Xcode 6.4 beta 2 (6E14) doesn't like the plug-in

(I suspect you may already be aware, but just in case…)

I was trying to use the 6.4 beta because of the note posted at the top of Apple's Swift forum, to wit:

Xcode 6.3.1 introduced a compile-time regression for Swift apps which is likely to impact the compile time of larger projects using Swift frameworks or using projects supplied from external sources (e.g. CocoaPods).
Xcode 6.4 beta fixes this problem so should be used as a workaround if this problem is affecting your current development.
Until Xcode 6.4 is released, App Store submissions still need to be built with Xcode 6.3.1.

Of course, the Dash-plugin stopped working. I tried adding the output of defaults read /Applications/Xcode-beta.app/Contents/Info DVTPlugInCompatibilityUUID to DVTPlugInCompatabilityUUIDs in the Info.plist which got me to an "Unexpected Code Bundles" dialog (see this image for an example.) Clicking "Load Bundles" made the dialog go away, and I had the menu items for Dash in the Help menu, but neither "Replace Quick Help" or "Replace Quick Help Reference Link" seemed to bring up Dash.

Turns out I'm not personally seeing the Swift issue mentioned above so I just reverted to 6.3.1 for now, but obviously 6.4 is all of our future's :-)

Alternatives to Xcode extension

I saw blog post on extension for Xcode 8 (https://blog.kapeli.com/dash-xcode-8-and-macos-sierra), and was wondering if there were any kludges/workaround to get a similar behavior from Dash working until the Xcode 8 extension is available?

problem with Swift methods

when I use option+click in Swift methods, parenttheses will be added to the end of the search field and causes the searching fails

The plugin shows online docset as first result

Steps:

• ALT-click on a class

Result

• online doc first result
  https://www.dropbox.com/s/01cf8dffgslmtf4/Screenshot%202014-01-11%2014.26.12.png

Expected Result

• local docset first result
  https://www.dropbox.com/s/gfzuiwtcjxoapl6/Screenshot%202014-01-11%2014.33.26.png

If you search manually inside the Dash app the online doc does not show up.
Xcode 5.1, OSX 10.9.1, Dash 1.9.4

Dash inserts dash-advanced://link type of link into the search string from Xcode instead of a class name

Search text generate is not correct

With the last Xcode, Dash and Dash plugin version, when I trying search anything, the Dash plugin generate a incorrect search text.

Detect platform based on file

I'm trying the automatic platform detection, without much luck. I have a very large, complex workspace filled with C, C++, and ObjC (and a little ObjC++). When I set my scheme to build one of the C-only projects, open a .c file and opt-double-click "signal", it's opening the Ruby Signal page. (Ruby is among my search docsets)

Rather than interrogating the scheme, it seems better to check the file type you're in. In a "C Source" file, for instance, it should search the C docset. In an "Objective-C Source" file, it should search osx: or ios: (that could be checked from the scheme), and then C. In an Objective-C++ Source" file, it should search osx, ios, C++, C.

"Dash not installed" when Dash installed

When Option-clicking in Processes.h I get a message "Dash not installed" when Dash is installed. It looks like there also might be an Xcode bug involved here since way more than the function name is being targeted, too.

http://sabi.net/temp/Dash.mov

Needs upgrade for Xcode 6.3

Needs upgrade for Xcode 6.3

Does not detect C++ context

When using C++ within an iOS/Mac project it would be great if the plugin could detect the file type and use that to decide on whether to use the C++ docset instead of iOS/OSX. For example if the filename ends with cpp. If it ends with mm then you would need to be able to search both cocoa and cpp, but I am not sure if Dash allows this to be specified. Anyway, just enabling this for cpp files would be great. I am happy to code this, but do not know how to get the current filename.

option+click does not work in my mac

option+click worked good in my device, but recently it doesn't work.
I added NSLog() in source code, and found error info in Console.app like below:
16/5/11 下午1:24:38.008 Xcode[20794]: OMQuickHelp: Couldn't swizzle _searchDocumentationForSelectedText:
16/5/11 下午1:24:38.008 Xcode[20794]: error: Error Domain=NSCocoaErrorDomain Code=-1 "+[NSObject(JRSwizzle) jr_swizzleMethod:withMethod:error:]: original method _searchDocumentationForSelectedText: not found for class IDESourceCodeEditor" UserInfo={NSLocalizedDescription=+[NSObject(JRSwizzle) jr_swizzleMethod:withMethod:error:]: original method _searchDocumentationForSelectedText: not found for class IDESourceCodeEditor}, info: {
NSLocalizedDescription = "+[NSObject(JRSwizzle) jr_swizzleMethod:withMethod:error:]: original method _searchDocumentationForSelectedText: not found for class IDESourceCodeEditor";

It seems method _searchDocumentationForSelectedText: does not exists. my Xcode version is 7.3.1, how can i solve this problem?

Plugin installed through Alcatraz is not working

I've removed and added the plugin using Alcatraz. I can see the Dash Integration menu in help. When I option double click a method or click a link in the help pane, it still opens the built in help. Xcode 7.3.1 7D1014

Dash creates results for application classes and methods.

Whether searched for via double-clicking on symbols or opened via links from the Quick Help popup.

Examples:

You can see that the search term is additionally messed up when searching for a class, though if it was just searching for "SLTerminal" it would probably still create a result like in the second image.

Xcode 6.3.2 Dash plugin not working.

I can not find Dash plugin in help menu, and also not working for searching document.

Submit to Alctraz plugin manager

Great plugin! Thanks for your work. It would be great submitting it to Alcatraz.

Not working in Xcode 6.4

I am using through Alcatraz. Option click is showing Xcode help and not using Dash

Dash menu not showing up in Xcode Version 6.3.2 (6D2105)

I had the plugin work earlier, but it seems its not getting picked up after the latest release of Xcode.
I tried running the project again but no luck.

Any suggestions on how to get it back ?

Thanks,
Eddie

option-click + double click behaviour changed for Xcode 7.1?

Hi there,

I am keep using this plugin since Xcode 6. I used to optional-click to get the system popup window for description, and optional- double click to get dash.

Now today I updated Xcode 7.1 and rebuild the plugin, the trick is not working. the option- double click will always call up the xcode document, not dash ( I have enabled the replacement)

What's changed and how do I get my old habbit back? Thanks. It works perfect on 7.0, not sure why 7.1 broke my habbit :(

I don't use any other plugins except dash and vvdocumenter (a comment tool), and I always do a rebuild once the Xcode updated.

Xcode 7.0 GM

The plugin has been working for me throughout the various Xcode betas but now isn't working in the GM seed. I tried deleting it from '~/Library/Application Support/Developer/Shared/Xcode/Plug-ins' and then reinstalling, but upon restarting Xcode after building the project I get no prompt to allow the plugin. I've checked to make sure it's being copied to the Plugin-ins folder during the build, which it is.

It is working with the Xcode 7.1 beta however when I option click methods / properties they seem to default search to Google. For example if you option click on NSObject Dash Google searches c:objc(cs)NSObject.

Open Dash from Xcode Quick Help?

I love the idea of opening Dash from Xcode, but I actually rather like the Quick Help popup--where Xcode falls down, IMO, is in the documentation viewer. What I would really like to do is to open Dash from the popup, in place of the documentation viewer--that is, when the user taps the "Reference" link at the bottom of the popup. Would you be able to give me any tips on implementing this?

• how I might discover what happens when the link is tapped (so I can swizzle that method)?
• how I might open the appropriate reference page in Dash? I see that you use Dash's service; where can I find documentation for that? cc @Kapeli