Page tree
Skip to end of metadata
Go to start of metadata

Purpose

The GlobalIncludes technique is a means of building a consistent, consolidated description of the symbols declared in the #include files of an ASP site.  This description is produced by analyzing the ASP site VBI files and saved as an IDF-like XML document.  If desired, the XML file can be edited manually to fine tune type data and other information. The XML file is then loaded in subsequent translations of either single pages or groups of pages from the site.    

Usage

  1. Prepare solo page translations for the page files in the site.  The resulting VBI files will be inputs to the GlobalIncludes process.  Adding FixTypes adn pre-edits to assist with getting good translations is acceptable.  Making the ASP.NET projects generated for the solo pages is also a good best practice.  You should also make sure the set of solo page VBIs are from "good" pages that are truly active within the site.  Junk/old pages create "bad data" that can interfere with getting good translations.  
     
  2. Prepare a GlobalIncludes script (see below) that will direct the tool to perform the global analysis VBI files and IDFs.
     
  3. Run the GlobalIncludes script  to produce the GlobalIncludes report .
     
    This operation requires a special gmBasic extension (AspGlobalIncludes.dll)
    This operation runs on the VBI files produced by page translations.
    It produces an IDF for the #includes detected in processing the site folder. 

  4. Unbundle the GlobalIncludes report 
     
  5. Modify the translation script to load the GlobalIncludes report.  This is typically done by the following

    in the a GlobalSettings file 

    <Include filename="..\usr\GlobalIncludes.xml" />)

    then in the Tscript: 

    <LoadRuntime Dllname="AspGlobalIncludes.dll" />
    <Select GlobalSettings="GlobalSettings" />
    <Select UseUserControls="on" />



Sample
<gmBasic>
<!--
This script will build interface definitions for include files in an ASP site.
The interfaces are used to author interfaces to support cross-references 
and prevent ambiguities between the classes for your generated ASP.NET site.
The output of this script is a <Registry type="GlobalInclude"> report
The report will be found in  %BndPath%.
The report maybe inserted into your GlobalSettings script.
-->
   <Storage Action="Create" Identifier="%MigName%_GlobalIncludes" />
   <Select progress="3" />
   <Select Target="%UserFolder%" />
   <LoadRuntime Dllname="AspGlobalIncludes.dll" />
   <Output Status="New" Filename="%BndPath%" />
<!-- 
This GlobalIncludes tells the tool where to find VBI files for 
the translated ASP pages.
-->
   <GlobalIncludes site="%ProjFolder%\log" />
   <Storage Action="Close" />
</gmBasic>
  • No labels