<?php $isip_window_title = "ISIP Homepage"; ?>
<?php include("/data/isip/www/templates/documentation/header/header.html"); ?>

<!--#set var="isip_page_title" value="capture_documentation" -->
<!--#include virtual="/hse/ies/templates/documentation/body/index_utility.html" -->
<?php include("/data/isip/www/templates/documentation/body/bar.html"); ?>

<a name="name">
<b>
name:
<a href="/perl/ifc_document.pl?file=$isip/util/devel/capture_documentation/capture_documentation.cc">capture_documentation.cc</a>
</b>

<br><br>

<a name="synopsis">
<b>synopsis:</b>
<br><br>

<blockquote>
<pre>
capture_documentation [-cgi] file1 file2 . . . .
capture_documentation [-reset] [URL]

</pre>
</blockquote>

<a name="quick_start">
<b>quick start:</b>
<br><br>

<blockquote>
<pre>
capture_documentation class/system/Integral/index.html
</pre>
</blockquote>

<a name="description"> 
<b>description:</b>
<br><br>

<ul>
  Utility to create web-browser readable IFC documentation that does
  not require Server Side Include (SSI) or CGI/BIN processing
</ul>
  
<a name="options">
<b>options:</b>
<br><br>

<ul>
  <li> -cgi: indicates whether or not we are changing file names in
       cgi/bin directory to remove "?" and "$" characters (default true)

  <li> -reset: indicates adding link in the root index.html file so
              it will automatically refresh to the documentation root.
              if URL is specified, it will jump to URL, instead of
              to the IFC documentation root (default false)
       <br><br>

</ul>       

<a name="operands">
<b>operands:</b>
<br><br>

<ul>
  <li> file(s): a standard Unix filename
</ul>

<a name="examples">
<b>examples:</b>
<br><br>

<ul>
  <li> This example shows how to download our documentation before release:
<pre>
echo Running wget to get files . . . .

wget -r -l50 -k -R.gz,.text -I/ -X/cgi/class,/cgi/include,/cgi/lib,/cgi/util,/search,/templates,/data,/rt,/software_checklist,/publications,/projects/jeida,/projects/nbest_pronunciations,/projects/nsf_itr,/projects/southern_accents,/projects/stock_market_simulation,/projects/switchboard,/projects/t1_interface,/projects/usfs,/projects/speech/experiments,/projects/speech/overview,/projects/speech/software,/projects/speech/support,/projects/speech/education/demos,/projects/speech/education/tutorials/asr_alphadigits,/projects/speech/education/tutorials/asr_swb,/projects/speech/education/tutorials/asr_tidigits,/projects/speech/education/toolkits,/projects/speech/education/publications,/projects/speech/education/web_stuff,/about_us,/administration,/audio,/conferences,/contact,/webapps,/whats_new -o wget.log http://www.isip.msstate.edu/projects/speech/education

echo Renaming cgi/bin files . . . .

cd www.isip.msstate.edu/cgi/bin
files=`ls`
capture_documentation -cgi $files
cd ../../..

echo Setting automatic link from root to documentation

cd www.isip.msstate.edu
capture_documentation -reset
cd ..

echo Changing references to ifc_document.pl parameters

files=`find www.isip.msstate.edu/ -name index.html -print`
capture_documentation $files

echo Building tar file . . . .

tar cf ifc_documentation.tar www.isip.msstate.edu

echo Tar file is ifc_documentation.tar

# echo Removing work files . . .
# rm wget.log
# rm -rf www.isip.msstate.edu

echo Job completed.
</pre>
</ul>
       
<a name="manuals">
<b>manuals:</b>
<br><br>

<ul>
  None.
</ul>
       
<a name="languages">
<b>languages:</b>
<br><br>

<ul>
  C++.
</ul>
       
<a name="variables">
<b>environment variables:</b>
<ul>
</ul>

<a name="files">
<b>files:</b>
<ul>
</ul>
       
<a name="see_also">
<b>see also:</b>
<br><br>

<ul>
</ul>

<a name="notes">
<b>notes:</b>
<br><br>

<ul>
  <li>
       This program requires GNU wget.  Wget builds a directory structure
       that mimics the SSI and CGI/BIN look and feel of the host server.
  <li>
       A shell script is also provided, <b><a href="/perl/ifc_document.pl?file=$isip/util/devel/capture_documentation/capture_documentation.sh">capture_documentation.sh</a></b>, which
       illustrates how to use <b>wget</b> and <b>find</b> to generate the files,
       and how to use <b>capture_documentation</b> to make modifications to
       those files and file names so they will work with web browsers.
</ul>

<!--#include virtual="/hse/ies/templates/documentation/footer/footer.html" -->
