Contents 
 Index 
 "Shell Script Reference" 
 < Previous 
 Next > 

56_nav_index.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_index.b,v 1.2 2002/12/24 21:36:23 gmaxe Exp $
00014 ////
00015 /** @file
00016  ** @brief Generates master index pages for all found mini-index files
00017  ** in the specified directory.
00018  **
00019  ** This makes some assumptions about where template files are found
00020  ** and where to process them.
00021  ** 
00022  ** The template file for an individual index page should be found in
00023  ** /rtfm/techpubs/web_files/voyant_master_index.html
00024  ** If this is not the directory or file you want to use, you can change it
00025  ** here in one place. Generally, all of my projects can get by with only
00026  ** one template file for the index.
00027  ** 
00028  ** This script copies the index file into all possible letters.
00029  ** Then it calls the voyant_indexer.pl with the same template file
00030  ** and the destination directory. The voyant_indexer.pl will overwrite
00031  ** any default index letter files with what it generates. However, you 
00032  ** need to have all default files for all letters in order for the 
00033  ** navigation in the index to work.
00034  ** 
00035  ** Depending upon the number of mini-index files that are in the 
00036  ** specified directory, voyant_indexer.pl can churn away for more than
00037  ** just a few minutes.
00038  ** 
00039  ** When finished, this script copies the generated index files into 
00040  ** the destination for publishing.
00041  **
00042  ** @ingroup tp_tools tp_shell
00043  **
00044  ** @author Glenn C. Maxey
00045  **/
00046 // //
00047 //// 2002 Created by Voyant Technologies, Inc., Westminster, Colorado, USA.
00048 ////
00049 //// Permission to use, copy, modify, and distribute this software and its 
00050 //// documentation under the terms of the GNU General Public License is hereby 
00051 //// granted. No representations are made about the suitability of this software 
00052 //// for any purpose. It is provided "as is" without express or implied warranty. 
00053 //// See the GNU General Public License (http://www.gnu.org/copyleft/gpl.html) 
00054 //// for more details.
00055 //// 
00056 //// Documents produced by this script are derivative works derived from the 
00057 //// input used in their production; they are not affected by this license.
00058 ////
00059 //// $Log: 56_nav_index.b,v $
00060 //// Revision 1.2  2002/12/24 21:36:23  gmaxe
00061 //// Commented version.
00062 ////
00063 ////
00064 /////////////////////////////////////////////////////////////////////////////////
00065 // assumes that you are in the <rtfm/>techpubs/<home> directory 
00066 // where this script resides
00067 echo "Entering 56_nav_index..."
00068 
00069 // Expect this to fail most of the time
00070 mkdir zdoc_merge/
00071 
00072 echo "Prepare by removing the old zdoc masters."
00073 rm zdoc_merge/m_idx_*.*
00074 
00075 echo "Default the master index files."
00076 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_a.html
00077 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_b.html
00078 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_c.html
00079 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_d.html
00080 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_e.html
00081 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_f.html
00082 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_g.html
00083 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_h.html
00084 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_i.html
00085 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_j.html
00086 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_k.html
00087 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_l.html
00088 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_m.html
00089 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_n.html
00090 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_o.html
00091 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_p.html
00092 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_q.html
00093 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_r.html
00094 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_s.html
00095 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_t.html
00096 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_u.html
00097 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_v.html
00098 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_w.html
00099 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_x.html
00100 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_y.html
00101 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_z.html
00102 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_0.html
00103 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_1.html
00104 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_2.html
00105 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_3.html
00106 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_4.html
00107 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_5.html
00108 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_6.html
00109 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_7.html
00110 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_8.html
00111 cp /rtfm/techpubs/web_files/voyant_master_index.html zdoc_merge/m_idx_9.html
00112 
00113 echo "Create master index files."
00114 /rtfm/techpubs/perl/voyant_indexer.pl zdoc_merge/ /rtfm/techpubs/web_files/voyant_master_index.html /rtfm/techpubs/perl/ignoreterms.cfg
00115 
00116 echo "cp zdoc_merge/m_idx_*.htm* doc_publish/"
00117 cp zdoc_merge/m_idx_*.htm* doc_publish/
00118 
00119 
00120 echo "Okay 56_nav_index.b  "
00121 exit 0
00122 


 "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