texlive[52111] Master/texmf-dist: upmethodology (17sep19)
commits+karl at tug.org
commits+karl at tug.org
Tue Sep 17 23:11:19 CEST 2019
Revision: 52111
http://tug.org/svn/texlive?view=revision&revision=52111
Author: karl
Date: 2019-09-17 23:11:19 +0200 (Tue, 17 Sep 2019)
Log Message:
-----------
upmethodology (17sep19)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.pdf
trunk/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
trunk/Master/texmf-dist/tex/latex/upmethodology/UPMVERSION.def
trunk/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.cls
trunk/Master/texmf-dist/tex/latex/upmethodology/upmethodology-spec.sty
Modified: trunk/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex 2019-09-17 21:11:03 UTC (rev 52110)
+++ trunk/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex 2019-09-17 21:11:19 UTC (rev 52111)
@@ -1,4 +1,4 @@
-\documentclass[book]{upmethodology-document}
+\documentclass[book,taskpackage,specpackage,codepackage]{upmethodology-document}
\setfrontcover{classic}
@@ -9,6 +9,8 @@
\incsubversion{\makedate{08}{08}{2017}}{Fixing spelling errors and typos.}{\upmpublic}
\incsubversion{\makedate{28}{11}{2017}}{Add 'standardlists' option.}{\upmpublic}
\incsubversion{\makedate{04}{08}{2019}}{Add 'graphicspathcontext' option.}{\upmpublic}
+\incversion{\makedate{17}{09}{2019}}{Add class options to include optional packages.}{\upmpublic}
+%\incversion{\makedate{17}{09}{2019}}{Add the documentation for the \texttt{upmethodology-spec} package.}{\upmpublic}
\addauthorvalidator*[galland at arakhne.org]{St{\'e}phane}{Galland}{Original Author}
\addauthor*{Frans}{van Dunn\'e}{Reviewer}
@@ -27,6 +29,7 @@
\let\VERtask\upm at package@task at ver
\let\VERdocclazz\upm at package@docclazz at ver
\let\VERcode\upm at package@code at ver
+\let\VERspec\upm at package@spec at ver
\makeatother
\setpublisher{Arakhn\^e.org Group}
@@ -66,9 +69,10 @@
\item \texttt{upmethodology-document.sty}: provides functions to manage the project, the subproject and the status of the document;
\item \texttt{upmethodology-frontpage.sty}: formats and provides a front page for the document;
\item \texttt{upmethodology-backpage.sty}: formats and provides a back page for the document;
-\item \texttt{upmethodology-task.sty}: is the \LaTeXe\xspace package that provides macros to manage project's tasks.
+\item \texttt{upmethodology-task.sty}: is the \emph{optional} \LaTeXe\xspace package that provides macros to manage project's tasks.
+\item \texttt{upmethodology-spec.sty}: is the \emph{optional} \LaTeXe\xspace package that provides macros to build a specification description.
\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 \emph{optional} macros for source code formatting;
\item \texttt{upmethodology-extension.sty}: provides macros for extension mechanism.
\end{itemize}
@@ -136,13 +140,13 @@
\item \texttt{a4wide}
\item \texttt{hyperref}
\item \texttt{upmethodology-backpage}
-\item \texttt{upmethodology-code}
+\item \texttt{upmethodology-code} (optional)
\item \texttt{upmethodology-document}
\item \texttt{upmethodology-extension}
\item \texttt{upmethodology-frontpage}
\item \texttt{upmethodology-p-common}
-\item \texttt{upmethodology-spec}
-\item \texttt{upmethodology-task}
+\item \texttt{upmethodology-spec} (optionnal)
+\item \texttt{upmethodology-task} (optionnal)
\item \texttt{url}
\end{itemize}
@@ -319,7 +323,19 @@
standardlists & The style does not override the standard list, description and enumeration definitions. \\
+\hline\hline
+
+codepackage & Include the \texttt{upmethodology-code} package. \\
+
\hline
+
+specpackage & Include the \texttt{upmethodology-spec} package. \\
+
+\hline
+
+taskpackage & Include the \texttt{upmethodology-task} package. \\
+
+\hline
\end{mtable}
\section{Additional Features}
@@ -2074,6 +2090,86 @@
%###########################################################
+%\chapter{Package upmethodology-spec}
+
+%\begin{center}
+% \texttt{Version: \VERspec}
+%\end{center}
+
+%The \LaTeX\ package \texttt{upmethodology-spec} provides a set of macros for building a specification document.
+
+%\section{Specification Definition}
+
+%The definition of a specification could be made only inside one of the following environments: \\
+%\texttt{{\textbackslash}begin\{detailspec\}[width]\{title\}...{\textbackslash}end\{detailspec\}} \\
+%\texttt{{\textbackslash}begin\{detailspec*\}[width]\{title\}...{\textbackslash}end\{detailspec*\}} \\
+%where \texttt{width} is the width of the specification box on the page, and \texttt{title} is the title of the specification box.
+
+%The environment \texttt{specdetail} displays the detailed description and uses a more complex rendering. On the other hand, \texttt{specdetail*} never displays the description and uses a simpler rendering.
+
+%\section{Components of a Specification}
+
+%A specification has several components that may be defined by the macros in the following table:
+%\begin{tabularx}{\linewidth}{|>{\ttfamily}l|X|}
+% \hline
+% {\normalfont Macro} & Description \\
+% \hline\hline
+% {\textbackslash}specfunc[modifiers]\{return type\}\{name\}\{parameters\} & \\
+% \hline
+% {\textbackslash}speccons[modifiers]\{name\}\{parameters\} & \\
+% \hline
+% {\textbackslash}specget[modifiers]\{return type\}\{name\} & \\
+% \hline
+% {\textbackslash}specset[modifiers]\{return type\}\{name\} & \\
+% \hline\hline
+% {\textbackslash}specparam[in|inout|out]\{name\}\{description\} & \\
+% \hline\hline
+% {\textbackslash}specreturn[modifiers]\{description\} & \\
+% \hline
+% {\textbackslash}specglobalreturn[modifiers]\{description\} & \\
+% \hline\hline
+% {\textbackslash}specstarthline & \\
+% \hline
+% {\textbackslash}specendhline & \\
+% \hline
+%\end{tabularx}
+
+%\section{Examples of Specifications}
+
+%\subsection{Description of the specification}
+
+%Let consider a specification with a description:
+%\begin{verbatim}
+%\begin{detailspec}{Example 1}
+% This is a description.
+%\end{detailspec}
+%\end{verbatim}
+
+%The previous \LaTeX\ code generates the following figure:
+%\begin{detailspec}{Example 1}
+% This is a description.
+%\end{detailspec}
+
+%\subsection{Returned Values}
+
+%Let add into the previous example the specification of returned values:
+%\begin{verbatim}
+%\begin{detailspec}{Example 2}
+% This is a description.
+% \specreturn{description of a first returned value}
+% \specreturn{description of a second returned value}
+%\end{detailspec}
+%\end{verbatim}
+
+%The previous \LaTeX\ code generates the following figure:
+%\begin{detailspec}{Example 2}
+%% This is a description.
+%% \specreturn{description of a first returned value}
+%% \specreturn{description of a second returned value}
+%\end{detailspec}
+
+%###########################################################
+
\chapter{Authors and License}
Copyright \copyright\ \upmcopyrightdate\ \makename{St\'ephane}{Galland}
Modified: trunk/Master/texmf-dist/tex/latex/upmethodology/UPMVERSION.def
===================================================================
--- trunk/Master/texmf-dist/tex/latex/upmethodology/UPMVERSION.def 2019-09-17 21:11:03 UTC (rev 52110)
+++ trunk/Master/texmf-dist/tex/latex/upmethodology/UPMVERSION.def 2019-09-17 21:11:19 UTC (rev 52111)
@@ -1 +1 @@
-\def\UPMVERSION{20190804}
+\def\UPMVERSION{20190917}
Modified: trunk/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.cls
===================================================================
--- trunk/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.cls 2019-09-17 21:11:03 UTC (rev 52110)
+++ trunk/Master/texmf-dist/tex/latex/upmethodology/upmethodology-document.cls 2019-09-17 21:11:19 UTC (rev 52111)
@@ -17,7 +17,7 @@
% write to the Free Software Foundation, Inc., 59 Temple Place - Suite
% 330, Boston, MA 02111-1307, USA.
-\global\edef\upm at package@docclazz at ver{2014/09/11}
+\global\edef\upm at package@docclazz at ver{2019/09/17}
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
\ProvidesClass{upmethodology-document}[\upm at package@docclazz at ver]
@@ -35,6 +35,13 @@
\newif\ifupm at package@docclazz at addbackcover
\upm at package@docclazz at addbackcovertrue
+\newif\ifupm at package@docclazz at taskpackage
+\upm at package@docclazz at taskpackagefalse
+\newif\ifupm at package@docclazz at specpackage
+\upm at package@docclazz at specpackagefalse
+\newif\ifupm at package@docclazz at codepackage
+\upm at package@docclazz at codepackagefalse
+
\gdef\upm at package@docclazz at optionstopass{a4paper,11pt}
\DeclareOption{twoside}{%
@@ -91,6 +98,15 @@
\DeclareOption{backcover}{%
\global\upm at package@docclazz at addbackcovertrue%
}
+\DeclareOption{taskpackage}{%
+ \global\upm at package@docclazz at taskpackagetrue%
+}
+\DeclareOption{specpackage}{%
+ \global\upm at package@docclazz at specpackagetrue%
+}
+\DeclareOption{codepackage}{%
+ \global\upm at package@docclazz at codepackagetrue%
+}
\DeclareOption{book}{%
\global\upmbookformattrue
\global\upmreportformatfalse
@@ -139,9 +155,15 @@
\RequirePackage{upmethodology-extension}
\RequirePackage{upmethodology-frontpage}
\RequirePackage{upmethodology-backpage}
-\RequirePackage{upmethodology-task}
-\RequirePackage{upmethodology-code}
-\RequirePackage{upmethodology-spec}
+\ifupm at package@docclazz at taskpackage
+ \RequirePackage{upmethodology-task}
+\fi
+\ifupm at package@docclazz at codepackage
+ \RequirePackage{upmethodology-code}
+\fi
+\ifupm at package@docclazz at specpackage
+ \RequirePackage{upmethodology-spec}
+\fi
\RequirePackage{url}
\ifpdf
Modified: trunk/Master/texmf-dist/tex/latex/upmethodology/upmethodology-spec.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/upmethodology/upmethodology-spec.sty 2019-09-17 21:11:03 UTC (rev 52110)
+++ trunk/Master/texmf-dist/tex/latex/upmethodology/upmethodology-spec.sty 2019-09-17 21:11:19 UTC (rev 52111)
@@ -23,7 +23,7 @@
% 2007-03-19 Add localization.
%
-\global\edef\upm at package@spec at ver{2009/10/30}
+\global\edef\upm at package@spec at ver{2019/09/17}
\NeedsTeXFormat{LaTeX2e}[1995/12/01]
\ProvidesPackage{upmethodology-spec}[\upm at package@spec at ver]
@@ -133,7 +133,7 @@
\upm at spec@func at modifiers@scan{#1}%
}
\newcommand{\upm at spec@func at modifiers@scan}[1]{%
- \upm at ifnotempty{#1}{%
+ \Ifnotempty{#1}{%
\edef\upm at reserved@a{\upm at spec@head #1\@empty\@empty}%
\edef\upm at reserved@b{\upm at spec@tail #1\@empty\@empty}%
\ifthenelse{\equal{\upm at reserved@a}{+}}{%
@@ -187,7 +187,7 @@
%-----
%\upm at spec@param at modifiers{modifiers}
\newcommand{\upm at spec@param at modifiers}[1]{%
- \upm at ifnotempty{#1}{%
+ \Ifnotempty{#1}{%
\ifthenelse{\equal{#1}{out}}{%
%out
\upm at spec@lang at modifier@out%
@@ -205,7 +205,7 @@
%-----
\def\upm at spec@trim#1{#1}
\newcommand{\upm at spec@splitparams}[1]{%
- \upm at ifnotempty{#1}{%
+ \Ifnotempty{#1}{%
\upm at spec@firstparamtrue
\@for\reserved at a:=#1\do{%
\ifupm at spec@firstparam\upm at spec@firstparamfalse\else, \fi%
@@ -247,7 +247,7 @@
\addtocounter{upm at detailspec@function at counter}{1}%
\protected at xdef\upm at spec@reserved at a{\protect\csname upm at detailspec@return at ptr@\theupm at detailspec@function at counter\endcsname}%
\gdef\upm at spec@reserved at b{}
- \upm at ifnotempty{##2}{\gdef\upm at spec@reserved at b{\string:\ }}
+ \Ifnotempty{##2}{\gdef\upm at spec@reserved at b{\string:\ }}
\gdef\upm at spec@reserved at c{}%
\upm at spec@func at modifiers{##1}%
@@ -271,17 +271,17 @@
\gdef\upm at spec@reserved at e{\upm at spec@lang at modifier@const}%
\fi
\ifupm at spec@modifier at has@final%
- \upm at ifnotempty{\upm at spec@reserved at e}{%
+ \Ifnotempty{\upm at spec@reserved at e}{%
\xdef\upm at spec@reserved at e{\upm at spec@reserved at e,}}%
\protected at xdef\upm at spec@reserved at e{\upm at spec@reserved at e\protect\upm at spec@lang at modifier@final}%
\fi
\ifupm at spec@modifier at has@abstract%
- \upm at ifnotempty{\upm at spec@reserved at e}{%
+ \Ifnotempty{\upm at spec@reserved at e}{%
\xdef\upm at spec@reserved at e{\upm at spec@reserved at e,}}%
\protected at xdef\upm at spec@reserved at e{\upm at spec@reserved at e\protect\upm at spec@lang at modifier@abstract}%
\fi
\ifupm at spec@modifier at has@root%
- \upm at ifnotempty{\upm at spec@reserved at e}{%
+ \Ifnotempty{\upm at spec@reserved at e}{%
\xdef\upm at spec@reserved at e{\upm at spec@reserved at e,}}%
\protected at xdef\upm at spec@reserved at e{\upm at spec@reserved at e\protect\upm at spec@lang at modifier@root}%
\fi
@@ -343,13 +343,13 @@
\ifthenelse{\equal{\upm at spec@global at return}{\@empty}}{%
\gdef\upm at detailspec@return at section{}
- \upm at ifnotempty{\upm at spec@local at return}{
+ \Ifnotempty{\upm at spec@local at return}{
\gdef\upm at detailspec@separator{ & & & \\}
\protected at xdef\upm at detailspec@return at section{\upm at spec@local at return}%
\upm at spec@showreturnstrue%
}%
}{%
- \upm at ifnotempty{\upm at spec@local at return}{%
+ \Ifnotempty{\upm at spec@local at return}{%
\gdef\upm at detailspec@separator{ & & & \\}
\gdef\upm at spec@reserved at a{ \upm at spec@lang at except@for:\protect\upm at spec@local at return}}%
\protected at xdef\upm at detailspec@return at section{%
@@ -358,9 +358,8 @@
\upm at spec@showreturnstrue%
}
- \ifthenelse{\equal{\upm at spec@detailspec at title}{\@empty}}{
- \gdef\upm at spec@reserved at c{}
- }{
+ \gdef\upm at spec@reserved at c{}
+ \Ifnotempty{\upm at spec@detailspec at title}{
\gdef\upm at spec@reserved at c{\hline%
\multicolumn{4}{>{\columncolor{backtableheader}}l}{\color{fronttableheader}{\large\textsc{\upm at spec@detailspec at title}}} \\%
}
@@ -370,11 +369,11 @@
\upm at spec@showparamsfalse%
- \upm at ifnotempty{\upm at spec@parameters}{%
+ \Ifnotempty{\upm at spec@parameters}{%
\ifupm at spec@showdescription%
\gdef\upm at detailspec@separator{ & & & \\}%
\fi%
- \upm at ifnotempty{\upm at spec@functions}{%
+ \Ifnotempty{\upm at spec@functions}{%
\gdef\upm at detailspec@separator{ & & & \\}%
}%
\upm at spec@showparamstrue%
@@ -429,7 +428,7 @@
}
%-----
-%\begin{detailspec}}[width]{title}...\end{detailspec}....
+%\begin{detailspec}[width]{title}...\end{detailspec}....
\newenvironment{detailspec}[2][\linewidth]
{%
\upm at spec@showdescriptiontrue%
@@ -442,7 +441,7 @@
}
%-----
-%\begin{detailspec}}[width]{title}...\end{detailspec}....
+%\begin{detailspec*}[width]{title}...\end{detailspec*}....
\newenvironment{detailspec*}[2][\linewidth]
{%
\upm at spec@showdescriptionfalse%
More information about the tex-live-commits
mailing list