Contents 
 Index 
 "Shell Script Reference" 
 < Previous 
 Next > 

55_nav_cp.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_cp.b,v 1.2 2002/12/24 21:36:22 gmaxe Exp $
00014 ////
00015 /** @file
00016  ** @brief Copies previously generated mini-index and mini-TOC files
00017  ** to a known location.
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 does NOT call the voyant_nav.pl perl program. However, it should
00035  ** use the same input parameters as 55_nav_gen.b so that 55_nav_cp.b
00036  ** can be interchanged with it in a calling 50_nav_update.b file.
00037  ** 
00038  ** This script needs to copy the previously generated mini files 
00039  ** to a known location for
00040  ** subsequent processing. It must name them uniquely for the project, which
00041  ** is why the <sim_name> is required to be broken out.
00042  **
00043  ** In addition, getting individual project directories updated with the
00044  ** latest CSS was error prone. This handles it while processing, so that
00045  ** it doesn't get forgotten.
00046  **
00047  **
00048  ** @ingroup tp_tools tp_shell
00049  **
00050  ** @author Glenn C. Maxey
00051  **/
00052 // //
00053 //// 2002 Created by Voyant Technologies, Inc., Westminster, Colorado, USA.
00054 ////
00055 //// Permission to use, copy, modify, and distribute this software and its 
00056 //// documentation under the terms of the GNU General Public License is hereby 
00057 //// granted. No representations are made about the suitability of this software 
00058 //// for any purpose. It is provided "as is" without express or implied warranty. 
00059 //// See the GNU General Public License (http://www.gnu.org/copyleft/gpl.html) 
00060 //// for more details.
00061 //// 
00062 //// Documents produced by this script are derivative works derived from the 
00063 //// input used in their production; they are not affected by this license.
00064 ////
00065 //// $Log: 55_nav_cp.b,v $
00066 //// Revision 1.2  2002/12/24 21:36:22  gmaxe
00067 //// Commented version.
00068 ////
00069 ////
00070 /////////////////////////////////////////////////////////////////////////////////
00071 // assumes that you are in the <rtfm/>techpubs/<home> directory 
00072 // where this script resides
00073 
00074 set nav_path=$1
00075 set sim_name=$2
00076 set master_nav=$3
00077 echo "Entering 55_nav_cp with ${nav_path} ${sim_name} ${master_nav}..."
00078 
00079 // echo "Give all htm* files the same navigation bars, footers, etc."
00080 
00081 // The voyant_nav was already run.
00082 // /rtfm/techpubs/perl/voyant_nav.pl ${nav_path}${sim_name}/ ${master_nav}
00083 // set ret_val = $status
00084 // if ($ret_val > 0) then
00085 //    echo "ERROR: voyant_nav.pl didn't build ${nav_path}${sim_name}."
00086 //    exit $ret_val
00087 // endif
00088 cp ${nav_path}${sim_name}/_index_list zdoc_merge/index_${sim_name}
00089 set ret_val = $status
00090 if ($ret_val > 0) then
00091    echo "ERROR: Could not find index_${sim_name}."
00092    exit $ret_val
00093 endif
00094 
00095 cp ${nav_path}${sim_name}/tree.script zdoc_merge/tree_${sim_name}.script
00096 set ret_val = $status
00097 if ($ret_val > 0) then
00098    echo "ERROR: Could not find tree_${sim_name}."
00099    exit $ret_val
00100 endif
00101 
00102 
00103 echo "copy CSS into ${nav_path}${sim_name}" 
00104 cp /rtfm/techpubs/web_files/*.css ${nav_path}${sim_name}
00105 
00106 echo "Okay 55_nav_cp.b ${nav_path} ${sim_name} ${master_nav} "
00107 exit 0
00108 


 "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