source: Sophya/trunk/DocHFI_L2/exdocl2.tex@ 4043

Last change on this file since 4043 was 1142, checked in by ansari, 25 years ago

DocL2 style file and example, work on WBS - Reza 25/8/2000

File size: 2.6 KB
Line 
1\documentclass[twoside,11pt]{article}
2
3% The commands for setting up the title page are in file defdocl2.sty
4\usepackage{defdocl2}
5
6% ------- The document itself
7\begin{document}
8% ------- The title page -----
9\begin{titlepage}
10% Document title using the titleph command :
11\titleph{Using the defdocl2 style file}
12% The authors list using \authors{ name & institue \\ name & institue ...}
13\authors{R. Ansari & LAL-IN2P3/CNRS (Orsay)\\ E. Aubourg & DAPNIA-CEA (Saclay)}
14% Document number , revision/issue and date
15% \titlepfd{DocNumber}{Revision} adds the date automatically using \today
16\titlepfd{PL-HFI-LAL-MA-001}{1.0}
17% \titlepf{DocNumber}{Revision}{theDate} can be used to specify a date
18\end{titlepage}
19
20% It is a good practice to include a revision history table at the
21% beginning of the document
22\revisionhistory
23\begin{itemize}
24\item Version 1.0 (August 2000 - CVS version 1.1) \\
25First version of defdocl2.sty latex style file and example tex file
26\end{itemize}
27
28\newpage
29\section*{Using the docl2 style file}
30
31This document is an example or template file which can be used to produce
32documentation for Planck HFI using \LaTeX .
33The commands for setting up the cover page are defined in the style
34file {\tt defdocl2.sty}. The HFI icon (in Encapsulated Postscript format)
35is in the file \\
36{\tt hfi\_icon\_small.eps}. \\
37The following commands can be used to setup the title page inside
38the {\tt titlepage} environment.
39\begin{itemize}
40\item[] {\bf titleph} should be the first command in the {\tt titlepage} environment.
41It has one argument which defines to document title.
42\item[] {\bf authors} can be used for the authors list.
43\item[] {\bf titlepf} should be the last command in the {\tt titlepage} environment.
44It accepts three arguments: The document number, revision/issue nummber and
45the date.
46\item[] {\bf titlepfd} is a simplified version of the previous command, which
47inserts the current date automatically (using \verb+\today+).
48\end{itemize}
49The commands to produce the title/cover page of this document are reproduced
50below:
51\begin{verbatim}
52% ------- The title page -----
53\begin{titlepage}
54\titleph{Using the defdocl2.sty style file} % The document title
55\authors{R. Ansari & LAL-IN2P3/CNRS (Orsay)\\
56 E. Aubourg & DAPNIA-CEA (Saclay)} % Author list
57\titlepfd{PL-HFI-LAL-MA-001}{1.0} % Document number , revision/issue and date
58\end{titlepage}
59\end{verbatim}
60
61It is a good practice to include a revision history table at the beginning
62of the document, as shown in this example file. The command \verb+\revisionhistory+
63can be used for the corresponding page header.
64
65\end{document}
Note: See TracBrowser for help on using the repository browser.