XIDE help - was: Hint to find the source of a runtime function?

Chris · Post by **Chris** » Tue Dec 17, 2019 3:43 pm

Hi Karl,

Right, I had completely forgotten about this! Will look into it in the next days.

Karl-Heinz · Post by **Karl-Heinz** » Tue Dec 17, 2019 5:28 pm

Guys,

another kind of GitHub search

Replace in XIDE the "Tools -> "Preferences" -> "Advanced" -> "Search engine URL" setting with:

https://github.com/X-Sharp/XSharpPublic/search?q=%22function+%value%%22

When you double-click a function name and right select "Search web for selected Text"
the Github search starts with the word "Function " + the selected text.

How about a XIDE PopUp menu enhancement ?

Search Github for Selected Text
Search Github for 'FUNCTION ' + Selected Text
Search Github for 'METHOD ' + Selected Text
etc.
etc.
...

regards
Karl-Heinz

FFF · Post by **FFF** » Tue Dec 17, 2019 6:05 pm

Karl-Heinz,
problem is, if you do this the search for NON-Git content won't work anymore.

I'm confident, Chris will come with a generic solution

wriedmann · Post by **wriedmann** » Tue Dec 17, 2019 6:25 pm

Hi Karl,

Karl-Heinz meant a new function - other 3 entries in the XIDE context menu. That could be easily written in a XIDE plugin.

Wolfgang

Chris · Post by **Chris** » Tue Dec 17, 2019 11:50 pm

Haha that was a smart way to do it Karl-Heinz, would never think of it myself! But yeah, as the guys said it is better if I will take care for it internally.

Actually this context sensitive help search did work properly in the past, but was using the vulcan help file

(if you have vulcan installed, press SHIFT+F1 on a keyword, it will still open the topic for that keyword in the vulcan help file). Need to remap everything now, to the X# help file or online documentation. Or maybe both with an option...

wriedmann · Post by **wriedmann** » Wed Dec 18, 2019 4:54 am

Hi Chris,
if you could to that, I would like it.
Otherwise I was thinking about implementing it in my plugin (and sharing it of course).
Wolfgang

Karl-Heinz · Post by **Karl-Heinz** » Wed Dec 18, 2019 7:18 am

Hi Chris,

Yeah, when it´s possible to open with Shift+f1 the associated help description, the [view sources] button does the rest

. Whereby it´s even possible to add the line number where the func starts. I saw that in earlier X# help files, but i think it´s not easy to keep in sync, because every changes made changes the position of each function header within a prg.

https://github.com/X-Sharp/XSharpPublic ... S.prg#L282

regards
Karl-Heinz

wriedmann · Post by **wriedmann** » Wed Dec 18, 2019 8:01 am

Hi Karl-Heinz,
I would not implement this as Shift-F1 replacement, but put in rather in the context menu.
Wolfgang

Karl-Heinz · Post by **Karl-Heinz** » Wed Dec 18, 2019 9:16 am

Hi Wolfgang,

it´s not about my first post and not about a SHIFT+F1 replacement. It´s about the possibility that in XIDE the keys F1 or SHIFT+F1 open the X# help. When i click on the word "Right" and press SHIFT+F1 the X# help should open and jump to the description of the function Right(). According what Chris said, it does work with a VN Help file.

regards
Karl-Heinz

FFF · Post by **FFF** » Wed Dec 18, 2019 9:34 am

Exactly.
BTW, @Chris: you might consider swapping F1 and Shift-F1 - i think, we look a lot less often into Xide's help as otherwise

I know, it's contrary to "the rule", but in the end lazyness wins...

Main menu