Incorrect documentation for installation (with Natlink)

[jaanli]

The docs (https://dragonfly2.readthedocs.io/en/latest/natlink_engine.html#refnatlinkengine) state:

Natlink automatically loads macro files from a predefined directory. Common locations are:

C:\Program Files\NatLink\MacroSystem
My Documents\Natlink

At least one of these should be present after installing Natlink. 

However, after installing natlink following the instructions at https://github.com/dictation-toolbox/natlink - there is no MacroSystem directory.

After running start_natlinkconfig.exe, I had to enable the user directory (I put it in Dropbox).

This is the info tab:

Do you know how to create or find the MacroSystem directory?

(It could be helpful to update the install instructions with this info. Thank you!)

[drmfinlay]

Thank you for reporting this. This is a mistake. The typical path for the MacroSystem directory — C:\NatLink\NatLink\MacroSystem — is missing from this list. That directory is common using the stable versions of Natlink that require Python 2.7. It seems this is done differently using the (unstable) development version that works with Python 3.

Nevertheless, setting the Natlink User Directory was the right thing to do. I will update the Natlink engine documentation page to include "C:\NatLink\NatLink\MacroSystem" and a few other things that are missing.

[drmfinlay]

I've updated the Natlink engine documentation page. I think it is clearer now. Do you see anything else that should be added in?

[jaanli]

Thanks so much @Danesprite !

Would a 'quickstart' guide make sense to add as a top level heading in https://dragonfly2.readthedocs.io/en/latest/? It could simply be a few steps to reproduce a minimal working example with the least amount of effort, a few commands to help verify that everything is working properly.

Context: there are so many moving parts here and I still can't get natlink/dragonfly to work with Dragon 15. Being able to know what to test to verify a minimal working example would be super helpful.

(I've spent a few hours on the phone with Nuance support over the past few days reinstalling Dragon. Not sure whether it's Dragon itself breaking things or my attempts at configuring natlink/dragonfly, and I'm not sure how to test these things given it's my first time trying to use this!)

[LexiconCode]

I wouldn't mind connecting remotely over TeamViewer or something similar if you would think that would be helpful.

[LexiconCode]

@altosaar Okay go ahead and get a hold of me through gitter via private chat. Once you enter the chat you can click on my icon and it gives you the option for private chat. I'm available most of today up until 5:15pm (GMT-5) and tomorrow.

[drmfinlay]

@altosaar Glad I could help!

A 'quickstart' guide would very much depend on the engine back-end you're using. So we have separate pages for each engine. It is more involved with Natlink than the others. But, clearly, the page for it could be better. There are Natlink install instructions for the stable version (4.2), along with a video guide, here. I'll include a link for this on the page.

Sorry you've had trouble getting all this working.

[drmfinlay]

I've added the link for this page instead, which is the page "above" the other one in the sitemap.

[jaanli]

Thanks @Danesprite and @LexiconCode ! Just submitted a minimal working example with @LexiconCode 's template: master...altosaar:patch-1

Let me know if that looks OK!

[LexiconCode]

Let me know if that looks OK!

Looks great and to the point!