% File: ufthesis.ins % Copyright Ron Smith 1998-2002 % email ufthesis@ufthesis.com % URL: www.ufthesis.ece.ufl.edu % % This program may be distributed and/or modified under the % conditions of the LaTeX Project Public License, either version 1.2 % of this license or (at your option) any later version. % The latest version of this license is in % http://www.latex-project.org/lppl.txt % and version 1.2 or later is part of all distributions of LaTeX % version 1999/12/01 or later. % % This program consists of the files listed in manifest.txt % % % Installation file for the ufthesis class % % % To extract the ufthesis class file you need: % % ufthesis.ins (this file) % ufthesis.dtx % docstrip.tex (part of the standard LaTeX2e distribution) % % Please note that docstrip version 2.4 or higher is required. % % % INSTRUCTIONS % % 1) (Mandatory) To extract all of the files contained in the ufthesis % documentclass, use the following command: % latex ufthesis.ins % % 2) (Mandatory) To produce a short version of the documentation, which % explains how to use the ufthesis documentclass, use the following % commands: % latex shortdoc.drv % latex shortdoc.drv % latex shortdoc.drv % % 3) (Optional) To produce a long version of the documentation, which % includes the source coding of the ufthesis.cls file, use the % following commands: % latex fulldoc.drv % makeindex -s gind.ist fulldoc.idx % makeindex -s gglo.ist -o fulldoc.gls fulldoc.glo % latex fulldoc.drv % latex fulldoc.drv % makeindex -s gind.ist fulldoc.idx % makeindex -s gglo.ist -o fulldoc.gls fulldoc.glo % latex fulldoc.drv % latex fulldoc.drv % % % 4) (Optional) To compile the ufsample thesis, read the short documentation % obtained in step #2 and then use the following commands: % latex ufsample % makeindex -s ufnpage.ist keylist % makeindex -s ufpage.ist mathlist % latex ufsample % latex ufsample % makeindex -s ufnpage.ist keylist % makeindex -s ufpage.ist mathlist % latex ufsample % latex ufsample % % 5) To finish installation of the ufthesis documentclass you must place % several files where your TeX system can locate them. If you don't % know how to do this, ask your SysOp or local TeX guru. It may be % as simple as setting some environment variables that tell your % system where to look for personal LaTeX files. % % a) Mandatory: Place the ufthesis.cls file where LaTeX searches for % files. % % b) Optional: If you want to typeset your indices similar to the % table of contents, place the following files where % MakeIndex searches for its files: % % ufpage.ist % ufnpage.ist % % c) Optional: If you are using BibTeX (you should), I've included two % bibliography style files that are similar to those used % by the IEEE. (Thesis style files have NOT been approved % by the Editorial Office.) The references are listed in % the order of citation using either full names or initials % and surname. % % Place the following files where BibTeX searches % for its files: % % uffull.bst % ufinit.bst % % % --------------- start of docstrip commands ------------------ % \input docstrip \keepsilent \preamble Copyright Ron Smith 1998-2002 email ufthesis@ufthesis.com URL: www.ufthesis.ece.ufl.edu This program may be distributed and/or modified under the conditions of the LaTeX Project Public License, either version 1.2 of this license or (at your option) any later version. The latest version of this license is in http://www.latex-project.org/lppl.txt and version 1.2 or later is part of all distributions of LaTeX version 1999/12/01 or later. This program consists of the files listed in manifest.txt \endpreamble \declarepreamble\ufnatbib IMPORTANT NOTICE Use this file if you intend to use the "natbib" package with the ufthesis document class. The natbib package modifies the coding to the Bibliography in a way that is not compliant with the UF Editorial Office guidelines. INTRUCTIONS FOR USE: 1) Rename the "ufnatbib.cfg" file to "natbib.cfg" 2) Place the natbib.cfg file in the directory where your thesis files reside. (As usual, I assume that this is the directory from which the LaTeX commands are issued.) When the natbib package is loaded during LaTeX compilation, the commands contained in natbib.cfg (this file) will be read in to redefine the appropriate commands. It is hoped that the following commands make the natbib package compliant with the UF Editorial Office guidelines. \endpreamble \declarepreamble\ufmod IMPORTANT NOTICE Some users may need to modify the internal commands of the ufthesis document class. A major reason for modification is customization of the signature page material. INTRUCTIONS FOR USE: 1) Rename the "ufmod.cfg" file to "ufthesis.cfg" 2) Place the ufthesis.cfg file in the directory where your thesis files reside. (As usual, I assume that this is the directory from which the LaTeX commands are issued.) The ufthesis document class will load the contents of the ufthesis.cfg file prior loading other LaTeX packages (except for those loaded internal to the document class). \endpreamble % Generate UF Thesis Class file %%%%%%%%%%%%% \askforoverwritefalse \generate{\usepostamble\empty \file{ufsample.tex}{\from{ufthesis.dtx}{example}} \file{ufpage.ist}{\from{ufthesis.dtx}{pnum}} \file{ufnpage.ist}{\from{ufthesis.dtx}{nopnum}}} \generate{\file{ufthesis.cls}{\from{ufthesis.dtx}{class}}} \generate{\usepreamble\empty\usepostamble\empty \file{shortdoc.drv}{\from{ufthesis.dtx}{truedriver,short}} \file{fulldoc.drv}{\from{ufthesis.dtx}{truedriver,full}} \file{ltxdoc.cfg}{\from{ufthesis.dtx}{config}} \file{ufinit.bst}{\from{ufthesis.dtx}{bstfile,initials}} \file{uffull.bst}{\from{ufthesis.dtx}{bstfile,fullname}} \file{ufalign.tex}{\from{ufthesis.dtx}{alignment}}} \generate{\usepreamble\ufnatbib \file{ufnatbib.cfg}{\from{ufthesis.dtx}{ufnatbib}}} \generate{\usepreamble\ufmod \file{ufmod.cfg}{\from{ufthesis.dtx}{ufmod}}} \ifToplevel{ \Msg{***********************************************************} \Msg{*} \Msg{* To finish the installation you have to move several files} \Msg{* into a directory searched by your TeX system.} \Msg{*} \Msg{* Please read the instructions in ufthesis.ins for hints} \Msg{* on where to place these files.} \Msg{*} \Msg{* Happy TeXing} \Msg{***********************************************************} } \endbatchfile