How do you document specific sections of a VI?

Once in a while I'll use a VI (perhaps one of mine or one from vi.lib) to do something in an unusual way.  How would you document this usage so that when you go back to it some weeks later you don't have to scratch your head wondering why you did it that way?  A free label near that VI (or wire) clutters the diagram and gets lost when doing a diagram cleanup (ctrl-U).
I can think of a couple of ways that NI could help us out.  One would be to allow me to attach a documentation property to an instance of a VI or wire.  This documentation would show up as either a tool tip when you hover the mouse over the object, or in the Context Help window.  An indicator would be needed on the VI or wire to let me know that there is documentation available.  The indicator may be something that resembles a coersion dot though in a different location so it won't be confused as a coersion dot.
On a related note, I've seen a few diagrams that have transparent labels on top of a wire indicating what that wire does.  This is a pretty good kludge to document a wire.  Perhaps a label property can be attached to the wire in much the same way as the documentation property I describe above.  The label would be visible and automatically displayed on top of the wire.  The key difference is that the label would be owned by the wire and could not get misplaced.
 - les

I like the way NI documents code in some of their examples.  They use small labels with a number or letter in it.  Then below is a huge label with explanations of each numer of letter.  See the picture:
Message Edited by tbob on 09-23-2008 12:27 PM
- tbob
Inventor of the WORM Global
Attachments:
Dynamic Generation and Acquisition-Source Synchronous_BD.png ‏18 KB

Similar Messages

  • [Java and all else] How do you document DB design?

    Hello,
    Although most of the technical choices are explicit in SQL (UniqueKey & ForeignKey constraints, indexes,...), the semantics of the data columns and their constraints seem better served as plain human-readable comments ("ID column: identifies the plane copy; 6 figures are enough as we don't expect to sell more than 1 million planes in a foreseeable future...").
    In my current system, (EJB-based, but the DB schema is not created by the JPA-compliant ORM, but via SQL scripts), I see the following ways to write and maintain this documentation:
    - SQL comments in the schema creation and patch scripts
    - Javadoc comments in the Java source of the Entity classes.
    - UML notes in UML diagrams(1)
    - external "Architecture and design" document.
    All 4 of them are used, sometimes inconsistently, for various parts of the design choices; I mean, the docs do not contradict themselves (not yet, but it's a mere question of time), but some tables are commented in SQL scripts, others are in design docs, and the details for some columns are in entity javadocs. Although each developer may find it handier to "write" the doc via his preferred medium, it becomes increasingly difficult to "maintain" theoverall documentation.
    Our current situation is that most of the project team members are Java developers, so it would probably be better accepted and served if we standardized that we document DB tables and columns in Java source, but I am worried that:
    - someone else pouring over our DB (ex: DBA helping us to optimize things, or other team developping a data-mining tool to leverage the historical data in DB) may not be as comfortable with Java
    - this may not cover all design choices of the DB schema:
    - - - - first, although that is the case currently, in the future there might not be a 100% 1-1 mapping between e.g. each entity class and a DB table. Maybe some columns will not need to be mapped anymore,...
    - - - - second, I fear some DB constructs are not amenable to Java counterparts; no accurate idea there, I'm not an SQL nor JPA expert, but I presume Indexes, table partitioning, tablespaces, for example (yes, the DBMS is Oracle :o) are not taken into account in JPA mapping.
    And if we document those choices at the SQL level (my preferred idea so far), this will gradually make the javadocs in the entities obsolete, or removed altogether, and that will make future maintenance of the Java source risky.
    How do you document your DB design in general?
    Do you have specific advices for my case?
    Thanks in advance,
    J.
    (1) Just for the record, here are a few posts that refer to modelling the DB in UML:
    [A post on this forum highlighting that UML 1.4 standardizes a notation for RDB modelling|http://forums.sun.com/thread.jspa?messageID=1383724#1383724]
    [A DB modelling tutorial|http://www.tomjewett.com/dbdesign/dbdesign.php] (not sure whether it leverages the standard mentioned above :o)
    P.S.: "Java and all else" as in, damn, I'd love to use the familiar JDC forums and people to discuss not only Java-related issues, but also [all other things that surround Java|http://forums.sun.com/thread.jspa?threadID=5422264&tstart=0] (other technologies, processes, people) and enable to make workable systems out of Java code.

    jduprez wrote:
    Thank you again.
    A couple more questions:
    2. Table, and proc dictionary maintained as one or more text files. Those files and schema are all in source control.Do you mean, a proprietary text format (a la tabledesign.txt), or +.sql+ source files? Again, you seem to suggest the scehma info is present in two locations.I didn't say two locations unless you meant files. Then yes.Yes I meant two files. I trust the team to get the doc file lagging a few revisions behind the SQL file, and to correct that I would have to include one more step in the review process (e.g. "review CM actions to check that the doc file is updated consistently with the SQL source").
    The tool I wrote would throw errors if the comment file didn't match the schema. And if comments were not provided. That of course doesn't stop someone from documenting a table with "a table".
    You can of course keep the addtional info as special comments in the SQL, but when I did this, and even in retrospect, it seems better and perhaps easier to keep them seperate. I have done special comments in SQL before and it seems a bit of a kluge but you do have the single source. But in that case I was the only one maintaining it too.What do you mean by "special"?For code generation I have a schema file with the following (pseudo sql.)
        create mytable
           mytable_id int,
           column_foo varchar(10);
           column_fum varchar(20)
            -- Query: for_a_query (column_foo, column_fum)
        )The generator consumes the schema and generates the standard CRUD which would include a query based on the primary key.
    The above comment is used to provide an additional query where the proc is named 'for_a_query' (munged with table name) and takes two parameters (column_foo, column_fum) whose type/name matches those of the table.
    If we don't try to generate a browseable HTML out of the schema (although the idea is appealing, I don't have the resource to make such a tool), do you see anything kludgy in maintaining SQL comments interpersed within DDL code?
    Of course that is doable.

  • How do you document ABAP programs?

    hi
    How do you document ABAP programs? Do you use program documentation menu option?
    Regards
    Ashok Kumar

    Hi,
      good for selection screens:
    when in the ABAP Editor, in edit mode, choose
    Goto->Documentation.
    This gives you a SAPscript-type screen with many headings. Enter the instructions that you want your end-user to see when they run the program. SAP supplies many different headings here, choose the ones relevant to your program.
    Save and activate.
    When you run your program, when you are at the selection screen, choose
    Help->Application Help
    and you see your user documentation!
    I expect Sapscript experts can make this look even better, with links to other help topics etc.
    Regards

  • How do you document EJBs?

    I want to document my EJB client-wise, meaning that I need docs for users of
    my EJBs. I used to write javadocs comments for interface and home classes.
    But I use JBuilder and those classes are being regenerated often. How do you
    document your EJBs?

    "GD" <[email protected]> wrote in message news:[email protected]..
    I want to document my EJB client-wise, meaning that I need docs for users of
    my EJBs. I used to write javadocs comments for interface and home classes.
    But I use JBuilder and those classes are being regenerated often. How do you
    document your EJBs?I'd look for documentation options in the JBuilder
    setup. I don't beleive there is no one.
    Regards,
    Slava Imeshev

  • How do you sort specific columns and freeze a header column?

    I'm creating a list of people attending a workshop and would like the first column to be the number of people attending. The first column is the number and that row sorts with the rest, so then my numbers go 1, 9, 5, etc instead of remaining 1-20. Is there a different way for me to determing the number? I put 1 in cell A 2 and then for A 3 I give it a formula A1 + 1 to create the number sequence. I've tried making it a header column and freezing the column, but it still changes.
    thanks,
    Nancy

    Nancy,
    You can search the discussions when you have a specific question, or you can just browse them from time to time to see what there is to be learned. Your question is a little like "How did you learn to be a good cook?" Most of the good home cooks never went to cooking school, but they have had lots of good coaching and lots of experience. Many of the helpers here have been using spreadsheets for so long that they don't remember when they learned a particular trick or method. And, we like to share, so keep the questions coming.
    I keep the Formula Browser in view, and I study the examples for the functions I think I might want to use.
    Regards,
    Jerry

  • How do you request specific music to apple that isn't on itunes?

    How do you request apple to put specific music on itunes that isn't available. I know that this was a tab on the store a few years ago.

    You can submit suggestions for the iTunes Music Store through the feedback page. Whether or not your suggestion will ever be acted upon will depend on a number of factors, some out of Apple's control (to start with, the artists and record companies have to be willing to license the tracks to Apple), so don't expect instant action.

  • How do you transfer specific music from your computer to your ipod touch?

    Ive read threads of how to do this and so far none have helped...Im trying to add specific songs that are on my computer to my ipod touch (4th gen).  I do not want the songs on my ipod transfered to my computer. 
    When I go to the ipod device in the menu collum of itunes on my computer, & then pick the "music" tab in the menu bar I get very limited options that I can choose.
    it says
    1. sync music .... If I try this selection a warning msg pops up " all existing content on ipod will be removed & replaced with songs & playlist from your itunes library"  I don't want this! I just want songs added to ipod
    2. below this selection are 4 options inside a gray box.  These selections are not available for reasons unknown to me.  They read
      a.  Entire music library
       b.  Selected playlist, artist, albums, and genres
       c.  include music videos
       d.  include voice memos
    selections a,  c, & d have tick marks by them
    As far as I have found up to this point this is somwhere close to the vicinity that I want to be in order to get done what I want to get done.  I don't know... perhaps I'm coming at this from the wrong angle.  Maybe I should use the ipod , and come at itunes from its interface?...

    I have not sync with another computer.  Brand new Ipod touch from christmas.  same computer.  I have however conected it to this computer before & because I was ingnorant it synced automatically with this same computer.  I was ****** because it messed everything up.  So I erased my ipod completlely and started over.  I also un-installed itunes and started over with its as well.  I then put only music that I wanted on my ipod onto my computer in itunes. 
    Now I cant figure out how to get that specific music on my ipod... this is all very maddening!!.. I feel like throughing both computer and ipod out my 2 story bedroom window

  • How do you delete specific message from users in Exchange 2013 DAG database?

    Our network has been inundated with spam from INTUIT.COM with the SUBJECT: PAYMENT OVERDUE and contains a link to download a form from a Dropbox. Obviously, very suspicious and clearly spam. We're using Postini as our Edge Transport/ Spam filter but messages
    are still getting in. I've enable anti-spam on all my mailbox servers, set the SCL values but that hasn't worked.
    I understand that Exchange Edge Transport role has the more aggressive spam fighting features but Microsoft also recommends an online spam filter. 
    Needless to say, we've taken steps to quarantine those messages based on subject and sender in Postini but now would like to delete those messages from the users in went to. My users are two different DAG mailbox databases. I found this article http://www.techieshelp.com/delete-mail-from-multiple-mailboxes/ but
    the command didn't work. I'm thinking its because I have DAG and a couple of databases. I even tried "get-mailbox -database "databasename" | search-mailbox -searchquery subject: "Payment Overdue"" and that didn't work. 
    I'm running Exchange 2013 SP1 DAG across two sites comprised of four 2013 SP1 mailbox servers.

    Check this out
    http://technet.microsoft.com/en-us/library/ff459253%28v=exchg.150%29.aspx and specifically look at the section titled  "Search messages and log the search results"
    Or you can use this
    http://technet.microsoft.com/en-us/library/aa996371%28v=exchg.150%29.aspx with the WHATIF parameter
    Alternatively if you are open the 3rd party solutions check out Lucid8's DigiScope
    http://www.lucid8.com/product/digiscope.asp
    which would allow you to see the search results and then delete OR if desired you can set the On FIND action to Export to PST and then Delete so that you can preserve and then remove messages on the fly as the search system finds
    Search, Recover, & Extract Mailboxes, Folders, & Email Items from Offline Exchange Mailbox and Public Folder EDB's and Live Exchange Servers or Import/Migrate direct from Offline EDB to Any Production Exchange Server, even cross version i.e. 2003 -->
    2007 --> 2010 --> 2013 with Lucid8's
    DigiScope

  • How do you enforce specific password syntax rules?

    Hi Guys,
    I'm setting up iPlanet Directory Server 5.1.3 and I need to configure it to enforce a password rule which says that you must have at least one letter and one number in your password. I've searched the documentation and googled the heck out of it, but I can't seem to find any reference as to how to do that. Does anybody have any info on if this is possible and where I might look for some info on how to do it?
    Thanks,
    Mike

    Thanks gary, excelent find, ive just installed it on solaris 10.
    heres what happened when i tried to use a password
    test
    then tester
    then tester1
    $ passwd
    passwd: Changing password for admin
    Enter existing login password:
    New Password:
    passwd: Password too short - must be at least 6 characters.
    Please try again
    New Password:
    passwd: The password must contain at least 1 numeric or special character(s).
    Please try again
    New Password:
    Re-enter new Password:
    Your new password was rejected for the following reason:
    it is based on a dictionary word
    Permission denied
    to build get hold of pam_cracklib.tar.gz, from sourceforge and
    cracklib,2.7.tar.gz
    first cracklib, change the DICTPATH in the Makefile for
    /usr/dict/pw_dict
    do
    CC=/opt/sfw/bin/gcc; export CC
    and in the utils directory change the make file so all the cc's are gcc
    then
    make all
    now cd cracklib and cp libcrack.a /usr/lib and packer.h to /usr/include
    cd to the utils directory and copy all the binaries to /usr/bin
    cp mkdict testlib testnum teststr unpacker /usr/bin
    now move on to the pam part
    unpack and cd to pam_cracklib
    edit the GNUmakefile as follows or use this GNUmakefile
    # !!! Hello !!!
    # Make sure you are using GNU Make, and not some cheap imitation.
    # !!! Thank you !!!
    OS=$(shell uname)
    ARCH=$(shell uname -p)
    CRACKLIB_TARGET=pam_cracklib.so
    DESTDIR=/usr/lib/security
    PERMS=0700
    PASSWORD_SRCS=pam_password.c
    COMMON_SRCS=pam_module.c logging.c util.c
    CRACKLIB_SRCS=cracklib.c $(COMMON_SRCS) $(PASSWORD_SRCS)
    CRACKLIB_OBJS=$(CRACKLIB_SRCS:.c=.o)
    DICTPATH="/usr/dict/pw_dict"
    INCL=
    LIBS=-lpam
    CRACK_LIBS=-lcrack
    CC=gcc
    CFLAGS=-g -Wall -fPIC -D$(OS) -D$(ARCH)
    LD=ld
    ifeq ($(OS),SunOS)
    LDFLAGS=-G -z redlocsym -L/usr/lib -R/usr/lib
    else
    LDFLAGS=-x --shared -L/usr/lib -R/usr/lib<br />
    endif
    RM=rm
    FORCE_REBUILD=
    password: $(CRACKLIB_TARGET)
    # We will use this when cproto(1) stops sucking
    # %.h : %.c $(FORCE_REBUILD) # A ".o" file depends on the corresponding ".c" fil
    e
    # cproto -E 0 $<
    %.o : %.c $(FORCE_REBUILD) # A ".o" file depends on the corresponding ".c" file
    $(CC) $(INCL) $(CFLAGS) -c $< -o $@
    % : %.o # override default linking rule just in case
    @echo
    @echo $@ is not a valid target
    @echo
    $(CRACKLIB_TARGET) : CFLAGS += -DMODULE_NAME=\"$(CRACKLIB_TARGET)\" -DCRACKLIB_
    DICTPATH=\"$(DICTPATH)\"
    $(CRACKLIB_TARGET) : $(FORCE_REBUILD) $(CRACKLIB_OBJS)
    $(LD) $(LDFLAGS) -o $@ $(CRACKLIB_OBJS) $(LIBS) $(CRACK_LIBS)
    @echo
    @echo $@ built successfully!
    @echo
    # Need -O so the inline "stat()" gets compiled, grr
    $(DESTDIR)/$(CRACKLIB_TARGET) : $(CRACKLIB_TARGET)
    @echo installing...
    test -d $(DESTDIR) || mkdir -p $(DESTDIR)
    cp $(CRACKLIB_TARGET) $(DESTDIR)
    chown root $(DESTDIR)/$(CRACKLIB_TARGET)
    chgrp root $(DESTDIR)/$(CRACKLIB_TARGET)
    chmod $(PERMS) $(DESTDIR)/$(CRACKLIB_TARGET)
    $(FORCE_REBUILD):
    @echo rebuilding...
    install: $(DESTDIR)/$(CRACKLIB_TARGET)
    rebuild:
    $(MAKE) $(MOREMAKEFLAGS) "FORCE_REBUILD=REBUILD"
    clean:
    $(RM) -f $(CRACKLIB_TARGET)
    $(RM) -f $(CRACKLIB_OBJS)
    $(RM) -f #*
    $(RM) -f *~
    now run gmake
    and gmake install
    edit /etc/pam.conf as follows
    95 #
    96 other password required pam_dhkeys.so.1
    97 other password requisite pam_authtok_get.so.1
    98 other password requisite pam_cracklib.so
    99 other password requisite pam_authtok_check.so.1
    100 other password required pam_authtok_store.so.1
    101 #
    102 # Support for Kerberos V5 authentication and example configurations can
    103 # be found in the pam_krb5(5) man page under the "EXAMPLES" section.
    104 #
    this is adding line 98 and save the file
    thats it
    regards peter

  • How do you mark a section from the timeline to send to Compressor 4 using Final Cut Pro X?

    I am trying to send just a certain piece from the Timeline to Compressor 4 using Final Cut Pro X and I can't figure it out. Please help!

    jakelovesanna wrote:
    The video itself is intirely 5 minutes, but the timeline goes to 24 hrs.
    24 hours?
    If you select the timeline and press Shift+Z do you see a lot of black space in the timeline? If so, you may have a huge gap clip (although I fail to understand how you achieved it). Click on it and if it can be selected, delete it with the Backspace Key (next to the = key).
    Then press Shift+Z again.
    If I've got this wrong, can you post a screen grab of your timeline?
    Andy

  • How do you crop blank sections of tracks?

    ...meaning empty sections of tracks at beginning and end, before the regions start and after they end in a GB project. (I already know you can make a selection with the Cycle Button to export.)

    If you want to get rid of whole parts of your song, there's several ways: Select all regions (cmd-A) and push them to the left (lock the automation curves if you have any). Or use the Arrange Track: mark the empty area as a region and delete it.

  • How do you create a section in labview using the configurat​ion file vis

    I'm trying to create a new section in Labview. All i see is the possibilties to read sections and keys, write keys, delete sections. Is there a way to write a new section in Labview.
    Thanks,
    Brandon
    Solved!
    Go to Solution.

    When you write to a key, you have to supply a section.  If the section isn't there, then it will be created.  Basically, you can't have a section without any keys.
    There are only two ways to tell somebody thanks: Kudos and Marked Solutions
    Unofficial Forum Rules and Guidelines

  • How do you force a section to begin on an odd-numbered page?

    I would like to be able to format sections in my Pages document to automatically begin on odd-numbered pages.
    In this manner, each chapter of my document will begin on a right-hand page regardless of where the previous chapter ended.
    Yes, this has the possibility of having blank pages in the final document, but this is a common practice in many publications.
    Yes, I can insert additional page breaks to get the sections to begin on odd-numbered pages, but this technique requires that the document be checked and double-checked to be certain that each section begins on an odd-numbered page. Further, each time any editing is done, the document must be rechecked to assure that the correct number of page breaks have been inserted between each section.
    The goal is to have this done automatically so that each section begins on an odd-numbered page without any further intervention on my part.
    I'm trying to make the shift from MicroSucks Word to Pages and am struggling with some of the finer details. I have used MicroSucks Office products since version 1 and know them inside and out. As a dedicated Mac user, I figured it was about time I made the switch.

    From the Layout inspector, at the bottom of the Section tab choose
    Section starts on: Right Page

  • On iMovie how can you mute a section of the sound track so you can hear the audio from the video clip?

    .

    Hey,
    If you double-click on the soundtrack you can open it up in the inspector tab and lower the soundtrack so that you can hear the audio from the video clip.
    A great resource for finding answers to questions like this is http://www.imovietutorialhelp.com
    You can ask questions just like these and they will be answered for you. If you need a tutorial video made or anything like that, you can go there as well and ask for a video to made as well. Check it out.
    If you still have questions on how to do this, they can help you for sure.
    I may receive some form of compensation, financial or otherwise, from my video or link.

  • How do you render specific parts of timeline without rendering the whole sequence? cs5

    New to CS5 Premiere pro, im trying to render certain sections of my timeline without rendering the whole timeline, in Avid you would just mark in and mark out the area you wanted to render, is there something similar to that or do you always have to render the whole timeline?

    Place Work Area Bar over the part of the timeline you want to render and then hit Sequence/Render Whole Work Area.
    If you mean Export also place work area bar over section and make sure in the export settings, Source Range (bottom left) is set to Work Area.

Maybe you are looking for

  • Corruption in PreparedStatement

    We are finding that doing an UPDATE using a PreparedStatement was leading to corruption of some character in the updated data. Re-arranging the the elements in the statement to place the TIMESTAMP first fixed the corruption. Is there an issue or limi

  • Form is not submitting through Oracle Application Server

    Hi Experts, We are creating one Java Application and deploy this java application on Oracle Application Server Enterprise Manager release 2 through War File. Now, There one Form on submitting calls procedure with some 42 parameter in that 20 are Orac

  • Oracle portal page error.

    Hi! When I click on a tab in Oracle Portal page i got the following error: - ORA-01403: no data found ORA-20101: ORA-06512: at "DEV_PORTAL.WWPOB_API_PAGE", line 5247 ORA-01403: no data found ORA-01403: no data found. In WLS_PORTAL.log fileL do not ap

  • #2 screen or monitor won't come into focus!

    #2 screen or monitor won't come into focus! Have gone from 1:3, 1:2, 1:1....none will come into focus. Lightroom 5 on Mac Pro. 24 gigs of ram. Use it as I have on LR#2,3,and 4 to view faces up close (on same monitor) while viewing full image in main

  • Canon 7D Workflow

    Hi Everyone, I've recently downloaded the EOS plug in for FCP 7 and would like to know the following: What ProRes setting will I use on the 'log and transfer' window? What will I need to set the 'Easy Set Up' window to? Anything further would be help