Contents 
 Index 
 "Shell Script Reference" 
 < Previous 
 Next > 

56_nav_script.b

Go to the documentation of this file.
00001 // This file has been modified on-the-fly with an input filter
00002 // to change it from shell syntax to C++ strictly for the purposes
00003 // of faking out Doxygen. Modifications include:
00004 
00005 // - changing # comments to C++ comments.
00006 // - ...
00007 
00008 // If you see other strangeness in the HTML version of the script file,
00009 // it comes from getting it to look more C++ like.
00010 
00011 
00012 /////////////////////////////////////////////////////////////////////////////////
00013 //// $Id: 56_nav_script.b,v 1.2 2002/12/24 21:36:24 gmaxe Exp $
00014 ////
00015 /** @file
00016  ** @brief Generates a master TOC script file appropriate for all found
00017  ** mini-TOC files in the specified directory.
00018  ** 
00019  ** This script calls voyant_mt_app.pl (master tree application). This
00020  ** looks at all tree_<...>.script files in the specified project file.
00021  ** If a tree file doesn't exist, a warning is output.
00022  ** It creates a master tree script file that references the mini-TOC tree script
00023  ** files.
00024  ** 
00025  ** In addition, it creates master_tree script files for each of the
00026  ** mini-TOC files, whereby the paths to the individual topics are resolved
00027  ** for where they actually reside with respect to the top-level publication
00028  ** directory.
00029  ** 
00030  ** In other words, the mini-TOC tree files are intended to work from where
00031  ** they were generated. When plugged into a bigger system, the master tree
00032  ** navigation files typically reside at a lever higher.
00033  ** 
00034  ** This two-stage process has benefits, most of them along the lines of
00035  ** how a modular system can be generated from different TOC files. A given
00036  ** directory can be symbolically linked in several different places and
00037  ** be referenced in several different project files. As such, information
00038  ** can be re-used efficient with accurate master TOCs for the project.
00039  **
00040  ** @ingroup tp_tools tp_shell
00041  **
00042  ** @author Glenn C. Maxey
00043  **/
00044 // //
00045 //// 2002 Created by Voyant Technologies, Inc., Westminster, Colorado, USA.
00046 ////
00047 //// Permission to use, copy, modify, and distribute this software and its 
00048 //// documentation under the terms of the GNU General Public License is hereby 
00049 //// granted. No representations are made about the suitability of this software 
00050 //// for any purpose. It is provided "as is" without express or implied warranty. 
00051 //// See the GNU General Public License (http://www.gnu.org/copyleft/gpl.html) 
00052 //// for more details.
00053 //// 
00054 //// Documents produced by this script are derivative works derived from the 
00055 //// input used in their production; they are not affected by this license.
00056 ////
00057 //// $Log: 56_nav_script.b,v $
00058 //// Revision 1.2  2002/12/24 21:36:24  gmaxe
00059 //// Commented version.
00060 ////
00061 ////
00062 /////////////////////////////////////////////////////////////////////////////////
00063 // assumes that you are in the <rtfm/>techpubs/<home> directory 
00064 // where this script resides
00065 echo "Entering 56_nav_script..."
00066 
00067 // Expect this to fail most of the time
00068 mkdir zdoc_merge/
00069 
00070 echo "Prepare by removing the old zdoc masters."
00071 rm zdoc_merge/m_tree*.script
00072 
00073 echo "Create the master TOC script files."
00074 /rtfm/techpubs/perl/voyant_mt_app.pl zdoc_merge/ project_toc.txt
00075 set ret_val = $status
00076 if ($ret_val > 0) then
00077    echo "WARNING: Problems creating the master TOC."
00078 endif
00079 
00080 echo "rm doc_publish/m_tree*.script"
00081 rm doc_publish/m_tree*.script
00082 echo "cp zdoc_merge/m_tre*.script doc_publish/"
00083 cp zdoc_merge/m_tre*.script doc_publish/
00084 
00085 
00086 //####
00087 // Special case
00088 // Need to handle the special nested m_tree* scripts for vxworks.
00089 //####
00090 // cp doc_publish/book_vxworks/m_tree*.script doc_publish/
00091 
00092 
00093 echo "Okay 56_nav_script.b  "
00094 exit 0
00095 


 "Shell Script Reference" 
 < Previous 
 Next > 


Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003

TP Tools v2-00-0a

# tpt-script-hcr-02