Sign Up

Free Label To VI Description (Right-Click Menu Plugin) by Robusto Systems - Toolkit for LabVIEW Download

Right-Click Menu Plugin (IDE extension) that helps set the VI Description

* 3 ↓134
 screenshot
Version1.1.0.3
ReleasedJan 08, 2023
Publisher Robusto Systems
License MIT
LabVIEW VersionLabVIEW>=16.0
Operating System Windows, Mac, and Linux
Project links Homepage   Documentation   Repository  

Description

This is a right-click menu (a.k.a. shortcut menu) LabVIEW IDE extension. When right-clicking a free label (a comment) on the block diagram or front panel this tool adds a menu item named "Set as VI Description". When clicking this menu item, the tool copies the text from the free label and applies it to the VI Description. If the VI Description already contains text, a prompt asks the user for confirmation before overwriting the VI Description. Optionally, bold characters in the free label are replicated in the VI description (see section about "ProcessBoldCharacters = True" setting below).

This tool helps keep in sync the contents of a main comment on the block diagram or front panel and the VI Description. Such that the same comprehensive description of the VI is available both "inside" the VI (on the BD or FP) and "outside" the VI (in the VI Description/Context Help window).

This package installs the following two files to the following location: \resource\plugins\PopupMenus\edit time panel and diagram
- Free Label To VI Description.llb
- Free Label To VI Description.ini

For example, to "C:\Program Files (x86)\National Instruments\LabVIEW 2022\resource\plugins\PopupMenus\edit time panel and diagram"

Enable the bold character processing functionality by setting "ProcessBoldCharacters = True" inside the "Free Label To VI Description.ini" settings file. This functionality will result in the VI Description text containing bold text that replicates any bold text in the free label. Unfortunately this functionality can make the tool noticeably slower to execute, hence it's disabled by default.

The source code is available inside the LLB file, or at the following Github repository: https://github.com/RobustoSystems/FreeLabelToViDescription

Good or bad, we love to hear from our users. Please email us at engineering@robustosystems.com with your thoughts, including bug reports and suggestions.

Release Notes

1.1.0.3 (Jan 08, 2023)

Enhancements:
- Now able to detect bold text in the free label, and generate corresponding B and /B tags inside the VI description text. The end result is that the VI description text displayed in the Context Help window can replicate the bold text in the free label.

Credit to Brent Justice for suggesting and implementing this functionality.

Please note: Due to performance concerns, this functionality is disabled by default. The functionality can be enabled by setting "ProcessBoldCharacters = True" inside the "Free Label To VI Description.ini" settings file.

petrutarabuta was a contributor to this release


Download Package

Versions
All Contributors
Featured in

  Post an Idea   Post a Resource

Recent Posts

Support BOLD markdown
First, this package is genius. It takes way too many clicks to open and then edit VI descriptions,…

by Brent Justice, 4 weeks, 1 day ago, 5 , 1
suggestion