Developer Center Resources

cancel
Showing results for 
Search instead for 
Did you mean: 

VI Package Manager: Adding Examples, Help, and Tools Menu Items

Overview

We have developed a toolkit of VIs we would like to package and distribute to end-users. In the previous exercises, we built these VIs into a package using Package Builder and we reorganized the palette items. Now, we would like to add example VIs, a help document, and a LabVIEW Tools menu item to our package.

Configuring Destinations

Open the Package Builder in VIPM and switch to the Destinations category in the left-hand menu.

Image 010.jpg

Observe the preset destinations and their corresponding settings. These destinations follow a recommended folder naming convention for LabVIEW add-ons. New destinations can be added using the button below the Destinations list.

Let’s configure our destinations:

Image 011.jpg

    • Select the Examples destination.
    • Change the Destination Type to Directory.
    • Select the Tools Menu destination.
    • Change the Destination Type to Directory.
    • Select the Help Menu destination.
    • Change the Destination Type to Directory.
Note: The default setting of Directory (Preserving Hierarchy) will copy the source folder hierarchy over to the destination folder and thus does not apply to this example.

Configuring Source File Settings

Now, let’s switch to the Source File Settings category.

Image 012.jpg

Let’s set the destination for our examples:

    • Select the _Examples folder in the source file list.
    • Uncheck Use Destination of Parent Folder.
    • Select Examples from the Destinations drop-down menu.

Image 013.jpg

Let’s set the destination for our help document:

    • Select the _Help folder in the source file list.
    • Uncheck Use Destination of Parent Folder.
    • Select Help Menu from the Destinations drop-down menu.

Now, let’s set the destination for our tools menu item:

    • Select the _Tools Menu folder in the source file list.
    • Uncheck Use Destination of Parent Folder.
    • Select Tools Menu from the Destinations drop-down menu.

Build the package using either the Build Package button or Package > Build menu option.  Choose the Open Package in VIPM Main Window option.

Select LabVIEW 2011 and click on Install.  Click Continue.  Click Finish.

Now, to view our examples click on the Show Examples button.

Image 014.jpg

In order to view the new tools menu item and Help document in LabVIEW, we will need to close LabVIEW entirely and open it again. Please do so now by selecting File > Exit in LabVIEW.

Upon opening LabVIEW, you can now access the new tools menu item we added by clicking on Test Tools Menu….

Image 015.jpg

Similarly, you can find the help document we’ve added under the LabVIEW Help menu.

Image 016.jpg

(Optional) Find the examples in the NI Example Finder:

    • Open the NI Example Finder under Help > Find Examples… in the LabVIEW Help menu.
    • Choose the Directory Structure radio button under the Browse According to: heading.

Image 018.jpg

    • You can find the shipping examples we added to our package under NI > Simple Math.

Image 019.jpg


Next Steps

Click here to return to the table of contents, or continue to adding an End-User License Agreement.

Comments
Member JeremiahZOU
Member

Hi, all

 

I built a package recently using VIPM, and there is several subforders in my examples forder.

After I built this package and install it, I clicked the Show Examples button, and it open one of my subforders.

 

My question is how can I control which subforder the Show Examples button will open?

Or can it just open to the subforder? For example, just open the NI forder but not Simple Math forder in the picture below.

Image 014.jpg

 

Best regards!

Contributors