doc 4

git-svn-id: svn://tug.org/texlive/trunk@80 c570f23f-e606-0410-a88d-b1316a301751
author: Karl Berry <karl@freefriends.org> 2006-01-09 00:44:40 +0000
committer: Karl Berry <karl@freefriends.org> 2006-01-09 00:44:40 +0000
commit: b4fc5f639874db951177ec539299d20908adb654 (patch)
tree: 52f08823ca58fffe3db6a9b075635038c567626c /Master/texmf-dist/doc/latex/sae
parent: dec3d98ebe442d7ea93efbaa8dd2e2be8149a467 (diff)
3 files changed, 133 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/sae/example.pdf b/Master/texmf-dist/doc/latex/sae/example.pdf
new file mode 100644
index 00000000000..44022074b5b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sae/example.pdf
diff --git a/Master/texmf-dist/doc/latex/sae/example.tex b/Master/texmf-dist/doc/latex/sae/example.tex
new file mode 100644
index 00000000000..59565aee619
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sae/example.tex
@@ -0,0 +1,72 @@
+\documentclass[letterpaper]{sae}
+\PaperTitle{Proposal for a \LaTeX\ document class for SAE Technical Papers}
+\AddAuthor{Axel Franke}{Lund Institute of Technology, Sweden}
+\PaperNumber{No number}
+\SAECopyright{1999}
+\begin{document}
+\maketitle
+\section{abstract}
+  This \LaTeX\ class provides correct formatting according to the requirements
+  for the publication of an SAE Technical Paper. It is supposed to be useful
+  for authors publishing simulation models and similar containing lots of
+  formulas. The style contains many features automating the formatting and
+  thus, making it easier for the author to concentrate on contents. 
+
+\section{Introduction}
+This is a Level 1 heading, created with the command
+\begin{verbatim}
+\section{Introduction}
+\end{verbatim}
+As can be seen, the correct format (bold face and capitalized) is done by the
+style -- the author does not need to care about that.
+
+\section{Title and author information}
+Title, author information, paper number and copyright are created in the
+preface using the commands
+\begin{verbatim}
+\PaperTitle{Proposal for a \LaTeX\ document 
+class for SAE Technical Papers}
+\AddAuthor{Axel Franke}{Lund Institute of 
+Technology, Sweden}
+\PaperNumber{No number}
+\SAECopyright{1999}
+\end{verbatim}
+Authors from the same affiliation should be added within one
+\verb+\AddAuthor+ command. The general syntax is
+\begin{verbatim}
+\AddAuthor{Author1, Author2, ...}{Affiliation}
+\end{verbatim}
+The command may be used several times.
+
+
+\subsection{A subheading}
+This is a subheading which has been created as usual with the command
+\begin{verbatim}
+\subsection{A subsection}
+\end{verbatim}
+Also the following sub-subheading is formatted automatically by the style. 
+\subsubsection{General options of the style}
+The \texttt{sae} \LaTeX\ style supports optional arguments which determine the
+document font (Helvetica or Times) and the paper size (letterpaper or
+A4). Default is Helvetica and A4. The letter format of this publication has
+been obtained by the opening command
+\begin{verbatim}
+\documentclass[letterpaper]{sae}
+\end{verbatim}
+If Times is desired as document font, this can be achieved by using
+\begin{verbatim}
+\documentclass[letterpaper,times]{sae}
+\end{verbatim}
+or
+\begin{verbatim}
+\documentclass[times]{sae}
+\end{verbatim}
+The latter uses A4 as paper size. This concept has the advantage that document
+font and the paper size can be changed easily at any time of the publication
+process. 
+\end{document}
+
+%%% Local Variables: 
+%%% mode: latex
+%%% TeX-master: t
+%%% End: 
diff --git a/Master/texmf-dist/doc/latex/sae/index.html b/Master/texmf-dist/doc/latex/sae/index.html
new file mode 100644
index 00000000000..3f6b45f8c66
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/sae/index.html
@@ -0,0 +1,61 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
+
+<HTML>
+
+<HEAD>
+<META CONTENT="Axel Franke,  SAE, latex, tex, class, style, paper" HTTP-EQUIV="keywords">
+ <TITLE>A LaTeX style for writing an SAE Technical Paper</TITLE>
+</HEAD>
+
+<BODY BGCOLOR="#FFF8DC" TEXT="#23238E">
+
+
+
+<!-- AS-TOC_BEGIN{ -->
+<H1 ALIGN=center>Table of Contents</H1>
+
+<UL>
+	<LI><A HREF="#as-h3-80061">Background</A>
+	<LI><A HREF="#as-h3-80062">Creating the style</A>
+	<LI><A HREF="#as-h3-6020">System Requirements</A>
+	<LI><A HREF="#as-h3-80063">Download</A>
+	<LI><A HREF="#as-h3-6021">Changes</A>
+	<LI><A HREF="#as-h3-80064">Usage</A>
+	<LI><A HREF="#as-h3-80066">Contact</A>
+</UL>
+<!-- AS-TOC_END} -->
+<H2><A NAME="as-h2-80060">A LaTeX style for writing an SAE Technical Paper</A></H2>
+<H3><A NAME="as-h3-80061">Background</A></H3>
+The SAE Technical meetings are one of the most important publication medium for the research I am doing. Unfortunately, the SAE did not accept papers typeset in LaTeX by now. After many frustrating days trying to get a few so called <EM>wysiwyg</EM> text processors to behave in a reasonable way, I made up my mind and attempted to write an own style meeting the requirements of SAE. I had only been a LaTeX <EM>user</EM> by then, and I had no idea about how to change a titlepage, section styles and the fonts for a whole document. 
+<P>
+I hope the style will be useful for many authors, especially for those making extensive use of mathematical formula. 
+<H3><A NAME="as-h3-80062">Creating the style</A></H3>
+The first step was of course to ask <A HREF="http://www.altavista.com/"> AltaVista</A>, where I - after a while - found a link to <A HREF="http://www.ifs.hr/ifs/razno/doc/TeX/clsguide.html">LaTeX2e for class and package writers</A>. This helped me a lot. Many of the problems I encountered during the five days of creation could be solved with the help of  <EM>The LaTeX Companion</EM> by Goossens, Mittelbach and Samarin.
+<P>
+The <TT>sae</TT> document class inherits all from the <TT>article</TT> class. However, the definition of the titlepage within the <TT>article</TT> class was not suitable. So I had a look at the <TT>article.cls</TT> file to find out how I should write this. The problem was finally solved by creating <TT>savebox</TT>es. This makes it possible to add as many author/affiliation pairs as wished. With each <TT>\AddAuthor</TT> command the old <TT>savebox</TT> is redefined and the new two lines are appended. The <TT>\SAECopyright</TT> command takes a year as the only argument, the surrounding text is created by the style. 
+
+<H3><A NAME="as-h3-6020">System Requirements</A></H3>
+I have tested the style with a <EM>TeTeX</EM> (version pre0.9) distribution containing <EM>LaTeX</EM> (Web2C 7.2) 3.14159 and <EM>pdfTeX</EM> (Web2C 7.2) 3.14159-0.12r. The style has been tested with <EM>MiKTeX</EM> as well. The <STRONG>geometry</STRONG> style required by the latest version can be obtained from your closest CTAN mirror (teTeX has it installed by default!). Search for <TT>geometry</TT> at <A HREF="http://www.ctan.org/search/" TARGET="new">http://www.ctan.org/search/</A>. Download the files <STRONG>geometry.dtx, geometry.ins and Readme</STRONG>. Follow the instructions in the Readme file.
+
+<H3><A NAME="as-h3-80063">Download</A></H3>
+The style can be downloaded <A HREF="sae.cls">here</A>. The copyright notice is included in the file. The old version (before 2000-06-28) can still be obtained <A HREF="saeold.cls">here.</A>
+
+<H3><A NAME="as-h3-6021">Changes</A></H3>
+<TABLE>
+<TR><TD>2000-06-28<TD>Cleaned up the code. Now using <TT>geometry</TT> package instead of <TT>\setlength{}{}</TT> commands. New <TT>pdftex</TT> option, which is forwarded to the <TT>article</TT> class and the <TT>geometry</TT> package. 
+<TR><TD>2000-08-28<TD>Due to numerous questions I received during the past weeks, I decided to add a few instructions on how to obtain the geometry.sty file which is obviously missing in some TeX-distributions.
+</TABLE>
+
+
+<H3><A NAME="as-h3-80064">Usage</A></H3>
+Well, I put an <A HREF="example.tex">example</A> in the same directory. It should explain most. Please contact me if you get trouble using the style. Tell me what kind of LaTeX version you're using.
+<P>
+
+The class is compatible with the <TT>hyperref</TT> package and <TT>pdflatex</TT> and can be used to produce PDF files suitable for electronic publication and printing. There are no features in <TT>sae.cls</TT>which could prevent the usage together with other packages. I recommend the <TT>graphicx</TT>, <TT>natbib</TT> and <TT>tabularx</TT> styles to include figures, handle citations and build tables, respectively.
+
+<H3><A NAME="as-h3-80066">Contact</A></H3>
+Feel free to contact <A HREF="mailto:axel.franke@forbrf.lth.se">me</A> if you  want to suggest improvements or tell me about problems.
+<HR>
+<A HREF="..">Back to my homepage.</A>
+</BODY>
+</HTML>
author	Karl Berry <karl@freefriends.org>	2006-01-09 00:44:40 +0000
committer	Karl Berry <karl@freefriends.org>	2006-01-09 00:44:40 +0000
commit	b4fc5f639874db951177ec539299d20908adb654 (patch)
tree	52f08823ca58fffe3db6a9b075635038c567626c /Master/texmf-dist/doc/latex/sae
parent	dec3d98ebe442d7ea93efbaa8dd2e2be8149a467 (diff)