TeX-UPmethodology

LaTeX Style for writing cool reports (version: 20260410)

Publication: LGPL3

Authors or contributors: Stéphane Galland


TeX-UPmethodology is a LaTeX style which permits to create documents and reports with version, history, authors, validators, specification, task management, etc., as for the reports in a Unified Process methodology (UP or RUP).

TeX-UPmethodology could be used to write documents that are not related to the UP methodology. For example, the project TeX-templates uses TeX-UPmethology for building PhD dissertations and technical reports.

1. Available Styles

Several styles are already provided for direct download or as packages.

CAUTION: Several of them are under proprietary licenses. You are granted to use, modify or redistribute them under the terms of these proprietary licenses.

Type Name Infos Usage Restrictions Examples Ubuntu
Report classic Included LGPL front page tex-upmethodology
Report modern Included LGPL front page tex-upmethodology
Report Université de Technologie de Belfort-Montbéliard (UTBM) Open © UTBM front page page tex-templates-utbmciadreport-2025
PhD dissertation Université de Technologie de Belfort-Montbéliard (UTBM) Open © UTBM front page page tex-templates-utbm-phdthesis
PhD dissertation Université Bourgogne Europe (UBE) Open © UBE front page page tex-templates-ube-phdthesis
PhD dissertation Université Marie et Louis Pasteur (UMLP) Open © UMLP front page page tex-templates-umlp-phdthesis
HDR dissertation Université Bourgogne Europe (UBE) Open © UBE front page page tex-templates-spimhdr

2. Create your own style

You could create you own style by following the following steps.

2.1. Header and Copyright

Find the logo of your university in SVG or PDF format. We recommend to have the logo in vectorial format, not bitmap.

Create the .cfg file that describes the new style elements. The format of this file is TeX. It contains the elements in this section and the following. Define the copyright string of your extension in French and English:

\DeclareCopyright[french]{extension-name}{copyright-year}{author-name}{legal-text}
\DeclareCopyright[english]{extension-name}{copyright-year}{author-name}{legal-text}

Where:

  • extension-name is the code name of your extension;
  • copyright-year is the year(s) of the copyright;
  • author-name is the name(s) of the extension's authors;
  • legal-text is a text that is describing the copy rights.

2.2. LaTeX Package Inclusion

You could include any LaTeX package that is needed by your extension, for example:

\usepackage{helvet}
\renewcommand{\familydefault}{\sfdefault}

2.3. Redefine the colors

The style has many predefined colors. You could adapt them to your own style by using the macros \definecolor or \colorlet from the xcolor package, for example:

\definecolor{mycolor}{rgb}{0.62890625,0.0546875,0.18359375}

The major colors that could be redefined are listed in the following tables.

Algorithms
Color code Description of uses
algorithmboder borders of the algorithms
algorithmcaption text for the descriptions of the algorithms
algorithmcaptionlabel text that is displayed for the labels of the algorithms, e.g., Algorithm 1
Back-Cover Page
Color code Description of uses
backpagetext text that is displayed on the back page
backpagetitle titles that are displayed on the back page
Bibliography
Color code Description of uses
bibemphemphtextcolor text that is emphazing in the bibliogaphy, usually the titles
Contribution Blocks
Color code Description of uses
contributionbackground background color of the boxes \begin{contribution}\end{contribution}
contributiontitle text color of the boxes \begin{contribution}\end{contribution}
Definition Blocks
Color code Description of uses
definitionbackground background color of the definition environment
definitionborder border lines and the title's background of the definition environment
definitionheaderforeground title for the title of the definition environment
definitiontextforeground text in the definition environment
Emphazing Blocks
Color code Description of uses
emphboxbackground background color of the emphazing boxes, e.g., \begin{emphbox}\end{emphbox}
emphboxbackgroundb background color of the secondary emphazing boxes, e.g., \begin{emphbox2}\end{emphbox2}
emphboxbackgroundc background color of the third-level emphazing boxes, e.g., \begin{emphbox3}\end{emphbox3}
emphboxborder borders of the emphazing boxes, e.g., \begin{emphbox}\end{emphbox}
emphboxtext text in the emphazing boxes, e.g., \begin{emphbox}\end{emphbox}
emphemphtextcolor text that is marked with very emphazing, i.e., with \Emph{}
Emphazing Text
Color code Description of uses
emphtextcolor text that is marked with emphazing, i.e., with \emph{}
Floating Objects
Color code Description of uses
floatexplanationforeground explanation's text for floats (figures and tables)
floatsourceforeground source's text for floats (figures and tables)
Front-Cover Page
Color code Description of uses
frontpagetitle title on the front page
frontpageauthors author's name on the front page
Objective Blocks
Color code Description of uses
objectivebackground background color of the boxes \begin{objective}\end{objective}
objectivetitle text in the boxes \begin{objective}\end{objective}
Research Question Blocks
Color code Description of uses
researchquestionbackground background color of the boxes \begin{researchquestion}\end{researchquestion}
researchquestiontitle text in the boxes \begin{researchquestion}\end{researchquestion}
PhD Disseration Standards
Color code Description of uses
standardphdcolor the major color that is associated to the style. This color is usually used as the base for many of the other colors
Sectioning
Color code Description of uses
chaptertitlecolor text of a chapter's title
chaptertitlenumcolor chapter's number in the chapter's title
paragraphtitlecolor text of a paragraph's title
parttitlecolor text of a part's title
sectiontitleboxcolor background color of the box for the section's number in the section's title
sectiontitlecolor text of a section's title
sectiontitlenumcolor section's number in the section's title
subparagraphtitlecolor text of a subparagraph's title
subsectiontitlecolor text of a sub-section's title
subsectiontitlenumcolor sub-section's number in the sub-section's title
subsubsectiontitlecolor text of a sub-sub-section's title
Tables and Tabulars
Color code Description of uses
tablebackground background color of the cells in a table or a tabular that are not header cells
tableforeground text in the cells in a table or a tabular that are not header cells
tableheaderbackground background color of headers and titles in a table or a tabular
tableheaderforeground text in headers and titles in a table or a tabular
tablerule rules of table or a tabular
Watermark
Color code Description of uses
watermarkcolor watermark text

2.4. Define the layout of the front page

The front page has a specific layout. Usually, it is implemented using the TikZ package and associated macros. The definition of the front page must be done using the macro \Set{cfontpage}{latex-code}. For example:

\Set{cfrontpage}{
    \pagestyle{empty}
    \begin{picture}(0,0)
        \put(-45,-60){\parbox[t][12cm][t]{17cm}{
            \renewcommand{\baselinestretch}{1} 
            \begin{center}
                {\Large \theauthorlist} \\[1.5cm]

                \parbox{\linewidth}{\centering\Large\nohyphens{\theupmproject}}
                \Ifnotempty\theupmdocname{\\[.25cm]\parbox{\linewidth}{\centering\large\nohyphens{\theupmdocname}}}
            \end{center}
        }}
    \end{picture}
}

2.5. Define the layout of the back page

The back page has a specific layout. Usually, it is also implemented using the TikZ package and associated macros. The definition of the back page must be done using the macro \Set{backpage}{latex-code}. For example:

\Set{cfrontpage}{
    \pagestyle{empty}
    \begin{picture}(0,0)
        \put(-45,-60){\parbox[t][12cm][t]{17cm}{
            \nohyphens{\ignorespaces\theupmproject}
        }}
    \end{picture}
}

2.6. Create the LaTeX class

In order to make your style easy to be used, it is recommended to create a LaTeX class (.cls file) that describes the new style class. The format of this file is TeX. This class could be defined to help any user of your style to use it easily. This class file may contain the loading of the inherited class, and the loading of your style, for example:

\NeedsTeXFormat{LaTeX2e}[1995/12/01]
\ProvidesClass{extension-name}[2026/04/06]

\LoadClass[french]{upmethodology-document}
\UseExtension{extension-name}

\endinput

Where:

  • extension-name is the name of your style.

3. Installation

3.1. Inside the folder of your document

The most simple way to use the templates is to download the archive and uncompress it in the folder of your document. LaTeX will automatically find the template's files in the folder of your LaTeX document.

3.3. Inside your operating system with Ubuntu packages

Arakhnê.org provides several Ubuntu packages for automatically install the TeX-UPmethodology on the system. To configure the use of the Arakhnê.org Ubuntu repository, you have to follow the information provided on the dedicated page.

The name of the Ubuntu package is tex-upmethodology.

3.2. In the operating system by hand

  1. Download the archive of TeX-UPmethodology and uncompress it.
  2. Copy the content of the archive inside one of your texmf directory, usually /usr/share/texmf/tex/latex/tex-templates or $HOME/.texmf on Unix operating systems.
  3. Update the LaTeX databases from the command line:
sudo mktexlsr
sudo update-updmap --quiet