Symbolic path

[Norbert_B]

Putting these help text together, i would say: no, <topvi> shouldn't work for help documents.

However, i concur with you that the LV help doesn't explicitly states that it is NOT working, but it doesn't state that it does (as it does for <helpdir> for instance). That means that the LV help is ambiguous on this.....

I just verified that using <topvi>:\ in the help path of a VI leaves the help link in context help empty which indicates that the symbolic path cannot be resolved.

[sabri.jatlaoui]

I have the same conclusion. I'll check with NI and keep you inform.

Thanks.

[NIRebecca]

Hey guys, 

I've had a look over the documentation and I agree it's a little ambiguous, both in the definition and use of various symbolic paths.

e.g.

Using Relative Paths  gives "Relative paths are also referred to as symbolic paths."

CLD Mastery - File Managment, Linking, and Project Libraries gives  "Relative Paths:Caller VI stores relative path from itself to sub VI, Symbolic Paths:Caller VI stores path from symbolic path to sub VI."

I agree with the previous suggestion that the reason that <topvi> isn't able to be used in the same way as other symbolic paths is because it is not static, which I think the help file attempts to highlight by saying <topvi> is "only available" when setting VI Search Paths. From having a quick look in LabVIEW I don't think the background functionality is too dissimilar from attached snippet comparison.

I have created a CAR on these help documents, so we can make sure the information is corrected and clear. I've also asked for some clarification on the use of symbolic paths with code specifically. 

Thanks for looking into this guys! I'll update again if I hear of any progress with the CAR.

Kind regards, 
Rebecca.

[sabri.jatlaoui]

Hi Rebecca,

Thank you for the answer. I'll wait for your update.

So is it possible to use relative path for VI "Help path"?

I thought of making it with <topVI>, but as it's not really clear how to use it, maybe you have another way?

Regards. 

[NIRebecca]

Hey Sabri,

If I understand you correctly it might be worth checking out this previous forum post: "Defining the help path as .\filename will reference the file "filename" in the directory that contains the VI." 

https://forums.ni.com/t5/LabVIEW/relative-help-path/td-p/389251

Let us know how you get on.

Kind regards, 

Rebecca 

[saja_averna]

Hi Rebecca,

I already test this, but it is not working so well. It only work when you do it manually and you have previously set the absolute help path into documentation.

I made a project to explain what I meant.

In this project you will find 3 Vis

-The ‘SampleVI’ is the one I used to create the help documentation. I set the relative path dynamically using VI help path property node. Here the detailed help hyperlink doesn’t appear in the contextual help when the VI is open.

-The ‘Manual relative’ I set the same relative path manually. Here the detailed help hyperlink doesn’t appear in the contextual help when the VI is open.

-The ‘Manual Absolute then relative’ VI set the absolute path using the browser then I set same relative path manually. Here the detailed help hyperlink appears in the contextual help when the VI is open..

Even if the help is load into the project, the result is the same.

Regards.

[NIRebecca · Accepted solution]

Hey guys, 

I've had a look at the attached projects and although I can see the behavior you've listed I can't recreate it.

I think the issue with the  ‘Manual relative’ VI you attached may lie in the carriage return at the end of the "Help Path" in the Documentation tab of VI Properties. If you remove this does it work as expected?

Let me know how you get on.

Kind regards, Rebecca

[sabri.jatlaoui]

Indeed Rebecca,

That was the issue.

Thanks a lot for the help.