summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex')
-rw-r--r--Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex106
1 files changed, 73 insertions, 33 deletions
diff --git a/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex b/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
index 56cdf8faf72..0d79e7dfb3e 100644
--- a/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
+++ b/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
@@ -5,26 +5,11 @@
\declaredocument{\LaTeX\ Packages for Unified Process Methodology}{Official Documentation}{UPM-2012-01}
-\initialversion[1.0]{\makedate{11}{04}{2006}}{First release of this example}{\upmpublic}
-\incversion{\makedate{19}{04}{2006}}{Add mtabular and mtable environments}{\upmpublic}
-\incversion{\makedate{27}{04}{2006}}{Add package upmethodology-code}{\upmpublic}
-\incversion{\makedate{13}{04}{2007}}{Update upmethodology-fmt package\newline Adding macros for informed people}{\upmpublic}
-\incversion{\makedate{02}{07}{2007}}{Update upmethodology-fmt package\newline Adding symbols and text formatting functions\newline Updating footnote functions}{\upmpublic}
-\incversion{\makedate{04}{07}{2007}}{Add front page selection macro}{\upmpublic}
-\incversion{\makedate{07}{07}{2007}}{Add bibliography format macros}{\upmpublic}
-\incversion{\makedate{08}{05}{2009}}{Fixing several mismatchs\newline Adding section of document extensions}{\upmpublic}
-\incversion{\makedate{23}{06}{2009}}{Adding section on upmcaution, upminfo and upquestion environments}{\upmpublic}
-\incversion{\makedate{09}{10}{2009}}{Add nodocumentinfo option in upmethodology-document class}{\upmpublic}
-\incversion{\makedate{23}{10}{2009}}{Add back page package}{\upmpublic}
-\incversion{\makedate{24}{10}{2009}}{Add extension package}{\upmpublic}
-\incversion{\makedate{27}{10}{2009}}{Add extension macros and publication page}{\upmpublic}
-\incversion{\makedate{28}{10}{2009}}{Fixing macro names in the \texttt{upmethodology-fmt} package. Add installation chapter.}{\upmpublic}
-\incversion{\makedate{30}{10}{2009}}{Add document class explanations.}{\upmpublic}
-\incversion{\makedate{02}{11}{2009}}{Add people name formatting macros. \newline Add package dependency list.}{\upmpublic}
-\incversion{\makedate{03}{11}{2009}}{Add comment parameter for document role macros.}{\upmpublic}
-\incversion{\makedate{21}{12}{2012}}{{\textbackslash}upmuse \ensuremath{\rightarrow} {\textbackslash}UseExtension}{\upmpublic}
+\initialversion[1.0]{\makedate{11}{04}{2006}}{First release of this documentation}{\upmpublic}
+\updateversion{18.0}{\makedate{21}{12}{2012}}{{\textbackslash}upmuse \ensuremath{\rightarrow} {\textbackslash}UseExtension}{\upmpublic}
\incversion{\makedate{28}{04}{2013}}{Replace the package inclusion of \texttt{color.sty} by \texttt{xcolor.sty}}{\upmpublic}
\incversion{\makedate{17}{05}{2013}}{Add a section on the default configuration of the package \texttt{graphicx}}{\upmpublic}
+\incversion{\makedate{30}{05}{2013}}{Add the macros \texttt{{\textbackslash}includegraphicswtex} and \texttt{{\textbackslash}DeclareGraphicsExtensionsWtex}}{\upmpublic}
\addauthorvalidator*[galland@arakhne.org]{St{\'e}phane}{Galland}{Original Author}
@@ -409,7 +394,7 @@ You could include a figure inside your document with the following macros: \\
\texttt{{\textbackslash}mfigure[position]\{options\}\{filename\}\{caption\}\{label\}} \\
\texttt{{\textbackslash}mfigure*[position]\{options\}\{filename\}\{caption\}\{label\}} \\
-These two macros permits to include an image in your document.The parameters are:
+These two macros permits to include an image in your document. The parameters are:
\begin{itemize}
\item \texttt{position}: is the desired position of the figure (see {\textbackslash}begin{figure}[position]). It could be \texttt{t} (top of the page), \texttt{b} (bottom of the page), \texttt{h} (at the macro location if possible) or \texttt{H} (at macro location);
@@ -424,7 +409,7 @@ These two macros permits to include an image in your document.The parameters are
The difference between \texttt{{\textbackslash}mfigure} and \texttt{{\textbackslash}mfigure*} is the same as the difference between \texttt{{\textbackslash}begin\{figure\}} and \texttt{{\textbackslash}begin\{figure*\}}: the star-version fits to the entire paper width event if the document has two or more columns.
-Because the two macros abose register a label with string starting with \texttt{fig:}, we propose the following function to easily access to the figure's references:
+Because the two macros above register a label with string starting with \texttt{fig:}, we propose the following function to easily access to the figure's references:
\begin{itemize}
\item \texttt{{\textbackslash}figref\{label\}}: is equivalent to \texttt{{\textbackslash}ref\{fig:label\}};
\item \texttt{{\textbackslash}figpageref\{label\}}: is equivalent to \texttt{{\textbackslash}pageref\{fig:label\}}.
@@ -477,21 +462,76 @@ The references to the subfigures could be obtained in two way:\nopagebreak\begin
\section{Figures with embedded \TeX\xspace macros}
-In several case it is usefull to include \TeX\xspace macros inside a figure. It is possible with the files \texttt{.pstex} exporting from a software such as \texttt{xfig}.
-
-To put a \TeX\xspace macro inside your figure, follows the steps:
-\begin{enumerate}
-\item in \texttt{xfig} create a text label with the \emph{special} property set. In this label types the string \texttt{{\textbackslash}FIG$\delta$} where $\delta$ must be replaced by an identifier of your choice but only composed of letters (example: \texttt{{\textbackslash}FIGmyid});
-\item in \texttt{xfig} saves your figure as \texttt{.pstex} files;
-\item in \LaTeX, just before including the figure with the embedded \TeX\xspace macros, define the expressions to put in the figure. This action must be done with one of the macros:
- \begin{itemize}
- \item \texttt{{\textbackslash}figmath\{id\}\{expr\}} will associate to the given identifier the given mathematical expression,
- \item \texttt{{\textbackslash}figtext\{id\}\{expr\}} will associate to the given identifier the given text expression;
- \end{itemize}
-\item in \LaTeX, include the figure with one of the macros: \\
+In several case it is usefull to include \TeX\xspace macros inside a figure. It is possible with the files \texttt{.pstex\_t}/\texttt{.pdftex\_t}, exported from a software such as \texttt{xfig}, \texttt{inkscape}, or \texttt{GNU Plot}.
+
+\subsection{Include a Combined Picture/\TeX\ Figure}
+
+To include a figure with \TeX\ macros inside, you must have: \begin{enumerate}
+\item a Postcript figure (\texttt{.eps}), and a \TeX\ file \texttt{.pstex\_t} related to the Postscript figure; or
+\item a PDF figure (\texttt{.pdf}), and a \TeX\ file \texttt{.pdftex\_t} related to the PDF figure.
+\end{enumerate}
+
+The inclusion of the figure with embedded \TeX\ macros is similar to the inclusion of figures with \texttt{{\textbackslash}includegraphics}. You must type the following macro: \\
+\texttt{{\textbackslash}includegraphicswtex[options]\{filename\}} \\
+where \texttt{options} must be one or more of: \begin{itemize}
+\item \texttt{width=xxx}: specification of the width of the figure (\texttt{xxx} must be replaced by the length);
+\item \texttt{height=xxx}: specification of the height of the figure (\texttt{xxx} must be replaced by the length);
+\end{itemize}
+
+If the \texttt{filename} given to the macro \texttt{{\textbackslash}includegraphicswtex} does not specify an file extension, the macro tries to add the extensions \texttt{.pdftex\_t} and \texttt{.pstex\_t}, by default. If you want to specify other file extensions, you must use the macro:
+\texttt{{\textbackslash}DeclareGraphicsExtensionsWtex\{extensions\}} \\
+where the \texttt{extensions} is a list of file extensions (including the point character), separated by coma characters.
+
+If the \texttt{filename} does not correspond to a file on the disk, the macro \texttt{{\textbackslash}includegraphicswtex} tries to find the file in the directories specified in \texttt{{\textbackslash}graphicspath} (declared in the package \texttt{graphicx} for example).
+
+Figure~\figref{figure_and_tex} gives an example of a floating figure combined with \TeX\ macros, which is using the macro \texttt{{\textbackslash}includegraphicswtex}.
+
+\subsection{Floating figure with embedded \TeX\ macros}
+
+To put a floating figure with \TeX\xspace macro inside, you may use one of the macros:
\texttt{{\textbackslash}mfigurewtex[position]\{width\}\{filename\}\{caption\}\{label\}} \\
\texttt{{\textbackslash}mfigurewtex*[position]\{width\}\{filename\}\{caption\}\{label\}}
-\end{enumerate}
+
+The parameters are:
+\begin{itemize}
+\item \texttt{position}: is the desired position of the figure (see {\textbackslash}begin{figure}[position]). It could be \texttt{t} (top of the page), \texttt{b} (bottom of the page), \texttt{h} (at the macro location if possible) or \texttt{H} (at macro location);
+
+\item \texttt{width}: is the width length of the figure;
+
+\item \texttt{filename}: is the name of the file of the figure (see \texttt{{\textbackslash}includegraphicswtex} for details);
+
+\item \texttt{caption}: is the caption of the figure (see {\textbackslash}caption\{caption\});
+
+\item \texttt{label}: is the label used to reference the figure (see {\textbackslash}label\{fig:label\}).
+\end{itemize}
+
+The difference between \texttt{{\textbackslash}mfigurewtex} and \texttt{{\textbackslash}mfigurewtex*} is the same as the difference between \texttt{{\textbackslash}begin\{figure\}} and \texttt{{\textbackslash}begin\{figure*\}}: the star-version fits to the entire paper width event if the document has two or more columns.
+
+Because the two macros above register a label with string starting with \texttt{fig:}, the macros \texttt{{\textbackslash}figref} and \texttt{{\textbackslash}figpageref} could be used.
+
+\figmath{exampleofexpression}{t_i = \sum_i \left(\alpha + \beta\right)}
+\mfigurewtex{.8\linewidth}{figure_and_tex}{Example of a figure combined with \TeX\ macros}{figure_and_tex}
+
+Figure~\figref{figure_and_tex} gives an example of a floating figure combined with \TeX\ macros. Note that:
+\begin{itemize}
+\item the title of the figure contains the macro \texttt{{\textbackslash}LaTeX}, which produces: \LaTeX;
+\item a small equation, written in \TeX, is put between the two planes;
+\end{itemize}
+
+\subsection{Helpers for embedded \TeX}
+
+To help you to put \TeX\ macros in a figure, and to define its real test inside the \LaTeX\ document, several functions are provided:
+\begin{itemize}
+\item \texttt{{\textbackslash}figmath\{id\}\{expr\}} will associate to the given identifier the given mathematical expression,
+\item \texttt{{\textbackslash}figtext\{id\}\{expr\}} will associate to the given identifier the given text expression;
+\end{itemize}
+
+These expressions, defined with the two previous functions, may be referenced in the figure by a \TeX\ macro with a name similar to \texttt{{\textbackslash}FIG$\delta$}, where $\delta$ must be replaced by an identifier of your choice and used as parameter of one of the two previous functions (example: \texttt{{\textbackslash}FIGmyid}).
+
+Figure~\figref{figure_and_tex} gives an example where the equation is written as: \texttt{{\textbackslash}FIGexampleofexpression} in the figure, and it is replaced by the real equation with: \\
+\texttt{{\textbackslash}figmath\{exampleofexpression\}\{t\_i = {\textbackslash}sum\_i {\textbackslash}left({\textbackslash}alpha + {\textbackslash}beta{\textbackslash}right)\}}
+
+
\section{Tabulars}