summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2014-02-10 22:52:38 +0000
committerKarl Berry <karl@freefriends.org>2014-02-10 22:52:38 +0000
commitfba9823cd52d019b19b6e6ca59243400ca8cd434 (patch)
treefc427a4232bdcf0231b8666a38f7a02c55f5a485 /Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
parenta2724db9e1e09ef417a79e8e58d731e117497dd0 (diff)
upmethodology (10feb14)
git-svn-id: svn://tug.org/texlive/trunk@32933 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex')
-rw-r--r--Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex180
1 files changed, 113 insertions, 67 deletions
diff --git a/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex b/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
index 35b72f34557..bdbe73ba2d0 100644
--- a/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
+++ b/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
@@ -25,12 +25,14 @@
\incsubversion{\makedate{14}{10}{2013}}{Add the macros \texttt{{\textbackslash}chapterfull}, \texttt{{\textbackslash}sectionfull} and \texttt{{\textbackslash}newpageintoc}.}{\upmpublic}
\incsubversion{\makedate{16}{10}{2013}}{Add the section about the environment \texttt{description}.}{\upmpublic}
\incsubversion{\makedate{14}{12}{2013}}{Add the section about \texttt{backcovermessage}.}{\upmpublic}
+\incsubversion{\makedate{09}{02}{2014}}{Add the section about \texttt{enumerate}. Typos are fixed.}{\upmpublic}
\addauthorvalidator*[galland@arakhne.org]{St{\'e}phane}{Galland}{Original Author}
+\addauthor*{Frans}{van Dunn\'e}{Reviewer}
\setdockeywords{\LaTeX, Methodology Document Style, User Documentation, Extensible}
-\setdocabstract{Packages upmethodology permis to write documents according to Unified Process Methodology or other methodology. It was initially wittren by St\'ephane \textsc{Galland} from the laboratory ``Syst\`emes et Transports'' and is distributed by the \arakhneorg website.}
+\setdocabstract{The packages in upmethodology enable users to write documents according to Unified Process Methodology or other methodology. It was initially wittren by St\'ephane \textsc{Galland} from the laboratory ``Syst\`emes et Transports'' and is distributed by the \arakhneorg website.}
\makeatletter
\let\VERversion\upm@package@version@ver
@@ -71,13 +73,13 @@
\textcolor{red}{\large This documentation is written for and compiled by the\\version \UPMVERSION\\of tex-upmethodology.}
\end{center}
-This set of package permits to write documents according to Unified Process Methodology. It was initially wittren by St\'ephane \textsc{Galland} from the laboratory ``Syst\`emes et Transports''\savefootnote{Laboratory \emph{Syst\`emes et Transport} (IRTES-SET), Institut de Recherche sur le Transport, l'\'Energie et la Soci\'et\'e (ITRTES), Universit\'e de Technologie de Belfort-Montb{\'e}liard (UTBM), France, \href{http://set.utbm.fr/}{http://set.utbm.fr/}}{foot:setlab} and is distributed by the \arakhneorg website.
-The provided packages and classes may also be used for other types of documents (reports, thesis...) Since 2012, it is used to support the layout and the style for the PhD thesis of the Doctoral School SPIM\footnote{Doctoral School on the Sciences for enginers, and microtechnics, \href{http://ed-spim.univ-fcomte.fr/}{http://ed-spim.univ-fcomte.fr/}}.
+This set of packages enables users to write documents according to the Unified Process Methodology. It was initially written by St\'ephane \textsc{Galland} from the laboratory ``Syst\`emes et Transports''\savefootnote{Laboratory \emph{Syst\`emes et Transport} (IRTES-SET), Institut de Recherche sur le Transport, l'\'Energie et la Soci\'et\'e (ITRTES), Universit\'e de Technologie de Belfort-Montb{\'e}liard (UTBM), France, \href{http://set.utbm.fr/}{http://set.utbm.fr/}}{foot:setlab} and is distributed by the \arakhneorg website.
+The provided packages and classes may also be used for other types of documents (reports, theses...). Since 2012, it is used to support the layout and the style for the PhD theses of the Doctoral School SPIM\footnote{Doctoral School on the Sciences for engineers, and microtechnics, \href{http://ed-spim.univ-fcomte.fr/}{http://ed-spim.univ-fcomte.fr/}}.
Packages are:
\begin{itemize}
-\item \texttt{upmethodology-version.sty}: permits to set the version and the status of the document. It also permits to manage the document history;
-\item \texttt{upmethodology-fmt.sty}: provides some usefull functions to format the UP documents;
+\item \texttt{upmethodology-version.sty}: makes it possible to set the version and the status of the document. It also makes it possible to manage the document history;
+\item \texttt{upmethodology-fmt.sty}: provides some useful functions to format the UP documents;
\item \texttt{upmethodology-document.sty}: provides functions to manage the project, the subproject and the status of the document;
\item \texttt{upmethodology-frontpage.sty}: formats and provides a front page for the document;
\item \texttt{upmethodology-backpage.sty}: formats and provides a back page for the document;
@@ -93,7 +95,7 @@ Packages are:
\chapter{Download and Installation}
-This chapter describes were to download \texttt{tex-upmethodology} and how to install it.
+This chapter describes where to download \texttt{tex-upmethodology} and how to install it.
\section{Download}
@@ -113,7 +115,7 @@ The second is to rebuild the \LaTeX\ databases by invoking on a console (Unix sy
\texttt{\$> sudo mktexlsr}\\
\texttt{\$> sudo update-updmap --quiet}\\
-\texttt{sudo} is a standard Linux tool which permits to authorized users to temporarely obtain the administration rights.
+\texttt{sudo} is a standard Linux tool that allows authorized users to temporarily obtain the administration rights.
\section{Manual User-wide Installation}
@@ -329,7 +331,7 @@ previous occurrence of \texttt{pubpage} option. \\
\texttt{Version: \VERversion}
\end{center}
-The package \texttt{upmethodology-version} permits to set the version and the status of the document. It also provides functions to manage the document history;
+The package \texttt{upmethodology-version} makes it possible to set the version and the status of the document. It also provides functions to manage the document history;
\section{Constants for the Document Status}
@@ -362,15 +364,15 @@ The following functions permit to access to the informations about the document:
\section{Register Revisions}
-The package \texttt{upmethodology-version} permits to register revisions for building an history. The available functions are:
+The package \texttt{upmethodology-version} makes it possible to register revisions for building an history. The available functions are:
\begin{itemize}
\item \texttt{{\textbackslash}updateversion\{version\}\{date\}\{description\}\{status\}}: registers a revision for the document. The revision indicates that the given version was produced at the given date. A small description of the changes and the resulting document's status must be also provided. The function \texttt{{\textbackslash}updateversion} is a generalization of the following functions;
\item \texttt{{\textbackslash}initialversion[version]\{date\}\{description\}\{status\}}: registers the initial version of the document. If not given, the version is assumed to be \texttt{0.1};
-\item \texttt{{\textbackslash}incversion\{date\}\{description\}\{status\}}: regiters a revision corresponding to the next major version. For example, if the version number was \texttt{2.67} before \texttt{{\textbackslash}incversion}, this function add the version \texttt{3.67} with the given informations (incrementation of the major part of the version number);
+\item \texttt{{\textbackslash}incversion\{date\}\{description\}\{status\}}: registers a revision corresponding to the next major version. For example, if the version number was \texttt{2.67} before \texttt{{\textbackslash}incversion}, this function add the version \texttt{3.67} with the given informations (incrementation of the major part of the version number);
-\item \texttt{{\textbackslash}incsubversion\{date\}\{description\}\{status\}}: regiters a revision corresponding to the next minor version. For example, if the version number was \texttt{2.67} before \texttt{{\textbackslash}incsubversion}, this function add the version \texttt{2.68} with the given informations (incrementation of the minor part of the version number);
+\item \texttt{{\textbackslash}incsubversion\{date\}\{description\}\{status\}}: registers a revision corresponding to the next minor version. For example, if the version number was \texttt{2.67} before \texttt{{\textbackslash}incsubversion}, this function add the version \texttt{2.68} with the given informations (incrementation of the minor part of the version number);
\end{itemize}
\section{Formatted List of Versions}
@@ -397,7 +399,7 @@ The following macros defines some localized strings used by \texttt{upmethodolog
\texttt{Version: \VERfmt}
\end{center}
-The package \texttt{upmethodology-fmt} provides some usefull facilities to format a document.
+The package \texttt{upmethodology-fmt} provides some useful facilities to format a document.
\section{Default Configuration for the Package \texttt{graphicx}}
@@ -421,7 +423,7 @@ It may be verbose to put \LaTeX\ code to include a figure inside your document.
\texttt{{\textbackslash}mfigure[position]\{include\_graphics\_options\}\{filename\}\{caption\}\{label\}} \\
\texttt{{\textbackslash}mfigure*[position]\{include\_graphics\_options\}\{filename\}\{caption\}\{label\}} \\
-These two macros permits to include an image in your document. The parameters are:
+These two macros make it possible 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);
@@ -448,7 +450,7 @@ The figure~\figref{example:mfigure} page~\figpageref{example:mfigure} is obtaine
\section{Sub-figures}
-In some case, it is usefull to put several images inside the same floating figure, but without loosing the possibility to reference each of the subfigures. This feature was proposed by the package \texttt{subfigure}. The following environments provides helper functions for \texttt{subfigure}:
+In some case, it is useful to put several images inside the same floating figure, but without loosing the possibility to reference each of the subfigures. This feature was proposed by the package \texttt{subfigure}. The following environments provides helper functions for \texttt{subfigure}:
\texttt{{\textbackslash}begin\{mfigures\}[position]\{caption\}\{label\}\\
...\\
{\textbackslash}end\{mfigures\}} \\
@@ -456,7 +458,7 @@ In some case, it is usefull to put several images inside the same floating figur
...\\
{\textbackslash}end\{mfigures*\}} \\
-These two macros permits to include an image in your document.The parameters are:
+These two macros enable you 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);
@@ -484,12 +486,12 @@ The reference and page reference are obtained with \texttt{{\textbackslash}figre
The references to the subfigures could be obtained in two way:\nopagebreak\begin{itemize}
\item using the label given as the last parameter of \texttt{{\textbackslash}mfigure}, eg. the label \texttt{example:firstsubfigure} corresponds to \figref{example:firstsubfigure};
-\item using the label of the enclosing figure to which the index of the subfigure could be appended (in its roman representation and prefixed by the character ``\texttt{:}''), eg. the label \texttt{example:msubfigure:b} corresponds to \figref{example:msubfigure:b};
+\item using the label of the enclosing figure to which the index of the subfigure could be appended (in its Roman representation and prefixed by the character ``\texttt{:}''), eg. the label \texttt{example:msubfigure:b} corresponds to \figref{example:msubfigure:b};
\end{itemize}
\section{Figures with embedded \TeX\xspace macros}
-In several case it is usefull to include \TeX\xspace macros inside a figure. It is possible to combine figures and \TeX\ macros. Several figure editors provide exporting features to obtain combined figures: \texttt{xfig}, \texttt{inkscape}, \texttt{GNU Plot}, etc. Basically, these tools create two files per source figure: \begin{itemize}
+In several case it is useful to include \TeX\xspace macros inside a figure. It is possible to combine figures and \TeX\ macros. Several figure editors provide exporting features to obtain combined figures: \texttt{xfig}, \texttt{inkscape}, \texttt{GNU Plot}, etc. Basically, these tools create two files per source figure: \begin{itemize}
\item the figure in PDF or Postscript format (filename extensions, \texttt{.pdf} or \texttt{.ps}); and
\item a \TeX\ file that contains the macros to put over the figure, and that is including the generated figure. Its filename extension depends on the type of the figure: \texttt{.pdftex\_t} or \texttt{.pdf\_tex} for PDF, and \texttt{.pstex\_t} or \texttt{.ps\_tex} for Postscript.
\end{itemize}
@@ -530,7 +532,7 @@ 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{include\_graphics\_options}: are the options to pass to \texttt{{\textbackslash}includegraphicswtex}. For ascendent compatibility, if you pass a length without a key, e.g. \texttt{\{.8{\textbackslash}linewidth\}}, the length is assumed to be the width of the figure;
+\item \texttt{include\_graphics\_options}: are the options to pass to \texttt{{\textbackslash}includegraphicswtex}. For ascendant compatibility, if you pass a length without a key, e.g. \texttt{\{.8{\textbackslash}linewidth\}}, the length is assumed to be the width of the figure;
\item \texttt{filename}: is the name of the file of the figure (see \texttt{{\textbackslash}includegraphicswtex} for details);
@@ -591,13 +593,13 @@ This tabular is an extension of the \texttt{tabularx} environment which provides
The \texttt{mtabular} environment provides:
\begin{itemize}
\item \texttt{{\textbackslash}tabulartitle\{title\}} \\
- This macro permits to define the title of the tabular. It uses the colors \texttt{backtableheader} and \texttt{fronttableheader} for the background and the foreground respectively. The title has a single line at the top, and a single line below;
+ This macro allows you to define the title of the tabular. It uses the colors \texttt{backtableheader} and \texttt{fronttableheader} for the background and the foreground respectively. The title has a single line at the top, and a single line below;
\item \texttt{{\textbackslash}tabulartitleinside\{title\}} \\
- This macro permits to define the title of the tabular. It uses the colors \texttt{backtableheader} and \texttt{fronttableheader} for the background and the foreground respectively. The title has two lines at the top, and a single line below;
+ This macro allows you to define the title of the tabular. It uses the colors \texttt{backtableheader} and \texttt{fronttableheader} for the background and the foreground respectively. The title has two lines at the top, and a single line below;
\item \texttt{{\textbackslash}tabularheader\{$header_1$\}...\{$header_n$\}} \\
- This macro permits to define the titles of the columns. It uses the colors \texttt{backtableheader} and \texttt{fronttableheader} for the background and the foreground respectively. Because the count of columns was given to the environment this function takes the same count of parameters as the count of columns. This macro adds a line after the header, \emph{BUT NOT BEFORE}.
+ This macro allows you to define the titles of the columns. It uses the colors \texttt{backtableheader} and \texttt{fronttableheader} for the background and the foreground respectively. Because the count of columns was given to the environment this function takes the same count of parameters as the count of columns. This macro adds a line after the header, \emph{BUT NOT BEFORE}.
\begin{upmcaution}
Because \texttt{{\textbackslash}tabularheader} is adding a \texttt{{\textbackslash}hline} at the end of its expansion. You must put a \texttt{{\textbackslash}tabularheader} just after \texttt{{\textbackslash}tabularheader}. Otherwise you may obtain a \TeX\ error.
\end{upmcaution}
@@ -701,7 +703,7 @@ The package \texttt{upmethodology-fmt} provides a set of macros dedicated to enu
\subsection{Enumeration Counters}
-Sometimes it is usefull to start an enumeration list from a specifical given number. This package provides several macros for saving and restoring the counter use by the enumeration lists.
+Sometimes it is useful to start an enumeration list from a specific given number. This package provides several macros for saving and restoring the counter use by the enumeration lists.
\begin{upmcaution}
Only once counter could be saved at a given time.
@@ -727,7 +729,7 @@ It means that you cannot save the counters for an enumeration and for an enclosi
In several document, an enumeration of things is written inside a paragraph instead of inside a list of points.
-\paragraph{Exemple:} The following \LaTeX~code produces the result below:
+\paragraph{Example:} The following \LaTeX~code produces the result below:
\begin{verbatim}
This is a text: \begin{inlineenumeration}
\item first thing;
@@ -750,11 +752,11 @@ The environment \texttt{description} is redefined as following:
\item[desc] text
\end{description}
\end{verbatim}
-The text put in place of \texttt{desc} represents the text which may be emphazed in the description item.
+The text put in place of \texttt{desc} represents the text which may be emphasized in the description item.
The \texttt{separator} is the text that is inserted at the end of the head of each description item.
-\paragraph{Example~1:} The following \LaTeX~code, using roman numbers, produces the description just below:
+\paragraph{Example~1:} The following \LaTeX~code, using Roman numbers, produces the description just below:
\begin{verbatim}
\begin{description}
\item[first thing] this is a text for the first thing;
@@ -784,9 +786,9 @@ The \texttt{separator} is the text that is inserted at the end of the head of ea
\item[more] etc.
\end{description}
-\section{Descriptions in conjonction with enumeration}
+\section{Descriptions in conjunction with enumeration}
-It may be helpful to put a list of descriptions in conjonction with an enumeration.
+It may be helpful to put a list of descriptions in conjunction with an enumeration.
In other words, the following environment provides a mix between the standards \LaTeX~environments \texttt{description} and \texttt{enumerate}.
\subsection{Environment \texttt{enumdescription}}
@@ -799,11 +801,11 @@ The environment \texttt{enumdescription} is:
\end{verbatim}
where the \texttt{type} is the type of the enumeration. It may be one of:
\begin{itemize}
-\item ``\texttt{i}'': for an enumeration with roman numbers (this is the default),
-\item ``\texttt{1}'': for an enumeration with arabic numbers,
+\item ``\texttt{i}'': for an enumeration with Roman numbers (this is the default),
+\item ``\texttt{1}'': for an enumeration with Arabic numbers,
\item ``\texttt{a}'': for an enumeration with letters.
\end{itemize}
-The text put in place of \texttt{desc} represents the text which may be emphazed in the description item.
+The text put in place of \texttt{desc} represents the text which may be emphasized in the description item.
To change the rendering of the labels, you must redefined the macro as:
@@ -811,8 +813,17 @@ To change the rendering of the labels, you must redefined the macro as:
\renewcommand{\enumdescriptionlabel}[1]{ ... #1 ... }
\end{verbatim}
+To change the separator between the counter and the description, you must redefined the macro as:
+\begin{verbatim}
+\renewcommand{\enumdescriptioncounterseparator}{ ... }
+\end{verbatim}
+
+To change the separator between the description and the rest of the text, you must redefined the macro as:
+\begin{verbatim}
+\renewcommand{\enumdescriptionlabelseparator}{ ... }
+\end{verbatim}
-\paragraph{Example~1:} The following \LaTeX~code, using roman numbers, produces the enumerated description just below:
+\paragraph{Example~1:} The following \LaTeX~code, using Roman numbers, produces the enumerated description just below:
\begin{verbatim}
\begin{enumdescription}
\item[first thing] this is a text for the first thing;
@@ -857,6 +868,41 @@ To change the rendering of the labels, you must redefined the macro as:
\item[more] etc.
\end{enumdescription}
+\subsection{Environment \texttt{enumerate}}
+
+The environment \texttt{enumerate} exists in the standard \LaTeX\ distributions.
+The UPM package redefines this environment to provide a behavior similar to the one of the environment \texttt{enumdescription}.
+
+\paragraph{Example~1:} The following \LaTeX~code produces a list, which is similar to the one generated by the standard \LaTeX\ environment \texttt{enumerate}:
+\begin{verbatim}
+\begin{enumerate}
+\item this is a text for the first thing;
+\item this is a text for the second thing;
+\item etc.
+\end{enumerate}
+\end{verbatim}
+
+\begin{enumerate}
+\item this is a text for the first thing;
+\item this is a text for the second thing;
+\item etc.
+\end{enumerate}
+
+\paragraph{Example~2:} The following \LaTeX~code illustrates how the environment is reacting to a given description:
+\begin{verbatim}
+\begin{enumerate}
+\item this is a text for the first thing;
+\item[description] this is a text for the second thing;
+\item etc.
+\end{enumerate}
+\end{verbatim}
+
+\begin{enumerate}
+\item this is a text for the first thing;
+\item[description] this is a text for the second thing;
+\item etc.
+\end{enumerate}
+
\subsection{Environment \texttt{enumdescriptionx}}
The environment \texttt{enumdescriptionx} extends the environment \texttt{enumdescription} by enabling a finer configuration with more parameters.
@@ -870,11 +916,11 @@ The environment \texttt{enumdescriptionx} is:
\end{verbatim}
where the \texttt{type} is the type of the enumeration. It may be one of:
\begin{itemize}
-\item ``\texttt{i}'': for an enumeration with roman numbers (this is the default),
-\item ``\texttt{1}'': for an enumeration with arabic numbers,
+\item ``\texttt{i}'': for an enumeration with Roman numbers (this is the default),
+\item ``\texttt{1}'': for an enumeration with Arabic numbers,
\item ``\texttt{a}'': for an enumeration with letters.
\end{itemize}
-The text put in place of \texttt{desc} represents the text which may be emphazed in the description item.
+The text put in place of \texttt{desc} represents the text which may be emphasized in the description item.
The text \texttt{counter\_prefix} is put before all the counter values in the enumeration.
The text \texttt{counter\_postfix} is put after all the counter values in the enumeration.
@@ -928,7 +974,7 @@ The package \texttt{upmethodology-fmt} provides a set of macros allowing to save
\section{UML diagrams on the side of paragraphs}
-The package \texttt{upmethodology-fmt} provides an environment which permits to put an UML diagram (or any other picture) on the side of a paragraph.
+The package \texttt{upmethodology-fmt} provides an environment that makes it possible to put an UML diagram (or any other picture) on the side of a paragraph.
\begin{itemize}
\item \texttt{{\textbackslash}begin\{umlinpar\}[width]\{picture\_path\}}\\\texttt{text}\\\texttt{{\textbackslash}end\{umlinpat\}} \\
@@ -948,7 +994,7 @@ Because the concept of date was important and unfortunately localized, this pack
\begin{itemize}
\item \texttt{{\textbackslash}makedate\{day\}\{month\}\{year\}}\\
-permits to create the text corresponding to the given date according to the current localized date format.
+allows you to create the text corresponding to the given date according to the current localized date format.
\item \texttt{{\textbackslash}extractyear\{formatted\_date\}}\\
extract the year field from a date respecting the localized date format.
\item \texttt{{\textbackslash}extractmonth\{formatted\_date\}}\\
@@ -1162,12 +1208,12 @@ This is the theorem of Evereything.
\end{verbatim}
gives the result:
\begin{mytheorem}[Theorem of Everything]
-This is the theorem of Evereything.
+This is the theorem of Everything.
\end{mytheorem}
\subsection{\texttt{definition}}
-The package \texttt{upmethodology-fmt} defines the environment \texttt{definition}, which permits to put a definition in your document. This environment is based on the standard \texttt{theorem} environment. The \texttt{definition} takes one optional parameter: the name of the definition.
+The package \texttt{upmethodology-fmt} defines the environment \texttt{definition} to put a definition in your document. This environment is based on the standard \texttt{theorem} environment. The \texttt{definition} takes one optional parameter: the name of the definition.
\paragraph{Example:} The following \LaTeX\ code:
\begin{verbatim}
@@ -1209,7 +1255,7 @@ Text of the definition.
\section{Framed Boxes or Mini Pages}
-Standard \LaTeX\ distribution provides the \texttt{minipage} environment. This environment permits to put a small piece of page inside your document. The package \texttt{upmethodology-fmt} provides two framed extensions of the original \texttt{minipage} environment: \texttt{framedminipage} and \texttt{framedcolorminipage}.
+Standard \LaTeX\ distribution provides the \texttt{minipage} environment. This environment allows you to put a small piece of page inside your document. The package \texttt{upmethodology-fmt} provides two framed extensions of the original \texttt{minipage} environment: \texttt{framedminipage} and \texttt{framedcolorminipage}.
The prototypes of there two new environments are, respectively:
\begin{itemize}
@@ -1271,10 +1317,10 @@ The package \texttt{upmethodology-fmt} provides a set of environment to put emph
\section{Additional Macros for the Table of Content}
-The macro \texttt{{\textbackslash}newpageintoc} permits to insert a page break inside the table of contents (toc).
-It may be used to avoid orhpan titles in the toc.
+The macro \texttt{{\textbackslash}newpageintoc} makes it possible to insert a page break inside the table of contents (toc).
+It may be used to avoid orphan titles in the toc.
-\section{Additional Document Sectionning Macros}
+\section{Additional Document Sectioning Macros}
The package \texttt{upmethodology-fmt} provides several macros that permit to create special sections.
@@ -1373,8 +1419,8 @@ You could declare the information about your document with one of the following
\texttt{{\textbackslash}declaredocumentex\{project\}\{subproject\}\{name\}\{ref\}} \\
where the parameters are:
\begin{itemize}
-\item \texttt{project} is the name of the project for which the document is for;
-\item \texttt{subproject} is the name of the sub-project for which the document is for;
+\item \texttt{project} is the name of the project the document belongs to;
+\item \texttt{subproject} is the name of the sub-project the document belongs to;
\item \texttt{name} is the name of the document;
\item \texttt{ref} is the reference number of the document.
\end{itemize}
@@ -1389,7 +1435,7 @@ The macro \texttt{{\textbackslash}setdocabstract} is for entering the docment's
\texttt{{\textbackslash}setdocabstract{[}lang{]}\{abstract\_text\}} \\
where \texttt{abstract\_text} is the text of your abstract and \texttt{lang} designates for which language the abstract text is for. If the language is not specified, this macro uses the current document language.
-The macro \texttt{{\textbackslash}setdockeywords} is for entering the docment's key-words:\\
+The macro \texttt{{\textbackslash}setdockeywords} is for entering the document's key-words:\\
\texttt{{\textbackslash}setdockeywords{[}lang{]}\{keywords\}} \\
where \texttt{keywords} is the list of key-words and \texttt{lang} designates for which language the key-words are for. If the language is not specified, this macro uses the current document language.
@@ -1429,7 +1475,7 @@ An author is someone who participates to the writing of the document. You could
The list of the authors is accessible by two means:
\begin{itemize}
\item \texttt{{\textbackslash}theauthorlist} is a coma-separated list of the authors' names;
-\item \texttt{{\textbackslash}upmdocumentauthors} procudes an array of all the authors (see below for an example).
+\item \texttt{{\textbackslash}upmdocumentauthors} produces an array of all the authors (see below for an example).
\end{itemize}
\upmdocumentauthors
@@ -1452,7 +1498,7 @@ A validator is someone who participates to the validation of the document. You c
The list of the validators is accessible by two means:
\begin{itemize}
\item \texttt{{\textbackslash}thevalidatorlist} is a coma-separated list of the validator' names;
-\item \texttt{{\textbackslash}upmdocumentvalidators} procudes an array of all the validators (see below for an example).
+\item \texttt{{\textbackslash}upmdocumentvalidators} produces an array of all the validators (see below for an example).
\end{itemize}
\upmdocumentvalidators
@@ -1466,7 +1512,7 @@ An informed people is someone who receives the document to be informed about its
The list of the informed people is accessible by two means:
\begin{itemize}
\item \texttt{{\textbackslash}theinformedlist} is a coma-separated list of the informed people' names;
-\item \texttt{{\textbackslash}upmdocumentinformedpeople} procudes an array of all the informed people (see below for an example).
+\item \texttt{{\textbackslash}upmdocumentinformedpeople} produces an array of all the informed people (see below for an example).
\end{itemize}
\upmdocumentinformedpeople
@@ -1477,13 +1523,13 @@ Package \texttt{upmethodology-document} provides several macros to define the co
\subsection{Setting Information}
-Copyrighter is the people or the institution, or both, which is owning the copyright on the document. The following macro permits to set the identify of the copyighter in all the parts of the documents: \\
+The Copyright holder(s) are person(s) or institution(s), that own the copyright on the document. The following macro allows you to set the identity of the copyright holder in all parts of the documents: \\
\texttt{{\textbackslash}setcopyrighter\{name\}}\\
Publisher is the people or the institution, or both, which is publishing the document. Basically it is the same the copyrighter (see above): \\
\texttt{{\textbackslash}setpublisher\{name\}}\\
-Some times, copyright laws depend on the location where the document is printed. The following macro permits to put a message in the publication page which is indicating where the document is printed: \\
+Some times, copyright laws depend on the location where the document is printed. The following macro allows you to put a message in the publication page which is indicating where the document is printed: \\
\texttt{{\textbackslash}setprintingaddress\{address\}}\\
Publications may be identifier by international identifiers. Package \texttt{upmethodology-document} supports ISBN, ISSN and DOI:
@@ -1508,7 +1554,7 @@ The package \texttt{upmethodology-document} provides the \texttt{{\textbackslash
\begin{figure}
\begin{center}
\begin{framedminipage}{.8\linewidth}
- \upmpublicationminipage % in place of \upmpublicationpage to avod page number and page style changes
+ \upmpublicationminipage % in place of \upmpublicationpage to avoid page number and page style changes
\end{framedminipage}
\caption{Example of Publication Page generated with \texttt{{\textbackslash}upmpublicationpage}}
\label{fig:publication:page}
@@ -1560,7 +1606,7 @@ where \texttt{layout\_name} must be one of:
\item \texttt{modern}: front page layout with title and logo and background picture.
\end{itemize}
-The figure~\figref{frontpage:layout} illustrates the differents layouts.
+The figure~\figref{frontpage:layout} illustrates the different layouts.
\begin{mfigures}{Front Page Layouts}{frontpage:layout}
\mbox{}\hfill
@@ -1655,7 +1701,7 @@ A document extension could be written and described inside a file named \texttt{
The \texttt{upmext-NAME.cfg} file is a \LaTeX\ file in which a set of definition macros are put. These macros must respect the \LaTeX\ syntax.
-The \texttt{{\textbackslash}DeclaraCopyright} macro permits to declare several copyright information about the extension: \\
+The \texttt{{\textbackslash}DeclareCopyright} macro enables you to declare additional copyright information about the extension: \\
\texttt{{\textbackslash}DeclareCopyright{[}lang{]}\{extension\_name\}\{year\}\{copyrighter\}\{trademark and copyright information\}} \\
This macro declares the \texttt{copyright} value which contains the copyright text (for this documentation ``\Get{copyright}'').
@@ -1669,9 +1715,9 @@ The \texttt{variable\_name} is the name of the value to override. It must be tak
\begin{mtable}{\linewidth}{2}{lX}{List of overiddable value names}{documentextension:names:set}
\hline
\tabularheader{Value Name}{Description}
- logo & the filename of the picutre which must be used as a large logo. \\
+ logo & the filename of the picture which must be used as a large logo. \\
\hline
- smalllogo & the filename of the picutre which must be used as a small logo. \\
+ smalllogo & the filename of the picture which must be used as a small logo. \\
\hline
copyrighter & the name of the authors or the institution which own the copyright on the document. \\
\hline
@@ -1689,19 +1735,19 @@ The \texttt{variable\_name} is the name of the value to override. It must be tak
\hline
\end{mtable}
-The \texttt{{\textbackslash}Get} macro permits to retreive the value defined by a \texttt{{\textbackslash}Set}:\\
+The \texttt{{\textbackslash}Get} macro allows you to retrieve the value defined by a \texttt{{\textbackslash}Set}:\\
\texttt{{\textbackslash}Get\{variable\_name\}} \\
-The \texttt{{\textbackslash}Unset} macro permits to remove the definition of a value:\\
+The \texttt{{\textbackslash}Unset} macro allows you to remove the definition of a value:\\
\texttt{{\textbackslash}Unset\{variable\_name\}} \\
-The \texttt{{\textbackslash}Ifnotempty} macro permits to expand the \LaTeX\ macros if the given text is not empty:\\
+The \texttt{{\textbackslash}Ifnotempty} macro allows you to expand the \LaTeX\ macros if the given text is not empty:\\
\texttt{{\textbackslash}Ifnotempty\{text\}\{latex\_code\}} \\
-The \texttt{{\textbackslash}Ifempty} macro permits to expand the \LaTeX\ macros if the given text is empty:\\
+The \texttt{{\textbackslash}Ifempty} macro allows you to expand the \LaTeX\ macros if the given text is empty:\\
\texttt{{\textbackslash}Ifempty\{text\}\{latex\_code\}} \\
-The \texttt{{\textbackslash}Ifelsedefined} macro permits to expand the \LaTeX\ macros in \texttt{then\_code} if a value with the given name was defined, or to expand the \LaTeX\ macros in \texttt{else\_code} if no value with the given name was defined:\\
+The \texttt{{\textbackslash}Ifelsedefined} macro allows you to expand the \LaTeX\ macros in \texttt{then\_code} if a value with the given name was defined, or to expand the \LaTeX\ macros in \texttt{else\_code} if no value with the given name was defined:\\
\texttt{{\textbackslash}Ifelsedefined\{value\_name\}\{then\_code\}\{else\_code\}} \\
The \texttt{{\textbackslash}Put} macro is an extension of the standard picture \texttt{{\textbackslash}put} macro. It takes into account the joint margin applied in two sided documents when it is used on page's backside (eg. the back page of the document):\\
@@ -1728,22 +1774,22 @@ The definition of a task could be made only inside one of the following environm
\texttt{{\textbackslash}begin\{taskdescription*\}\{id\}...{\textbackslash}end\{taskdescription*\}} \\
where \texttt{id} is the identifier of the task.
-The environment \texttt{taskdefinion} displays the task's description with a call to \texttt{{\textbackslash}thetaskdescription\{id\}}. In the opposite \texttt{taskdefinition*} never displays the ta's description.
+The environment \texttt{taskdefinion} displays the task's description with a call to \texttt{{\textbackslash}thetaskdescription\{id\}}. On the other hand, \texttt{taskdefinition*} never displays the task's description.
Inside one of the task's definition environment above, you could use one of the following macros to define the task's attributes:
\begin{itemize}
\item \texttt{{\textbackslash}taskname\{name\}} \\
- permits to defines the name of the task;
+ to define the name of the task;
\item \texttt{{\textbackslash}tasksuper\{id\}} \\
indicates that the current task is a sub-task of the task identified by the given identifier;
\item \texttt{{\textbackslash}taskcomment\{text\}} \\
- permits to describe the task's purposes and goals (will be shown in the description box of the task's description);
+ to describe the task's purposes and goals (will be shown in the description box of the task's description);
\item \texttt{{\textbackslash}taskprogress\{percent\}} \\
- defines the percent for thtask's archieving;
+ to set the percentage for task achievement;
\item \texttt{{\textbackslash}taskstart\{date\}} \\
- permits to set the starting date of the task (real or predicted);
+ to set the starting date of the task (real or predicted);
\item \texttt{{\textbackslash}taskend\{date\}} \\
- permits to set the finished date of the task (real or predicted);
+ to set the finished date of the task (real or predicted);
\item \texttt{{\textbackslash}taskmanager\{name\}} \\
adds a task's manager into the list of the managers;
\item \texttt{{\textbackslash}taskmember\{name\}} \\
@@ -1790,7 +1836,7 @@ The following macros defines some localized strings used by \texttt{upmethodolog
\item \texttt{{\textbackslash}upm@task@lang@escription}: Description;
\item \texttt{{\textbackslash}upm@task@lang@startat}: Start at;
\item \texttt{{\textbackslash}upm@task@lang@endat}: End at;
-\item \texttt{{\textbackslash}upm@task@lang@archieved}: Archieved;
+\item \texttt{{\textbackslash}upm@task@lang@archieved}: Achieved;
\item \texttt{{\textbackslash}upm@task@lang@managers}: Managers;
\item \texttt{{\textbackslash}upm@task@lang@members}: Members;
\item \texttt{{\textbackslash}upm@task@lang@Milestones}: Milestones;