Menu
▾
▴
[opengtoolkit-cvs] deab/user docs OGB Build File Dscr.htm,1.1,1.2 OGB Glossary.htm,1.1,1.2 OGB Pathroots Dscr.htm,1.1,1.2 OGB Revision File Dscr.htm,1.1,1.2 release-notes.html,1.6,1.7 userguide-introduction.html,1.5,1.6
|
From: Konstantin S. <ks...@us...> - 2004-12-09 04:14:25
|
Update of /cvsroot/opengtoolkit/deab/user docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv15331/user docs Modified Files: OGB Build File Dscr.htm OGB Glossary.htm OGB Pathroots Dscr.htm OGB Revision File Dscr.htm release-notes.html userguide-introduction.html Log Message: Index: release-notes.html =================================================================== RCS file: /cvsroot/opengtoolkit/deab/user docs/release-notes.html,v retrieving revision 1.6 retrieving revision 1.7 diff -C2 -d -r1.6 -r1.7 *** release-notes.html 8 Dec 2004 01:45:49 -0000 1.6 --- release-notes.html 9 Dec 2004 04:13:36 -0000 1.7 *************** *** 66,73 **** <li>randomly generate password at build-time for optimal security</li> <li>documentation</li> ! <li>store software product version and build number in a <a href="DEAB%20Glossary.htm#Revision_File">Revision File</a></li> ! <li>auto-increment the build number stored in the <a href="DEAB%20Glossary.htm#Revision_File">Revision File</a>, each time a build occurs </li> <li>write version and build number information as default value to a cluster control on a VI's Front Panel during the build, allowing programmatic access to version information in the built software product</li> ! <li>specify a <a href="DEAB%20Glossary.htm#Log_File">Log File</a> to store information on build stages completed, errors, warnings, and another information that can be useful to analyze build errors</li> <li>automatically include help file, shared library, and external subroutine dependency files in the target build</li> <li>disconnect type definitions and polymorphic VIs, and not include them into the target build</li> --- 66,73 ---- <li>randomly generate password at build-time for optimal security</li> <li>documentation</li> ! <li>store software product version and build number in a <a href="OGB%20Glossary.htm#Revision_File">Revision File</a></li> ! <li>auto-increment the build number stored in the <a href="OGB%20Glossary.htm#Revision_File">Revision File</a>, each time a build occurs </li> <li>write version and build number information as default value to a cluster control on a VI's Front Panel during the build, allowing programmatic access to version information in the built software product</li> ! <li>specify a <a href="OGB%20Glossary.htm#Log_File">Log File</a> to store information on build stages completed, errors, warnings, and another information that can be useful to analyze build errors</li> <li>automatically include help file, shared library, and external subroutine dependency files in the target build</li> <li>disconnect type definitions and polymorphic VIs, and not include them into the target build</li> Index: OGB Revision File Dscr.htm =================================================================== RCS file: /cvsroot/opengtoolkit/deab/user docs/OGB Revision File Dscr.htm,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** OGB Revision File Dscr.htm 6 Dec 2004 02:52:45 -0000 1.1 --- OGB Revision File Dscr.htm 9 Dec 2004 04:13:36 -0000 1.2 *************** *** 5,20 **** <meta name="GENERATOR" content="Microsoft FrontPage 4.0"> <meta name="ProgId" content="FrontPage.Editor.Document"> ! <title>DEAB Revision File Description</title> </head> <body style="font-family: Verdana; font-size: 10pt"> ! <p>DEAB Revision File Format <br> ! DEAB version 1.0.0<br> $Revision$<br> $Date$</p> ! <p>This document describes parameters of a DEAB Revision file.</p> <p> </p> ! <p>A Revision File is an optional file that DEAB can use to control build versions and save general information on the last build status. A Revision File can treat several Build Files. Information relating to each Build File is stored --- 5,20 ---- <meta name="GENERATOR" content="Microsoft FrontPage 4.0"> <meta name="ProgId" content="FrontPage.Editor.Document"> ! <title>OGB Revision File Description</title> </head> <body style="font-family: Verdana; font-size: 10pt"> ! <p>OGB Revision File Format <br> ! OGB version 1.0.0<br> $Revision$<br> $Date$</p> ! <p>This document describes parameters of an OpenG Builder (OGB) Revision File.</p> <p> </p> ! <p>A Revision File is an optional file that OGB can use to control build versions and save general information on the last build status. A Revision File can treat several Build Files. Information relating to each Build File is stored *************** *** 32,44 **** <p><b>Version</b> = version string</p> <p>The <i>Version</i> can accept an arbitrary string to identify a version of a ! target application. The <i>Version</i> is beyond of the DEAB ! control. However, DEAB can use a value of it to assign a version information to a specified control of a VI in a built application as a default value, so the application can obtain the <i>Version</i> string, <i><a href="#Build_Number">Build_Number</a></i> ! and <i><a href="#Log_File">Build_Date</a></i> at runtime (see <a href="DEAB%20Build%20File%20Dscr.htm" target="_blank">DEAB ! Build File Description</a>, <a href="DEAB%20Build%20File%20Dscr.htm#General: Version VI/Ctrl Name" target="_blank">Version Ctrl Name</a> topic for details).</p> ! <p>If the <i>Version</i> parameter is not specified in a Revision File, DEAB ! adds the parameter with a value of "0.0.0" and assumes the value as a current version of an application.<br> </p> --- 32,43 ---- <p><b>Version</b> = version string</p> <p>The <i>Version</i> can accept an arbitrary string to identify a version of a ! target application. The <i>Version</i> is beyond of the OGB control. However, ! OGB can use a value of it to assign a version information to a specified control of a VI in a built application as a default value, so the application can obtain the <i>Version</i> string, <i><a href="#Build_Number">Build_Number</a></i> ! and <i><a href="#Log_File">Build_Date</a></i> at runtime (see <a href="OGB%20Build%20File%20Dscr.htm" target="_blank">OGB ! Build File Description</a>, <a href="OGB%20Build%20File%20Dscr.htm#General: Version VI/Ctrl Name" target="_blank">Version Ctrl Name</a> topic for details).</p> ! <p>If the <i>Version</i> parameter is not specified in a Revision File, OGB adds the parameter with a value of "0.0.0" and assumes the value as a current version of an application.<br> </p> *************** *** 50,59 **** <p><b><a name="Build_Number" id="Version0"></a><strong>[<em>BuildFileName</em>]</strong></b></p> <p><b>Build_Number</b> = integer</p> ! <p>DEAB increments the <i>Build_Number</i> parameter at the beginning of each ! build. DEAB can use a value of it to assign a version information to a specified control of a VI in a built application as a default value, so the application can obtain the <i><a href="#Version">Version</a></i> string, <i>Build_Number</i> ! and <i><a href="#Log_File">Build_Date</a></i> at runtime (see <a href="DEAB%20Build%20File%20Dscr.htm" target="_blank">DEAB ! Build File Description</a>, <a href="DEAB%20Build%20File%20Dscr.htm#General: Version VI/Ctrl Name" target="_blank">Version Ctrl Name</a> topic for details).</p> <p> If the <i>Build_Number</i> is not specified in a Revision File, it assimes --- 49,58 ---- <p><b><a name="Build_Number" id="Version0"></a><strong>[<em>BuildFileName</em>]</strong></b></p> <p><b>Build_Number</b> = integer</p> ! <p>OGB increments the <i>Build_Number</i> parameter at the beginning of each ! build. OGB can use a value of it to assign a version information to a specified control of a VI in a built application as a default value, so the application can obtain the <i><a href="#Version">Version</a></i> string, <i>Build_Number</i> ! and <i><a href="#Log_File">Build_Date</a></i> at runtime (see <a href="OGB%20Build%20File%20Dscr.htm" target="_blank">OGB ! Build File Description</a>, <a href="OGB%20Build%20File%20Dscr.htm#General: Version VI/Ctrl Name" target="_blank">Version Ctrl Name</a> topic for details).</p> <p> If the <i>Build_Number</i> is not specified in a Revision File, it assimes *************** *** 63,72 **** <p><b><a name="Build_Date" id="Version1"></a><strong>[<em>BuildFileName</em>]</strong></b></p> <p><b>Build_Date</b> = date/time string</p> ! <p>DEAB assign a date/time string to the <i>Build_Date</i> parameter at the ! beginning of each build. DEAB can use a value of it to assign a version information to a specified control of a VI in a built application as a default value, so the application can obtain the <i><a href="#Version">Version</a></i> string, <i><a href="#Build_Number">Build_Number</a></i> ! and <i>Build_Date</i> at runtime (see <a href="DEAB%20Build%20File%20Dscr.htm" target="_blank">DEAB ! Build File Description</a>, <a href="DEAB%20Build%20File%20Dscr.htm#General: Version VI/Ctrl Name" target="_blank">Version Ctrl Name</a> topic for details).<br> </p> --- 62,71 ---- <p><b><a name="Build_Date" id="Version1"></a><strong>[<em>BuildFileName</em>]</strong></b></p> <p><b>Build_Date</b> = date/time string</p> ! <p>OGB assign a date/time string to the <i>Build_Date</i> parameter at the ! beginning of each build. OGB can use a value of it to assign a version information to a specified control of a VI in a built application as a default value, so the application can obtain the <i><a href="#Version">Version</a></i> string, <i><a href="#Build_Number">Build_Number</a></i> ! and <i>Build_Date</i> at runtime (see <a href="OGB%20Build%20File%20Dscr.htm" target="_blank">OGB ! Build File Description</a>, <a href="OGB%20Build%20File%20Dscr.htm#General: Version VI/Ctrl Name" target="_blank">Version Ctrl Name</a> topic for details).<br> </p> Index: OGB Pathroots Dscr.htm =================================================================== RCS file: /cvsroot/opengtoolkit/deab/user docs/OGB Pathroots Dscr.htm,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** OGB Pathroots Dscr.htm 6 Dec 2004 02:52:45 -0000 1.1 --- OGB Pathroots Dscr.htm 9 Dec 2004 04:13:36 -0000 1.2 *************** *** 4,8 **** <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> ! <title>DEAB Pathroots</title> </head> --- 4,8 ---- <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> ! <title>OGB Pathroots</title> </head> Index: OGB Build File Dscr.htm =================================================================== RCS file: /cvsroot/opengtoolkit/deab/user docs/OGB Build File Dscr.htm,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** OGB Build File Dscr.htm 6 Dec 2004 02:52:45 -0000 1.1 --- OGB Build File Dscr.htm 9 Dec 2004 04:13:36 -0000 1.2 *************** *** 5,18 **** <meta name="GENERATOR" content="Microsoft FrontPage 4.0"> <meta name="ProgId" content="FrontPage.Editor.Document"> ! <title>DEAB Build File Description</title> </head> <body style="font-family: Verdana; font-size: 10pt"> ! <p>DEAB Build File Format<br> ! DEAB Version 1.0.0<br> $Revision$<br> $Date$</p> ! <p>This document describes parameters of a .DEAB file.</p> <p><b>[General]</b><br> --- 5,18 ---- <meta name="GENERATOR" content="Microsoft FrontPage 4.0"> <meta name="ProgId" content="FrontPage.Editor.Document"> ! <title>OGB Build File Description</title> </head> <body style="font-family: Verdana; font-size: 10pt"> ! <p>OGB Build File Format<br> ! OGB Version 1.0.0<br> $Revision$<br> $Date$</p> ! <p>This document describes parameters of an OpenG Builder (OGB) Build File.</p> <p><b>[General]</b><br> *************** *** 83,88 **** <p><b>File Format Version</b> = x.y.z</p> <p><i>File Format Version</i> is optional. If it is not specified, it is assumed to be ! version 0.0.0. If <i>File Format Version</i> is greater than the current DEAB ! version, a warning will be generated.</p> <p><u>Example:</u></p> <p>File Format Version = 1.0.0 --- 83,87 ---- <p><b>File Format Version</b> = x.y.z</p> <p><i>File Format Version</i> is optional. If it is not specified, it is assumed to be ! version 0.0.0. If <i>File Format Version</i> is greater than the current OGB version, a warning will be generated.</p> <p><u>Example:</u></p> <p>File Format Version = 1.0.0 *************** *** 98,104 **** <p><b>Revision File</b> = "file path"</p> <p><i>Revision File</i> is optional parameter that specifies a Revision File to ! be used. For more information on a Revision File, see <a href="DEAB%20Glossary.htm" target="_blank"> DEAB ! Glossary</a> and <a href="DEAB%20Revision%20File%20Dscr.htm" target="_blank">DEAB ! Revision File Description</a>. A <i>Revision File</i> may be either an absolute path, or a path relative to the <i><a href="#General: Project Root"> Project Root</a></i>. If a specified <i>Revision --- 97,102 ---- <p><b>Revision File</b> = "file path"</p> <p><i>Revision File</i> is optional parameter that specifies a Revision File to ! be used. For more information on a Revision File, see <a href="OGB%20Glossary.htm" target="_blank">OGB ! Glossary</a> and <a href="OGB%20Revision%20File%20Dscr.htm" target="_blank">OGB Revision File Description</a>. A <i>Revision File</i> may be either an absolute path, or a path relative to the <i><a href="#General: Project Root"> Project Root</a></i>. If a specified <i>Revision *************** *** 120,124 **** <p><b>Project Root</b> = "dir path"</p> <p><i>Project Root</i> is optional. If it is not specified, it is assumed to be the ! current .deab file's parent directory.</p> <p><u>Examples:</u></p> <p>Project Root = ""<br> --- 118,122 ---- <p><b>Project Root</b> = "dir path"</p> <p><i>Project Root</i> is optional. If it is not specified, it is assumed to be the ! current build file's parent directory.</p> <p><u>Examples:</u></p> <p>Project Root = ""<br> *************** *** 232,237 **** <p><b><a name="General: Log Dir"></a>[General]</b></p> <p><b>Log Dir</b> = "dir path"</p> ! <p><i>Log Dir</i> is an optional parameter that specifies a directory where a log file is written. If it is not specified, it is assumed to be the .deab file's parent directory. ! <i> Log Dir</i> may be either an absolute path or a path relative to the .deab file's parent directory. </p> <p> --- 230,236 ---- <p><b><a name="General: Log Dir"></a>[General]</b></p> <p><b>Log Dir</b> = "dir path"</p> ! <p><i>Log Dir</i> is an optional parameter that specifies a directory where a log file is written. If it is not specified, it is assumed to be the ! build file's parent directory. ! <i> Log Dir</i> may be either an absolute path or a path relative to the build file's parent directory. </p> <p> *************** *** 240,244 **** <p><b><a name="General: Log File"></a>[General]</b></p> <p><b>Log File</b> = "file path/name"</p> ! <p><i>Log File</i> is an optional parameter that specifies a log file. If it is not specified, it is assumed to be a file with name of the .deab file and '.log' extension, located in <i><a href="#General: Log Dir">Log Dir</a></i> directory. <i> Log File</i> may be either an absolute path or a path relative to <i> Log Dir</i> directory. If it's an absolute path, it overrides <i> Log Dir</i>. --- 239,244 ---- <p><b><a name="General: Log File"></a>[General]</b></p> <p><b>Log File</b> = "file path/name"</p> ! <p><i>Log File</i> is an optional parameter that specifies a log file. If it is not specified, it is assumed to be a file with name of the ! build file and '.log' extension, located in <i><a href="#General: Log Dir">Log Dir</a></i> directory. <i> Log File</i> may be either an absolute path or a path relative to <i> Log Dir</i> directory. If it's an absolute path, it overrides <i> Log Dir</i>. *************** *** 307,315 **** <b>External Subr Dir</b> = "dir path"</p> <p><i>Help File Dir</i>, <i> Shared Lib Dir</i> and <i> External Subr Dir</i> are optional. Any of them ! may be either an absolute path or a path relative to <i><a href="#General: Build Root"> Build Root</a></i>. By default (if a path is empty), the paths ! are assumed to be the following paths respectively:<br> ! <Build Root>\Help<br> ! <Build Root>\Rsrc<br> ! <Build Root>\Rsrc </p> <p> --- 307,313 ---- <b>External Subr Dir</b> = "dir path"</p> <p><i>Help File Dir</i>, <i> Shared Lib Dir</i> and <i> External Subr Dir</i> are optional. Any of them ! may be either an absolute path or a path relative to <i><a href="#General: Build Root"> Build Root</a></i>. By default (if a path is ! empty or missed), the paths ! are assumed to be the <i>Build Root</i>. </p> <p> *************** *** 334,345 **** Level VIs]</a></i> or <i><a href="#Dynamic VIs">[Dynamic VIs]</a></i> section. The control must have a type either the same as or compatible with <b><font size="1">Version Info ! Cluster__deab_api.ctl</font></b> type definition (it can be found on DEAB's Controls Palette).</p> ! <p>DEAB takes the version information from a <a href="#General: Revision File"><i>Revision File</i></a> and assigns it to the specified control as default value. This way, a built application can obtain version information such as a version string, a build number and build date/time at runtime.</p> ! <p>If either of these parameters is empty string (or missed), the DEAB does not ! save version information. If either of names is wrong, DEAB generates a non-fatal error and save the information on it to a <i><a href="#General: Log File">Log File</a></i>.</p> --- 332,343 ---- Level VIs]</a></i> or <i><a href="#Dynamic VIs">[Dynamic VIs]</a></i> section. The control must have a type either the same as or compatible with <b><font size="1">Version Info ! Cluster__ogb_api.ctl</font></b> type definition (it can be found on OGB's Controls Palette).</p> ! <p>OGB takes the version information from a <a href="#General: Revision File"><i>Revision File</i></a> and assigns it to the specified control as default value. This way, a built application can obtain version information such as a version string, a build number and build date/time at runtime.</p> ! <p>If either of these parameters is empty string (or missed), the OGB does not ! save version information. If either of names is wrong, OGB generates a non-fatal error and save the information on it to a <i><a href="#General: Log File">Log File</a></i>.</p> *************** *** 353,357 **** <p><b><a name="General: RemovePolyVIsAndTypedefs"></a>[General]</b></p> <p><b>RemovePolyVIsAndTypedefs</b> = True/False</p> ! <p>The <i>RemovePolyVIsAndTypedefs</i> is optional. If it is TRUE, DEAB will disconnect type definitions and polymorphic VIs, and not include them into the target build. A disconnected type definition instance will look the same, but --- 351,355 ---- <p><b><a name="General: RemovePolyVIsAndTypedefs"></a>[General]</b></p> <p><b>RemovePolyVIsAndTypedefs</b> = True/False</p> ! <p>The <i>RemovePolyVIsAndTypedefs</i> is optional. If it is TRUE, OGB will disconnect type definitions and polymorphic VIs, and not include them into the target build. A disconnected type definition instance will look the same, but *************** *** 374,378 **** <p> A Pre-build VI takes parameters to be used to perform building; herewith, all paths are absolute. A Post-build VI takes, in addition, actual parameters used during the build. </p> ! <p> Use <b><font size="1">Pre-Post Build VI Template__deab_api.vit</font></b> as a template to make a custom pre/post-build VI. </p> --- 372,376 ---- <p> A Pre-build VI takes parameters to be used to perform building; herewith, all paths are absolute. A Post-build VI takes, in addition, actual parameters used during the build. </p> ! <p> Use <b><font size="1">Pre-Post Build VI Template__ogb_api.vit</font></b> as a template to make a custom pre/post-build VI. </p> *************** *** 392,401 **** omitted, it assumes to be zero. </p> ! <p>DEAB calls Call-Back VIs for each VI of a build hierarchy after a VI tolerated all the transformations required and immediately before the VI is saved to its target location. A Call-Back VI takes a VI reference to the target VI, build parameters specific for the VI and general build parameters. </p> ! <p>Use <b><font size="1">Call-Back VI Template__deab_api.vit </font></b>as a template to make a custom Call-Back VI.<br> </p> --- 390,399 ---- omitted, it assumes to be zero. </p> ! <p>OGB calls Call-Back VIs for each VI of a build hierarchy after a VI tolerated all the transformations required and immediately before the VI is saved to its target location. A Call-Back VI takes a VI reference to the target VI, build parameters specific for the VI and general build parameters. </p> ! <p>Use <b><font size="1">Call-Back VI Template__ogb_api.vit </font></b>as a template to make a custom Call-Back VI.<br> </p> *************** *** 413,417 **** (by default), a <i><a href="#General: Call-Back VI">Call-Back VI</a></i> is not allowed to have VIs in its hierarchy that are also in a currently built ! hierarchy. In this case, DEAB will terminate with an error if a VI belongs to the both hierarchies. </p> --- 411,415 ---- (by default), a <i><a href="#General: Call-Back VI">Call-Back VI</a></i> is not allowed to have VIs in its hierarchy that are also in a currently built ! hierarchy. In this case, OGB will terminate with an error if a VI belongs to the both hierarchies. </p> *************** *** 512,516 **** <p> <i><b>Apply New Password</b></i> is optional parameter that may be used to apply a password string to all VIs of the destination. If the parameter is missed or a ! value of it is an empty string, DEAB uses a value of the <i><a href="#General: Apply New Password">Apply New Password</a> </i>parameter in [General] section as a default value. If a resulting password is an empty string, no password will be applied to VIs of the --- 510,514 ---- <p> <i><b>Apply New Password</b></i> is optional parameter that may be used to apply a password string to all VIs of the destination. If the parameter is missed or a ! value of it is an empty string, OGB uses a value of the <i><a href="#General: Apply New Password">Apply New Password</a> </i>parameter in [General] section as a default value. If a resulting password is an empty string, no password will be applied to VIs of the *************** *** 523,527 **** default <i><a href="#General: Namespace">Namespace</a></i>, specified in [General] section, for VIs of the destination. If the parameter is missed or a ! value of it is an empty string, DEAB uses a default namespace. A special case is a use of <random:N> keyword to generate a random namespace and <none> keyword to discard a namespace. <a href="#KWD: none & pwd">Click --- 521,525 ---- default <i><a href="#General: Namespace">Namespace</a></i>, specified in [General] section, for VIs of the destination. If the parameter is missed or a ! value of it is an empty string, OGB uses a default namespace. A special case is a use of <random:N> keyword to generate a random namespace and <none> keyword to discard a namespace. <a href="#KWD: none & pwd">Click *************** *** 582,586 **** <i> TargetDir</i>.</p> <p><i><b>FollowVIDirHierarchy</b></i> is optional. If there are VIs, destination directories of which are beneath ! <i> TargetDir</i>, DEAB looks for the specified <i> SourceFiles</i> in the VIs' source directories and copies them to the appropriate positions beneath <i> TargetDir</i>. I.e., if a source VI has a support file in its parent directory, it will also have the support file in its new (destination) parent directory. Note that only name of a <i> SupportFile</i> is used in this mode, any path is ignored; however, a use of wildcards is still possible.</p> --- 580,584 ---- <i> TargetDir</i>.</p> <p><i><b>FollowVIDirHierarchy</b></i> is optional. If there are VIs, destination directories of which are beneath ! <i> TargetDir</i>, OGB looks for the specified <i> SourceFiles</i> in the VIs' source directories and copies them to the appropriate positions beneath <i> TargetDir</i>. I.e., if a source VI has a support file in its parent directory, it will also have the support file in its new (destination) parent directory. Note that only name of a <i> SupportFile</i> is used in this mode, any path is ignored; however, a use of wildcards is still possible.</p> *************** *** 616,623 **** <p><a name="KWD: none & pwd"></a>Keywords applicable to <i><b>Namespace</b></i> and <i><b>Apply New Password</b></i> parameters</p> ! <p><random:N> keyword forces DEAB to generate a random string of length N, where N is a positive integer. If N is less than or equal to zero, or it is omitted, it assumes the default value of 32. A random string may contain digits (0..9), upper-case letters (A..Z) and lower-case letters (a..z).</p> ! <p><none> keyword forces DEAB to generate empty string. A use of this keyword is useful in <i><a href="#Destination">[Destination N]</a></i> section to discard a default password and/or a default namespace (<i><a href="#General: Apply New Password">Apply --- 614,621 ---- <p><a name="KWD: none & pwd"></a>Keywords applicable to <i><b>Namespace</b></i> and <i><b>Apply New Password</b></i> parameters</p> ! <p><random:N> keyword forces OGB to generate a random string of length N, where N is a positive integer. If N is less than or equal to zero, or it is omitted, it assumes the default value of 32. A random string may contain digits (0..9), upper-case letters (A..Z) and lower-case letters (a..z).</p> ! <p><none> keyword forces OGB to generate empty string. A use of this keyword is useful in <i><a href="#Destination">[Destination N]</a></i> section to discard a default password and/or a default namespace (<i><a href="#General: Apply New Password">Apply Index: userguide-introduction.html =================================================================== RCS file: /cvsroot/opengtoolkit/deab/user docs/userguide-introduction.html,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** userguide-introduction.html 8 Dec 2004 01:45:49 -0000 1.5 --- userguide-introduction.html 9 Dec 2004 04:13:36 -0000 1.6 *************** *** 66,73 **** <li>well-documented programattic API, allowing custom 3rd party tools and GUIs</li> <li>well-documented plain-text INI file format used for build file and other files</li> ! <li>store software product version and build number in a <a href="DEAB%20Glossary.htm#Revision_File">Revision File</a></li> ! <li>auto-increment the build number stored in the <a href="DEAB%20Glossary.htm#Revision_File">Revision File</a>, each time a build occurs </li> <li>write version and build number information as default value to a cluster control on a VI's Front Panel during the build, allowing programmatic access to version information in the built software product</li> ! <li>specify a <a href="DEAB%20Glossary.htm#Log_File">Log File</a> to store information on build stages completed, errors, warnings, and another information that can be useful to analyze build errors</li> <li>automatically include help file, shared library, and external subroutine dependency files in the target build</li> <li>disconnect type definitions and polymorphic VIs, and not include them into the target build</li> --- 66,73 ---- <li>well-documented programattic API, allowing custom 3rd party tools and GUIs</li> <li>well-documented plain-text INI file format used for build file and other files</li> ! <li>store software product version and build number in a <a href="OGB%20Glossary.htm#Revision_File">Revision File</a></li> ! <li>auto-increment the build number stored in the <a href="OGB%20Glossary.htm#Revision_File">Revision File</a>, each time a build occurs </li> <li>write version and build number information as default value to a cluster control on a VI's Front Panel during the build, allowing programmatic access to version information in the built software product</li> ! <li>specify a <a href="OGB%20Glossary.htm#Log_File">Log File</a> to store information on build stages completed, errors, warnings, and another information that can be useful to analyze build errors</li> <li>automatically include help file, shared library, and external subroutine dependency files in the target build</li> <li>disconnect type definitions and polymorphic VIs, and not include them into the target build</li> Index: OGB Glossary.htm =================================================================== RCS file: /cvsroot/opengtoolkit/deab/user docs/OGB Glossary.htm,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** OGB Glossary.htm 6 Dec 2004 02:52:45 -0000 1.1 --- OGB Glossary.htm 9 Dec 2004 04:13:36 -0000 1.2 *************** *** 4,8 **** <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> ! <title>DEAB Glossary</title> </head> --- 4,8 ---- <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> ! <title>OGB Glossary</title> </head> *************** *** 23,26 **** --- 23,27 ---- <li><a href="#Name_Mangle">Name Mangle</a></li> <li><a href="#Namespace">Namespace</a></li> + <li><a href="#OGB">OGB</a></li> <li><a href="#Project_Root">Project Root</a></li> <li><a href="#Resource">Resource File</a></li> *************** *** 53,60 **** </p> <p><a name="Icon_File" id="Icon_File"></a><b>Icon File</b> - In windows an icon file contains several icon images. Icon files in windows have an *.ico file extension. </p> ! <p><a name="Log_Dir" id="Log_Dir"></a><b>Log Dir</b> - A directory, to which ! DEAB writes a log file.</p> ! <p><a name="Log_File" id="Log_File"></a><b>Log File</b> - A file, to which DEAB ! writes information on build stages completed, error description, warnings and some another information that can be useful to analyze errors and warnings.</p> <p><a name="Log_File_Suffix" id="Log_File_Suffix"></a><b>Log File Suffix</b> - --- 54,60 ---- </p> <p><a name="Icon_File" id="Icon_File"></a><b>Icon File</b> - In windows an icon file contains several icon images. Icon files in windows have an *.ico file extension. </p> ! <p><a name="Log_Dir" id="Log_Dir"></a><b>Log Dir</b> - A directory, to which OGB ! writes a log file.</p> ! <p><a name="Log_File" id="Log_File"></a><b>Log File</b> - A file, to which OGB writes information on build stages completed, error description, warnings and some another information that can be useful to analyze errors and warnings.</p> <p><a name="Log_File_Suffix" id="Log_File_Suffix"></a><b>Log File Suffix</b> - *************** *** 62,67 **** suffix pattern that will generate a unique suffix containing date/time of a build, so each build will write new log file.</p> ! <p><a name="Name_Mangle" id="Name_Mangle"></a><b>Name Mangle</b> - Name mangling is the process of renaming a file according to some convention. The DEAB uses the convention <em>OriginalFilePrefix</em>.vi --> <em>OriginalFilePrefix</em>__<em>NameSpace</em>.vi, where a double-underscore ("_") character seperates the original file name prefix and the namespace. This is done to create a unique <a href="#Namespace">namespace</a> for the application. </p> <p><a name="Namespace" id="Namespace"></a><b>Namespace</b> - In LabVIEW, no VIs in memory can share the same name. This is referred to as a global namespace. By <a href="#Name_Mangle">Name Mangling</a>, we can create unique namespaces for applications. This allows two built applications to be in memory, which share source VIs having the same name.</p> <p><a name="Project_Root" id="Project_Root"></a><b>Project Root</b> - The (configurable) path where the software product is located. Relative paths such as the <a href="#Source_Root">Source Root</a> and <a href="#Build_Root">Build Root</a> are specified relative to the Project Root.</p> <p><a name="Resource"></a><b>Resource File</b> - General term used to designate --- 62,69 ---- suffix pattern that will generate a unique suffix containing date/time of a build, so each build will write new log file.</p> ! <p><a name="Name_Mangle" id="Name_Mangle"></a><b>Name Mangle</b> - Name mangling is the process of renaming a file according to some convention. The ! OGB uses the convention <em>OriginalFilePrefix</em>.vi --> <em>OriginalFilePrefix</em>__<em>NameSpace</em>.vi, where a double-underscore ("_") character seperates the original file name prefix and the namespace. This is done to create a unique <a href="#Namespace">namespace</a> for the application. </p> <p><a name="Namespace" id="Namespace"></a><b>Namespace</b> - In LabVIEW, no VIs in memory can share the same name. This is referred to as a global namespace. By <a href="#Name_Mangle">Name Mangling</a>, we can create unique namespaces for applications. This allows two built applications to be in memory, which share source VIs having the same name.</p> + <p><b><a name="OGB"></a>OGB</b> - Abbreviation for OpenG Builder.</p> <p><a name="Project_Root" id="Project_Root"></a><b>Project Root</b> - The (configurable) path where the software product is located. Relative paths such as the <a href="#Source_Root">Source Root</a> and <a href="#Build_Root">Build Root</a> are specified relative to the Project Root.</p> <p><a name="Resource"></a><b>Resource File</b> - General term used to designate *************** *** 73,77 **** The build status information includes fatal and non-fatal errors status, and a name of <a href="#Log_File">Log File</a> written. A single revision file can be used to serve several ! Build Files independently. See <a href="DEAB%20Revision%20File%20Dscr.htm" target="_blank">DEAB Revision File Description</a> for more information. </p> <p><a name="Shared_Library" id="Shared_Library"></a><b>Shared Library</b> - <font size="-1">A file that contains routines that can be dynamically loaded and shared by applications. In LabVIEW, shared libraries are called using the Call Library Function primitive.</font> In Windows shared libary files are called Dynamic Linked Libraries and have a *.dll file extension. In Linux, shared libraries have a *.so file extension. In Mac OS 9 shared libraries have a .shlb file extension and in Mac OS X, they have a *.framework file extension. </p> --- 75,79 ---- The build status information includes fatal and non-fatal errors status, and a name of <a href="#Log_File">Log File</a> written. A single revision file can be used to serve several ! Build Files independently. See <a href="OGB%20Revision%20File%20Dscr.htm" target="_blank">OGB Revision File Description</a> for more information. </p> <p><a name="Shared_Library" id="Shared_Library"></a><b>Shared Library</b> - <font size="-1">A file that contains routines that can be dynamically loaded and shared by applications. In LabVIEW, shared libraries are called using the Call Library Function primitive.</font> In Windows shared libary files are called Dynamic Linked Libraries and have a *.dll file extension. In Linux, shared libraries have a *.so file extension. In Mac OS 9 shared libraries have a .shlb file extension and in Mac OS X, they have a *.framework file extension. </p> |
