diff options
23 files changed, 2006 insertions, 522 deletions
diff --git a/Master/texmf-dist/doc/latex/upmethodology/Changelog b/Master/texmf-dist/doc/latex/upmethodology/Changelog index 0a0da128c22..dcac8226348 100644 --- a/Master/texmf-dist/doc/latex/upmethodology/Changelog +++ b/Master/texmf-dist/doc/latex/upmethodology/Changelog @@ -1,3 +1,76 @@ +2009-11-03 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-document.sty: Add star-ed macros for author, informed people + and validator addition macros. + * upmethodology-p-common.sty: \If* macros are marked with \long. + * upmethodology-extension.sty: \If* macros are marked with \long. + +2009-11-02 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-fmt.sty: Fixing footnote macros to allow to put any character as id. + * upmethodology-fmt.sty: Add macros: \prname, \drname, \phdname, \scdname, + \mdname, \pename, \iename. + +2009-10-30 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-fmt.sty: Add support for book and report classes. + * upmethodology-document.cls: Add "book", "report" and "article" options. + * upmethodology-document.sty: Allow to override the default document font. + * upmethodology-document.sty: Add "book", "report" and "article" support. + * upmethodology-backpage.sty: Rename \setbacklayout to \setbackcover. + * upmethodology-backpage.sty: Add \makebackcover. + * upmethodology-extension.sty: Bug fix: provides "upmethodology-extension" + insteed of "upmethodology-document". + * upmethodology-frontpage.sty: Clean code. + * upmethodology-p-common.sty: First public release. + +2009-10-29 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-frontpage.sty: Major bug fix: invert order of the \setfrontillustration parameters. + * upmethodology-document.sty: Allow to override the default document font. + +2009-10-28 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-fmt.sty: add \parskip. + * upmethodology-fmt.sty: add \setpdfcolor. + * upmethodology-document.sty: Fixing major bug on PDF bookmarks. + * upmethodology-document.cls: Fixing major bug on PDF bookmarks. + +2009-10-27 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-extension.sty: Clean the extension API. + * upmethodology-extension.sty: Add publication page. + * upmethodology-frontpage.sty: Clean the extension API. + * upmethodology-document.sty: Clean the extension API. + * upmethodology-document.sty: Fixing document synoptic. + * upmethodology-document.sty: Add publication page. + * upmethodology-document.cls: Add publication page. + * upmethodology-fmt.cls: Add framedminipage environment. + +2009-10-25 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-document.sty: Add abstract and keywords. + +2009-10-24 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-extension.sty: first public release. + +2009-10-23 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-document.sty: add front/back pages in extensions. + * upmethodology-document.sty: add \if commands on extension's values. + * upmethodology-frontpage.sty: add support for front page UPM extensions. + * upmethodology-backpage.sty: first public release. + * upmethodology-document.cls: add back page support. + +2009-10-09 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-document.cls: add "nodocumentinfo" option. + +2009-06-25 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-fmt.sty: Add \tablenote in mtable environment. + +2009-06-24 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-version.sty: Update English words. + * upmethodology-document.sty: Add automatic watermarks. + +2009-06-23 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-fmt.sty: Add upmcaution, upminfo and upmquestion environments. + +2009-05-08 Stéphane GALLAND <galland@arakhne.org> + * upmethodology-fmt.sty: Remove CR character + * upmethodology-fmt.sty: Add \arakhneorg command + 2009-04-29 Stéphane GALLAND <galland@arakhne.org> * upmethodology-fmt.sty: Include package pifont (texlive distribution) diff --git a/Master/texmf-dist/doc/latex/upmethodology/VERSION b/Master/texmf-dist/doc/latex/upmethodology/VERSION index 11b8d428f9f..2829ddae330 100644 --- a/Master/texmf-dist/doc/latex/upmethodology/VERSION +++ b/Master/texmf-dist/doc/latex/upmethodology/VERSION @@ -1 +1 @@ -upmethodology-20090429 +upmethodology-20091103 diff --git a/Master/texmf-dist/doc/latex/upmethodology/logo.jpg b/Master/texmf-dist/doc/latex/upmethodology/arakhne_org_logo.jpg Binary files differindex 896e75bfd8c..896e75bfd8c 100644 --- a/Master/texmf-dist/doc/latex/upmethodology/logo.jpg +++ b/Master/texmf-dist/doc/latex/upmethodology/arakhne_org_logo.jpg diff --git a/Master/texmf-dist/doc/latex/upmethodology/caution.png b/Master/texmf-dist/doc/latex/upmethodology/caution.png Binary files differnew file mode 100644 index 00000000000..892e28aad57 --- /dev/null +++ b/Master/texmf-dist/doc/latex/upmethodology/caution.png diff --git a/Master/texmf-dist/doc/latex/upmethodology/frontclassic.jpg b/Master/texmf-dist/doc/latex/upmethodology/frontclassic.jpg Binary files differindex 74ef480cc1a..e0a183a8e9d 100644 --- a/Master/texmf-dist/doc/latex/upmethodology/frontclassic.jpg +++ b/Master/texmf-dist/doc/latex/upmethodology/frontclassic.jpg diff --git a/Master/texmf-dist/doc/latex/upmethodology/info.png b/Master/texmf-dist/doc/latex/upmethodology/info.png Binary files differnew file mode 100644 index 00000000000..ea470f49afa --- /dev/null +++ b/Master/texmf-dist/doc/latex/upmethodology/info.png diff --git a/Master/texmf-dist/doc/latex/upmethodology/question.png b/Master/texmf-dist/doc/latex/upmethodology/question.png Binary files differnew file mode 100644 index 00000000000..a959004aa73 --- /dev/null +++ b/Master/texmf-dist/doc/latex/upmethodology/question.png diff --git a/Master/texmf-dist/doc/latex/upmethodology/smalllogo.jpg b/Master/texmf-dist/doc/latex/upmethodology/small_arakhne_org_logo.jpg Binary files differindex ec992154187..ec992154187 100644 --- a/Master/texmf-dist/doc/latex/upmethodology/smalllogo.jpg +++ b/Master/texmf-dist/doc/latex/upmethodology/small_arakhne_org_logo.jpg diff --git a/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.pdf b/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.pdf Binary files differindex 013ef3d3712..cb82110e3a9 100644 --- a/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.pdf +++ b/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.pdf diff --git a/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex b/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex index 49377bd8367..44b651927c9 100644 --- a/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex +++ b/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex @@ -1,33 +1,55 @@ -\documentclass[oneside]{upmethodology-document} +\documentclass[book]{upmethodology-document} -\usepackage{upmethodology-task} -\usepackage{upmethodology-code} -\usepackage{upmethodology-spec} +\setfrontcover{classic} +%\UseExtension{setlab} -%\setfrontlayout{modern} - -\declaredocument{\LaTeX\ Packages for the Unified Process Methodology}{Official Documentation}{UPM-2007-01} +\declaredocument{\LaTeX\ Packages for Unified Process Methodology}{Official Documentation}{UPM-2007-01} \initialversion[1.0]{\makedate{11}{04}{2006}}{First release of this example}{\upmpublic} -\incversion{\makedate{19}{04}{2006}}{Add the mtabular and mtable environments}{\upmpublic} -\incversion{\makedate{27}{04}{2006}}{Add the package upmethodology-code}{\upmpublic} -\incversion{\makedate{13}{04}{2007}}{Update the upmethodology-fmt package\newline Adding commands for informed people}{\upmpublic} -\incversion{\makedate{02}{07}{2007}}{Update the upmethodology-fmt package\newline Adding symbols and text formatting functions\newline Updating footnote functions}{\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} + +\addauthorvalidator*[galland@arakhne.org]{St{\'e}phane}{Galland}{Original Author} -\addauthorvalidator[galland@arakhne.org]{St{\'e}phane}{Galland} +\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 Systems and Transport laboratory and is distributed by the \arakhneorg website.} \makeatletter \let\VERversion\upm@package@version@ver \let\VERfmt\upm@package@fmt@ver \let\VERdoc\upm@package@doc@ver \let\VERfp\upm@package@fp@ver +\let\VERbp\upm@package@bp@ver +\let\VERext\upm@package@ext@ver \let\VERtask\upm@package@task@ver \let\VERdocclazz\upm@package@docclazz@ver \let\VERcode\upm@package@code@ver \makeatother +\setpublisher{Arakhn\^e.org Group} +\setcopyrighter{St\'ephane GALLAND} +\setprintingaddress{France} +\defupmlogo{arakhne_org_logo} +\defupmsmalllogo{small_arakhne_org_logo} + +%\tracingmacros=2 +%\tracingcommands=1 + \begin{document} \tableofcontents @@ -40,19 +62,253 @@ \chapter{Introduction} -This set of package permits to write documents according to the Unifess Process Methodology. It was initially wittren by St\'ephane \textsc{Galland} from the Systems and Transport laboratory\footnote{University of Technology of Belfort-Montb{\'e}liard, France, \href{http://set.utbm.fr/}{http://set.utbm.fr/}}. +This set of package permits to write documents according to Unified Process Methodology. It was initially wittren by St\'ephane \textsc{Galland} from Systems and Transport laboratory\savefootnote{Systems and Transport Laboratory, University of Technology of Belfort-Montb{\'e}liard, France, \href{http://set.utbm.fr/}{http://set.utbm.fr/}}{foot:setlab} and is distributed by the \arakhneorg website. -The packages are: +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-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-task.sty}: is the \LaTeXe\xspace package that provides commands to manage project's tasks. +\item \texttt{upmethodology-backpage.sty}: formats and provides a back page for the document; +\item \texttt{upmethodology-task.sty}: is the \LaTeXe\xspace package that provides macros to manage project's tasks. \item \texttt{upmethodology-document.cls}: is the \LaTeXe\xspace class that provides the whole document specification. It is based on \texttt{book} and on the previous packages; -\item \texttt{upmethodology-code.sty}: provides macros for source code formatting. +\item \texttt{upmethodology-code.sty}: provides macros for source code formatting; +\item \texttt{upmethodology-extension.sty}: provides macros for extension mechanism. +\end{itemize} + + +%########################################################### +\part{General User Documentation} + +\chapter{Download and Installation} + +This chapter describes were to download \texttt{tex-upmethodology} and how to install it. + +\section{Download} + +\texttt{tex-upmethodology} is available on the \arakhneorg website: \url{http://www.arakhne.org/tex-upmethodology/}. + +Different types of installation are available: manual installation, Debian packages. + +\section{Manual System-wide Installation} + +To make \texttt{tex-upmethodology} available to all users, copy the content of the \texttt{tex-upmethodology} archive inside one of your system texmf directory, usually one of: +\begin{itemize} +\item \texttt{/usr/share/texmf-texlive/tex/latex/upmethodology}, +\item \texttt{/usr/share/texmf/tex/latex/upmethodology}. +\end{itemize} + +The second is to rebuild the \LaTeX\ databases by invoking on a console (Unix syntax us used): \\ +\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. + +\section{Manual User-wide Installation} + +To make \texttt{tex-upmethodology} available to one user, copy the content of the \texttt{tex-upmethodology} archive inside the \texttt{\$HOME/texmf} directory. + +It is not required to rebuild the system-wide \LaTeX\ databases because the user's texmf are dynamically parsed by the \LaTeX\ distributions. + +\section{Debian Package Installation} + +Debian packages are available on \arakhneorg website: \url{http://www.arakhne.org/download.html}. Please follow the given rules. + +\section{Package Dependencies} + +This section contains the list of all the package dependencies for the \texttt{upmethodology} packages. + +\subsection{upmethdology-backpage.sty} + +\texttt{upmethodology-backpage} package depends on: +\begin{itemize} +\item \texttt{upmethodology-p-common} +\item \texttt{upmethodology-extension} +\end{itemize} + +\subsection{upmethdology-code.sty} + +\texttt{upmethodology-code} package depends on: +\begin{itemize} +\item \texttt{upmethodology-p-common} +\end{itemize} + +\subsection{upmethdology-document.cls} + +\texttt{upmethodology-document} class depends on: +\begin{itemize} +\item \texttt{upmethodology-p-common} +\item \texttt{a4wide} +\item \texttt{fancyhdr} +\item \texttt{upmethodology-document} +\item \texttt{upmethodology-extension} +\item \texttt{upmethodology-frontpage} +\item \texttt{upmethodology-backpage} +\item \texttt{upmethodology-task} +\item \texttt{upmethodology-code} +\item \texttt{upmethodology-spec} +\item \texttt{url} +\item \texttt{hyperref} +\end{itemize} + +\subsection{upmethdology-document.sty} + +\texttt{upmethodology-document} package depends on: +\begin{itemize} +\item \texttt{upmethodology-p-common} +\item \texttt{babel} +\item \texttt{vmargin} +\item \texttt{upmethodology-extension} +\item \texttt{upmethodology-fmt} +\item \texttt{upmethodology-version} +\end{itemize} + +\subsection{upmethdology-extension.sty} + +\texttt{upmethodology-extension} package depends on: +\begin{itemize} +\item \texttt{upmethodology-p-common} +\end{itemize} + +\subsection{upmethdology-fmt.sty} + +\texttt{upmethodology-fmt} package depends on: +\begin{itemize} +\item \texttt{upmethodology-p-common} +\item \texttt{graphicx} +\item \texttt{subfigure} +\item \texttt{tabularx} +\item \texttt{multicol} +\item \texttt{colortbl} +\item \texttt{picinpar} +\item \texttt{amsmath} +\item \texttt{pifont} +\item \texttt{setspace} +\item \texttt{txfonts} +\end{itemize} + +\subsection{upmethdology-frontpage.sty} + +\texttt{upmethodology-frontpage} package depends on: +\begin{itemize} +\item \texttt{upmethodology-p-common} +\item \texttt{upmethodology-extension} +\item \texttt{upmethodology-document} +\end{itemize} + +\subsection{upmethdology-p-common.sty} + +\texttt{upmethodology-p-common} package depends on: +\begin{itemize} +\item \texttt{ifthen} +\item \texttt{xspace} +\item \texttt{color} +\end{itemize} + +\subsection{upmethdology-spec.sty} + +\texttt{upmethodology-spec} package depends on: +\begin{itemize} +\item \texttt{upmethodology-p-common} +\item \texttt{ulem} +\item \texttt{upmethodology-fmt} +\item \texttt{upmethodology-code} +\end{itemize} + +\subsection{upmethdology-task.sty} + +\texttt{upmethodology-task} package depends on: +\begin{itemize} +\item \texttt{upmethodology-p-common} +\item \texttt{upmethodology-version} \end{itemize} +\subsection{upmethdology-version.sty} + +\texttt{upmethodology-version} package depends on: +\begin{itemize} +\item \texttt{upmethodology-p-common} +\item \texttt{upmethodology-fmt} +\end{itemize} + +%########################################################### +\part{Package Documentation} + +\chapter{Class upmethodology-document} + +\begin{center} + \texttt{Version: \VERdocclazz} +\end{center} + +The \LaTeX\ class \texttt{upmethodology-document} provides the basic configuration for a document. According to an option, this class is able to extend the standard \texttt{book}, \texttt{report} or \texttt{article} \LaTeX\ classes. It also include a snipset of the other \texttt{upmethdology} packages. + +\section{Types of documents}\label{section:documentclass:doctype} + +\texttt{upmethodology-document} supports three special options which permits to set the type of document: +\begin{itemize} +\item \texttt{book}: A book-specification is a two-sided document composed of parts and chapters, and with a copyright page and document information page. This option indicates to \texttt{upmethodology-document} to load the \LaTeX\ standard \texttt{book} class. In addition the \texttt{{\textbackslash}part} and \texttt{{\textbackslash}chapter} macros are supported, and the following macros are automatically expanded: \texttt{{\textbackslash}makefrontcover}, \texttt{{\textbackslash}upmpublicationpage}, \texttt{{\textbackslash}upmdocumentsummary}, \texttt{{\textbackslash}makebackcover}. This behaviour may be overridden by the other class options. + +\item \texttt{report}: A report-specification is a one-sided document composed of chapters (no part), and with a document information page. This option indicates to \texttt{upmethodology-document} to load the \LaTeX\ standard \texttt{report} class. In addition the \texttt{{\textbackslash}part} macro is ignored\savefootnote{The macro is redefined to print a warning message when used, no error message is generated.}{ignoretexmacro} and \texttt{{\textbackslash}chapter} macro is supported, and the following macros are automatically expanded: \texttt{{\textbackslash}makefrontcover}, \texttt{{\textbackslash}upmdocumentsummary}, \texttt{{\textbackslash}makebackcover}. This behaviour may be overridden by the other class options. + +\item \texttt{article}: An article-specification is a one-sided document composed of sections (no part nor chapter). This option indicates to \texttt{upmethodology-document} to load the \LaTeX\ standard \texttt{article} class. In addition the \texttt{{\textbackslash}part}and \texttt{{\textbackslash}chapter} macros are ignored\reffootnote{ignoretexmacro}, and the following macros are automatically expanded: \texttt{{\textbackslash}makefrontcover}, \texttt{{\textbackslash}makebackcover}. This behaviour may be overridden by the other class options. + +\end{itemize} + +\section{Class options} + +Table~\tabref{documentclassoptions} contains the options supported by \texttt{upmethodology-document}. Any option not explicitely supported by the class is directly pass to the underlying standard \LaTeX\ class (\texttt{book}, \texttt{report} or \texttt{article} according to the type of document, see~\ref{section:documentclass:doctype}). + +\begin{mtable}{\linewidth}{2}{|l|X|}{Options of \texttt{upmethodology-document} class}{documentclassoptions} +\captionastitle +\tabularheader{Option}{Explanation} + +\hline + +book & see section~\ref{section:documentclass:doctype}. \\ +\hline +report & see section~\ref{section:documentclass:doctype}. \\ +\hline +article & see section~\ref{section:documentclass:doctype}. \\ + +\hline\hline + +oneside & the document is generated assuming that each page will be printed on its recto side. This option overrides any previous occurrence of \texttt{twoside} option. \\ +\hline +twoside & the document is generated assuming that each page will be printed on both recto and verso sides. This option overrides any previous occurrence of \texttt{oneside} option. \\ + +\hline\hline + +francais & same as \texttt{french}. \\ +\hline +french & the document is written in French. \texttt{upmethodology} packages use the French translations for the generated texts. This option overrides any previous occurrence of \texttt{english} option. \\ +\hline +english & the document is written in English. \texttt{upmethodology} packages use the English translations for the generated texts. This option overrides any previous occurrence of \texttt{french} option. \\ + +\hline\hline + +documentinfo & invoke \texttt{{\textbackslash}upmdocumentsummary}, \texttt{{\textbackslash}upmdocumentauthors}, \texttt{{\textbackslash}upmdocumentvalidators}, \texttt{{\textbackslash}upmdocumentinformedpeople}, and \texttt{{\textbackslash}upmhistory} macros at the begining of the document. This option overrides any previous occurrence of \texttt{nodocumentinfo} option. \\ +\hline +nodocumentinfo & do not invoke \texttt{{\textbackslash}upmdocumentsummary}, \texttt{{\textbackslash}upmdocumentauthors}, \texttt{{\textbackslash}upmdocumentvalidators}, \texttt{{\textbackslash}upmdocumentinformedpeople}, nor \texttt{{\textbackslash}upmhistory} macros at the begining of the document. This option overrides any previous occurrence of \texttt{documentinfo} option. \\ + +\hline\hline + +pubpage & invoke \texttt{{\textbackslash}upmpublicationpage} macro at the begining of the document. This option overrides any previous occurrence of \texttt{nopubpage} option. \\ +\hline +nopubpage & do not invoke \texttt{{\textbackslash}upmpublicationpage} macro at the begining of the document. This option overrides any +previous occurrence of \texttt{pubpage} option. \\ + +\hline +\end{mtable} + +\section{Additional Features} + +\texttt{upmethodology-document} provides a constant behaviour for all types of document: +\begin{itemize} +\item \texttt{hyperref} is loaded and set with the document informations; +\item \texttt{{\textbackslash}setpdfcolor} is redefined and linked to \texttt{hyperref}; +\item \texttt{fancyhdr} is loaded and default page header and page footer is provided. +\end{itemize} %########################################################### @@ -108,13 +364,13 @@ The package \texttt{upmethodology-version} permits to register revisions for bui \section{Formatted List of Versions} -To obtain a formatted list of versions, you could use the command \texttt{{\textbackslash}upmhistory[width]} which produces: +To obtain a formatted list of versions, you could use the macro \texttt{{\textbackslash}upmhistory[width]} which produces: \upmhistory \section{Localization} -The following commands defines some localized strings used by \texttt{upmethodology-version}: +The following macros defines some localized strings used by \texttt{upmethodology-version}: \begin{itemize} \item \texttt{{\textbackslash}upm@lang@date}: Date; \item \texttt{{\textbackslash}upm@lang@updates}: Updates; @@ -134,13 +390,13 @@ The package \texttt{upmethodology-fmt} provides some usefull facilities to forma \section{Figures} -You could include afigure inside your document with the following commands: \\ +You could include afigure 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 commands 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 command location if possible) or \texttt{H} (at command location); +\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{options}: are the options passed to \texttt{{\textbackslash}includegraphics}; @@ -153,15 +409,15 @@ These two commands permits to include an image in your document.The parameters a 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 commands 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 abose 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\}}. \end{itemize} -The figure~\figref{example:mfigure} page~\figpageref{example:mfigure} is obtained with the command: \texttt{{\textbackslash}mfigure[ht]\{width=.6{\textbackslash}linewidth\}\{slogo\}\{Example of figure inclusion with {\textbackslash}texttt\{\{{\textbackslash}textbackslash\}mfigure\}\}\{example:mfigure\}}. The reference and page reference are obtained with \texttt{{\textbackslash}figref\{example:mfigure\}} and \texttt{{\textbackslash}figpageref\{example:mfigure\}}. +The figure~\figref{example:mfigure} page~\figpageref{example:mfigure} is obtained with the macro: \texttt{{\textbackslash}mfigure[ht]\{width=.6{\textbackslash}linewidth\}\{slogo\}\{Example of figure inclusion with {\textbackslash}texttt\{\{{\textbackslash}textbackslash\}mfigure\}\}\{example:mfigure\}}. The reference and page reference are obtained with \texttt{{\textbackslash}figref\{example:mfigure\}} and \texttt{{\textbackslash}figpageref\{example:mfigure\}}. -\mfigure[ht]{width=.6\linewidth}{logo}{Example of figure inclusion with \texttt{{\textbackslash}mfigure}}{example:mfigure} +\mfigure[ht]{width=.6\linewidth}{arakhne_org_logo}{Example of figure inclusion with \texttt{{\textbackslash}mfigure}}{example:mfigure} \section{Sub-figures} @@ -173,16 +429,16 @@ In some case, it is usefull to put several images inside the same picture, but w ...\\ {\textbackslash}end\{mfigures*\}} \\ -These two commands 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 command location if possible) or \texttt{H} (at command location); +\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{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} -Inside the environment \texttt{{\textbackslash}mfigures[*]}, you could use the command \texttt{{\textbackslash}mfigure} to properly include a subfigure (the first optional parameter is ignored) or you could use the command \texttt{{\textbackslash}msubfigure\{options\}\{file\}\{caption\}}. +Inside the environment \texttt{{\textbackslash}mfigures[*]}, you could use the macro \texttt{{\textbackslash}mfigure} to properly include a subfigure (the first optional parameter is ignored) or you could use the macro \texttt{{\textbackslash}msubfigure\{options\}\{file\}\{caption\}}. The figure~\figref{example:msubfigure} page~\figpageref{example:msubfigure} is obtained with the environment:\\ \texttt{{\textbackslash}begin\{mfigures\}\{Example of subfigures with {\textbackslash}texttt\{mfigures\}\}\{example:msubfigure\}}\\ @@ -194,9 +450,9 @@ The figure~\figref{example:msubfigure} page~\figpageref{example:msubfigure} is o The reference and page reference are obtained with \texttt{{\textbackslash}figref\{example:msubfigure\}} and \texttt{{\textbackslash}figpageref\{example:msubfigure\}}. \begin{mfigures}{Example of subfigures with \texttt{mfigures}}{example:msubfigure} - \mfigure{width=.4\linewidth}{logo}{First subfigure}{example:firstsubfigure} + \mfigure{width=.4\linewidth}{arakhne_org_logo}{First subfigure}{example:firstsubfigure} \hfill - \msubfigure{width=.4\linewidth}{smalllogo}{Second subfigure} + \msubfigure{width=.4\linewidth}{small_arakhne_org_logo}{Second subfigure} \end{mfigures} The references to the subfigures could be obtained in two way:\nopagebreak\begin{itemize} @@ -204,20 +460,20 @@ The references to the subfigures could be obtained in two way:\nopagebreak\begin \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 commands} +\section{Figures with embedded \TeX\xspace macros} -In several case it is usefull to include \TeX\xspace commands inside a figure. It is possible with the files \texttt{.pstex} exporting from a software such as \texttt{xfig}. +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 command inside your figure, follows the steps: +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 commands, define the expressions to put in the figure. This action must be done with one of the commands: +\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 commands: \\ +\item in \LaTeX, include the figure with one of the macros: \\ \texttt{{\textbackslash}mfigurewtex[position]\{width\}\{filename\}\{caption\}\{label\}} \\ \texttt{{\textbackslash}mfigurewtex*[position]\{width\}\{filename\}\{caption\}\{label\}} \end{enumerate} @@ -240,10 +496,10 @@ 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 command permits to define the title of the tabular. It uses the colors \texttt{backtableheader} and \texttt{fronttableheader} for the background and the foreground respectively; + 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; \item \texttt{{\textbackslash}tabularheader\{$header_1$\}...\{$header_n$\}} \\ - this command 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 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. \end{itemize} The following example of table is obtained by: \\ @@ -303,16 +559,16 @@ The table~\tabref{example:mtable} page~\tabpageref{example:mtable} is an illustr e & f & g & h \\ \end{mtable} -The command \texttt{{\textbackslash}captionastitle} is equivalent to a call to the macro \texttt{{\textbackslash}tabulartitle} with the caption in parameter. +The macro \texttt{{\textbackslash}captionastitle} is equivalent to a call to the macro \texttt{{\textbackslash}tabulartitle} with the caption in parameter. \section{Enumerations} -The package \texttt{upmethodology-fmt} provides a set of commands dedicated to enumeration lists. +The package \texttt{upmethodology-fmt} provides a set of macros dedicated to enumeration lists. \subsection{Enumeration Counters} -Sometimes it is usefull to start an enumeration list from a specifical given number. This package provides several commands for saving and restoring the counter use by the enumeration lists. +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. Caution: only once counter could be saved at a given time. @@ -348,7 +604,7 @@ And it is produced by the \LaTeX~code: \\ \section{Footnotes} -The package \texttt{upmethodology-fmt} provides a set of commands allowing to save the reference number of a footnote and to recall this reference many time as required. +The package \texttt{upmethodology-fmt} provides a set of macros allowing to save the reference number of a footnote and to recall this reference many time as required. \begin{itemize} \item \texttt{{\textbackslash}savefootnote\{footnote text\}\{footnote id\}} \\ @@ -356,13 +612,19 @@ The package \texttt{upmethodology-fmt} provides a set of commands allowing to sa Example: \texttt{{\textbackslash}savefootnote\{This is an example of a recallable footnote\}\{footrecalla\}}\savefootnote{This is an example of a recallable footnote}{footrecalla}; \item \texttt{{\textbackslash}savefootnote*\{footnote text\}\{footnote id\}} \\ mark a footnote with the corresponding label but do not put in the current page. \\ - Example: \texttt{{\textbackslash}savefootnote*\{This is a second example of a recallable footnote\}\{footrecallb\}}\savefootnote*{This is a second example of a recallable footnote}{footrecallb}; + Example 1: \texttt{{\textbackslash}savefootnote*\{This is a second example of a recallable footnote\}\{footrecallb\}}\savefootnote*{This is a second example of a recallable footnote}{footrecallb}; \\ + Example 2: \texttt{{\textbackslash}savefootnote*\{This is a third example of a recallable footnote\}\{footrecallc\}}\savefootnote*{This is a third example of a recallable footnote}{footrecallc}. \item \texttt{{\textbackslash}reffootnote\{footnote id\}} \\ recall the footnote reference without page number. \\ - Example: \texttt{{\textbackslash}reffootnote\{footrecalla\}}\reffootnote{footrecalla}. + Example 1: \texttt{{\textbackslash}reffootnote\{footrecalla\}}\reffootnote{footrecalla}$=B$; \\ + example 2: \texttt{{\textbackslash}reffootnote\{footrecallb\}}\reffootnote{footrecallb}$=A$; \\ + example 4: \texttt{{\textbackslash}reffootnote\{footrecalld\}}\reffootnote{footrecalld}$=?$. \item \texttt{{\textbackslash}reffootnote*\{footnote id\}} \\ recall the footnote reference with the page number if different of the current page. \\ - Example: \texttt{{\textbackslash}reffootnote*\{footrecallb\}}\reffootnote*{footrecallb}. + Example 1: \texttt{{\textbackslash}reffootnote*\{footrecalla\}}\reffootnote*{footrecalla}; \\ + example 2: \texttt{{\textbackslash}reffootnote*\{footrecallb\}}\reffootnote*{footrecallb}; \\ + example 3: \texttt{{\textbackslash}reffootnote*\{footrecallc\}}\reffootnote*{footrecallc}; \\ + example 4: \texttt{{\textbackslash}reffootnote*\{footrecalld\}}\reffootnote*{footrecalld}. \end{itemize} \section{UML diagrams on the side of paragraphs} @@ -374,7 +636,7 @@ The package \texttt{upmethodology-fmt} provides an environment which permits to put the specified picture on the side of the given text. The optional parameter \texttt{width} corresponds to the desired width ofthe picture. By default it is \texttt{.5{\textbackslash}linewidth}. \end{itemize} -\begin{umlinpar}{smalllogo} +\begin{umlinpar}{small_arakhne_org_logo} This paragraph is an typical example of the usage of the environment \texttt{umlinpar}. To obtain it, the following \LaTeX\ code was typed: \\ \texttt{{\textbackslash}begin\{umlinpar\}\{smalllogo\}}Â \\ \texttt{This paragraph is an typical example of the usage of the environment {\textbackslash}texttt\{umlinpar\}.} \\ @@ -412,7 +674,7 @@ extract the day field from a date respecting the localized date format. \section{Text formatting} -The package \texttt{upmethodology-fmt} provides a set of commands to format the text. +The package \texttt{upmethodology-fmt} provides a set of macros to format the text. \begin{itemize} \item \texttt{{\textbackslash}textsup\{text\}} \\ @@ -422,10 +684,49 @@ The package \texttt{upmethodology-fmt} provides a set of commands to format the put a text as indice in text mode instead of the basic \LaTeX indice in math mode. \\ Example: \texttt{{\textbackslash}textsub\{this is an indice\}}\textsub{this is an indice}; \item \texttt{{\textbackslash}makename[von]\{first name\}\{last name\}} \\ - format the specified peoople name components according to the document standards. By default, the format \texttt{first von last} is used. \\ - Example: \texttt{{\textbackslash}makename\{St\'ephane\}\{Galland\}}, \makename{St\'ephane}{Galland}; + format the specified people name components according to the document standards. By default, the format \texttt{first von last} is used. \\ + Example: \texttt{{\textbackslash}makename[von]\{Ludwig Otto Frederik Wilhelm\}\{Wittelsbach\}},\\ + ``\makename[von]{Ludwig Otto Frederik Wilhelm}{Wittelsbach}''; +\item \texttt{{\textbackslash}upmmakename[von]\{first name\}\{last name\}\{separator\}} \\ + format the specified people name components according to the document standards. By default, the format \texttt{first von last} is used. \\ + Example: \texttt{{\textbackslash}upmmakename[von]\{Ludwig Otto Frederik Wilhelm\}\{Wittelsbach\}\{/\}}, \\ + ``\upmmakename[von]{Ludwig Otto Frederik Wilhelm}{Wittelsbach}{/}''; +\item \texttt{{\textbackslash}prname[von]\{first name\}\{last name\}} \\ + \texttt{{\textbackslash}prname*[von]\{first name\}\{last name\}} \\ + format the specified people name components according to the document standards for \emph{Professor} title. By default, the format \texttt{first von last} is used. The star-ed version is post-fixed, the non-star-ed version is prefixed. \\ + Example 1: \texttt{{\textbackslash}prname\{Pierre\}\{Martin\}}, ``\prname{Pierre}{Martin}''; \\ + Example 2: \texttt{{\textbackslash}prname*\{Pierre\}\{Martin\}}, ``\prname*{Pierre}{Martin}''; +\item \texttt{{\textbackslash}drname[von]\{first name\}\{last name\}} \\ + \texttt{{\textbackslash}drname*[von]\{first name\}\{last name\}} \\ + format the specified people name components according to the document standards for \emph{Doctor} title. By default, the format \texttt{first von last} is used. The star-ed version is post-fixed, the non-star-ed version is prefixed. \\ + Example 1: \texttt{{\textbackslash}drname\{Pierre\}\{Martin\}}, ``\drname{Pierre}{Martin}''; \\ + Example 2: \texttt{{\textbackslash}drname*\{Pierre\}\{Martin\}}, ``\drname*{Pierre}{Martin}''; +\item \texttt{{\textbackslash}phdname[von]\{first name\}\{last name\}} \\ + \texttt{{\textbackslash}phdname*[von]\{first name\}\{last name\}} \\ + format the specified people name components according to the document standards for \emph{Philosophi\ae Doctor} title. By default, the format \texttt{first von last} is used. The star-ed version is post-fixed, the non-star-ed version is prefixed. \\ + Example 1: \texttt{{\textbackslash}phdname\{Pierre\}\{Martin\}}, ``\phdname{Pierre}{Martin}''; \\ + Example 2: \texttt{{\textbackslash}phdname*\{Pierre\}\{Martin\}}, ``\phdname*{Pierre}{Martin}''; +\item \texttt{{\textbackslash}scdname[von]\{first name\}\{last name\}} \\ + \texttt{{\textbackslash}scdname*[von]\{first name\}\{last name\}} \\ + format the specified people name components according to the document standards for \emph{Scienti\ae Doctor} title. By default, the format \texttt{first von last} is used. The star-ed version is post-fixed, the non-star-ed version is prefixed. \\ + Example 1: \texttt{{\textbackslash}scdname\{Pierre\}\{Martin\}}, ``\scdname{Pierre}{Martin}''; \\ + Example 2: \texttt{{\textbackslash}scdname*\{Pierre\}\{Martin\}}, ``\scdname*{Pierre}{Martin}''; +\item \texttt{{\textbackslash}mdname[von]\{first name\}\{last name\}} \\ + \texttt{{\textbackslash}mdname*[von]\{first name\}\{last name\}} \\ + format the specified people name components according to the document standards for \emph{Medicin\ae Doctor} title. By default, the format \texttt{first von last} is used. The star-ed version is post-fixed, the non-star-ed version is prefixed. \\ + Example 1: \texttt{{\textbackslash}mdname\{Pierre\}\{Martin\}}, ``\mdname{Pierre}{Martin}''; \\ + Example 2: \texttt{{\textbackslash}mdname*\{Pierre\}\{Martin\}}, ``\mdname*{Pierre}{Martin}''; +\item \texttt{{\textbackslash}pengname[von]\{first name\}\{last name\}} \\ + \texttt{{\textbackslash}pengname*[von]\{first name\}\{last name\}} \\ + format the specified people name components according to the document standards for \emph{Professional/Chartered Engineer} title. By default, the format \texttt{first von last} is used. The star-ed version is post-fixed, the non-star-ed version is prefixed. \\ + Example 1: \texttt{{\textbackslash}pengname\{Pierre\}\{Martin\}}, ``\pengname{Pierre}{Martin}''; \\ + Example 2: \texttt{{\textbackslash}pengname*\{Pierre\}\{Martin\}}, ``\pengname*{Pierre}{Martin}''; +\item \texttt{{\textbackslash}iengname[von]\{first name\}\{last name\}} \\ + \texttt{{\textbackslash}iengname*[von]\{first name\}\{last name\}} \\ + format the specified people name components according to the document standards for \emph{Incorporated Engineer} title. By default, the format \texttt{first von last} is used. The star-ed version is post-fixed, the non-star-ed version is prefixed. \\ + Example 1: \texttt{{\textbackslash}iengname\{Pierre\}\{Martin\}}, ``\iengname{Pierre}{Martin}''; \\ + Example 2: \texttt{{\textbackslash}iengname*\{Pierre\}\{Martin\}}, ``\iengname*{Pierre}{Martin}''. \end{itemize} - \section{Symbols} The package \texttt{upmethodology-fmt} provides several symbols described inside the table~\ref{tab:symbols}. @@ -434,16 +735,17 @@ The package \texttt{upmethodology-fmt} provides several symbols described inside \begin{center} \begin{tabular}{|>{\ttfamily}l|l|} \hline + {\textbackslash}arakhneorg & \arakhneorg \\ {\textbackslash}copyright & \copyright \\ {\textbackslash}trademark & \trademark \\ {\textbackslash}regmark & \regmark \\ {\textbackslash}smalltrade & \smalltrade \\ {\textbackslash}smallreg & \smallreg \\ {\textbackslash}smallcopy & \smallcopy \\ - {\textbackslash}st & \st \\ - {\textbackslash}nd & \nd \\ - {\textbackslash}rd & \rd \\ - {\textbackslash}th & \th \\ + {\textbackslash}ust & \ust \\ + {\textbackslash}und & \und \\ + {\textbackslash}urd & \urd \\ + {\textbackslash}uth & \uth \\ \hline \end{tabular} \end{center} @@ -453,7 +755,7 @@ The package \texttt{upmethodology-fmt} provides several symbols described inside \section{Bibliography} -The package \texttt{upmethodology-fmt} provides a set of commands allowing to manage the bibliography. The default bibliography style is \texttt{abbr}. +The package \texttt{upmethodology-fmt} provides a set of macros allowing to manage the bibliography. The default bibliography style is \texttt{abbr}. \begin{itemize} \item \texttt{{\textbackslash}bibliographystyle\{style\}} \\ @@ -464,9 +766,107 @@ The package \texttt{upmethodology-fmt} provides a set of commands allowing to ma Example: \texttt{{\textbackslash}bibliography\{mybib\}}; \item \texttt{{\textbackslash}bibsize\{size\}} \\ set the font size used for the bibliography section. \\ - Example: \texttt{{\textbackslash}bibsize\{\Huge\}}; + Example: \texttt{{\textbackslash}bibsize\{{\textbackslash}Huge\}}; \end{itemize} +\section{Framed Mini Pages} + +Standard \LaTeX\ distribution provides the \texttt{minipage} environment. This environment permits to put a small piece of page inside your document. Package \texttt{upmethodology-fmt} provides a framed extension of the original \texttt{minipage} environment: +\par +\begin{tabularx}{\linewidth}{XX} +\texttt{{\textbackslash}begin\{framedminipage\}{[}{\textbackslash}linewidth{]}} \newline +\texttt{This is an example of a framed minipage.} \newline +\texttt{{\textbackslash}end\{framedminipage\}} +& +\begin{framedminipage}{\linewidth}This is an example of a framed minipage.\end{framedminipage} +\\ +\end{tabularx} + +\section{Message Boxes} + +The package \texttt{upmethodology-fmt} provides a set of environment to put emphasis message boxes in the text. Three types of boxes are supported: caution, information, and question. + +\par +\begin{tabularx}{\linewidth}{XX} + +\texttt{{\textbackslash}begin\{upmcaution\}{[}width{]}} \newline +\texttt{This is an example of a caution message. This text must be rendered with enough height (usually 2 lines of text) to avoid intersection between the caution icon and the box frame.} \newline +\texttt{{\textbackslash}end\{upmcaution\}} +& +\begin{upmcaution}This is an example of a caution message. This text must be rendered with enough height (usually 2 lines of text) to avoid intersection between the caution icon and the box frame.\end{upmcaution} +\\ + +\texttt{{\textbackslash}begin\{upminfo\}{[}width{]}} \newline +\texttt{This is an example of an information message. This text must be rendered with enough height (usually 2 lines of text) to avoid intersection between the caution icon and the box frame.} \newline +\texttt{{\textbackslash}end\{upminfo\}} +& +\begin{upminfo}This is an example of an information message. This text must be rendered with enough height (usually 2 lines of text) to avoid intersection between the caution icon and the box frame.\end{upminfo} +\\ + +\texttt{{\textbackslash}begin\{upmquestion\}{[}width{]}} \newline +\texttt{This is an example of a question message. This text must be rendered with enough height (usually 2 lines of text) to avoid intersection between the caution icon and the box frame.} \newline +\texttt{{\textbackslash}end\{upmquestion\}} +& +\begin{upmquestion}This is an example of a question message. This text must be rendered with enough height (usually 2 lines of text) to avoid intersection between the caution icon and the box frame.\end{upmquestion} +\\ + +\end{tabularx} + +\section{Additional Document Sectionning Macros} + +The package \texttt{upmethodology-fmt} provides several macros that permit to create special sections. + +\subsection{Non-numbered Part in Table of Content} + +If you want to add a document part that has no part number but appearing inside the table of content, the classical \LaTeX\ macros \texttt{{\textbackslash}part} and \texttt{{\textbackslash}part*} are inefficient. Indeed, \texttt{{\textbackslash}part} is adding a numbered part inside the table of content, and \texttt{{\textbackslash}part*} is adding an unnumbered part but not inside the table of content. + +To add a unnumbered part inside the table of content, you could use one of the macros: \\ +\texttt{{\textbackslash}parttoc[toctitle]\{title\}} \\ +\texttt{{\textbackslash}parttoc*[toctitle]\{title\}} + +The macros \texttt{{\textbackslash}parttoc} and \texttt{{\textbackslash}parttoc*} have the same effect except that \texttt{{\textbackslash}parttoc*} aligns the part's title to the other numbered parts' titles; and \texttt{{\textbackslash}parttoc} not. + +\subsection{Non-numbered Chapter in Table of Content} + +If you want to add a document chapter that has no chapter number but appearing inside the table of content, the classical \LaTeX\ macros \texttt{{\textbackslash}chapter} and \texttt{{\textbackslash}chapter*} are inefficient. Indeed, \texttt{{\textbackslash}chapter} is adding a numbered chapter inside the table of content, and \texttt{{\textbackslash}chapter*} is adding an unnumbered chapter but not inside the table of content. + +To add a unnumbered chapter inside the table of content, you could use one of the macros: \\ +\texttt{{\textbackslash}chaptertoc[toctitle]\{title\}} \\ +\texttt{{\textbackslash}chaptertoc*[toctitle]\{title\}} + +The macros \texttt{{\textbackslash}chaptertoc} and \texttt{{\textbackslash}chaptertoc*} have the same effect except that \texttt{{\textbackslash}chaptertoc*} aligns the chapter's title to the other numbered chapters' titles; and \texttt{{\textbackslash}chaptertoc} not. + +\subsection{Non-numbered Section in Table of Content} + +If you want to add a document section that has no a section number but appearing inside the table of content, the classical \LaTeX\ macros \texttt{{\textbackslash}section} and \texttt{{\textbackslash}section*} are inefficient. Indeed, \texttt{{\textbackslash}section} add a numbered section inside the table of content, and \texttt{{\textbackslash}section*} adds an unnumbered section but not inside the table of content. + +To add a unnumbered section inside the table of content, you could use one of the macros: \\ +\texttt{{\textbackslash}sectiontoc[toctitle]\{title\}} \\ +\texttt{{\textbackslash}sectiontoc*[toctitle]\{title\}} + +The macros \texttt{{\textbackslash}sectiontoc} and \texttt{{\textbackslash}sectiontoc*} have the same effect except that \texttt{{\textbackslash}sectiontoc*} aligns the section's title to the other numbered sections' titles; and \texttt{{\textbackslash}sectiontoc} not. + +\subsection{Non-numbered Subsection in Table of Content} + +If you want to add a document subsection that has no subsection number but appearing inside the table of content, the classical \LaTeX\ macros \texttt{{\textbackslash}subsection} and \texttt{{\textbackslash}subsection*} are inefficient. Indeed, \texttt{{\textbackslash}subsection} is adding a numbered subsection inside the table of content, and \texttt{{\textbackslash}subsection*} is adding an unnumbered subsection but not inside the table of content. + +To add a unnumbered subsection inside the table of content, you could use one of the macros: \\ +\texttt{{\textbackslash}subsectiontoc[toctitle]\{title\}} \\ +\texttt{{\textbackslash}subsectiontoc*[toctitle]\{title\}} + +The macros \texttt{{\textbackslash}subsectiontoc} and \texttt{{\textbackslash}subsectiontoc*} have the same effect except that \texttt{{\textbackslash}subsectiontoc*} aligns the subsection's title to the other numbered subsections' titles; and \texttt{{\textbackslash}subsectiontoc} not. + +\subsection{Non-numbered Subsubsection in Table of Content} + +If you want to add a document subsubsection that has no subsubsection number but appearing inside the table of content, the classical \LaTeX\ macros \texttt{{\textbackslash}subsubsection} and \texttt{{\textbackslash}subsubsection*} are inefficient. Indeed, \texttt{{\textbackslash}subsubsection} is adding a numbered subsubsection inside the table of content, and \texttt{{\textbackslash}subsubsection*} is adding an unnumbered subsubsection but not inside the table of content. + +To add a unnumbered subsubsection inside the table of content, you could use one of the macros: \\ +\texttt{{\textbackslash}subsubsectiontoc[toctitle]\{title\}} \\ +\texttt{{\textbackslash}subsubsectiontoc*[toctitle]\{title\}} + +The macros \texttt{{\textbackslash}subsubsectiontoc} and \texttt{{\textbackslash}subsubsectiontoc*} have the same effect except that \texttt{{\textbackslash}subsubsectiontoc*} aligns the subsubsection's title to the other numbered subsubsections' titles; and \texttt{{\textbackslash}subsubsectiontoc} not. + + %########################################################### \chapter{Package upmethodology-document} @@ -499,15 +899,37 @@ where the parameters are: \item \texttt{ref} is the reference number of the document. \end{itemize} +\section{Abstract and Key-words} + +You are able to declare the abstract and the key-words for your document. Both are basically used by the back page package. + +\subsection{Declarations} + +The macro \texttt{{\textbackslash}setdocabstract} is for entering the docment's abstract:\\ +\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:\\ +\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. + +\subsection{Rendering} + +The macro \texttt{{\textbackslash}theupmdocabstract} is expanded with the abstract text:\\ +\texttt{{\textbackslash}theupmdocabstract} + +The macro \texttt{{\textbackslash}theupmdockeywords} is expanded with the key-words:\\ +\texttt{{\textbackslash}theupmdockeywords} + \section{Document Summary} -You can obtain a documet summary with the command \texttt{{\textbackslash}upmdocumentsummary[width]} which produces: +You can obtain a document summary with the macro \texttt{{\textbackslash}upmdocumentsummary{[}width{]}} which produces: \upmdocumentsummary \section{Change Icons} -By default, this package uses the logo of the laboratory Systems and Transport as icons. You could change them with the commands: +By default, this package uses the logo of \arakhneorg as icons. You could change them with the macros: \begin{itemize} \item \texttt{{\textbackslash}defupmsmalllogo\{filename\}} defines the small logo used in the headers for instance; @@ -520,7 +942,9 @@ The logos' filenames are accessible with the functions \texttt{{\textbackslash}t An author is someone who participates to the writing of the document. You could register author identities with: \\ \texttt{{\textbackslash}addauthor[email]\{firstname\}\{name\}} \\ -\texttt{{\textbackslash}addauthorvalidator[email]\{firstname\}\{name\}} +\texttt{{\textbackslash}addauthor*[email]\{firstname\}\{name\}\{comment\}} \\ +\texttt{{\textbackslash}addauthorvalidator[email]\{firstname\}\{name\}} \\ +\texttt{{\textbackslash}addauthorvalidator*[email]\{firstname\}\{name\}\{comment\}} The list of the authors is accessible by two means: \begin{itemize} @@ -534,7 +958,9 @@ The list of the authors is accessible by two means: A validator is someone who participates to the validation of the document. You could register validator identities with: \\ \texttt{{\textbackslash}addvalidator[email]\{firstname\}\{name\}} \\ -\texttt{{\textbackslash}addauthorvalidator[email]\{firstname\}\{name\}} +\texttt{{\textbackslash}addvalidator*[email]\{firstname\}\{name\}\{comment\}} \\ +\texttt{{\textbackslash}addauthorvalidator[email]\{firstname\}\{name\}} \\ +\texttt{{\textbackslash}addauthorvalidator*[email]\{firstname\}\{name\}\{comment\}} The list of the validators is accessible by two means: \begin{itemize} @@ -547,7 +973,8 @@ The list of the validators is accessible by two means: \section{Informed People} An informed people is someone who receives the document to be informed about its content. You could register informed people identities with: \\ -\texttt{{\textbackslash}addinformed[email]\{firstname\}\{name\}} +\texttt{{\textbackslash}addinformed[email]\{firstname\}\{name\}} \\ +\texttt{{\textbackslash}addinformed*[email]\{firstname\}\{name\}\{comment\}} The list of the informed people is accessible by two means: \begin{itemize} @@ -557,63 +984,53 @@ The list of the informed people is accessible by two means: \upmdocumentinformedpeople -\section{Document Sectionning} - -The package \texttt{upmethodology-document} provides several commands that permit to create special sections: - -\subsection{Part Sectionning} - -If you want to add a document part that has no a part number but appearing inside the table of content, the classical \LaTeX\ commands \texttt{{\textbackslash}part} and \texttt{{\textbackslash}part*} are inefficient. Indeed, \texttt{{\textbackslash}part} add a numbered part inside the table of content, and \texttt{{\textbackslash}part*} adds an unnumbered part but not inside the table of content. - -To add a unnumbered part inside the table of content, you could use one of the commands: \\ -\texttt{{\textbackslash}parttoc[toctitle]\{title\}} \\ -\texttt{{\textbackslash}parttoc*[toctitle]\{title\}} - -The commands \texttt{{\textbackslash}parttoc} and \texttt{{\textbackslash}parttoc*} have the same effect except that \texttt{{\textbackslash}parttoc*} aligns the part's title to the other numbered parts' titles; and \texttt{{\textbackslash}parttoc} not. - -\subsection{Chapter Sectionning} +\section{Copyright and Publication Information} -If you want to add a document chapter that has no a chapter number but appearing inside the table of content, the classical \LaTeX\ commands \texttt{{\textbackslash}chapter} and \texttt{{\textbackslash}chapter*} are inefficient. Indeed, \texttt{{\textbackslash}chapter} add a numbered chapter inside the table of content, and \texttt{{\textbackslash}chapter*} adds an unnumbered chapter but not inside the table of content. +Package \texttt{upmethodology-document} provides several macros to define the copyright owner and the publication informations required to generate a publication page. -To add a unnumbered chapter inside the table of content, you could use one of the commands: \\ -\texttt{{\textbackslash}chaptertoc[toctitle]\{title\}} \\ -\texttt{{\textbackslash}chaptertoc*[toctitle]\{title\}} +\subsection{Setting Information} -The commands \texttt{{\textbackslash}chaptertoc} and \texttt{{\textbackslash}chaptertoc*} have the same effect except that \texttt{{\textbackslash}chaptertoc*} aligns the chapter's title to the other numbered chapters' titles; and \texttt{{\textbackslash}chaptertoc} not. +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: \\ +\texttt{{\textbackslash}setcopyrighter\{name\}}\\ -\subsection{Section Sectionning} +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\}}\\ -If you want to add a document section that has no a section number but appearing inside the table of content, the classical \LaTeX\ commands \texttt{{\textbackslash}section} and \texttt{{\textbackslash}section*} are inefficient. Indeed, \texttt{{\textbackslash}section} add a numbered section inside the table of content, and \texttt{{\textbackslash}section*} adds an unnumbered section but not inside the table of content. +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: \\ +\texttt{{\textbackslash}setprintingaddress\{address\}}\\ -To add a unnumbered section inside the table of content, you could use one of the commands: \\ -\texttt{{\textbackslash}sectiontoc[toctitle]\{title\}} \\ -\texttt{{\textbackslash}sectiontoc*[toctitle]\{title\}} +Publications may be identifier by international identifiers. Package \texttt{upmethodology-document} supports ISBN, ISSN and DOI: +\texttt{{\textbackslash}setisbn\{number\}}\\ +\texttt{{\textbackslash}setissn\{number\}}\\ +\texttt{{\textbackslash}setdoi\{number\}}\\ -The commands \texttt{{\textbackslash}sectiontoc} and \texttt{{\textbackslash}sectiontoc*} have the same effect except that \texttt{{\textbackslash}sectiontoc*} aligns the section's title to the other numbered sections' titles; and \texttt{{\textbackslash}sectiontoc} not. +\subsection{Retreiving Information} -\subsection{Subsection Sectionning} +The information set by the macros described in the previous section may be retreived with the following macros: \\ +\texttt{{\textbackslash}theupmcopyrighter}\\ +\texttt{{\textbackslash}theupmpublisher}\\ +\texttt{{\textbackslash}theupmprintedin}\\ +\texttt{{\textbackslash}theupmisbn}\\ +\texttt{{\textbackslash}theupmissn}\\ +\texttt{{\textbackslash}theupmdoi}\\ -If you want to add a document subsection that has no a subsection number but appearing inside the table of content, the classical \LaTeX\ commands \texttt{{\textbackslash}subsection} and \texttt{{\textbackslash}subsection*} are inefficient. Indeed, \texttt{{\textbackslash}subsection} add a numbered subsection inside the table of content, and \texttt{{\textbackslash}subsection*} adds an unnumbered subsection but not inside the table of content. +\subsection{Publication Page} -To add a unnumbered subsection inside the table of content, you could use one of the commands: \\ -\texttt{{\textbackslash}subsectiontoc[toctitle]\{title\}} \\ -\texttt{{\textbackslash}subsectiontoc*[toctitle]\{title\}} +The package \texttt{upmethodology-document} provides the \texttt{{\textbackslash}upmpublicationpage} macro which is displaying a empty page with publication informations and optionally set the page number (default value is $-1$). Figure~\ref{fig:publication:page} illustrates the publication page of this document. -The commands \texttt{{\textbackslash}subsectiontoc} and \texttt{{\textbackslash}subsectiontoc*} have the same effect except that \texttt{{\textbackslash}subsectiontoc*} aligns the subsection's title to the other numbered subsections' titles; and \texttt{{\textbackslash}subsectiontoc} not. - -\subsection{Subsubsection Sectionning} - -If you want to add a document subsubsection that has no a subsubsection number but appearing inside the table of content, the classical \LaTeX\ commands \texttt{{\textbackslash}subsubsection} and \texttt{{\textbackslash}subsubsection*} are inefficient. Indeed, \texttt{{\textbackslash}subsubsection} add a numbered subsubsection inside the table of content, and \texttt{{\textbackslash}subsubsection*} adds an unnumbered subsubsection but not inside the table of content. - -To add a unnumbered subsubsection inside the table of content, you could use one of the commands: \\ -\texttt{{\textbackslash}subsubsectiontoc[toctitle]\{title\}} \\ -\texttt{{\textbackslash}subsubsectiontoc*[toctitle]\{title\}} - -The commands \texttt{{\textbackslash}subsubsectiontoc} and \texttt{{\textbackslash}subsubsectiontoc*} have the same effect except that \texttt{{\textbackslash}subsubsectiontoc*} aligns the subsubsection's title to the other numbered subsubsections' titles; and \texttt{{\textbackslash}subsubsectiontoc} not. +\begin{figure} + \begin{center} + \begin{framedminipage}{.8\linewidth} + \upmpublicationminipage % in place of \upmpublicationpage to avod page number and page style changes + \end{framedminipage} + \caption{Example of Publication Page generated with \texttt{{\textbackslash}upmpublicationpage}} + \label{fig:publication:page} + \end{center} +\end{figure} \section{Localization} -The following commands defines some localized strings used by \texttt{upmethodology-document}: +The following macros defines some localized strings used by \texttt{upmethodology-document}: \begin{itemize} \item \texttt{{\textbackslash}upm@lang@project}: Project; \item \texttt{{\textbackslash}upm@lang@document}: Document; @@ -624,7 +1041,9 @@ The following commands defines some localized strings used by \texttt{upmethodol \item \texttt{{\textbackslash}upm@lang@document@validators}: Validators; \item \texttt{{\textbackslash}upm@lang@document@names}: Names; \item \texttt{{\textbackslash}upm@lang@document@emails}: Emails; -\item \texttt{{\textbackslash}upm@lang@document@initials}: Initials. +\item \texttt{{\textbackslash}upm@lang@document@initials}: Initials; +\item \texttt{{\textbackslash}upm@lang@document@abstract}: Abstract; +\item \texttt{{\textbackslash}upm@lang@document@keywords}: Key-words. \end{itemize} @@ -636,11 +1055,17 @@ The following commands defines some localized strings used by \texttt{upmethodol \texttt{Version: \VERfp} \end{center} -The package \texttt{upmethodology-frontpage} provides an front page for the UP documents. This package does not provides any public function. It is based on all the previous packages. +The \texttt{upmethodology-frontpage} package provides an front page for the UP documents. This package does not provides any public function. It is based on all the previous packages. + +\section{Display the front page} + +The front cover is displayed by invoking one of the following macros: \\ +\texttt{{\textbackslash}maketitle} \\ +\texttt{{\textbackslash}makefrontcover} \\ \section{Change Front Page Layout} -It is possible to change the layout of the front page with the command: \\ +It is possible to change the layout of the front page with the macro: \\ \texttt{{\textbackslash}setfrontlayout\{layout\_name\}}\\ where \texttt{layout\_name} must be one of: \begin{itemize} @@ -660,32 +1085,148 @@ The figure~\figref{frontpage:layout} illustrates the differents layouts. \section{Change Illustration Picture} -It is possible to insert an illustration picture on the front page. You could specify the image with the command: \\ +It is possible to insert an illustration picture on the front page. You could specify the image with the macro: \\ \texttt{{\textbackslash}setfrontillustration[width\_factor]\{filename\}} \\ where: \begin{itemize} -\item \texttt{width\_actor} is the scaling factor of the picture according to the line width. If you specifies \texttt{1} the image will not be scaled, for \texttt{.5} the image will be the half of its original width... +\item \texttt{width\_factor} is the scaling factor of the picture according to the line width. If you specifies \texttt{1} the image will not be scaled, for \texttt{.5} the image will be the half of its original width... \item \texttt{filename} is the name of picture to use as the illustration. \end{itemize} +\section{Define a Front Page in Extensions} + +The \texttt{upmethodology-frontpage} package is able to use a page layout defined in a document extension (see chapter~\ref{section:document:extension} for details on document extension). + +\pagebreak A \LaTeX\ macro must be defined in the \texttt{upmext-NAME.cfg} file of the extension. The name of this macro (for example \texttt{mylayout}) must be set with the \texttt{{\textbackslash}set} macro in the same file:\\ +\texttt{{\textbackslash}set\{frontpage\}\{mylayout\}}\\ + \section{Localization} -The following commands defines some localized strings used by \texttt{upmethodology-frontpage}: +The following macros defines some localized strings used by \texttt{upmethodology-frontpage}: \begin{itemize} \item \texttt{{\textbackslash}upm@lang@front@authors}: Authors; \end{itemize} %########################################################### +\chapter{Package upmethodology-backpage} + +\begin{center} + \texttt{Version: \VERbp} +\end{center} + +The package \texttt{upmethodology-backpage} provides an back page for the UP documents. This package does not provides any public function. It is based on all the previous packages. + +\section{Display the back page} + +The back cover is displayed by invoking the following macro: \\ +\texttt{{\textbackslash}makebackcover} \\ + +\section{Change Back Page Layout} + +It is possible to change the layout of the back page with the macro: \\ +\texttt{{\textbackslash}setbacklayout\{layout\_name\}}\\ +where \texttt{layout\_name} must be one of: +\begin{itemize} +\item \texttt{none}: no back page. +\end{itemize} + +\section{Define a Back Page in Extensions} + +The \texttt{upmethodology-backpage} package is able to use a page layout defined in a document extension (see chapter~\ref{section:document:extension} for details on document extension). + +A \LaTeX\ macro must be defined in the \texttt{upmext-NAME.cfg} file of the extension. The name of this macro (for example \texttt{mylayout}) must be set with the \texttt{{\textbackslash}set} macro in the same file:\\ +\texttt{{\textbackslash}set\{backpage\}\{mylayout\}}\\ + + +%########################################################### + +\chapter{Package upmethodology-extension}\label{section:document:extension} + +\begin{center} + \texttt{Version: \VERext} +\end{center} + +The package \texttt{upmethodology-extension} provides tools to create layout and rendering extensions. +It is possible to write an extension to the \texttt{upmethodology-document} package. An extension is able to override several values from the default \texttt{upmethodology-}packages or may be used by the other suite's packages. For example, the Systems and Transport laboratory\reffootnote*{foot:setlab} extension is providing laboratory's icons, publisher's name and page layouts. + +\section{Load a Document Extension} + +To load and use a document extension, you must invoke the macro:\\ +\texttt{{\textbackslash}upmuse\{extension\_name\}}\\ +where \texttt{extension\_name} is the identifier of the extension to load. The extension's files must be inside your \LaTeX\ search path. + +\section{Write a Document Extension} + +An document extension must be written and described inside a file named \texttt{upmext-NAME.cfg}, where \texttt{NAME} is the name of the extension. This file must be put in your \LaTeX\ search path. + +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: \\ +\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}''). +This macro also declares the \texttt{trademarks} value which contains the trademark and other related informations about the extension (for this documentation ``\Get{trademarks}''). + +Additional macros are provided to redefine the \texttt{upmethodology-document} constants:\\ +\texttt{{\textbackslash}Set{[}lang{]}\{variable\_name\}\{value\}}\\ + +The \texttt{variable\_name} is the name of the value to override. It must be taken in one of the names listed in table~\tabref{documentextension:names:set}. The \texttt{lang} parameter is a language identifier. It is used to restrict the definition to a specific language. If not given, the default language is used insteed. The \texttt{image\_name} and \texttt{image\_scale} are the name of the image file and the scaling factor respectively. + +\begin{mtable}{\linewidth}{2}{lX}{List of overiddable value names}{documentextension:names:set} + \tabularheader{Value Name}{Description} + \hline + logo & the filename of the picutre which must be used as a large logo. \\ + \hline + smalllogo & the filename of the picutre 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 + publisher & the name of the document's publisher. The \texttt{lang} parameter is supported. \\ + \hline + printedin & the location/address where this document is printed. \\ + \hline + frontillustration & the image to use as illustration. The \texttt{lang} parameter is ignored. \\ + \hline + frontpage & the name of the front page style --- not the \LaTeX\ macros --- to layout the front page. \newline OR \newline the front page illustration.\\ + \hline + backpage & the \LaTeX\ macros to layout the back page. \newline OR \newline the back page illustration.\\ + \hline + cfrontpage & the \LaTeX\ macros --- not the name of the front page style --- to layout the front page.\\ + \hline +\end{mtable} + +The \texttt{{\textbackslash}Get} macro permits to retreive 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:\\ +\texttt{{\textbackslash}Unset\{variable\_name\}} \\ + +The \texttt{{\textbackslash}Ifnotempty} macro permits 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:\\ +\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:\\ +\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):\\ +\texttt{{\textbackslash}Put(x,y)\{macros\}} \\ + +This macro must be used inside a \texttt{picture} environment in place of the standard \texttt{{\textbackslash}put} macro. + +%########################################################### + \chapter{Package upmethodology-task} \begin{center} \texttt{Version: \VERtask} \end{center} -The \LaTeX\ package \texttt{upmethodology-task} provides a set of commands to define project's tasks. +The \LaTeX\ package \texttt{upmethodology-task} provides a set of macros to define project's tasks. -This package could log the message "\verb+Project Task(s) may have changed. Rerun to get cross-references right+" when some task information was not found or due to cross-references on them. +During \LaTeX\ compilation this package could log the message \texttt{"Project Task(s) may have changed. Rerun to get cross-references right"} when some task information was not found or due to cross-references on them. \section{Task Definition} @@ -696,7 +1237,7 @@ 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. -Inside one of the task's definition environment above, you could use one of the following commands to define the task's attributes: +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; @@ -722,7 +1263,7 @@ Inside one of the task's definition environment above, you could use one of the You could reference any information about the defined tasks in your document. In case you used cross-references this package could log the message "\verb+Project Task(s) may have changed. Rerun to get cross-references right+" to complain about rebuilding of our document. -The following commands are available: +The following macros are available: \begin{itemize} \item \texttt{{\textbackslash}thetasksuper\{id\}} \\ replies the identifier of the parent task corresponding to the task identified by \texttt{id}; @@ -750,7 +1291,7 @@ The following commands are available: \section{Localization} -The following commands defines some localized strings used by \texttt{upmethodology-task}: +The following macros defines some localized strings used by \texttt{upmethodology-task}: \begin{itemize} \item \texttt{{\textbackslash}upm@task@lang@task}: Task; \item \texttt{{\textbackslash}upm@task@lang@escription}: Description; @@ -765,25 +1306,13 @@ The following commands defines some localized strings used by \texttt{upmethodol %########################################################### -\chapter{Class upmethodology-document} - -\begin{center} - \texttt{Version: \VERdocclazz} -\end{center} - -The \LaTeX\ class \texttt{upmethodology-document} provides an extension of the class \texttt{book} dedicated to the UP documents. This class automatically add a front page, a document summary, an author's list, a validator's list and a version history. - -It also provides a default formatting of the headers of the pages. - -%########################################################### - \chapter{Package upmethodology-code} \begin{center} \texttt{Version: \VERcode} \end{center} -The \LaTeX\ package \texttt{upmethodology-code} provides a set of commands for source code formatting. The supported source codes are UML, Java and C++. +The \LaTeX\ package \texttt{upmethodology-code} provides a set of macros for source code formatting. The supported source codes are UML, Java and C++. You could load the package with the following options: \begin{center} @@ -796,13 +1325,13 @@ cpp & use the C++ notation \\ \end{tabular} \end{center} -You could also change the notation language with the command: \\ +You could also change the notation language with the macro: \\ \texttt{{\textbackslash}upmcodelang\{upm\string|java\string|cpp\}} -The provided commands are listed in the following table: \\ +The provided macros are listed in the following table: \\ \begin{tabularx}{\linewidth}{|>{\ttfamily}l|X|X|X|} \hline - {\normalfont Command} & UML & Java & C++ \\ + {\normalfont macro} & UML & Java & C++ \\ \hline \multicolumn{4}{|X|}{Prototypes} \\ \hline @@ -830,7 +1359,7 @@ The provided commands are listed in the following table: \\ \newpage \begin{tabularx}{\linewidth}{|>{\ttfamily}l|X|X|X|} \hline - {\normalfont Command} & UML & Java & C++ \\ + {\normalfont macro} & UML & Java & C++ \\ \hline \multicolumn{4}{|X|}{Constants} \\ \hline @@ -845,6 +1374,8 @@ The provided commands are listed in the following table: \\ \hline \end{tabularx} +%########################################################### + \chapter{Authors and License} Copyright \copyright\ \upmcopyrightdate\ \makename{St\'ephane}{Galland} diff --git a/Master/texmf-dist/source/latex/upmethodology/Makefile b/Master/texmf-dist/source/latex/upmethodology/Makefile index 6f4773ed453..9766eca2f40 100644 --- a/Master/texmf-dist/source/latex/upmethodology/Makefile +++ b/Master/texmf-dist/source/latex/upmethodology/Makefile @@ -40,12 +40,12 @@ all: pdf pdf: gen_pdf ifeq ("${PDF_VIEWER}","") - @ if `which acroread 2>/dev/null >/dev/null`; \ - then \ - acroread ${PDFFILE}; \ - elif `which evince 2>/dev/null >/dev/null`; \ + @ if `which evince 2>/dev/null >/dev/null`; \ then \ evince ${PDFFILE}; \ + elif `which acroread 2>/dev/null >/dev/null`; \ + then \ + acroread ${PDFFILE}; \ elif `which xpdf 2>/dev/null >/dev/null`; \ then \ xpdf ${PDFFILE}; \ diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-backpage.sty b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-backpage.sty new file mode 100644 index 00000000000..754b7a0dae5 --- /dev/null +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-backpage.sty @@ -0,0 +1,86 @@ +% Back page for Unified Process Methodology +% +% Copyright (c) 2009 Stephane GALLAND <galland@arakhne.org> +% +% This program is free library; you can redistribute it and/or modify +% it under the terms of the GNU Lesser General Public License as +% published by the Free Software Foundation; either version 3 of the +% License, or any later version. +% +% This library is distributed in the hope that it will be useful, but +% WITHOUT ANY WARRANTY; without even the implied warranty of +% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +% Lesser General Public License for more details. +% +% You should have received a copy of the GNU Lesser General Public +% License along with this library; see the file COPYING. If not, +% write to the Free Software Foundation, Inc., 59 Temple Place - Suite +% 330, Boston, MA 02111-1307, USA. +% +% Creation date: 2009-10-22 +% Modifications: +% 2009-10-30 Rename \setbacklayout to \setbackcover. +% Add \makebackcover. +% + +\global\edef\upm@package@bp@ver{2009/10/30} + +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesPackage{upmethodology-backpage}[\upm@package@bp@ver] + +\RequirePackage{upmethodology-p-common} + +%----- +% Locales +\def\upm@back@lang@english{ + \gdef\upm@lang@@{\message{**** upmethodology-backpage is using English language ****}}% +} +\def\upm@back@lang@french{ + \gdef\upm@lang@@{\message{**** upmethodology-backpage is using French language ****}}% +} +%---------------------------------------- +% OPTIONS +%---------------------------------------- +\DeclareOption{french}{% + \upm@back@lang@french +} +\DeclareOption{francais}{% + \upm@back@lang@french +} +\DeclareOption{english}{% + \upm@back@lang@english +} +\ExecuteOptions{english}
+\ProcessOptions +\upm@lang@@ + +\RequirePackage{upmethodology-extension} + +%---- +% Set the back page layout as the classic layout theme +%\setbackcover{layout_name} +\newcommand{\setbackcover}[1]{% + \ifthenelse{\equal{#1}{none}}{% + \global\let\makebackcover\relax% + }{% + \errmessage{invalid back layout theme: #1}% + }% +} +\newcommand{\setbacklayout}[1]{\errmessage{\string\setbacklayout\ is deprecated. Use \string\setbackcover}} + +\setbackcover{none} + +\AtEndDocument{ + \Ifdefined{backpage}{ + \gdef\makebackcover{ + \ifupmarticleformat\clearpage% + \else + \cleardoublepage% + \if@twoside\thispagestyle{empty}\mbox{}\clearpage\fi + \fi + \thispagestyle{empty}\Get{backpage} + } + } +} + +\endinput diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-code.sty b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-code.sty index 548d402c973..470a1d3d598 100644 --- a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-code.sty +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-code.sty @@ -19,15 +19,15 @@ % % Creation date: 2006-04-27 % Modifications: +% 2009-10-30 Clean code. % -\global\edef\upm@package@code@ver{2006/04/27} +\global\edef\upm@package@code@ver{2009/10/30} \NeedsTeXFormat{LaTeX2e}[1995/12/01] \ProvidesPackage{upmethodology-code}[\upm@package@code@ver] -\RequirePackage{ifthen} -\RequirePackage{xspace} +\RequirePackage{upmethodology-p-common} \def\upm@code@eat@spaces#1{#1} \def\upm@code@makemul#1{\upm@code@eat@spaces{#1}\bgroup\textbf{s}\egroup\xspace} diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.cls b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.cls index 3860f56c895..484e45af230 100644 --- a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.cls +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.cls @@ -1,6 +1,6 @@ % Document class for Unified Process Methodology % -% Copyright (c) 2006-2007 Stephane GALLAND <galland@arakhne.org> +% Copyright (c) 2006-2009 Stephane GALLAND <galland@arakhne.org> % % This program is free library; you can redistribute it and/or modify % it under the terms of the GNU Lesser General Public License as @@ -19,6 +19,11 @@ % % Creation date: 2006-04-06 % Modifications: +% 2009-10-30 Add "book", "report" and "article" options. +% 2009-10-28 Add hyperref declarations. +% 2009-10-27 Add publication page. +% 2009-10-22 Add back page. +% 2009-10-09 Add option to hide the document informations % 2007-07-03 Force the height of the small logo in headers. % Remove the copyright date building function. % 2007-03-19 Add localization. @@ -28,43 +33,119 @@ % 2006-04-22 Remove task and specification packages. % -\global\edef\upm@package@docclazz@ver{2007/07/03} +\global\edef\upm@package@docclazz@ver{2009/10/30} \NeedsTeXFormat{LaTeX2e}[1995/12/01] \ProvidesClass{upmethodology-document}[\upm@package@docclazz@ver] +\RequirePackage{upmethodology-p-common} + +\newif\ifupm@package@docclazz@nodocinfo +\upm@package@docclazz@nodocinfofalse +\newif\ifupm@package@docclazz@nopubpage +\upm@package@docclazz@nopubpagefalse + +\gdef\upm@package@docclazz@optionstopass{a4paper,11pt} + \DeclareOption{twoside}{% - \PassOptionsToClass{twoside,openright}{book} + \xdef\upm@package@docclazz@optionstopass{\upm@package@docclazz@optionstopass,twoside,openright}% } \DeclareOption{oneside}{% - \PassOptionsToClass{oneside}{book} + \xdef\upm@package@docclazz@optionstopass{\upm@package@docclazz@optionstopass,oneside}% } \DeclareOption{french}{% - \PassOptionsToClass{french}{book} + \xdef\upm@package@docclazz@optionstopass{\upm@package@docclazz@optionstopass,french}% \PassOptionsToPackage{french}{upmethodology-document} } \DeclareOption{francais}{% - \PassOptionsToClass{french}{book} + \xdef\upm@package@docclazz@optionstopass{\upm@package@docclazz@optionstopass,french}% \PassOptionsToPackage{french}{upmethodology-document} } \DeclareOption{english}{% - \PassOptionsToClass{english}{book} + \xdef\upm@package@docclazz@optionstopass{\upm@package@docclazz@optionstopass,english}% \PassOptionsToPackage{english}{upmethodology-document} } +\DeclareOption{nodocumentinfo}{% + \upm@package@docclazz@nodocinfotrue% +} +\DeclareOption{documentinfo}{% + \upm@package@docclazz@nodocinfofalse% +} +\DeclareOption{nopubpage}{% + \upm@package@docclazz@nopubpagetrue% +} +\DeclareOption{pubpage}{% + \upm@package@docclazz@nopubpagefalse% +} +\DeclareOption{book}{% + \upmbookformattrue + \upmreportformatfalse + \upmarticleformatfalse + \upm@package@docclazz@nopubpagefalse% + \upm@package@docclazz@nodocinfofalse% + \xdef\upm@package@docclazz@optionstopass{\upm@package@docclazz@optionstopass,twoside}% +} +\DeclareOption{report}{% + \upmbookformatfalse + \upmreportformattrue + \upmarticleformatfalse + \upm@package@docclazz@nopubpagetrue% + \upm@package@docclazz@nodocinfofalse% + \xdef\upm@package@docclazz@optionstopass{\upm@package@docclazz@optionstopass,oneside}% +} +\DeclareOption{article}{% + \upmbookformatfalse + \upmreportformatfalse + \upmarticleformattrue + \upm@package@docclazz@nopubpagetrue% + \upm@package@docclazz@nodocinfotrue% + \xdef\upm@package@docclazz@optionstopass{\upm@package@docclazz@optionstopass,oneside}% +} -\DeclareOption*{\PassOptionsToClass{\CurrentOption}{book}} -\ExecuteOptions{oneside} +\DeclareOption*{% + \xdef\upm@package@docclazz@optionstopass{\upm@package@docclazz@optionstopass,\CurrentOption}% + } +\ExecuteOptions{report} \ProcessOptions -\PassOptionsToClass{a4paper,11pt}{book} -\LoadClass{book} +\ifupmbookformat + \message{*********** UPMETHODOLOGY BOOK CLASS (WITH PART AND CHAPTER)} + \expandafter\LoadClass[\upm@package@docclazz@optionstopass]{book} +\else\ifupmreportformat + \message{*********** UPMETHODOLOGY REPORT CLASS (WITHOUT PART, WITH CHAPTER)} + \expandafter\LoadClass[\upm@package@docclazz@optionstopass]{report} +\else + \message{*********** UPMETHODOLOGY ARTICLE CLASS (WITHOUT PART AND CHAPTER)} + \expandafter\LoadClass[\upm@package@docclazz@optionstopass]{article} +\fi\fi \RequirePackage{a4wide} \RequirePackage{fancyhdr} \RequirePackage{upmethodology-document} +\RequirePackage{upmethodology-extension} \RequirePackage{upmethodology-frontpage} +\RequirePackage{upmethodology-backpage} +\RequirePackage{upmethodology-task} +\RequirePackage{upmethodology-code} +\RequirePackage{upmethodology-spec} + +\RequirePackage{url} +\RequirePackage[pdftex=true, + breaklinks, %make links breakable on several lines + pageanchor=true, %put implicit anchor on each page (required for \printindex) + bookmarks=false, %hide bookmarks + hyperfigures=true, %not documented + hyperindex=true, %the page numbers in the index are links + linktocpage=true, %page numbers are used for links in TOC, LOF... + bookmarks=true, %open the bookmarks + bookmarksopen=true, %open all the bookmark's nodes by default + bookmarksnumbered=true, %section number in bookmarks + colorlinks=false, % Use a frame around links + pdfproducer={upmethodology \upm@package@docclazz@ver}, + ]{hyperref} +\urlstyle{same} \pdfpageheight=29.7cm \pdfpagewidth=21.0cm @@ -83,23 +164,21 @@ \if@twoside - - -\lhead[\includegraphics[height=\upm@smalllogo@height]{\theupmsmalldoclogo}]{\fancyplain{}{\upm@header@fmt{\theupmfulldocname}}} +\lhead[]{\fancyplain{}{\upm@header@fmt{\theupmfulldocname}}} \chead{} -\rhead[\fancyplain{}{\upm@header@fmt{\theupmfulldocname}}]{\includegraphics[height=\upm@smalllogo@height]{\theupmsmalldoclogo}} -\lfoot[\upm@header@fmt{\thepage}]{\upm@copyright@fmt{\theupmdocref~\copyright~\upmcopyrightdate~\theupmpublisher}} +\rhead{\Ifdefined{smalllogo}{\expandafter\includegraphics[height=\upm@smalllogo@height]{\theupmsmalldoclogo}}} +\lfoot[\upm@header@fmt{\ifthenelse{\thepage>0}{\thepage}{}}]{\upm@copyright@fmt{\tiny\theupmdocref~\copyright~\upmcopyrightdate~\theupmformattedcopyrighter}} \cfoot{} -\rfoot[\upm@copyright@fmt{\tiny\theupmdocref~\copyright~\upmcopyrightdate~\theupmpublisher}]{\upm@header@fmt{\thepage}} +\rfoot[\upm@copyright@fmt{\tiny\theupmdocref~\copyright~\upmcopyrightdate~\theupmformattedcopyrighter}]{\upm@header@fmt{\ifthenelse{\thepage>0}{\thepage}{}}} \else \lhead{\fancyplain{}{\upm@header@fmt{\theupmfulldocname}}} \chead{} -\rhead{\includegraphics[height=\upm@smalllogo@height]{\theupmsmalldoclogo}} -\lfoot{\upm@copyright@fmt{\tiny\theupmdocref~\copyright~\upmcopyrightdate~\theupmpublisher}} +\rhead{\Ifdefined{smalllogo}{\expandafter\includegraphics[height=\upm@smalllogo@height]{\theupmsmalldoclogo}}} +\lfoot{\upm@copyright@fmt{\tiny\theupmdocref~\copyright~\upmcopyrightdate~\theupmformattedcopyrighter}} \cfoot{} -\rfoot{\upm@header@fmt{\thepage}} +\rfoot{\upm@header@fmt{\ifthenelse{\thepage>0}{\thepage}{}}} \fi @@ -108,9 +187,54 @@ %---------------------------------------- \AtBeginDocument{ - \maketitle - \thispagestyle{plain}\upmdocumentsummary\upmdocumentauthors\upmdocumentvalidators\upmdocumentinformedpeople\vfill\upmhistory\cleardoublepage + \makefrontcover + \ifupm@package@docclazz@nopubpage\else\upmpublicationpage\fi + \ifupm@package@docclazz@nodocinfo\else\upmdocinfopage\fi \sloppy } +\AtEndDocument{ + \makebackcover +} + +%---------------------------------------- +% PDF COLORS +%---------------------------------------- +\gdef\upm@package@getcolor#1,#2,#3{#1 #2 #3} +\renewcommand{\setpdfcolor}[1]{ + \hypersetup{ + filebordercolor={\upm@package@getcolor #1}, % frame color + linkbordercolor={\upm@package@getcolor #1}, % frame color + citebordercolor={\upm@package@getcolor #1}, % frame color + menubordercolor={\upm@package@getcolor #1}, % frame color + urlbordercolor={\upm@package@getcolor #1}, % frame color + runbordercolor={\upm@package@getcolor #1}, % frame color + } +} + +%---------------------------------------- +% SET FORBIDDEN SECTIONNING FUNCTIONS +%---------------------------------------- +\ifupmbookformat\else + \gdef\upm@package@docclazz@hidesec@a#1{% + \@ifnextchar*{\upm@package@docclazz@hidesec@d{#1}}{% + \@ifnextchar[{\upm@package@docclazz@hidesec@b{#1}}{\upm@package@docclazz@hidesec@c{#1}}% + }} + \gdef\upm@package@docclazz@hidesec@d#1#2{% + \@ifnextchar[{\upm@package@docclazz@hidesec@b{#1}}{\upm@package@docclazz@hidesec@c{#1}}} + \gdef\upm@package@docclazz@hidesec@b#1[#2]#3{\@warning{"#1" macro is skipped. Title: "#3"}} + \gdef\upm@package@docclazz@hidesec@c#1#2{\@warning{"#1" macro is skipped. Title: "#2"}} + + \gdef\part{\upm@package@docclazz@hidesec@a{\string\part}} + \gdef\partstar{\upm@package@docclazz@hidesec@a{\string\part*}} + \gdef\parttoc{\upm@package@docclazz@hidesec@a{\string\parttoc}} + +\ifupmreportformat\else + + \gdef\chapter{\upm@package@docclazz@hidesec@a{\string\part}} + \gdef\chapterstar{\upm@package@docclazz@hidesec@a{\string\part*}} + \gdef\chaptertoc{\upm@package@docclazz@hidesec@a{\string\parttoc}} + +\fi\fi + \endinput diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.sty b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.sty index ed3e10d6d51..11a2a30eb7b 100644 --- a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.sty +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.sty @@ -1,6 +1,6 @@ % Package for Unified Process Methodology's documents % -% Copyright (c) 2006-2007 Stephane GALLAND <galland@arakhne.org> +% Copyright (c) 2006-2009 Stephane GALLAND <galland@arakhne.org> % % This program is free library; you can redistribute it and/or modify % it under the terms of the GNU Lesser General Public License as @@ -19,6 +19,20 @@ % % Creation date: 2006-04-20 % Modifications: +% 2009-11-03 Add star-ed macros for author, informed people +% and validator addition macros. +% 2009-10-30 Add "book", "report" and "article" support. +% Allow to override the default document font. +% 2009-10-28 Configure hyperref: add \setpdfcolor. +% 2009-10-27 Clean the extension API. +% Fixing document synoptic. +% 2009-10-25 Add abstract and keywords. +% 2009-10-25 Add abstract and keywords. +% 2009-10-24 Move extensions inside a dedicated package. +% 2009-10-23 Add front/back pages in extensions. +% Add \if commands on the extension's values. +% 2008-06-24 Add automatic watermarks. +% 2007-07-05 Add people name formatting function. % 2007-07-05 Add people name formatting function. % 2007-07-03 Add extension feature. % 2007-03-19 Add localization. @@ -28,17 +42,19 @@ % Add sectioning commands. % -\global\edef\upm@package@doc@ver{2007/07/03} +\global\edef\upm@package@doc@ver{2009/11/03} \NeedsTeXFormat{LaTeX2e}[1995/12/01] \ProvidesPackage{upmethodology-document}[\upm@package@doc@ver] +\RequirePackage{upmethodology-p-common} + %---------------------------------------- % LOCALES %---------------------------------------- \def\upm@document@lang@english{% \gdef\upm@lang@@{\message{**** upmethodology-document is using English language ****}}% - \gdef\upm@lang@@lang@{english}% + \gdef\upmcurrentlang{english}% \gdef\upm@lang@project{Project}% \gdef\upm@lang@document{Document}% \gdef\upm@lang@docref{Reference}% @@ -50,12 +66,21 @@ \gdef\upm@lang@document@informed{Informed People}% \gdef\upm@lang@document@validators{Validators}% \gdef\upm@lang@document@names{Names}% + \gdef\upm@lang@document@comments{Comments}% \gdef\upm@lang@document@emails{Emails}% \gdef\upm@lang@document@initials{Initials}% + \gdef\upm@lang@document@abstract{Abstract}% + \gdef\upm@lang@document@keywords{Key-words}% + \gdef\upm@lang@document@copyright@purpose{This document describes the \theupmproject\ project\Ifnotempty{\theupmsubproject}{ and its \theupmsubproject\ subproject}.}% + \gdef\upm@lang@document@copyright@tex{\TeX\ is a trademark of the American Mathematical Society.}% + \gdef\upm@lang@document@copyright@upmethodology{\texttt{tex-upmethodology} is owned by St\'ephane Galland, \arakhneorg, France.}% + \gdef\upm@lang@document@copyright@madewith{This document was realised with \LaTeX\ and \texttt{tex-upmethodology}.}% + \gdef\upm@lang@document@copyright@trademarks{This document is published by the \theupmformattedpublisher. All right reserved. No part of this publication may be reproduced, stored in a retreival system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of the publishers.} + \gdef\upm@lang@document@copyright@printedin{Printed in \theupmprintedin.} } \def\upm@document@lang@french{% \gdef\upm@lang@@{\message{**** upmethodology-document is using French language ****}}% - \gdef\upm@lang@@lang@{french}% + \gdef\upmcurrentlang{french}% \gdef\upm@lang@project{Projet}% \gdef\upm@lang@document{Document}% \gdef\upm@lang@docref{R\'ef\'erence}% @@ -64,24 +89,30 @@ \gdef\upm@lang@document@summary{Synoptique}% \gdef\upm@lang@status{Statut}% \gdef\upm@lang@document@authors{Auteurs}% + \gdef\upm@lang@document@comments{Commentaires}% \gdef\upm@lang@document@informed{Pour information}% \gdef\upm@lang@document@validators{Validateurs}% \gdef\upm@lang@document@names{Noms}% \gdef\upm@lang@document@emails{Emails}% \gdef\upm@lang@document@initials{Initiales}% + \gdef\upm@lang@document@abstract{R\'esum\'e}% + \gdef\upm@lang@document@keywords{Mots-cl\'es}% + \gdef\upm@lang@document@copyright@purpose{Ce document d\'ecrit le projet \theupmproject\Ifnotempty{\theupmsubproject}{ et son sous-projet \theupmsubproject}.}% + \gdef\upm@lang@document@copyright@tex{\TeX\ et \LaTeX\ sont des marques de la Soci\'et\'e Am\'ericaine de Math\'ematiques.}% + \gdef\upm@lang@document@copyright@upmethodology{\texttt{tex-upmethodology} est la propri\'et\'e de St\'ephane Galland, \arakhneorg, France.}% + \gdef\upm@lang@document@copyright@madewith{Ce document a \'et\'e r\'ealis\'e avec \LaTeX\ et \texttt{tex-upmethodology}.}% + \gdef\upm@lang@document@copyright@trademarks{Ce document est publi\'e par \theupmformattedpublisher. Tous droits r\'eserv\'es. \par Le Code de la propri\'et\'e intellectuelle n'autorisant, aux termes de l'article L.122-5, 2\textdegree et 3\textdegree a), d'une part, que les ``copies ou reproductions strictement r\'eserv\'ees \`a l'usage priv\'e du copiste et non destin\'ees \`a une utilisation collective'' et, d'autre part, que les analyses et les courtes citations dans un but d'exemple et d'illustation, ``toute repr\'esentation ou reproduction int\'egrale ou partielle faite sans le consentement de l'auteur ou de ses ayants droit ou ayants cause est illicite'' (art. L.122-4). \par Cette repr\'esentation ou reproduction, par quelque proc\'ed\'e que ce soit, constiturait donc une contrefa\c{c}on sanctionn\'ee par les articles L.335-2 et suivants du Code de la propri\'et\'e intellectuelle.} + \gdef\upm@lang@document@copyright@printedin{Imprim\'e en \theupmprintedin.} } %---------------------------------------- % OPTIONS %---------------------------------------- -\newif\ifupm@document@langset\upm@document@langsetfalse \DeclareOption{french}{% \upm@document@lang@french - \upm@document@langsettrue } \DeclareOption{francais}{% \upm@document@lang@french - \upm@document@langsettrue } \DeclareOption{english}{% \upm@document@lang@english @@ -91,36 +122,13 @@ \upm@lang@@ -\ifupm@document@langset\else\PassOptionsToPackage{english}{babel}\fi -\RequirePackage{babel} -\RequirePackage{ifthen} -\RequirePackage{xspace} -\RequirePackage{graphicx} +\RequirePackage[\upmcurrentlang]{babel} \RequirePackage{vmargin} -\RequirePackage{url} -\RequirePackage[pdftex]{thumbpdf} % PDF thumbail -\RequirePackage[pdftex=true, - pdfpagelayout = useoutlines, - bookmarks, - bookmarksopen = true, - bookmarksnumbered = true, - breaklinks = true, - linktocpage, - %backref, % Ecrit le lieu citation (lien) ds la biblio - linkcolor = blue, - urlcolor = blue, - citecolor = blue, - anchorcolor = blue, - hyperindex = true, - hyperfigures - ]{hyperref} -\urlstyle{sf} +\RequirePackage{upmethodology-extension} \RequirePackage{upmethodology-fmt} \RequirePackage{upmethodology-version} -\def\upm@ifnotempty#1{\ifthenelse{\equal{#1}{\@empty}}{}} - %---------------------------------------- % DOCUMENT MANAGEMENT %---------------------------------------- @@ -149,16 +157,74 @@ % Display the summary of the document %\upmdocumentsummary[width] \newcommand{\upmdocumentsummary}[1][\linewidth]{% - \noindent\begin{mtabular}[#1]{5}{|X|X|c|c|c|}% + \noindent\begin{mtabular}[#1]{2}{|l|X|}% \tabulartitle{\upm@lang@document@summary}% - \tabularheader{\upm@lang@project}{\upm@lang@document}{\upm@lang@docref}{\upm@lang@version}{\upm@lang@lastupdate}% - \hline - \theupmproject\upm@ifnotempty{\theupmsubproject}{ -- \theupmsubproject} & \theupmdocname & \theupmdocref & \theupmversion & \theupmdate \\ + \upm@lang@project & \theupmproject\Ifnotempty{\theupmsubproject}{ -- \theupmsubproject} \\ + \upm@lang@document & \theupmdocname \\ + \upm@lang@docref & \theupmdocref \\ + \upm@lang@version & \theupmversion \\ + \upm@lang@lastupdate & \theupmdate \\ \hline \end{mtabular}\par\vspace{.5cm}% } %----- +% Display the the document information on a page +%\upmpublicationpage +\newcommand{\upmdocinfopage}{ + \if@twoside% + \ifodd\thepage% + \setcounter{page}{-1}% + \else% + \setcounter{page}{0}% + \fi% + \else% + \setcounter{page}{0}% + \fi% + \thispagestyle{plain} + \upmdocumentsummary\upmdocumentauthors\upmdocumentvalidators\upmdocumentinformedpeople\vfill\upmhistory\clearpage% +} + +%----- +% Display the publication pag for the document +%\upmpublicationpage +\newcommand{\upmpublicationpage}{ + \setcounter{page}{0}% + \thispagestyle{empty}% + \upmpublicationminipage% +} +\newcommand{\upmpublicationminipage}{ + \if@twoside\ifodd\c@page\clearpage\fi\fi% + \mbox{}\vfill\small% + \par\noindent + \upm@lang@document@copyright@purpose + \vspace{.5cm} + \par\noindent + \upm@lang@document@copyright@tex + \par\noindent + \upm@lang@document@copyright@upmethodology + \vspace{.5cm} + \par\noindent + \Get{trademarks} + \vspace{4cm} + \par\noindent + \upm@lang@document@copyright@madewith + \vspace{.15cm} + \par\noindent + Copyright~\copyright~\upmcopyrightdate~\theupmformattedcopyrighter. + \vspace{.15cm} + \par\noindent + \upm@lang@document@copyright@trademarks \Ifdefined{printed}{\upm@lang@document@copyright@printedin} + \vspace{.25cm} + \par\noindent + \upm@lang@docref~: \theupmdocref \\ + \Ifnotempty{\theupmisbn}{ISBN~:~\theupmisbn\\} + \Ifnotempty{\theupmissn}{ISSN~:~\theupmissn\\} + \Ifnotempty{\theupmdoi}{DOI~:~\theupmdoi\\} + \clearpage% +} + +%----- %Name of the project for which this document was written \def\theupmproject{Arakhn\^e Project} @@ -177,27 +243,56 @@ %----- %Name of the logo -\def\theupmsmalldoclogo{smalllogo} -\def\theupmdoclogo{logo} +\newcommand{\theupmsmalldoclogo}{\Get{smalllogo}} +\newcommand{\theupmdoclogo}{\Get{logo}} %----- % Define the name of the logo picture to use -\newcommand{\defupmsmalllogo}[1]{\global\edef\theupmsmalldoclogo{#1}} -\newcommand{\defupmlogo}[1]{\global\edef\theupmdoclogo{#1}} +\newcommand{\defupmsmalllogo}[1]{\Set{smalllogo}{#1}} +\newcommand{\defupmlogo}[1]{\Set{logo}{#1}} %----- %Full name of the document \def\theupmfulldocname{% \theupmproject% - \upm@ifnotempty{\theupmsubproject}{/\theupmsubproject}% - \upm@ifnotempty{\theupmdocname}{ -- \theupmdocname}% + \Ifnotempty{\theupmsubproject}{/\theupmsubproject}% + \Ifnotempty{\theupmdocname}{ -- \theupmdocname}% +} + +%----- +% Declare a document's abstract +%\setdocabstract[lang]{text} +\newcommand{\setdocabstract}[2][\upmcurrentlang]{% + \ifthenelse{\equal{#1}{\upmcurrentlang}}{ + \gdef\theupmdocabstract{#2}}{}% + \global\@namedef{theupmdocabstract#1}{#2}% +} + +%----- +% Declare a document's key-words +%\setdockeywords[lang]{words} +\newcommand{\setdockeywords}[2][\upmcurrentlang]{% + \ifthenelse{\equal{#1}{\upmcurrentlang}}{ + \gdef\theupmdockeywords{#2}}{}% + \global\@namedef{theupmdockeywords#1}{#2}% } +%----- +%Abstract of the document +\def\theupmdocabstract{} + +%----- +%Key-words of the document +\def\theupmdockeywords{} + %---------------------------------------- % AUTHOR MANAGEMENT %---------------------------------------- +\newif\ifupm@document@author@tab@hascomment +\upm@document@author@tab@hascommentfalse \def\upm@document@author@tab{} +\def\upm@document@author@tab@commented{} %----- \def\theauthorlist{} @@ -205,30 +300,61 @@ %----- %Add an author %\addauthor[email]{firstname}{name} -\newcommand{\addauthor}[3][]{% - \global\protected@edef\theauthorlist{\theauthorlist\protect\upm@ifnotempty{\theauthorlist}{,} \protect\upmmakename{#2}{#3}{~}} - \global\protected@edef\upm@document@author@tab{\upm@document@author@tab \protect\upmmakename{#2}{#3}{~} & - \protect\upm@ifnotempty{#1}{\protect\href{mailto:#1}{#1}} \protect\\} +%\addauthor*[email]{firstname}{name}{comment} +\def\addauthor{\@ifstar\upm@document@addauthorstar\upm@document@addauthor} +\newcommand{\upm@document@addauthor}[3][]{% + \global\protected@edef\theauthorlist{\theauthorlist\protect\Ifnotempty{\theauthorlist}{,} \protect\upmmakename{#2}{#3}{~}} + + \global\protected@edef\upm@document@author@tab@commented{\upm@document@author@tab@commented \protect\upmmakename{#2}{#3}{~} & + & \protect\Ifnotempty{#1}{\protect\href{mailto:#1}{#1}} \protect\\} + + \ifupm@document@author@tab@hascomment\else + \global\protected@edef\upm@document@author@tab{\upm@document@author@tab \protect\upmmakename{#2}{#3}{~} & + \protect\Ifnotempty{#1}{\protect\href{mailto:#1}{#1}} \protect\\} + \fi +} +\newcommand{\upm@document@addauthorstar}[4][]{% + \global\protected@edef\theauthorlist{\theauthorlist\protect\Ifnotempty{\theauthorlist}{,} \protect\upmmakename{#2}{#3}{~}} + + \global\let\upm@document@author@tab\relax + + \global\protected@edef\upm@document@author@tab@commented{\upm@document@author@tab@commented \protect\upmmakename{#2}{#3}{~} & + #4 & \protect\Ifnotempty{#1}{\protect\href{mailto:#1}{#1}} \protect\\} + + \upm@document@author@tab@hascommenttrue } %----- % Display the summary of the authors %\upmdocumentauthors[width] \newcommand{\upmdocumentauthors}[1][\linewidth]{% - \upm@ifnotempty{\upm@document@author@tab}{% - \noindent\expandafter\begin{mtabular}[#1]{2}{|X|c|}% - \tabulartitle{\upm@lang@document@authors}% - \tabularheader{\upm@lang@document@names}{\upm@lang@document@emails}% - \upm@document@author@tab - \hline% - \expandafter\end{mtabular}\par\vspace{.5cm}}% + \ifupm@document@author@tab@hascomment% + \Ifnotempty{\upm@document@author@tab@commented}{% + \noindent\expandafter\begin{mtabular}[#1]{3}{|X|l|c|}% + \tabulartitle{\upm@lang@document@authors}% + \tabularheader{\upm@lang@document@names}{\upm@lang@document@comments}{\upm@lang@document@emails}% + \upm@document@author@tab@commented + \hline% + \expandafter\end{mtabular}\par\vspace{.5cm}}% + \else% + \Ifnotempty{\upm@document@author@tab}{% + \noindent\expandafter\begin{mtabular}[#1]{2}{|X|c|}% + \tabulartitle{\upm@lang@document@authors}% + \tabularheader{\upm@lang@document@names}{\upm@lang@document@emails}% + \upm@document@author@tab + \hline% + \expandafter\end{mtabular}\par\vspace{.5cm}}% + \fi% } %---------------------------------------- % VALIDATOR MANAGEMENT %---------------------------------------- +\newif\ifupm@document@validator@tab@hascomment +\upm@document@validator@tab@hascommentfalse \def\upm@document@validator@tab{} +\def\upm@document@validator@tab@commented{} %----- \def\thevalidatorlist{} @@ -236,38 +362,74 @@ %----- %Add a validator %\addvalidator[email]{firstname}{name} -\newcommand{\addvalidator}[3][]{% - \global\protected@edef\thevalidatorlist{\thevalidatorlist\protect\upm@ifnotempty{\thevalidatorlist}{,} \protect\upmmakename{#2}{#3}{~}} - \global\protected@edef\upm@document@validator@tab{\upm@document@validator@tab \protect\upmmakename{#2}{#3}{~} & - \protect\upm@ifnotempty{#1}{\protect\href{mailto:#1}{#1}} & \protect\\} +%\addvalidator*[email]{firstname}{name}{comment} +\def\addvalidator{\@ifstar\upm@document@addvalidatorstar\upm@document@addvalidator} +\newcommand{\upm@document@addvalidator}[3][]{% + \global\protected@edef\thevalidatorlist{\thevalidatorlist\protect\Ifnotempty{\thevalidatorlist}{,} \protect\upmmakename{#2}{#3}{~}} + + \global\protected@edef\upm@document@validator@tab@commented{\upm@document@validator@tab@commented \protect\upmmakename{#2}{#3}{~} & + & \protect\Ifnotempty{#1}{\protect\href{mailto:#1}{#1}} & \protect\\} + + \ifupm@document@validator@tab@hascomment\else + \global\protected@edef\upm@document@validator@tab{\upm@document@validator@tab \protect\upmmakename{#2}{#3}{~} & + \protect\Ifnotempty{#1}{\protect\href{mailto:#1}{#1}} & \protect\\} + \fi +} +\newcommand{\upm@document@addvalidatorstar}[4][]{% + \global\protected@edef\thevalidatorlist{\thevalidatorlist\protect\Ifnotempty{\thevalidatorlist}{,} \protect\upmmakename{#2}{#3}{~}} + + \global\let\upm@document@validator@tab\relax + + \global\protected@edef\upm@document@validator@tab@commented{\upm@document@validator@tab@commented \protect\upmmakename{#2}{#3}{~} & + #4 & \protect\Ifnotempty{#1}{\protect\href{mailto:#1}{#1}} & \protect\\} + + \upm@document@validator@tab@hascommenttrue } %----- % Display the summary of the validators %\upmdocumentvalidators[width] \newcommand{\upmdocumentvalidators}[1][\linewidth]{% - \upm@ifnotempty{\upm@document@validator@tab}{% - \noindent\expandafter\begin{mtabular}[#1]{3}{|X|c|p{3cm}|}% - \tabulartitle{\upm@lang@document@validators}% - \tabularheader{\upm@lang@document@names}{\upm@lang@document@emails}{\upm@lang@document@initials}% - \upm@document@validator@tab - \hline% - \expandafter\end{mtabular}\par\vspace{.5cm}}% + \ifupm@document@validator@tab@hascomment% + \Ifnotempty{\upm@document@validator@tab@commented}{% + \noindent\expandafter\begin{mtabular}[#1]{4}{|X|l|c|p{3cm}|}% + \tabulartitle{\upm@lang@document@validators}% + \tabularheader{\upm@lang@document@names}{\upm@lang@document@comments}{\upm@lang@document@emails}{\upm@lang@document@initials}% + \upm@document@validator@tab@commented + \hline% + \expandafter\end{mtabular}\par\vspace{.5cm}}% + \else% + \Ifnotempty{\upm@document@validator@tab}{% + \noindent\expandafter\begin{mtabular}[#1]{3}{|X|c|p{3cm}|}% + \tabulartitle{\upm@lang@document@validators}% + \tabularheader{\upm@lang@document@names}{\upm@lang@document@emails}{\upm@lang@document@initials}% + \upm@document@validator@tab + \hline% + \expandafter\end{mtabular}\par\vspace{.5cm}}% + \fi% } %----- %Add an author/validator -%\addvalidator[email]{firstname}{name} -\newcommand{\addauthorvalidator}[3][]{% +%\addauthorvalidator[email]{firstname}{name} +%\addauthorvalidator*[email]{firstname}{name}{comment} +\def\addauthorvalidator{\@ifstar\upm@document@addauthorvalidatorstar\upm@document@addauthorvalidator} +\newcommand{\upm@document@addauthorvalidator}[3][]{% \addauthor[#1]{#2}{#3}\addvalidator[#1]{#2}{#3}% } +\newcommand{\upm@document@addauthorvalidatorstar}[4][]{% + \addauthor*[#1]{#2}{#3}{#4}\addvalidator*[#1]{#2}{#3}{#4}% +} %---------------------------------------- % INFORMED MANAGEMENT %---------------------------------------- +\newif\ifupm@document@informed@tab@hascomment +\upm@document@informed@tab@hascommentfalse \def\upm@document@informed@tab{} +\def\upm@document@informed@tab@commented{} %----- \def\theinformedlist{} @@ -275,161 +437,115 @@ %----- %Add an informed %\addinformed[email]{firstname}{name} -\newcommand{\addinformed}[3][]{% - \global\protected@edef\theinformedlist{\theinformedlist\protect\upm@ifnotempty{\theinformedlist}{,} \protect\upmmakename{#2}{#3}{~}} - \global\protected@edef\upm@document@informed@tab{\upm@document@informed@tab \protect\upmmakename{#2}{#3}{~} & - \protect\upm@ifnotempty{#1}{\protect\href{mailto:#1}{#1}} \protect\\} +%\addinformed*[email]{firstname}{name}{comment} +\def\addinformed{\@ifstar\upm@document@addinformedstar\upm@document@addinformed} +\newcommand{\upm@document@addinformed}[3][]{% + \global\protected@edef\theinformedlist{\theinformedlist\protect\Ifnotempty{\theinformedlist}{,} \protect\upmmakename{#2}{#3}{~}} + + \global\protected@edef\upm@document@informed@tab@commented{\upm@document@informed@tab@commented \protect\upmmakename{#2}{#3}{~} & + & \protect\Ifnotempty{#1}{\protect\href{mailto:#1}{#1}} \protect\\} + + \ifupm@document@informed@tab@hascomment\else + \global\protected@edef\upm@document@informed@tab{\upm@document@informed@tab \protect\upmmakename{#2}{#3}{~} & + \protect\Ifnotempty{#1}{\protect\href{mailto:#1}{#1}} \protect\\} + \fi +} +\newcommand{\upm@document@addinformedstar}[4][]{% + \global\protected@edef\theinformedlist{\theinformedlist\protect\Ifnotempty{\theinformedlist}{,} \protect\upmmakename{#2}{#3}{~}} + + \global\let\upm@document@informed@tab\relax + + \global\protected@edef\upm@document@informed@tab@commented{\upm@document@informed@tab@commented \protect\upmmakename{#2}{#3}{~} & + #4 & \protect\Ifnotempty{#1}{\protect\href{mailto:#1}{#1}} \protect\\} + + \upm@document@informed@tab@hascommenttrue } %----- % Display the summary of the informed people %\upmdocumentinformedpeople[width] \newcommand{\upmdocumentinformedpeople}[1][\linewidth]{% - \upm@ifnotempty{\upm@document@informed@tab}{% - \noindent\expandafter\begin{mtabular}[#1]{2}{|X|c|}% - \tabulartitle{\upm@lang@document@informed}% - \tabularheader{\upm@lang@document@names}{\upm@lang@document@emails}% - \upm@document@informed@tab - \hline% - \expandafter\end{mtabular}\par\vspace{.5cm}}% + \ifupm@document@validator@tab@hascomment% + \Ifnotempty{\upm@document@informed@tab@commented}{% + \noindent\expandafter\begin{mtabular}[#1]{3}{|X|l|c|}% + \tabulartitle{\upm@lang@document@informed}% + \tabularheader{\upm@lang@document@names}{\upm@lang@document@comments}{\upm@lang@document@emails}% + \upm@document@informed@tab@commented + \hline% + \expandafter\end{mtabular}\par\vspace{.5cm}}% + \else% + \Ifnotempty{\upm@document@informed@tab}{% + \noindent\expandafter\begin{mtabular}[#1]{2}{|X|c|}% + \tabulartitle{\upm@lang@document@informed}% + \tabularheader{\upm@lang@document@names}{\upm@lang@document@emails}% + \upm@document@informed@tab + \hline% + \expandafter\end{mtabular}\par\vspace{.5cm}}% + \fi% } %---------------------------------------- -% PUBLISHER +% PUBLISHER, COPYRIGHT, PRINTING... %---------------------------------------- -\gdef\theupmpublisher{Arakhn\^e.org Group} +\gdef\theupmcopyrighter{\Get{copyrighter}} +\gdef\theupmpublisher{\Get{publisher}} +\gdef\theupmprintedin{\Get{printedin}} +\gdef\theupmisbn{} +\gdef\theupmissn{} +\gdef\theupmdoi{} \gdef\theupmpublishingdate{} +\newcommand{\theupmformattedpublisher}{\Ifelsedefined{publisher}{\theupmpublisher}{\textcolor{red}{???}}} +\newcommand{\theupmformattedcopyrighter}{\Ifelsedefined{copyrighter}{\theupmcopyrighter}{\textcolor{red}{???}}} + %----- %Set the publisher identity %\setpublisher{name} -\newcommand{\setpublisher}[1]{% - \gdef\theupmpublisher{#1}% -} +\newcommand{\setpublisher}[1]{\Set{publisher}{#1}} -%---------------------------------------- -% DOCUMENT SECTIONS -%---------------------------------------- - -\gdef\upm@document@section@alignment{} - -%----- -% Part without number but inside the TOC -%\parttoc [toctitle]{title} % left-alignment inside TOC -%\parttoc*[toctitle]{title} % right-alignment inside TOC -\def\parttoc{\@ifstar% - {\gdef\upm@document@section@alignment{\protect\numberline{}}\expandafter\upm@document@section@part}% - {\gdef\upm@document@section@alignment{}\expandafter\upm@document@section@part}} -\def\upm@document@section@part{\@ifnextchar [% - {\expandafter\upm@document@section@part@opt}% - {\expandafter\upm@document@section@part@nopt}} -\def\upm@document@section@part@opt[#1]#2{% - \part*{#2\addcontentsline{toc}{part}{\upm@document@section@alignment{#1}}}% - \chaptermark{}% -} -\def\upm@document@section@part@nopt#1{% - \part*{#1\addcontentsline{toc}{part}{\upm@document@section@alignment{#1}}}% - \chaptermark{}% -} +%----- +%Set the copyrighter identity +%\setcopyrighter{name} +\newcommand{\setcopyrighter}[1]{\Set{copyrighter}{#1}} %----- -% Chapter without number but inside the TOC -%\chaptertoc [toctitle]{title} % left-alignment inside TOC -%\chaptertoc*[toctitle]{title} % right-alignment inside TOC -\def\chaptertoc{\@ifstar% - {\gdef\upm@document@section@alignment{\protect\numberline{}}\expandafter\upm@document@section@chapter}% - {\gdef\upm@document@section@alignment{}\expandafter\upm@document@section@chapter}} -\def\upm@document@section@chapter{\@ifnextchar [% - {\expandafter\upm@document@section@chapter@opt}% - {\expandafter\upm@document@section@chapter@nopt}} -\def\upm@document@section@chapter@opt[#1]#2{% - \@schapter{#2\addcontentsline{toc}{chapter}{\upm@document@section@alignment{#1}}}% - \chaptermark{#1}% -} -\def\upm@document@section@chapter@nopt#1{% - \@schapter{#1\addcontentsline{toc}{chapter}{\upm@document@section@alignment{#1}}}% - \chaptermark{#1}% -} +%Set the address where this document is printed +%\setprintingaddress{address} +\newcommand{\setprintingaddress}[1]{\Set{printedin}{#1}} %----- -% Section without number but inside the TOC -%\sectiontoc [toctitle]{title} % left-alignment inside TOC -%\sectiontoc*[toctitle]{title} % right-alignment inside TOC -\def\sectiontoc{\@ifstar% - {\gdef\upm@document@section@alignment{\protect\numberline{}}\expandafter\upm@document@section@section}% - {\gdef\upm@document@section@alignment{}\expandafter\upm@document@section@section}} -\def\upm@document@section@section{\@ifnextchar [% - {\expandafter\upm@document@section@section@opt}% - {\expandafter\upm@document@section@section@nopt}} -\def\upm@document@section@section@opt[#1]#2{% - \section*{#2\addcontentsline{toc}{section}{\upm@document@section@alignment{#1}}}% -} -\def\upm@document@section@section@nopt#1{% - \section*{#1\addcontentsline{toc}{section}{\upm@document@section@alignment{#1}}}% +%Set the ISBN +%\setisbn{isbn} +\newcommand{\setisbn}[1]{% + \gdef\theupmisbn{#1}% } %----- -% Subsection without number but inside the TOC -%\subsectiontoc [toctitle]{title} % left-alignment inside TOC -%\subsectiontoc*[toctitle]{title} % right-alignment inside TOC -\def\subsectiontoc{\@ifstar% - {\gdef\upm@document@section@alignment{\protect\numberline{}}\expandafter\upm@document@section@subsection}% - {\gdef\upm@document@section@alignment{}\expandafter\upm@document@section@subsection}} -\def\upm@document@section@subsection{\@ifnextchar [% - {\expandafter\upm@document@section@subsection@opt}% - {\expandafter\upm@document@section@subsection@nopt}} -\def\upm@document@section@subsection@opt[#1]#2{% - \subsection*{#2\addcontentsline{toc}{subsection}{\upm@document@section@alignment{#1}}}% -} -\def\upm@document@section@subsection@nopt#1{% - \subsection*{#1\addcontentsline{toc}{subsection}{\upm@document@section@alignment{#1}}}% +%Set the ISSN +%\setisbn{issn} +\newcommand{\setissn}[1]{% + \gdef\theupmissn{#1}% } %----- -% Subsubsection without number but inside the TOC -%\subsubsectiontoc [toctitle]{title} % left-alignment inside TOC -%\subsubsectiontoc*[toctitle]{title} % right-alignment inside TOC -\def\subsubsectiontoc{\@ifstar% - {\gdef\upm@document@section@alignment{\protect\numberline{}}\expandafter\upm@document@section@subsubsection}% - {\gdef\upm@document@section@alignment{}\expandafter\upm@document@section@subsubsection}} -\def\upm@document@section@subsubsection{\@ifnextchar [% - {\expandafter\upm@document@section@subsubsection@opt}% - {\expandafter\upm@document@section@subsubsection@nopt}} -\def\upm@document@section@subsubsection@opt[#1]#2{% - \subsubsection*{#2\addcontentsline{toc}{subsubsection}{\upm@document@section@alignment{#1}}}% -} -\def\upm@document@section@subsubsection@nopt#1{% - \subsubsection*{#1\addcontentsline{toc}{subsubsection}{\upm@document@section@alignment{#1}}}% +%Set the DOI +%\setdoi{doi} +\newcommand{\setdoi}[1]{% + \gdef\theupmdoi{#1}% } %---------------------------------------- -% EXTENSION MANAGEMENT +% WATERMARK %---------------------------------------- -%----- -% Use the specified extension -%\upmuse{extension_name} -\newcommand{\upmuse}[1]{% - \message{**** including upm extension #1 (upmext-#1.cfg) ****}% - {\begingroup% - \newcommand{\set}[3][\upm@lang@@lang@]{% - % NORMAL LOGO - \ifthenelse{\equal{##2}{logo}}{\defupmlogo{##3}}{% - % SMALL LOGO - \ifthenelse{\equal{##2}{smalllogo}}{\defupmsmalllogo{##3}}{% - % PUBLISHER - \ifthenelse{\equal{##2}{publisher}}{% - \ifthenelse{\equal{\upm@lang@@lang@}{##1}}{% - \setpublisher{##3}% - }{}% - % ERROR ON ATTRIBUTE - }{% - \errmessage{extension's value '##2' is not supported.}% - }}}% - }% - \input{upmext-#1.cfg}% - \endgroup}% +\AtBeginDocument{ + \ifthenelse{\equal{\theupmstatus}{\upmrestricted}}{ + \edef\upm@doc@tmp@watermark{\uppercase{\upm@lang@restricted}} + \RequirePackage{draftwatermark} + \SetWatermarkText{\upm@doc@tmp@watermark} + \SetWatermarkScale{\Get{watermarksize}} + }{} } \endinput diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-extension.sty b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-extension.sty new file mode 100644 index 00000000000..9424f2d2ed3 --- /dev/null +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-extension.sty @@ -0,0 +1,112 @@ +% Package for Unified Process Methodology's extensions +% +% Copyright (c) 2006-2009 Stephane GALLAND <galland@arakhne.org> +% +% This program is free library; you can redistribute it and/or modify +% it under the terms of the GNU Lesser General Public License as +% published by the Free Software Foundation; either version 3 of the +% License, or any later version. +% +% This library is distributed in the hope that it will be useful, but +% WITHOUT ANY WARRANTY; without even the implied warranty of +% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +% Lesser General Public License for more details. +% +% You should have received a copy of the GNU Lesser General Public +% License along with this library; see the file COPYING. If not, +% write to the Free Software Foundation, Inc., 59 Temple Place - Suite +% 330, Boston, MA 02111-1307, USA. +% +% Creation date: 2006-10-24 +% Modifications: +% 2009-11-03 \If* are marked as \long. +% 2006-10-30 Bug fix: provides "upmethodology-extension" insteed of "upmethodology-document". +% 2006-10-29 Allow to override the default font. +% 2006-10-27 Clean the API +% + +\global\edef\upm@package@ext@ver{2009/11/03} + +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesPackage{upmethodology-extension}[\upm@package@ext@ver] + +\RequirePackage{upmethodology-p-common} + +%---------------------------------------- +% TEST MACROS +%---------------------------------------- +\long\def\Ifdefined#1#2{\@ifundefined{upmext@extension@value@#1}{}{#2}} +\long\def\Ifelsedefined#1#2#3{\@ifundefined{upmext@extension@value@#1}{#3}{#2}} +\long\def\Ifundefined#1#2{\@ifundefined{upmext@extension@value@#1}{#2}{}} +\long\def\Ifelseundefined#1#2#3{\@ifundefined{upmext@extension@value@#1}{#2}{#3}} + +%---------------------------------------- +% EXTENSION MANAGEMENT +%---------------------------------------- + +\newcommand{\Get}[1]{\@nameuse{upmext@extension@value@#1}} + +\newcommand{\Set}[3][\upmcurrentlang]{% + % PREDEFINED FRONT PAGE + \ifthenelse{\equal{#2}{frontpage}}{% + \gdef\upmext@extension@value@frontpage{#3}% + \global\let\upmext@extension@value@frontpage@custom\relax% + }{% + % CUSTOM BACK PAGE + \ifthenelse{\equal{#2}{backpage}}{% + \ifthenelse{\equal{\upmcurrentlang}{#1}}{% + \gdef\upmext@extension@value@backpage{#3}% + }{}% + }{% + % CUSTOM FRONT PAGE + \ifthenelse{\equal{#2}{cfrontpage}}{% + \ifthenelse{\equal{\upmcurrentlang}{#1}}{% + \gdef\upmext@extension@value@frontpage{custom}% + \gdef\upmext@extension@value@frontpage@custom{#3}% + }{}% + }{% + \ifthenelse{\equal{\upmcurrentlang}{#1}}{% + \message{*** define extension value #2 ****}% + \global\@namedef{upmext@extension@value@#2}{#3}% + }{}% + }}}% +} + +\newcommand{\Unset}[2][\upmcurrentlang]{% + \ifthenelse{\equal{\upmcurrentlang}{#1}}{% + \message{*** undefine extension value #2 ****}% + \global\expandafter\let\csname upmext@extension@value@#2\endcsname\@undefined% + }{}% +} + +\newcommand{\DeclareCopyright}[5][\upmcurrentlang]{% + \ifthenelse{\equal{\upmcurrentlang}{#1}}{% + \Set{copyright}{Copyright (c) #3 #4.}% + \message{*** style extension #2, \Get{copyright} ****}% + \Set{trademarks}{#5}% + }{}% +} + +\newlength{\upmext@tmp@putx} +\def\Put(#1,#2){% + \setlength{\upmext@tmp@putx}{#1\unitlength}% + \if@twoside\ifodd\c@page\else\addtolength{\upmext@tmp@putx}{28\unitlength}\fi\fi% + \put(\strip@pt\upmext@tmp@putx,#2)} + +%----- +% Use the specified extension +%\UseExtension{extension_name} +\newcommand{\UseExtension}[1]{% + \message{**** including upm extension #1 (upmext-#1.cfg) ****}% + \input{upmext-#1.cfg}% +} + +%------------ +% Default declarations +\Set{frontillustrationsize}{1} +\Set{watermarksize}{1} +\Unset{publisher} +\Unset{copyrighter} +\Unset{printedin} + +\endinput diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-fmt.sty b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-fmt.sty index bef85f869ed..823ad0eee69 100644 --- a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-fmt.sty +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-fmt.sty @@ -18,7 +18,19 @@ % 330, Boston, MA 02111-1307, USA. % % Creation date: 2006-04-06 -% Modifications: +% Modifications (lastest first): +% 2009-11-02 Bug fix: footnote macros are fixed. +% Add macros: \prname, \drname, \phdname, \scdname, +% \mdname, \pename, \iename. +% 2009-10-30 Add support for book and report classes. +% 2009-10-28 Add \parskip. +% Rename macros to avoid conflicts: \st->\ust, \nd->\und, +% \rd->\urd, \th->\uth +% 2009-10-27 Add framedminipage environment. +% 2009-06-25 Add \tablenote in mtable environment. +% 2009-06-23 Add upmcaution, upminfo and upmquestion environments. +% 2009-05-08 Remove CR character +% Add \arakhneorg command % 2009-04-29 Include package pifont (texlive distribution) % 2007-07-07 Override the bibliography functions. % 2007-07-06 Bug fix: use varioref for the footnote references. @@ -33,11 +45,13 @@ % Bug fix: centering table's headers. % -\global\edef\upm@package@fmt@ver{2009/04/29} +\global\edef\upm@package@fmt@ver{2009/11/01} \NeedsTeXFormat{LaTeX2e}[1995/12/01] \ProvidesPackage{upmethodology-fmt}[\upm@package@fmt@ver] +\RequirePackage{upmethodology-p-common} + \gdef\upm@fmt@force@single@spacing#1{{\begin{singlespace}#1\end{singlespace}}} \gdef\upm@date@head#1/#2\@nil{#1} \gdef\upm@date@tail#1/#2\@nil{#2} @@ -53,6 +67,13 @@ \global\renewcommand{\upm@format@lang@makedate}[3]{##3\string/\two@digits{##2}\string/\two@digits{##1}}% \global\let\upm@format@lang@extractyear\upm@date@first% \global\let\upm@format@lang@extractmonth\upm@date@second% + \gdef\upm@format@lang@professor{Pr.}% + \gdef\upm@format@lang@doctor{Dr.}% + \gdef\upm@format@lang@phdoctor{Ph.D.}% + \gdef\upm@format@lang@scdoctor{Sc.D.}% + \gdef\upm@format@lang@mdoctor{M.D.}% + \gdef\upm@format@lang@professionalengineer{CEng.}% + \gdef\upm@format@lang@incorporatedengineer{IEng.}% } \global\let\upm@format@lang@extractyear\upm@date@first% \def\upm@format@lang@french{% @@ -61,6 +82,13 @@ \global\let\upm@format@lang@extractyear\upm@date@third% \global\let\upm@format@lang@extractmonth\upm@date@second% \global\let\upm@format@lang@extractday\upm@date@first% + \gdef\upm@format@lang@professor{Pr.}% + \gdef\upm@format@lang@doctor{Dr.}% + \gdef\upm@format@lang@phdoctor{Ph.D.}% + \gdef\upm@format@lang@scdoctor{Sc.D.}% + \gdef\upm@format@lang@mdoctor{M.D.}% + \gdef\upm@format@lang@professionalengineer{Ing.}% + \gdef\upm@format@lang@incorporatedengineer{Ing.}% } \global\providecommand{\upm@format@lang@makedate}[3]{}% @@ -84,9 +112,7 @@ \upm@lang@@ -\RequirePackage{xspace} -\RequirePackage{ifthen} -\RequirePackage{graphicx} +\RequirePackage[final]{graphicx} \RequirePackage{subfigure} \RequirePackage{tabularx} \RequirePackage{multicol} @@ -96,14 +122,17 @@ \RequirePackage{pifont} \RequirePackage{setspace} \RequirePackage{varioref} +\RequirePackage{txfonts} %---------------------------------------- % Exponent and indice %---------------------------------------- % Exponent -\newcommand{\textsup}[1]{\ensuremath{^{\text{#1}}}\xspace} +%\newcommand{\textsup}[1]{\ensuremath{^{\text{#1}}}\xspace} +\newcommand{\textsup}[1]{\upm@textsuperscript{#1}\xspace} % Indice -\newcommand{\textsub}[1]{\ensuremath{_{\text{#1}}}\xspace} +%\newcommand{\textsub}[1]{\ensuremath{_{\text{#1}}}\xspace} +\newcommand{\textsub}[1]{\upm@textsubscript{#1}\xspace} %---------------------------------------- % SYMBOLS @@ -115,10 +144,10 @@ \newcommand{\smalltrade}{{\tiny\trademark}\xspace} \newcommand{\smallreg}{{\tiny\regmark}\xspace} \newcommand{\smallcopy}{{\tiny\copyright}\xspace} -\gdef\st{\textsup{st}} -\gdef\nd{\textsup{nd}} -\gdef\rd{\textsup{rd}} -\gdef\th{\textsup{th}} +\newcommand{\ust}{\textsup{st}} +\newcommand{\und}{\textsup{nd}} +\newcommand{\urd}{\textsup{rd}} +\newcommand{\uth}{\textsup{th}} %---------------------------------------- @@ -317,15 +346,20 @@ \table[#1]\center% \global\protected@edef\upm@table@caption{#5}% \global\protected@edef\upm@table@label{tab:#6}% + \gdef\upm@table@note{}% \newcommand{\captionastitle}{\tabulartitle{\upm@table@caption}}% + \newcommand{\tablenote}[1]{\gdef\upm@table@note{##1}}% \mtabular[#2]{#3}{#4}% }{% \endmtabular% \caption{\upm@table@caption}% \label{\upm@table@label}% - \endcenter\endtable% + \endcenter% + {\upm@table@note}% + \endtable% \let\upm@table@caption\relax% \let\upm@table@label\relax% + \let\upm@table@note\relax% } %----- @@ -339,83 +373,215 @@ % PARAGRAPHS %---------------------------------------- \setlength{\parindent}{0pt} +\setlength{\parskip}{.2cm} %---------------------------------------- % COLORIZED SECTION'S TITLES %---------------------------------------- -\definecolor{titlecolor}{rgb}{0.93,0.41,0} -\definecolor{maintitlecolor}{rgb}{0.24,0.33,0.48} - -\gdef\upm@format@chapternum#1{\textcolor{maintitlecolor}{\huge \scshape #1}} -\gdef\upm@format@chaptertitle#1{\textcolor{maintitlecolor}{ - \Huge\scshape {#1}}} -\gdef\upm@format@sectionnum#1{\textcolor{titlecolor}{#1}} -\gdef\upm@format@sectiontitle#1{\textcolor{titlecolor}{#1}} - -\gdef\@makechapterhead#1{% - \vspace*{50\p@}% - {\parindent \z@ \raggedright \normalfont - \ifnum \c@secnumdepth >\m@ne - \if@mainmatter - \upm@format@chapternum{\@chapapp\space \thechapter} - \par\nobreak - \vskip 20\p@ - \fi - \fi - \interlinepenalty\@M - \doublespacing - \upm@format@chaptertitle{#1}\par\nobreak - \vskip 40\p@ - } -} -\gdef\@makeschapterhead#1{% - \vspace*{50\p@}% - {\parindent \z@ \raggedright - \normalfont - \interlinepenalty\@M - \doublespacing - \upm@format@chaptertitle{#1}\par\nobreak - \vskip 40\p@ - } -} -\renewcommand{\section}{\@startsection{section}{1}{\z@}{-3.5ex \@plus -1ex \@minus -.2ex}{2.3ex \@plus.2ex}{\normalfont\Large\scshape}} -\renewcommand{\subsection}{\@startsection{subsection}{2}{\z@}{-3.25ex\@plus -1ex \@minus -.2ex}{1.5ex \@plus .2ex}{\normalfont\large\scshape}} -\renewcommand{\subsubsection}{\@startsection{subsubsection}{3}{\z@}{-3.25ex\@plus -1ex \@minus -.2ex}{1.5ex \@plus .2ex}{\normalfont\normalsize\scshape}} + +% PRIVATE COLORS +\definecolor{sectiontitlecolor}{rgb}{0.93,0.41,0} +\definecolor{chaptertitlecolor}{rgb}{0.24,0.33,0.48} +\definecolor{parttitlecolor}{rgb}{0.24,0.33,0.48} + +% PRIVATE FORMATTING MACROS +\newcounter{upm@format@section@sectionlevel} +\setcounter{upm@format@section@sectionlevel}{0} + +\gdef\upm@format@partnum#1{\textcolor{parttitlecolor}{\expandafter\fontsize{40pt}{60pt}\selectfont#1\normalfont}} +\gdef\upm@format@parttitle#1{\textcolor{parttitlecolor}{\huge\scshape #1}} +\gdef\upm@format@chapternum#1{\textcolor{chaptertitlecolor}{\expandafter\fontsize{40pt}{60pt}\selectfont#1\normalfont}} +\gdef\upm@format@chaptertitle#1{\textcolor{chaptertitlecolor}{\Huge\scshape #1}} +\gdef\upm@format@sectionnum#1#2{\textcolor{sectiontitlecolor}{#2}} +\gdef\upm@format@sectiontitle#1#2{\textcolor{sectiontitlecolor}{#2}} + +% PART +\ifupmbookformat + \gdef\@part[#1]#2{% + \ifnum \c@secnumdepth >-2\relax + \refstepcounter{part}% + \addcontentsline{toc}{part}{\thepart\hspace{1em}#1}% + \else + \addcontentsline{toc}{part}{#1}% + \fi + \markboth{}{}% + {\centering + \interlinepenalty \@M + \normalfont + \ifnum \c@secnumdepth >-2\relax + \upm@format@partnum{\thepart} + \par + \vskip 20\p@ + \fi + \upm@format@parttitle{#2}\par}% + \@endpart} + \gdef\@spart#1{% + {\centering + \interlinepenalty \@M + \normalfont + \upm@format@parttitle{#1}\par}% + \@endpart} +\fi + +% CHAPTER +\ifupmarticleformat\else + \newcommand{\upm@format@makechapterhead}[2]{% + %\vspace*{50\p@}% + {\parindent \z@ \raggedleft \normalfont + \ifx\@empty#1\ifnum \c@secnumdepth >\m@ne + \upm@format@chapternum{\thechapter} + \par\nobreak + \vskip 20\p@ + \fi\fi + \interlinepenalty\@M + \ifupmbookformat\doublespacing\fi + \upm@format@chaptertitle{#2}\par\nobreak + \vskip 80\p@ + } + } + %internal implementation of \chapter + \gdef\@makechapterhead#1{\upm@format@makechapterhead{\@empty}{#1}} + %internal implementation of \chapter* + \gdef\@makeschapterhead#1{\upm@format@makechapterhead{\relax}{#1}} +\fi + +% SECTIONS \let\upm@format@sect@old\@sect -\gdef\@sect#1#2#3#4#5#6[#7]#8{\upm@format@sect@old{#1}{#2}{#3}{#4}{#5}{#6}[#7]{\upm@format@sectiontitle{#8}}} \let\upm@format@ssect@old\@ssect -\gdef\@ssect#1#2#3#4#5{\upm@format@ssect@old{#1}{#2}{#3}{#4}{\upm@format@sectiontitle{#5}}} -\gdef\@seccntformat#1{\upm@format@sectionnum{\csname the#1\endcsname/}\quad} + +% public implementation of sections. +\renewcommand{\section}{\setcounter{upm@format@section@sectionlevel}{1}\@startsection{section}{1}{\z@}{-3.5ex \@plus -1ex \@minus -.2ex}{2.3ex \@plus.2ex}{\normalfont\Large\scshape}} +\renewcommand{\subsection}{\setcounter{upm@format@section@sectionlevel}{2}\@startsection{subsection}{2}{\z@}{-3.25ex\@plus -1ex \@minus -.2ex}{1.5ex \@plus .2ex}{\normalfont\large\scshape}} +\renewcommand{\subsubsection}{\setcounter{upm@format@section@sectionlevel}{3}\@startsection{subsubsection}{3}{\z@}{-3.25ex\@plus -1ex \@minus -.2ex}{1.5ex \@plus .2ex}{\normalfont\normalsize\scshape}} + +% internal implementations for sections. +\gdef\@sect#1#2#3#4#5#6[#7]#8{\upm@format@sect@old{#1}{#2}{#3}{#4}{#5}{#6}[#7]{\upm@format@sectiontitle{\theupm@format@section@sectionlevel}{#8}}} +\gdef\@ssect#1#2#3#4#5{\upm@format@ssect@old{#1}{#2}{#3}{#4}{\upm@format@sectiontitle{\theupm@format@section@sectionlevel}{#5}}} +\gdef\@seccntformat#1{\upm@format@sectionnum{\theupm@format@section@sectionlevel}{\csname the#1\endcsname/}\quad} %---------------------------------------- % PAGE LAYOUT %---------------------------------------- -% Update the formatof the saved pages and sections -\AtBeginDocument{ - \renewcommand{\chaptermark}[1]{\markboth{\textsc{#1}}{}} - \renewcommand{\sectionmark}[1]{\markright{\thesection\ \textsc{#1}}} - \renewcommand{\@mkboth}[2]{% + +% Update the format of the saved pages and sections +\renewcommand{\sectionmark}[1]{\markright{\thesection\ \textsc{#1}}} +\ifupmarticleformat\else +\renewcommand{\chaptermark}[1]{\markboth{\textsc{#1}}{}} +\renewcommand{\@mkboth}[2]{% \let\upm@doc@MakeUppercase\MakeUppercase% \gdef\MakeUppercase##1{##1}% \chaptermark{#1}% \let\MakeUppercase\upm@doc@MakeUppercase% \let\upm@doc@MakeUppercase\relax% - } } +\fi % Make sure that the page before a part or % a chapter title was empty -\AtBeginDocument{% - \renewcommand{\cleardoublepage}{% - \clearpage% - \if@twoside\ifodd\c@page% - \else% - \thispagestyle{facingtochapter}% - \hbox{}\newpage% - \if@twocolumn\hbox{}\newpage% - \fi\fi\fi% - } - \newcommand{\ps@facingtochapter}{\ps@empty} - } +\renewcommand{\cleardoublepage}{% + \clearpage% + \if@twoside\ifodd\c@page% + \else% + \thispagestyle{facingtochapter}% + \hbox{}\newpage% + \if@twocolumn\hbox{}\newpage% + \fi\fi\fi% +} +\newcommand{\ps@facingtochapter}{\ps@empty} + +%---------------------------------------- +% ADDITIONAL SECTIONS +%---------------------------------------- + +\gdef\upm@format@newsection@alignment{} + +%----- +% Part without number but inside the TOC +%\parttoc [toctitle]{title} % left-alignment inside TOC +%\parttoc*[toctitle]{title} % right-alignment inside TOC +\def\parttoc{\@ifstar% + {\gdef\upm@format@newsection@alignment{\protect\numberline{}}\expandafter\upm@format@newsection@part}% + {\gdef\upm@format@newsection@alignment{}\expandafter\upm@format@newsection@part}} +\def\upm@format@newsection@part{\@ifnextchar [% + {\expandafter\upm@format@newsection@part@opt}% + {\expandafter\upm@format@newsection@part@nopt}} +\def\upm@format@newsection@part@opt[#1]#2{% + \part*{#2\addcontentsline{toc}{part}{\upm@format@newsection@alignment{#1}}}% + \chaptermark{}% +} +\def\upm@format@newsection@part@nopt#1{% + \part*{#1\addcontentsline{toc}{part}{\upm@format@newsection@alignment{#1}}}% + \chaptermark{}% +} + +%----- +% Chapter without number but inside the TOC +%\chaptertoc [toctitle]{title} % left-alignment inside TOC +%\chaptertoc*[toctitle]{title} % right-alignment inside TOC +\def\chaptertoc{\@ifstar% + {\gdef\upm@format@newsection@alignment{\protect\numberline{}}\expandafter\upm@format@newsection@chapter}% + {\gdef\upm@format@newsection@alignment{}\expandafter\upm@format@newsection@chapter}} +\def\upm@format@newsection@chapter{\@ifnextchar [% + {\expandafter\upm@format@newsection@chapter@opt}% + {\expandafter\upm@format@newsection@chapter@nopt}} +\def\upm@format@newsection@chapter@opt[#1]#2{% + \@schapter{#2\addcontentsline{toc}{chapter}{\upm@format@newsection@alignment{#1}}}% + \chaptermark{#1}% +} +\def\upm@format@newsection@chapter@nopt#1{% + \@schapter{#1\addcontentsline{toc}{chapter}{\upm@format@newsection@alignment{#1}}}% + \chaptermark{#1}% +} + +%----- +% Section without number but inside the TOC +%\sectiontoc [toctitle]{title} % left-alignment inside TOC +%\sectiontoc*[toctitle]{title} % right-alignment inside TOC +\def\sectiontoc{\@ifstar% + {\gdef\upm@format@newsection@alignment{\protect\numberline{}}\expandafter\upm@format@newsection@section}% + {\gdef\upm@format@newsection@alignment{}\expandafter\upm@format@newsection@section}} +\def\upm@format@newsection@section{\@ifnextchar [% + {\expandafter\upm@format@newsection@section@opt}% + {\expandafter\upm@format@newsection@section@nopt}} +\def\upm@format@newsection@section@opt[#1]#2{% + \section*{#2\addcontentsline{toc}{section}{\upm@format@newsection@alignment{#1}}}% +} +\def\upm@format@newsection@section@nopt#1{% + \section*{#1\addcontentsline{toc}{section}{\upm@format@newsection@alignment{#1}}}% +} + +%----- +% Subsection without number but inside the TOC +%\subsectiontoc [toctitle]{title} % left-alignment inside TOC +%\subsectiontoc*[toctitle]{title} % right-alignment inside TOC +\def\subsectiontoc{\@ifstar% + {\gdef\upm@format@newsection@alignment{\protect\numberline{}}\expandafter\upm@format@newsection@subsection}% + {\gdef\upm@format@newsection@alignment{}\expandafter\upm@format@newsection@subsection}} +\def\upm@format@newsection@subsection{\@ifnextchar [% + {\expandafter\upm@format@newsection@subsection@opt}% + {\expandafter\upm@format@newsection@subsection@nopt}} +\def\upm@format@newsection@subsection@opt[#1]#2{% + \subsection*{#2\addcontentsline{toc}{subsection}{\upm@format@newsection@alignment{#1}}}% +} +\def\upm@format@newsection@subsection@nopt#1{% + \subsection*{#1\addcontentsline{toc}{subsection}{\upm@format@newsection@alignment{#1}}}% +} + +%----- +% Subsubsection without number but inside the TOC +%\subsubsectiontoc [toctitle]{title} % left-alignment inside TOC +%\subsubsectiontoc*[toctitle]{title} % right-alignment inside TOC +\def\subsubsectiontoc{\@ifstar% + {\gdef\upm@format@newsection@alignment{\protect\numberline{}}\expandafter\upm@format@newsection@subsubsection}% + {\gdef\upm@format@newsection@alignment{}\expandafter\upm@format@newsection@subsubsection}} +\def\upm@format@newsection@subsubsection{\@ifnextchar [% + {\expandafter\upm@format@newsection@subsubsection@opt}% + {\expandafter\upm@format@newsection@subsubsection@nopt}} +\def\upm@format@newsection@subsubsection@opt[#1]#2{% + \subsubsection*{#2\addcontentsline{toc}{subsubsection}{\upm@format@newsection@alignment{#1}}}% +} +\def\upm@format@newsection@subsubsection@nopt#1{% + \subsubsection*{#1\addcontentsline{toc}{subsubsection}{\upm@format@newsection@alignment{#1}}}% +} %---------------------------------------- % BIBLIOGRAPHY @@ -471,38 +637,37 @@ % FOOTNOTE %---------------------------------------- -\newcommand{\upm@footnoteref}[1]{\mbox{\ensuremath{^{\text{\ref{footnote:#1}}}}}} -\newcommand{\upm@footnotepageref}[1]{\mbox{\ensuremath{^{\text{\ref{footnote:#1}}}_{\text{\tiny \vpageref[]{footnote:#1}}}}}} -\newcommand{\@namelet}[1]{\expandafter\let\csname #1\endcsname} +\gdef\upm@footnoteref#1{\upm@textsuperscript{#1}} +\gdef\upm@footnotepageref#1#2{\upm@textsuperscript{{#1\tiny(#2)}}} -\newcommand{\upm@savefootnote}[2]{% - \footnote{#1\label{footnote:#2}}% - \global\@namelet{footnote:#2:cmd}\relax% +\def\upm@savefootnote#1#2{% + \footnote{#1\label{\upm@protect{footnote:#2}}}% + \upm@nameundef{footnote:#2:cmd}% } -\newcommand{\upm@savefootnotestar}[2]{% - \global\@namedef{footnote:#2:cmd}{% - \upm@savefootnote{#1}{#2}% - }% +\def\upm@savefootnotestar#1#2{% + \upm@namedef{footnote:#2:cmd}{\upm@savefootnote{#1}{#2}}% } -\gdef\savefootnote{\@ifstar\upm@savefootnotestar\upm@savefootnote} +\DeclareRobustCommand\savefootnote{\@ifstar\upm@savefootnotestar\upm@savefootnote} -\newcommand{\upm@reffootnote}[1]{% - \expandafter\ifx\csname footnote:#1:cmd\endcsname\relax% - \upm@footnoteref{#1}% - \else% - \@nameuse{footnote:#1:cmd}% - \fi\xspace% +\def\upm@reffootnote#1{% + \upm@ifdefinedname{footnote:#1:cmd}{% + \upm@nameuse{footnote:#1:cmd}}{% + \upm@footnoteref{\upm@getref{\upm@protect{footnote:#1}}}% + }% + \xspace% } -\newcommand{\upm@reffootnotestar}[1]{% - \expandafter\ifx\csname footnote:#1:cmd\endcsname\relax% - \upm@footnotepageref{#1}% - \else% - \@nameuse{footnote:#1:cmd}% - \fi\xspace% +\def\upm@reffootnotestar#1{% + \upm@ifdefinedname{footnote:#1:cmd}{% + \upm@nameuse{footnote:#1:cmd}}{% + \xdef\upm@tmp@tmp{\upm@protect{footnote:#1}}% + \upm@footnotepageref{\expandafter\upm@getref{\upm@tmp@tmp}}{\expandafter\upm@getpageref{\upm@tmp@tmp}}% + \global\let\upm@tmp@tmp\relax% + }% + \xspace% } -\gdef\reffootnote{\@ifstar\upm@reffootnotestar\upm@reffootnote} +\DeclareRobustCommand\reffootnote{\@ifstar\upm@reffootnotestar\upm@reffootnote} %---------------------------------------- % IMAGES IN PARAGRAPHS @@ -550,12 +715,83 @@ \else% {\mbox{\small #2}#4\mbox{\small #1}#4\textsc{#3}}% \fi% - \xspace% } %\makename[von]{firstname}{lastname} \newcommand{\makename}[3][\relax]{% - \upmmakename[#1]{#2}{#3}{\ } + \upmmakename[#1]{#2}{#3}{\ }% +} + +\gdef\upm@format@people@title#1{\textsc{#1}} + +%\prname[von]{firstname}{lastname} +%\prname*[von]{firstname}{lastname} +\def\prname{\@ifstar\upm@prnamestar\upm@prname} +\newcommand{\upm@prname}[3][\relax]{% + \upm@format@people@title{\upm@format@lang@professor}~\upmmakename[#1]{#2}{#3}{\ }% +} +\newcommand{\upm@prnamestar}[3][\relax]{% + \upmmakename[#1]{#2}{#3}{\ }, \upm@format@people@title{\upm@format@lang@professor}% +} + +%\drname[von]{firstname}{lastname} +%\drname*[von]{firstname}{lastname} +\def\drname{\@ifstar\upm@drnamestar\upm@drname} +\newcommand{\upm@drname}[3][\relax]{% + \upm@format@people@title{\upm@format@lang@doctor}~\upmmakename[#1]{#2}{#3}{\ }% +} +\newcommand{\upm@drnamestar}[3][\relax]{% + \upmmakename[#1]{#2}{#3}{\ }, \upm@format@people@title{\upm@format@lang@doctor}% +} + +%\phdname[von]{firstname}{lastname} +%\phdname*[von]{firstname}{lastname} +\def\phdname{\@ifstar\upm@phdnamestar\upm@phdname} +\newcommand{\upm@phdname}[3][\relax]{% + \upm@format@people@title{\upm@format@lang@phdoctor}~\upmmakename[#1]{#2}{#3}{\ }% +} +\newcommand{\upm@phdnamestar}[3][\relax]{% + \upmmakename[#1]{#2}{#3}{\ }, \upm@format@people@title{\upm@format@lang@phdoctor}% +} + +%\scdname[von]{firstname}{lastname} +%\scdname*[von]{firstname}{lastname} +\def\scdname{\@ifstar\upm@scdnamestar\upm@scdname} +\newcommand{\upm@scdname}[3][\relax]{% + \upm@format@people@title{\upm@format@lang@scdoctor}~\upmmakename[#1]{#2}{#3}{\ }% +} +\newcommand{\upm@scdnamestar}[3][\relax]{% + \upmmakename[#1]{#2}{#3}{\ }, \upm@format@people@title{\upm@format@lang@scdoctor}% +} + +%\mdname[von]{firstname}{lastname} +%\mdname*[von]{firstname}{lastname} +\def\mdname{\@ifstar\upm@mdnamestar\upm@mdname} +\newcommand{\upm@mdname}[3][\relax]{% + \upm@format@people@title{\upm@format@lang@mdoctor}~\upmmakename[#1]{#2}{#3}{\ }% +} +\newcommand{\upm@mdnamestar}[3][\relax]{% + \upmmakename[#1]{#2}{#3}{\ }, \upm@format@people@title{\upm@format@lang@mdoctor}% +} + +%\pengname[von]{firstname}{lastname} +%\pengname*[von]{firstname}{lastname} +\def\pengname{\@ifstar\upm@pengnamestar\upm@pengname} +\newcommand{\upm@pengname}[3][\relax]{% + \upm@format@people@title{\upm@format@lang@professionalengineer}~\upmmakename[#1]{#2}{#3}{\ }% +} +\newcommand{\upm@pengnamestar}[3][\relax]{% + \upmmakename[#1]{#2}{#3}{\ }, \upm@format@people@title{\upm@format@lang@professionalengineer}% +} + +%\iengname[von]{firstname}{lastname} +%\iengname*[von]{firstname}{lastname} +\def\iengname{\@ifstar\upm@iengnamestar\upm@iengname} +\newcommand{\upm@iengname}[3][\relax]{% + \upm@format@people@title{\upm@format@lang@incorporatedengineer}~\upmmakename[#1]{#2}{#3}{\ }% +} +\newcommand{\upm@iengnamestar}[3][\relax]{% + \upmmakename[#1]{#2}{#3}{\ }, \upm@format@people@title{\upm@format@lang@incorporatedengineer}% } %---------------------------------------- @@ -633,4 +869,59 @@ #1% }{\endgroup} +%---------------------------------------- +% FRAMED MINIPAGE +%---------------------------------------- + +\newsavebox{\upm@framed@minipage} +%\begin{framedminipage}{width}...\end{frameedminipage} +\newenvironment{framedminipage}[1]{% + \begin{lrbox}{\upm@framed@minipage}\begin{minipage}{#1}% + }{% + \end{minipage}\end{lrbox}\fbox{\usebox{\upm@framed@minipage}}} + +%---------------------------------------- +% HIGHLIGH BOXES +%---------------------------------------- + +\newsavebox{\upm@highlight@box@save} + +\newenvironment{upm@highligh@box}[2]{% + \par + \vspace{.5cm} + \begin{tabular}{|p{#1}|} + \hline + \begin{window}[0,l,{\mbox{\includegraphics[width=1cm]{#2}}},{}] +}{% + \end{window}\\ \hline \end{tabular} + \vspace{.5cm} + \par +} + +\newenvironment{upmcaution}[1][\linewidth]{% + \upm@highligh@box{#1}{caution.png}% +}{% + \endupm@highligh@box% +} + +\newenvironment{upminfo}[1][\linewidth]{% + \upm@highligh@box{#1}{info.png}% +}{% + \endupm@highligh@box% +} + +\newenvironment{upmquestion}[1][\linewidth]{% + \upm@highligh@box{#1}{question.png}% +}{% + \endupm@highligh@box% +} + +%---------------------------------------- +% PROVIDE URL MACROS, WHICH WILL BE +% OVERRIDDEN BY THE DOCUMENT CLASS +%---------------------------------------- + +\newcommand{\url}[2][]{\texttt{#2}} +\newcommand{\href}[3][]{\texttt{#3}} + \endinput diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-frontpage.sty b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-frontpage.sty index 0f35ac7e19d..ded8bcfa8fe 100644 --- a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-frontpage.sty +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-frontpage.sty @@ -1,6 +1,6 @@ % Front page for Unified Process Methodology % -% Copyright (c) 2006-2007 Stephane GALLAND <galland@arakhne.org> +% Copyright (c) 2006-2009 Stephane GALLAND <galland@arakhne.org> % % This program is free library; you can redistribute it and/or modify % it under the terms of the GNU Lesser General Public License as @@ -19,17 +19,23 @@ % % Creation date: 2006-04-11 % Modifications: +% 2009-10-30 Clean code. +% 2009-10-29 Major bug fix: invert order of the \setfrontillustration parameters. +% 2009-10-27 Clean the extension API. +% 2009-10-22 Add support for front page from UPM extensions. % 2007-07-05 Add people name formatting function. % 2007-07-03 Force single spacing inside the title. % 2007-03-19 Add localization. % 2006-04-19 Add version number. % -\global\edef\upm@package@fp@ver{2007/07/04} +\global\edef\upm@package@fp@ver{2009/10/30} \NeedsTeXFormat{LaTeX2e}[1995/12/01] \ProvidesPackage{upmethodology-frontpage}[\upm@package@fp@ver] +\RequirePackage{upmethodology-p-common} + %----- % Locales \def\upm@front@lang@english{ @@ -56,11 +62,7 @@ \ProcessOptions \upm@lang@@ -\RequirePackage{xspace} -\RequirePackage{tabularx} -\RequirePackage{graphicx} -\RequirePackage{setspace} - +\RequirePackage{upmethodology-extension} \RequirePackage{upmethodology-document} % Declare the temporary dimensions @@ -82,15 +84,16 @@ %----- % Define the command to put the title with a classic layout \newcommand{\upm@front@layout@classic}{% + \message{************ USE CLASSIC FRONT COVER} \begin{titlepage}% \begin{center} % Illustration picture - \ifx\upm@front@illustration\relax - \noindent\vfill\includegraphics[width=.4\linewidth]{\theupmdoclogo} - \else - \noindent\expandafter\includegraphics[width=\upm@front@illustration@size\expandafter\linewidth]{\upm@front@illustration} - \fi + \Ifelsedefined{frontillustration}{% + \noindent\expandafter\includegraphics[width=\Get{frontillustrationsize}\expandafter\linewidth]{\Get{frontillustration}} + }{% + \Ifdefined{logo}{\noindent\vfill\expandafter\includegraphics[width=.4\linewidth]{\Get{logo}}}% + }% % Project name \vspace{1cm} @@ -100,7 +103,7 @@ % Document title \noindent\rule{\linewidth}{1mm} \\ \noindent\raggedleft\upm@front@project@fmt{\theupmproject} \\ - \upm@ifnotempty{\theupmsubproject}{\noindent\raggedleft\upm@front@subproject@fmt{\theupmsubproject}\\} + \Ifnotempty{\theupmsubproject}{\noindent\raggedleft\upm@front@subproject@fmt{\theupmsubproject}\\} \vspace{.5cm} \noindent\raggedleft\upm@front@document@fmt{\theupmdocname} \\ \noindent\rule{\linewidth}{1mm} \\ @@ -116,14 +119,18 @@ \end{tabular} \vfill - \ifx\upm@front@illustration\relax - \noindent\raggedleft\upm@front@author@fmt{\upm@lang@front@authors:~\theauthorlist} \\ - \else - \noindent\begin{tabularx}{\linewidth}{l>{\raggedleft}X} - \includegraphics[width=.3\linewidth]{\theupmdoclogo} & - \upm@front@author@fmt{\upm@lang@front@authors:~\theauthorlist} \\ - \end{tabularx} - \fi + \Ifelsedefined{frontillustration}{% + \Ifelsedefined{logo}{% + \noindent\begin{tabularx}{\linewidth}{l>{\raggedleft}X}% + \expandafter\includegraphics[width=.3\linewidth]{\Get{logo}} & % + \upm@front@author@fmt{\upm@lang@front@authors:~\theauthorlist} \\% + \end{tabularx}% + }{% + \noindent\raggedleft\upm@front@author@fmt{\upm@lang@front@authors:~\theauthorlist} \\% + }% + }{% + \noindent\raggedleft\upm@front@author@fmt{\upm@lang@front@authors:~\theauthorlist} \\% + }% \end{center} \end{titlepage} @@ -133,13 +140,14 @@ %----- % Define the command to put the title with a classic layout \newcommand{\upm@front@layout@modern}{% + \message{************ USE MODERN FRONT COVER} \begin{titlepage}% % Project name \upm@front@maintitle@fmt{\theupmproject} \\ \noindent\rule{\linewidth}{.5mm} \\ % Document title - \upm@ifnotempty{\theupmsubproject}{\noindent\raggedright\upm@front@subproject@fmt{\theupmsubproject}\\} + \Ifnotempty{\theupmsubproject}{\noindent\raggedright\upm@front@subproject@fmt{\theupmsubproject}\\} \vspace{.5cm} \noindent\raggedright\upm@front@force@single@spacing{\upm@front@document@fmt{\theupmdocname}} @@ -147,12 +155,12 @@ \vbox{ \begin{picture}(0,0) - \ifx\upm@front@illustration\relax - \else - \put(-110,-100){ - \includegraphics[width=\upm@front@illustration@size\expandafter\linewidth]{\upm@front@illustration} + \Ifelsedefined{frontillustration}{% + \put(-110,-100){% + \includegraphics[width=\Get{frontillustrationsize}\expandafter\linewidth]{\Get{frontillustration}}% + }% + }{% } - \fi \upm@front@tmpa=\linewidth \advance\upm@front@tmpa-.4\linewidth \put(\strip@pt\upm@front@tmpa,75){ @@ -165,8 +173,10 @@ } \upm@front@tmpa=\linewidth \advance\upm@front@tmpa-.3\linewidth - \put(\strip@pt\upm@front@tmpa,-50){ - \includegraphics[width=.3\linewidth]{\theupmdoclogo}% + \Ifdefined{logo}{ + \put(\strip@pt\upm@front@tmpa,-50){ + \expandafter\includegraphics[width=.3\linewidth]{\Get{logo}}% + } } \end{picture} @@ -174,37 +184,58 @@ \end{titlepage} } -%---- -% Set the front page layout as the classic layout theme -%\setfrontlayout{layout_name} -\newcommand{\setfrontlayout}[1]{% +\newcommand{\upm@front@setfrontlayout}[2]{% \ifthenelse{\equal{#1}{classic}}{% - \gdef\upm@front@illustration@size{.6} + \Set{frontillustrationsize}{.6}% \global\let\upm@front@layout\upm@front@layout@classic% }{% \ifthenelse{\equal{#1}{modern}}{% - \gdef\upm@front@illustration@size{1} + \Set{frontillustrationsize}{1} \global\let\upm@front@layout\upm@front@layout@modern% }{% - \errmessage{invalid front layout theme: #1}% + \ifthenelse{\equal{#1}{custom}}{#2}{\errmessage{invalid front layout theme: #1}}% }% }% } -\setfrontlayout{classic} - -\AtBeginDocument{% - \renewcommand{\maketitle}{\upm@front@layout}% +%---- +% Set the front page layout as the classic layout theme +%\setfrontcover{layout_name} +\newcommand{\setfrontcover}[1]{% + \upm@front@setfrontlayout{#1}{\errmessage{invalid front layout theme: #1}}% } - -\let\upm@front@illustration\relax +\newcommand{\setfrontlayout}[1]{\errmessage{"\string\setfrontlayout" is deprecated. Use "\string\setfrontcover" insteed}} + +\setfrontcover{classic} + +\renewcommand{\maketitle}{% + \Ifdefined{frontpage}{ + \upm@front@setfrontlayout{\Get{frontpage}}{% + \message{************ USE CUSTOM FRONT COVER} + \gdef\upm@front@layout{% + \begin{titlepage}% + \Get{frontpage@custom}% + \end{titlepage}% + }% + }% + }% + \upm@front@layout}% +\newcommand{\makefrontcover}{\maketitle} %---- % Set the illustration figure on the front page %\setfrontillustration[size_factor]{filename} \newcommand{\setfrontillustration}[2][1]{% - \gdef\upm@front@illustration{#2}% - \gdef\upm@front@illustration@size{#1}% + \Set{frontillustrationsize}{#1}% + \Set{frontillustration}{#2}% +} + +%---- +% Clear the illustration figure on the front page +%\clearfrontillustration +\newcommand{\clearfrontillustration}{% + \Set{frontillustrationsize}{1}% + \Unset{frontillustration}% } \endinput diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-p-common.sty b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-p-common.sty new file mode 100644 index 00000000000..3768fc94363 --- /dev/null +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-p-common.sty @@ -0,0 +1,137 @@ +% Copyright (c) 2009 Stephane GALLAND <galland@arakhne.org> +% +% This program is free library; you can redistribute it and/or modify +% it under the terms of the GNU Lesser General Public License as +% published by the Free Software Foundation; either version 3 of the +% License, or any later version. +% +% This library is distributed in the hope that it will be useful, but +% WITHOUT ANY WARRANTY; without even the implied warranty of +% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +% Lesser General Public License for more details. +% +% You should have received a copy of the GNU Lesser General Public +% License along with this library; see the file COPYING. If not, +% write to the Free Software Foundation, Inc., 59 Temple Place - Suite +% 330, Boston, MA 02111-1307, USA. +% +% Creation date: 2009-10-30 +% Modifications (lastest first): +% 2009-11-03 \If* macros are marked with \long +% 2009-11-02 Add internal commands for footnotes. +% + +\global\edef\upm@package@private@doctype@ver{2009/11/03} + +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesPackage{upmethodology-p-doctype}[\upm@package@private@doctype@ver] + +\RequirePackage{ifthen} +\RequirePackage{xspace} +\RequirePackage{color} + +%---------------------------------------- +% ARAKHNE.ORG MACRO +%---------------------------------------- +\providecommand{\arakhneorg}{{\begingroup% + {\usefont{T1}{pzc}{m}{it}\selectfont Arakhn\^e}% + {\usefont{T1}{phv}{bc}{sc}\selectfont\tiny.org}\endgroup}\xspace} + +%---------------------------------------- +% CURRENT LANGUAGE +%---------------------------------------- +\def\upmcurrentlang{english} + +%---------------------------------------- +% TEST MACROS +%---------------------------------------- +\long\def\Ifnotempty#1{\ifthenelse{\equal{#1}{\@empty}}{}} +\long\def\Ifempty#1#2{\ifthenelse{\equal{#1}{\@empty}}{#2}{}} +\long\def\Ifelseempty#1#2#3{\ifthenelse{\equal{#1}{\@empty}}{#2}{#3}} + +%---------------------------------------- +% DOCUMENT TYPE +%---------------------------------------- +\newif\ifupmbookformat +\newif\ifupmreportformat +\newif\ifupmarticleformat + +\upmbookformatfalse +\upmreportformattrue +\upmarticleformatfalse + +%---------------------------------------- +% PDF COLORS +%---------------------------------------- +\newcommand{\setpdfcolor}[1]{} + +%---------------------------------------- +% CREATE COMMAND WITH ID AS NAME +%---------------------------------------- +\def\upm@protect#1{\upm@p@protect #1\relax} +\def\upm@p@protect#1#2\relax{% + \ifx\relax #1% + \relax + \else% + \string #1% + \ifx\relax #2% + \relax + \else + \upm@p@protect #2\relax% + \fi + \fi} + +\def\upm@namedef#1#2{% + \@namedef{\upm@protect{#1}}{#2}% +} + +\def\upm@nameuse#1{% + \@nameuse{\upm@protect{#1}}% +} + +\def\upm@nameundef#1{% + \expandafter\let\csname\upm@protect{#1}\endcsname\relax% +} + +\def\upm@ifdefinedname#1#2#3{% + \expandafter\ifx\csname\upm@protect{#1}\endcsname\relax% + #3% + \else% + #2% + \fi% +} + +%---------------------------------------- +% GET THE REFERENCE ID WITHOUT \REF +%---------------------------------------- +\gdef\upm@getref#1{% + \expandafter\ifx\csname r@#1\endcsname\relax + \nfss@text{\reset@font\bfseries ??}% + \else + \expandafter\expandafter\expandafter\@car\csname r@#1\endcsname\@nil + \fi +} + +\gdef\upm@getpageref@filter#1#2#3#4#5{#2} + +\gdef\upm@getpageref#1{% + \expandafter\ifx\csname r@#1\endcsname\relax + \nfss@text{\reset@font\bfseries ??}% + \else% + \protected@xdef\upm@p@tmp@tmp{\protect\upm@getpageref@filter\csname r@#1\endcsname}% + \upm@p@tmp@tmp% + \global\let\upm@p@tmp@tmp\relax% + \fi +} + +%---------------------------------------- +% INTERNAL COMMAND FOR TEXT SUPPER/SUB SCRIPT +%---------------------------------------- + +\let\upm@textsuperscript\textsuperscript + +\def\upm@textsubscript#1{% + {\m@th\ensuremath{_{\mbox{\fontsize\sf@size\z@#1}}}}} + + +\endinput diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-spec.sty b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-spec.sty index 4249e7b44a7..0ad41328ee0 100644 --- a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-spec.sty +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-spec.sty @@ -19,16 +19,18 @@ % % Creation date: 2006-04-27 % Modifications: +% 2009-10-30 Clean code. % 2007-03-19 Add localization. % -\global\edef\upm@package@spec@ver{2007/03/19} +\global\edef\upm@package@spec@ver{2009/10/30} \NeedsTeXFormat{LaTeX2e}[1995/12/01] \ProvidesPackage{upmethodology-spec}[\upm@package@spec@ver] +\RequirePackage{upmethodology-p-common} + \RequirePackage[normalem]{ulem} -\RequirePackage{tabularx} \RequirePackage{upmethodology-fmt} \RequirePackage{upmethodology-code} @@ -378,33 +380,6 @@ \upm@spec@showparamstrue% }% -% \global\let\upm@arraycr\@arraycr -% \gdef\@arraycr{(\the\pagetotal)\upm@arraycr} -% \newdimen\upm@spec@total\upm@spec@total\pagetotal -% \newdimen\upm@spec@left -% \upm@spec@left=\@colroom -% \gdef\@arraycr{ -% \upm@arraycr -% } -% \newdimen\upm@spec@pagesize -% \upm@spec@pagesize=\@colroom - -% \def\upm@spec@arraycr{{\ifnum0=`}\fi\@ifstar{\upm@spec@xarraycr}{\upm@spec@xarraycr}} -% \def\upm@spec@xarraycr{\@ifnextchar[{\upm@spec@argarraycr}{\ifnum0=`{\fi}\cr\upm@spec@cr}} -% \def\upm@spec@argarraycr[#1]{% -% \ifnum0=`{\fi}% -% \ifdim #1>\z@ -% \unskip\ST@xargarraycr{#1} -% \else -% \ST@yargarraycr{#1}% -% \fi} -% \def\ST@xargarraycr#1{% -% \@tempdima #1\advance\@tempdima \dp \@arstrutbox -% \vrule \@height\z@ \@depth\@tempdima \@width\z@ \cr -% \noalign{\global\ST@toadd=#1}\ST@cr} -% \def\ST@yargarraycr#1{% -% \cr\noalign{\vskip #1\global\ST@toadd=#1}\ST@cr} - \vspace{.5cm}\noindent\begin{tabularx}{\the\upm@spec@detailspec@width}{|clr@{}>{\raggedright\arraybackslash}X|} \upm@spec@reserved@c% \upm@detailspec@start@hline% diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-task.sty b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-task.sty index 90468a7b81a..fdc90a712ac 100644 --- a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-task.sty +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-task.sty @@ -19,14 +19,17 @@ % % Creation date: 2006-04-20 % Modifications: +% 2009-10-30 Clean code. % 2007-03-19 Add localization. % -\global\edef\upm@package@task@ver{2007/03/19} +\global\edef\upm@package@task@ver{2009/10/30} \NeedsTeXFormat{LaTeX2e}[1995/12/01] \ProvidesPackage{upmethodology-task}[\upm@package@task@ver] +\RequirePackage{upmethodology-p-common} + %----- LOCALIZATION \def\upm@task@lang@english{ \gdef\upm@lang@@{\message{**** upmethodology-task is using English language ****}}% diff --git a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-version.sty b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-version.sty index 0b5eed82617..c2ed1da2355 100644 --- a/Master/texmf-dist/tex/latex/upmethodology/upmethodology-version.sty +++ b/Master/texmf-dist/tex/latex/upmethodology/upmethodology-version.sty @@ -19,17 +19,21 @@ % % Creation date: 2006-04-06 % Modifications: +% 2009-10-30 Clean code. +% 2008-06-24 Update English words. % 2007-07-03 Add the copyright date building function. % 2007-03-19 Add localization. % Move date functions into fmt package. % 2006-04-19 Add version number % -\global\edef\upm@package@version@ver{2007/07/03} +\global\edef\upm@package@version@ver{2009/10/30} \NeedsTeXFormat{LaTeX2e}[1995/12/01] \ProvidesPackage{upmethodology-version}[\upm@package@version@ver] +\RequirePackage{upmethodology-p-common} + %locales \def\upm@version@lang@english{ \gdef\upm@lang@@{\message{**** upmethodology-version is using English language ****}}% @@ -37,7 +41,7 @@ \gdef\upm@lang@updates{Updates} \gdef\upm@lang@version{Version} \gdef\upm@lang@version@history{Version History} - \gdef\upm@lang@restricted{Restricted} + \gdef\upm@lang@restricted{Confidential} \gdef\upm@lang@validable{Validable} \gdef\upm@lang@validated{Validated} \gdef\upm@lang@public{Public} diff --git a/Master/tlpkg/libexec/ctan2tds b/Master/tlpkg/libexec/ctan2tds index 998ff0d6798..f7adcc192ad 100755 --- a/Master/tlpkg/libexec/ctan2tds +++ b/Master/tlpkg/libexec/ctan2tds @@ -571,6 +571,7 @@ chdir $startdir || die "chdir($startdir) failed: $!"; # back to raw 'ukrhyph', "&MAKEukrhyph", 'umrand', "die 'skipping, nonfree'", 'unitsdef', "&MAKEflatten", + 'upmethodology',"&MAKEflatten", 'velthuis', "&MAKEcopy", 'venturisadf', "&MAKEcopy", 'vhistory', "&MAKEflatten", |
