LabVIEW Idea Exchange

cancel
Showing results for 
Search instead for 
Did you mean: 
Pie566942.0

Make Bookmarks Available in Documentation for Compatibility with Requirements Gateway

Status: New

Requirements Gateway supports [Covers: <Req_ID>] tags in the documentation dialog box.  Bookmarks don't appear in the Bookmark Manager when the hash tags are in VI, control, library, etc. documentation dialog box.  Please make Bookmarks available in documentation dialog so I can use RG or Bookmarks to navigate to any coverage tag regardless of where it appears.

 

Thanks for your consideration,

 

-Steve K

3 Comments
Elijah_K
Active Participant

So to be clear, you want the bookmark manager to be able to parse the contents of the 'Description and Tip' field?  I'm assuming that's what you mean by 'documentation dialog box,' just wanted to check...

Elijah Kerry
NI Director, Software Community
Pie566942.0
Member

Hi Eli,

 

Thanks for taking a look.  Correct, but not entirely:

 

  • Front panel object » Description and Tip
  • .VI / .CTL » File » VI Properties » Documentation
  • Project » Properties » Project Description
  • Library / Class/ XControl / » Properties » Documentation » Description

Regards,

 

-Steve K

Christina_R
Active Participant

It might be possible to get this functionality without waiting for NI to provide it.

 

The Bookmark Manager is a user-configurable piece of the LabVIEW environment. Refer to this document: https://decibel.ni.com/content/docs/DOC-31854

 

As far as I know, all of those description fields are accessible via VI Server interfaces, so you could modify the dialog to show them.

 

There are two problems that I foresee. First, you wouldn't be able to read the descriptions of front panel objects unless the VI was loaded into memory. Second, you wouldn't have a notification event to let you know when descriptions were edited and you should update the manager to show them. The first problem can be handled by loading VIs into memory to read their descriptions, but this can have a noticeable performance impact. For the second problem, you might add a manual option to refresh the Bookmark Manager's contents.


Christina Rogers
Principal Product Owner, LabVIEW R&D