moderncv/manual/moderncv_userguide.tex

%% moderncv_userguide.tex (compiled with pdfLaTeX)
%% Copyright 2007 Cristina Sambo, 2021 David Seus, cryptointerest@posteo.de
%
% This work may be distributed and/or modified under the
% conditions of the LaTeX Project Public License version 1.3c,
% available at http://www.latex-project.org/lppl/.

\documentclass[a4paper,11pt]{article}

\title{\bfseries moderncv -- v2.1.0}
\author{Package by Xavier Danaux \\ \begin{small}Documentation by Cristina Sambo, David Seus \end{small}}
\date{\today}

%language and encoding options
\usepackage[english]{babel}
\usepackage{ifxetex,ifluatex}
\newif\ifxetexorluatex
\ifxetex
  \xetexorluatextrue
\else
  \ifluatex
    \xetexorluatextrue
  \else
    \xetexorluatexfalse
  \fi
\fi
%%%% PDFLaTeX or LUALaTeX/XeLaTeX %%%%%%%
\ifxetexorluatex
    %\usepackage{luatextra}
%     \usepackage{lualatex-math}
    \usepackage{shellesc} % fix a bug for lualatex shellescape
  %  \usepackage{unicode-math}
%  \setmathfont{xits-math.otf}
\else
    %% if pdflatex is used uncomment the following packages. If lualatex is used comment them.
    \usepackage[utf8]{inputenx}
    %additions for utf8
    \input{ix-utf8enc.dfu}
    %% if pdflatex is used uncomment above packages. If lualatex is used comment them.
\fi
\PassOptionsToPackage{T1}{fontenc} % T2A for cyrillics
\usepackage[T1]{fontenc}

%font options
\usepackage{txfonts}
\usepackage{marvosym}
\usepackage{pifont}

%margins, spacing and page layout
\PassOptionsToPackage{dvipsnames*,svgnames,table}{xcolor}
% \usepackage{geometry}
% \geometry{top=2.5cm, bottom=3cm}
% \setlength{\parindent}{0pt} %(to soppress indentation when starting a new paragraph)
\frenchspacing %(to suppress additional space after a full stop)

%packages
\usepackage{graphicx}
\usepackage{xcolor}
\usepackage[labelfont=sl,font=small,width=0.9\textwidth]{caption}
\usepackage{marvosym}
\usepackage{latexsym}
\usepackage{url}
\usepackage{scrhack} % Fix warnings when using KOMA with listings package  
\usepackage{xspace}  % To get the spacing after macros right
\usepackage{mparhack} % To get marginpar right
\usepackage{microtype}
% ****************************************************************************************************
% Setup code listings
% ****************************************************************************************************
\usepackage{listings}
%\lstset{emph={trueIndex,root},emphstyle=\color{BlueViolet}}%\underbar} % for special keywords
\lstset{language=[LaTeX]Tex,%C++,
  morekeywords={PassOptionsToPackage,selectlanguage},
  keywordstyle=\color{bluecv},%\bfseries,
  basicstyle=\small\ttfamily,
  %identifierstyle=\color{NavyBlue},
  commentstyle=\color{grey}\ttfamily,
  stringstyle=\rmfamily,
  numbers=none,%left,%
  numberstyle=\scriptsize,%\tiny
  stepnumber=5,
  numbersep=8pt,
  showstringspaces=false,
  breaklines=true,
  %frameround=ftff,
  %frame=single,
  belowcaptionskip=.75\baselineskip
  %frame=L
}
\usepackage{hyperref}
\hypersetup{%
  unicode=true,
%   draft, % hyperref's draft mode, for printing see below
  colorlinks=true, linktocpage=true, pdfstartpage=3, pdfstartview=FitV,%
  % uncomment the following line if you want to have black links (e.g., for printing)
  %colorlinks=false, linktocpage=false, pdfstartpage=3, pdfstartview=FitV, pdfborder={0 0 0},%
  breaklinks=true, pageanchor=true,%
  pdfpagemode=UseNone, %
  % pdfpagemode=UseOutlines,%
  plainpages=false, bookmarksnumbered, bookmarksopen=true, bookmarksopenlevel=1,%
  hypertexnames=true, pdfhighlight=/O,%nesting=true,%frenchlinks,%
  urlcolor=bluecv, linkcolor=bluecv, citecolor=bluecv, %pagecolor=RoyalBlue,%
  %urlcolor=Black, linkcolor=Black, citecolor=Black, %pagecolor=Black,%
%   pdfborder={0 0 1},		% width of pdf link border 0 0 1, 0 0 0 = colorlinks 
%   linkbordercolor=gray!15,
%   citebordercolor=green!15,
}


%my commands
\definecolor{bluecv}{rgb}{0.25,0.5,0.75}
\definecolor{greencv}{rgb}{0.55,0.85,0.35}
\definecolor{redcv}{rgb}{1.00,0.30,0.30}
\definecolor{orangecv}{rgb}{1,0.65,0.20}
\definecolor{greycv}{rgb}{0.75,0.75,0.75}

\newcommand{\todo}[1]{\marginpar{\textcolor{red}{[\textbf{TODO:} #1]}}}
\newcommand{\todox}[1]{\textcolor{red}{[\textbf{TODO:} #1]}} 
% macros 
\newcommand{\code}[1]{\lstinline!#1!}
\newcommand{\Code}[1]{\lstinline!#1! }
\newcommand{\moderncv}{\code{moderncv}}
\newcommand{\Moderncv}{\Code{moderncv}}
\newcommand{\github}{GitHub}
\newcommand{\Github}{GitHub }
\newcommand{\ctan}{CTAN}
\newcommand{\Ctan}{CTAN }
\newcommand{\cvtemplate}{\code{template.tex}}
\newcommand{\Cvtemplate}{\code{template.tex} }

% current Code repository. 
\newcommand{\moderncvGithub}{\url{https://github.com/moderncv/moderncv}}
\newcommand{\moderncvCtan}{\url{https://ctan.org/pkg/moderncv}}
%==================
% DOCUMENT BEGINNING
%==================
\begin{document}
\maketitle
\begin{abstract}
\noindent 
\Moderncv provides a document class for typesetting modern curriculum vitae and corresponding cover letters 
for applications in various styles. 
Five predefined styles are available and each of the styles can be adjusted through options adjusting headings and colors.  
It is fairly customizable, allowing the user to adjust the look and feel of each style to their liking.
\end{abstract}
\tableofcontents

\section{Getting started}
\subsection{How to read this manual}
This manual is organized as follows.
The present section contains information on how to get started with the \Moderncv 
package, i.e. how to install required packages to your system.
% 
% \emph{Note, that it is assumed, that you know how to install \LaTeX\ packages in case some are missing}. 

Section \ref{section:moderncvTemplate} provides a step by step guide of the \Moderncv template file and how to work with it. 

Section \ref{section:customization} discusses details of the customizations that can be done by the user: 
The different styles, their options, colors and tips and tricks.

Section \ref{section:implementationDetails} contains information about the packages being used by \moderncv, 
known problems and possible solutions that have been found. 

\subsection{Installation instructions}
If the \Moderncv package does not ship with your \LaTeX\ distribution, or the installed version is too old, 
grab the \Moderncv code from \Ctan or \github: \medskip

\begin{tabular}{l}
    \moderncvCtan \\%[.5ex]
    \moderncvGithub
\end{tabular}

\paragraph{Note:} Depending on your \LaTeX\ distribution some additional packages might have to be installed. 
Section \ref{section:implementationDetails:requiredPackages} lists all packages that \Moderncv requires to be installed on your system. 

\section{The \texorpdfstring{\Moderncv}{} template step by step.}
This section is meant as a quick reference to the \Moderncv package and should contain enough information 
to get a first working curriculum vitae typeset. 
\label{section:moderncvTemplate}
The easiest way to get started with \Moderncv is to adjust the template that comes with the package.
In case the \Moderncv package is part of your \LaTeX\ distribution, search for the folder \Moderncv 
on your system containing all files of the package. 
In this folder, there should be a file called \cvtemplate. 
In case you downloaded the package from \Github or \Ctan move into the folder of the package and 
find the file \Cvtemplate there. 

\paragraph{Note:} If you downloaded \Moderncv from \Github or \Ctan and you move the template file to another folder, make sure to adjust the \Code{TEXINPUTS} variable to find the newly downloaded package. 
At all or before the system installed version. 

\subsection{Basic setup}

At the very beginning of your preamble (that is the part before \verb|\begin{document}|) insert:

\begin{verbatim}
\document class[<options>]{moderncv}
\end{verbatim} 

where the options are:

\begin{description}
 \item[paper size options:] \Code{a4paper}, \Code{a5paper}, \Code{b5paper}, \Code{letterpaper}, \Code{legalpaper}, \Code{ex\-ec\-u\-tive\-pa\-per}, \Code{landscape}
 \item[font size options:] \Code{10pt}, \Code{11pt}, \Code{12pt}
 \item[font option:] \Code{nolmodern}, for people without the latin modern fonts
 \item[color option:] \Code{nocolor}, to have all in black and white
 \item[draft/final options:] \Code{draft}, \Code{final}
\end{description}

The default options are: \Code{a4paper}, \Code{11pt}, \Code{color}, \Code{final}. 

After the document class specification, choose the theme for your curriculum vit\ae:

\begin{verbatim}
\Moderncvtheme[<options>]{casual}
\end{verbatim} 

which is the default theme, or

\begin{verbatim}
\Moderncvtheme[<options>]{classic}
\end{verbatim} 

where the theme options are:

\begin{description}
 \item[color options:] you can choose between five color: 
	\begin{itemize}
	 \item[\Code{blue}] {\color{bluecv}\rule{1cm}{2ex}} (default color)
	 \item[\Code{green}] {\color{greencv}\rule{1cm}{2ex}}
	 \item[\Code{red}] {\color{redcv}\rule{1cm}{2ex}}
	 \item[\Code{orange}] {\color{orangecv}\rule{1cm}{2ex}}
	 \item[\Code{grey}] {\color{greycv}\rule{1cm}{2ex}}
	\end{itemize}
 \item[roman option:] \Code{roman}, for {\fontsize{11}{12} \usefont{T1}{lmr}{m}{n}\selectfont roman} fonts, instead of \fontsize{11}{12} \usefont{T1}{lmss}{m}{n}\selectfont sans serif fonts.
\end{description}

Then you have to specify the character encoding (utf8, latin1, and so on):

\begin{verbatim}
\usepackage[<your encoding>]{inputenc}
\end{verbatim} 

and you can adjust the page geometry:

\begin{verbatim}
\usepackage[<options>]{geometry}
\recomputelengths
\end{verbatim} 

where \verb|\recomputelengths| is required when changes are made to page layout lengths.

Now we can get into the part most related to our curriculum vit\ae: our personal data. They will be inserted in the header of the first page, in the classic theme, or in the footer of every page, in the case of casual theme.

\begin{itemize}
\item \verb|\name{John}{Doe}|
\item \verb|\title{Resum\'e title}|: optional
\item \verb|\address{street and number}{postcode city}|: optional 
\item \verb|\mobile{mobile}|: optional
\item \verb|\phone{phone}|: optional
\item \verb|\fax{fax}|: optional
\item \verb|\email{email}|: optional
\item \verb|\extrainfo{additional information}|: optional; here you can put, for example, the address of your website
\item \verb|\photo[64pt]{picture}|: optional; \Code{64pt} is the height the picture, you can set here the size you prefer; \Code{picture} is the name of the picture file
\item \verb|\quote{Some quote}|: optional
\end{itemize} 

Finally you can suppress automatic page numbering for CVs longer than one page:

\begin{verbatim}
\nopagenumbers{}
\end{verbatim} 

\subsection{Examples}

In practice, you will type:

\begin{verbatim}
\document class[11pt,a4paper]{moderncv}

% moderncv themes
\Moderncvtheme[green]{casual}

% character encoding
\usepackage[utf8]{inputenc}

% adjust the page margins
\usepackage[scale=0.8]{geometry}
\recomputelengths

% personal data 
\name{John}{Doe}
\title{Design enthusiast}
\address{12 somestreet}{3456 somecity}
\mobile{+123 456 7890}
\phone{+12 (3)456 78 90}
\fax{+12 (3)456 78 90}
\email{jdoe@design.org}
\extrainfo{\link{www.ctan.org}}
\photo[64pt]{jdoe_picture}
\quote{Any intelligent fool can make things bigger, more complex, 
and more violent. It takes a touch of genius -- and a lot of courage -- to 
move in the opposite direction.}

\begin{document}
\maketitle

... <what you'll see in the next section>

\end{document}
\end{verbatim}

to obtain a casual moderncv in green, as shown in figure \ref{fig:casual}, and you will substitute the line describing the theme with:

\begin{verbatim}
% moderncv themes
\Moderncvtheme[blue]{classic}
\end{verbatim}

to obtain a classic moderncv in blue, as shown in figure \ref{fig:classic}.


\begin{figure}[p]
 \centering
%  \fbox{\includegraphics[angle=90,width=\textwidth]{cv_casual.pdf}}
 \caption{An example of casual moderncv in green.}
 \label{fig:casual}
\end{figure}

\begin{figure}[p]
 \centering
%  \fbox{\includegraphics[angle=90,width=\textwidth]{cv_classic.pdf}}
 \caption{An example of classic moderncv in blue.}
 \label{fig:classic}
\end{figure}

\subsection{Customize sections}

Now we are ready to edit the part between \verb|\begin{document}| and \verb|\end{document}|.

As you can seen in figure \ref{fig:casual} e \ref{fig:classic}, you can divide your CV into sections, each of them describing what you are, what you know and what you have done in your life. Every section is divide into items chosen from different flavours. More in details:

\subsection{Section}

The command to open a new section is: 

\begin{verbatim}
\section{<title>}
\end{verbatim}

and every section can be divided into subsections:

\begin{verbatim}
\subsection{<title>}
\end{verbatim}

If necessary, there is a command to close the section: 

\begin{verbatim}
\closesection{}
\end{verbatim}

and even one to create an empty section:

\begin{verbatim}
\emptysection{}
\end{verbatim}

An example of their usage can be the next one:

\begin{verbatim}
\section{Section with your own content}\closesection
Your content here, inside the normal \LaTeX{} environment. 
You can use any regular \LaTeX{} command, display mathematics
\[e =m\,c^2,\]
put some table or figure, \dots

\emptysection{}
\cvitem{Now}{Back to moderncv layout, without making a new section :-)}
\end{verbatim}

whose results is shown in figure \ref{fig:ex_sec}.

\begin{figure}[!ht]
 \centering
%  \fbox{\includegraphics[width=0.9\textwidth]{ex_sec}}
 \caption{Example of usage of section commands.}
 \label{fig:ex_sec}
\end{figure}

\subsection{Items}

Inside sections, you can choose between different kind of items depending on the purpose:

\begin{itemize}
 \item in the sections describing your education or your job experiences, you can use:
 \begin{verbatim}
\cventry{years}{degree/job title}{institution/employer}
{localization}{optional: grade/...}
{optional: comment/job description}
  \end{verbatim} 
\vspace{-20pt}  
where the last three arguments are optional
 \item inside `language' cvsection environment, you can type every entry with:
 \begin{verbatim}
\cvlanguage{name}{level}{comment}
 \end{verbatim}
 \item inside `computer skills' cvsection environment, you can type every entry with:
 \begin{verbatim}
\cvcomputer{category}{programs}{category}{programs}
 \end{verbatim}
 \item to typeset lines with a hint on the left:
 \begin{verbatim}
\cvline{leftmark}{text}
 \end{verbatim}
 \item to typeset entry with a description on the left, but in two columns inside a cvsection:
 \begin{verbatim}
\cvdoubleitem{subtitle}{text}{subtitle}{text}
 \end{verbatim}
 \item to typeset lists on one column inside a cvsection:
 \begin{verbatim}
\cvlistitem{point1}
 \end{verbatim}
 \item to typeset lists on two columns inside a cvsection:
 \begin{verbatim}
\cvlistdoubleitem{point1}{point2}
 \end{verbatim}
 \item to add a section listing all your publications stored in a BibTeX file:
 \begin{verbatim}
\nocite{*}
\bibliographystyle{plain}
\bibliography{BibTeX_file}
 \end{verbatim}
\vspace{-20pt}
 where the name of the section title can be changed by redefining the \Code{refname} with  \verb|\renewcommand{\refname}{<new_name>}|
\end{itemize}

\subsection*{Example}

Let's put all together and see in figure \ref{fig:sections} what is the result:

\begin{verbatim}
... preamble ...
\begin{document}
\section{Education}
\cventry{year--year}{Degree}{Institution}{City}{\textit{Grade}}{Description}
\cventry{year--year}{Degree}{Institution}{City}{\textit{Grade}}{Description}
% 
\section{Master thesis}
\cvline{title}{\emph{Title}}
\cvline{supervisors}{Supervisors}
\cvline{description}{\small Short thesis abstract}
% 
\section{Experience}
\subsection{Vocational}
\cventry{year--year}{Job title}{Employer}{City}{}{Description}
\cventry{year--year}{Job title}{Employer}{City}{}{Description}
\subsection{Miscellaneous}
\cventry{year--year}{Job title}{Employer}{City}{}%
  {Description line 1\newline{}Description line 2}
% 
\section{Languages}
\cvlanguage{language 1}{Skill level}{Comment}
\cvlanguage{language 2}{Skill level}{Comment}
% 
\section{Computer skills}
\cvcomputer{category 1}{XXX, YYY, ZZZ}{category 3}{XXX, YYY, ZZZ}
\cvcomputer{category 2}{XXX, YYY, ZZZ}{category 4}{XXX, YYY, ZZZ}
% 
\section{Interests}
\cvline{hobby 1}{\small Description}
\cvline{hobby 2}{\small Description}
\cvline{hobby 3}{\small Description}
% 
\closesection{}
\pagebreak
%
\section{Extra}
\cvlistitem{Item 1}
\cvlistitem{Item 2}
\cvlistitem{Item 3}
%
\section{Extra 2}
\cvlistdoubleitem{Item 1}{Item 4}
\cvlistdoubleitem{Item 2}{Item 5}
\cvlistdoubleitem{Item 3}{}
%
% Publications from a BibTeX file
\nocite{*}
\bibliographystyle{plain}
\bibliography{publications}  % 'publications' is the name of a BibTeX file 
%
\end{document}
\end{verbatim} 

\begin{figure}[!ht]
 \centering
%  \fbox{\includegraphics[angle=90,width=\textwidth]{test_cvsection2.pdf}}\\
%  \fbox{\includegraphics[angle=90,width=\textwidth]{test_cvsection1.pdf}} 
\caption{Example of usage of items inside cvsections.}
 \label{fig:sections}
\end{figure}

\subsection{More customizations}

You have some useful commands to personalize your CV further.

\subsection*{Modifying the symbols}
You can modify the symbols used for the personal data (phone number, the email, \ldots) redefining \Code{phonesymbol}, \Code{emailsymbol}, \Code{addresssymbol}, \Code{mobilesymbol}, \Code{faxsymbol}.

For example: if you want to use the dingbat fonts, load the \Code{pifont} package in the preamble, then substitute the default symbol \Telefon\ with the dingbat symbol \ding{38}\ by:
\begin{verbatim}
\renewcommand{\phonesymbol}{\ding{38}}
\end{verbatim} 

You can change the symbol for lists in two way:
\begin{itemize}
 \item redefining the command \Code{listitemsymbol}: \verb|\renewcommand{\listitemsymbol}{-}|
 \item adding a specification for the label in \Code{cvlistitem} and \Code{cvlistdoubleitem}
\end{itemize}

For example: the  following code produces the result shown in figure \ref{fig:ex_items}.

\begin{verbatim}
\closesection{}                   % needed to renewcommands
\renewcommand{\listitemsymbol}{-} % change the symbol for lists

\section{Extra 1}
\cvlistitem{Item 1}
\cvlistitem{Item 2}
\cvlistitem[+]{Item 3}            % optional other symbol

\section{Extra 2}
\cvlistdoubleitem[\Neutral]{Item 1}{Item 4}
\cvlistdoubleitem[\Neutral]{Item 2}{Item 5}
\cvlistdoubleitem[\Neutral]{Item 3}{}
\end{verbatim} 

\begin{figure}[!hbt]
 \centering
%  \fbox{\includegraphics[width=.8\textwidth]{ex_items.png}}
 \caption{Example of customization of the list labels.}
 \label{fig:ex_items}
\end{figure}

\subsection*{Adjusting lengths}
The different lengths used by moderncv are customizable by
\begin{verbatim}
\setlength{<length>}{<new_dimensions>}
\end{verbatim}
where \Code{<length>} are \Code{quote\-width}, \Code{sep\-a\-ra\-tor\-col\-umn\-width}, \Code{main\-col\-umn\-width}, \Code{doub\-le\-i\-tem\-main\-col\-umn\-width}, \Code{list\-i\-tem\-sym\-bol\-width}, \Code{list\-doub\-le\-i\-tem\-main\-col\-umn\-width}, 

In particular, the first column, can be set to any width. You can do that in two way:
\begin{itemize}
 \item using \verb|\sethintscolumnlength{<length>}|, where  \Code{<length>} is the desired length in a unit LaTeX understands
 \item using \verb|\sethintscolumntowidth{<string>}|, where \Code{<string>} is a string of the desired length (usually, the longest string that has to appear in the column)
\end{itemize}

\subsection*{Additional commands}
There are commands to manage hypertextual links:
\begin{itemize}
 \item[-] \verb|\link[optional text]{URL}|
 \item[-] \verb|\httplink[optional text]{link}|
 \item[-] \verb|\emaillink[optional text]{link}|
\end{itemize}

There is a \verb|\today| command, useful for example if you need to add the date the CV was produced.

\subsection*{Putting things at the end of CV}
Sometimes there is the need to add some lines at the end of the CV. For example, in Italy is necessary to add the permission to treat the personal data contained in the r\'esum\'e. You can do that dropping out of the layout of \Code{moderncv} and pushing the lines at the end by the command \verb|\vfill|:
\begin{verbatim}
\emptysection{}\closesection
\vfill
\begin{center} 
\textit{\small Ai sensi del D. Lgs. 196/2003 ...}
\end{center}
\end{verbatim}

\section{Customization}
\label{section:customization}
\subsection{Styles and their options}
\subsection{Colors}
\subsection{Tweaks}

\section{Implementation details}
\label{section:implementationDetails}
\subsection{Required packages}
\label{section:implementationDetails:requiredPackages}
In addition to the packages that \Moderncv itself provides the following packages are loaded internally:

\noindent
\code{etoolbox}, 
\code{ifthen}, 
\code{xcolor}, 
\code{ifxetex,ifluatex}, 
\code{fontenc}, 
\code{url}, 
\code{hyperref}, 
\code{graphicx}, 
\code{fancyhdr}, 
\code{tweaklist}, 
\code{calc}, 
\code{xparse}, 
\code{microtype}, 
\code{expl3}, 
\code{tikz}, 
\code{changepage}, 
\code{fontawesome5}, 
\code{academicons}, 
\code{tgpagella}, %
\code{ebgaramond}, %
\code{kurier}. %

Optionally \Code{lmodern} gets loaded as well if the packages is installed.
Note that the \Code{tweaklist} package has been altered for the development of \Moderncv and ships 
with \moderncv.
\todox{Add required packages of cvskillmatrix}

Most of the packages should be included in the \LaTeX\ distribution of your choice.

\subsection{Known conflicts with other packages}
\subsection{Known bugs}



\end{document}