Contents 
 Index 
 "Shell Script Reference" 
 < Previous 
 Next > 

55_nav_gen.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: 55_nav_gen.b,v 1.2 2002/12/24 21:36:23 gmaxe Exp $
00014 ////
00015 /** @file
00016  ** @brief Creates the mini-TOC and mini-index navigation files for
00017  ** the specified project using information extracted from two input files.
00018  ** 
00019  ** @param nav_path The starting location to look for subdirectories.
00020  ** Generally, this is "doc_publish/". It was broken out of the full
00021  ** path, because the sim_name parameter was needed for other purposes. 
00022  ** 
00023  ** @param sim_name The simplified name of the destination project.
00024  ** This parameter is used to locate both the source HTML files 
00025  ** (as in <nav_path><sim_name> but also to name generated mini-index
00026  ** and mini-TOC files appropriately for the project.
00027  ** 
00028  ** @param master_nav The name of an master HTML file that has common HTML 
00029  ** fragments which are to be inserted in all generated HTML pages.
00030  ** 
00031  ** @param master_proj The name of the project_toc.txt file that defines
00032  ** all directories and their associated names, pdf files, and document numbers.
00033  ** 
00034  ** This calls the voyant_nav.pl perl program. It processes the files specified
00035  ** in the <nav_path><sim_name> directory. It requires the master_nav 
00036  ** file and the master_proj file.
00037  ** 
00038  ** The master_nav file is an HTML file that contain tags which are to be
00039  ** placed in every single HTML file in the directory. 
00040  ** 
00041  ** The voyant_nav.pl perl program generates a mini-index and mini-TOC file.
00042  ** When finished, this script needs to copy them to a known location for
00043  ** subsequent processing. It must name them uniquely for the project, which
00044  ** is why the <sim_name> is required to be broken out.
00045  **
00046  ** In addition, getting individual project directories updated with the
00047  ** latest CSS was error prone. This handles it while processing, so that
00048  ** it doesn't get forgotten.
00049  **
00050  ** @ingroup tp_tools tp_shell
00051  **
00052  ** @author Glenn C. Maxey
00053  **/
00054 // //
00055 //// 2002 Created by Voyant Technologies, Inc., Westminster, Colorado, USA.
00056 ////
00057 //// Permission to use, copy, modify, and distribute this software and its 
00058 //// documentation under the terms of the GNU General Public License is hereby 
00059 //// granted. No representations are made about the suitability of this software 
00060 //// for any purpose. It is provided "as is" without express or implied warranty. 
00061 //// See the GNU General Public License (http://www.gnu.org/copyleft/gpl.html) 
00062 //// for more details.
00063 //// 
00064 //// Documents produced by this script are derivative works derived from the 
00065 //// input used in their production; they are not affected by this license.
00066 ////
00067 //// $Log: 55_nav_gen.b,v $
00068 //// Revision 1.2  2002/12/24 21:36:23  gmaxe
00069 //// Commented version.
00070 ////
00071 ////
00072 /////////////////////////////////////////////////////////////////////////////////
00073 // assumes that you are in the <rtfm/>techpubs/<home> directory 
00074 // where this script resides
00075 
00076 set nav_path=$1
00077 set sim_name=$2
00078 set master_nav=$3
00079 set master_proj=$4
00080 // echo "Give all htm* files the same navigation bars, footers, etc."
00081 echo "Entering 55_nav_gen with ${nav_path} ${sim_name} ${master_nav} ${master_proj}..."
00082 
00083 /rtfm/techpubs/perl/voyant_nav.pl ${nav_path}${sim_name}/ ${master_nav} ${master_proj}
00084 set ret_val = $status
00085 if ($ret_val > 0) then
00086    echo "ERROR: voyant_nav.pl didn't build ${nav_path}${sim_name}."
00087    exit $ret_val
00088 endif
00089 
00090 
00091 cp ${nav_path}${sim_name}/_index_list zdoc_merge/index_${sim_name}
00092 set ret_val = $status
00093 if ($ret_val > 0) then
00094    echo "ERROR: Could not find index_${sim_name}."
00095    exit $ret_val
00096 endif
00097 
00098 cp ${nav_path}${sim_name}/tree.script zdoc_merge/tree_${sim_name}.script
00099 set ret_val = $status
00100 if ($ret_val > 0) then
00101    echo "ERROR: Could not find tree_${sim_name}."
00102    exit $ret_val
00103 endif
00104 
00105 echo "copy CSS into ${nav_path}${sim_name}" 
00106 cp /rtfm/techpubs/web_files/*.css ${nav_path}${sim_name}
00107 
00108 echo "Okay 55_nav_gen.b ${nav_path} ${sim_name} ${master_nav} "
00109 exit 0
00110 


 "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