Documentation for: vprint.r

Usage document for %vprint.r

1. Introduction to verbose logging control

This library script is for inclusion in other programs and allows sophisticated logging and program debugging through use of a virtual console concept.

Please note. This document is a work in progress. There are advanced features that need usage examples. This is posted early to make REBOL users aware of this powerful logging utility. 06-May-2007

2. vprint At a Glance

 >> von/tags [one]
 == none
 >> vprint/tags "This gets displayed, the tagging symbol matches" [one]
 This gets displayed, the tagging symbol matches
 == none
 >> vprint/tags "This isn't displayed, the tagging does not match current logging tag" [two]
 == none
 

The v in vprint, may be thought of as both verbose and virtual.

3. Using %vprint.r

Including these tools is simple. Just DO it.

 >>do %vprint.r
 

or to execute this right out of the rebol.org library

 >>do http://www.rebol.org/cgi-bin/cgiwrap/rebol/download-a-script.r?script-name=vprint.r
 

3.1. Utility word list

 >> help vprint
 USAGE:
     VPRINT data /in /out /error /always /tags ftags

 DESCRIPTION:
      verbose print
      VPRINT is a function value.

 ARGUMENTS:
      data -- (Type: any)

 REFINEMENTS:
      /in -- indents after printing
      /out -- un indents before printing. Use none so that nothing is printed
      /error -- like always, but adds stack trace
      /always -- always print, even if verbose is off
      /tags
          ftags -- only effective if one of the specified tags exist in vtags (Type: any)
 

4. Some advanced features

This section will be updated. Two quick notes.

• Setting lib-vprint-ctx/vconsole: to a block!, will log output to the block
• Setting lib-vprint-ctx/vlogfile: to a file! will log output to the file.

5. Credits

• The rebol.org Library Team
• Usage document by Brian Tiffin, Library Team Apprentice, Last updated: 6-May-2007