diff options
author | Karl Berry <karl@freefriends.org> | 2013-12-26 23:20:24 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2013-12-26 23:20:24 +0000 |
commit | 5406241703f490e61300636739ae7294e7edd1ce (patch) | |
tree | b62d5d8f1abd43ddd2fabffe6e097eecff12bb55 /Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex | |
parent | 407b969501bb500853f34eb44afffd3db568c9a8 (diff) |
upmethodology (26dec13)
git-svn-id: svn://tug.org/texlive/trunk@32493 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex')
-rw-r--r-- | Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex | 86 |
1 files changed, 82 insertions, 4 deletions
diff --git a/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex b/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex index 88f24a80388..35b72f34557 100644 --- a/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex +++ b/Master/texmf-dist/doc/latex/upmethodology/upmethodology-doc.tex @@ -20,6 +20,11 @@ \incversion{\makedate{19}{09}{2013}}{Add the mathematic symbols}{\upmpublic} \incsubversion{\makedate{26}{09}{2013}}{Add the missed table placement flag \texttt{p}}{\upmpublic} \incsubversion{\makedate{29}{09}{2013}}{Add a notification text about the version of the library at the beginning of the introduction.}{\upmpublic} +\incsubversion{\makedate{30}{09}{2013}}{Add the macro \texttt{{\textbackslash}makefirstname}}{\upmpublic} +\incsubversion{\makedate{09}{10}{2013}}{Remove references to \texttt{fancyhdr}}{\upmpublic} +\incsubversion{\makedate{14}{10}{2013}}{Add the macros \texttt{{\textbackslash}chapterfull}, \texttt{{\textbackslash}sectionfull} and \texttt{{\textbackslash}newpageintoc}.}{\upmpublic} +\incsubversion{\makedate{16}{10}{2013}}{Add the section about the environment \texttt{description}.}{\upmpublic} +\incsubversion{\makedate{14}{12}{2013}}{Add the section about \texttt{backcovermessage}.}{\upmpublic} \addauthorvalidator*[galland@arakhne.org]{St{\'e}phane}{Galland}{Original Author} @@ -145,7 +150,6 @@ This section contains the list of all the package dependencies for the \texttt{u \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} @@ -315,7 +319,6 @@ previous occurrence of \texttt{pubpage} option. \\ \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} %########################################################### @@ -739,6 +742,48 @@ This is a text: \begin{inlineenumeration} \item etc. \end{inlineenumeration} This is the text after. +\section{Environment \texttt{description}} + +The environment \texttt{description} is redefined as following: +\begin{verbatim} +\begin{description}[separator] +\item[desc] text +\end{description} +\end{verbatim} +The text put in place of \texttt{desc} represents the text which may be emphazed in the description item. +The \texttt{separator} is the text that is inserted at the end of the head of each description item. + + +\paragraph{Example~1:} The following \LaTeX~code, using roman numbers, produces the description just below: +\begin{verbatim} +\begin{description} +\item[first thing] this is a text for the first thing; +\item[second thing] this is a text for the second thing; +\item[more] etc. +\end{description} +\end{verbatim} + +\begin{description} +\item[first thing] this is a text for the first thing; +\item[second thing] this is a text for the second thing; +\item[more] etc. +\end{description} + +\paragraph{Example~2:} The following \LaTeX~code produces the description just below: +\begin{verbatim} +\begin{description}[///] +\item[first thing] this is a text for the first thing; +\item[second thing] this is a text for the second thing; +\item[more] etc. +\end{description} +\end{verbatim} + +\begin{description}[///] +\item[first thing] this is a text for the first thing; +\item[second thing] this is a text for the second thing; +\item[more] etc. +\end{description} + \section{Descriptions in conjonction with enumeration} It may be helpful to put a list of descriptions in conjonction with an enumeration. @@ -965,6 +1010,10 @@ The package \texttt{upmethodology-fmt} provides a set of macros to format the te format the specified last/family name. \\ Example: \texttt{{\textbackslash}makelastname\{Galland\}}, \\ ``\makelastname{Galland}''; +\item \texttt{{\textbackslash}makefirstname\{name\}} \\ + format the specified first name. \\ + Example: \texttt{{\textbackslash}makefirstname\{St\'ephane\}}, \\ + ``\makefirstname{St\'ephane}''; \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. \\ @@ -1220,6 +1269,11 @@ The package \texttt{upmethodology-fmt} provides a set of environment to put emph \end{tabularx} +\section{Additional Macros for the Table of Content} + +The macro \texttt{{\textbackslash}newpageintoc} permits to insert a page break inside the table of contents (toc). +It may be used to avoid orhpan titles in the toc. + \section{Additional Document Sectionning Macros} The package \texttt{upmethodology-fmt} provides several macros that permit to create special sections. @@ -1274,6 +1328,24 @@ To add a unnumbered subsubsection inside the table of content, you could use one 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. +\subsection{Chapter with different labels in TOC, headers and document} + +If you want to control the labels in the table of contents (TOC), the headers and the document for a chapter, the classical \LaTeX\ macros \texttt{{\textbackslash}chapter} and \texttt{{\textbackslash}chapter*} are inefficient. + +To control these labels, you could use the macro: \\ +\texttt{{\textbackslash}chapterfull[toctitle]\{title\}\{headertitle\}} + +The macro create a chapter with the given label ``\texttt{title}'' in the core part of the document, with the given label ``\texttt{toctitle}'' in the table of contents, and with the label ``\texttt{headertitle}'' in the headers. + +\subsection{Section with different labels in TOC, headers and document} + +If you want to control the labels in the table of contents (TOC), the headers and the document for a section, the classical \LaTeX\ macros \texttt{{\textbackslash}section} and \texttt{{\textbackslash}section*} are inefficient. + +To control these labels, you could use the macro: \\ +\texttt{{\textbackslash}sectionfull[toctitle]\{title\}\{headertitle\}} + +The macro create a section with the given label ``\texttt{title}'' in the core part of the document, with the given label ``\texttt{toctitle}'' in the table of contents, and with the label ``\texttt{headertitle}'' in the headers. + %########################################################### @@ -1546,12 +1618,18 @@ where \texttt{layout\_name} must be one of: \item \texttt{none}: no back page. \end{itemize} +\section{Small text before the back page} + +It is possible to insert a text at the bottom of the page just before the back page (usually the inner page of the cover for a two sided document). +You must set tha macro \texttt{backcovermessage} with the \texttt{{\textbackslash}Set} macro: \\ +\texttt{{\textbackslash}Set\{backcovermessage\}\{text\}}\\ + \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\}}\\ +A \LaTeX\ macro must be defined in the \texttt{upmext-NAME.cfg} file of the extension. The name of this macro is \texttt{backpage}, and it must be set with the \texttt{{\textbackslash}Set} macro in the same file:\\ +\texttt{{\textbackslash}Set\{backpage\}\{\TeX\ macros\}}\\ %########################################################### |