diff --git a/manual/moderncv_userguide.tex b/manual/moderncv_userguide.tex index 1e084a0..9e334ac 100644 --- a/manual/moderncv_userguide.tex +++ b/manual/moderncv_userguide.tex @@ -5,7 +5,7 @@ % conditions of the LaTeX Project Public License version 1.3c, % available at http://www.latex-project.org/lppl/. -\documentclass[a4paper,11pt,draft]{article} +\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}} @@ -48,11 +48,10 @@ %margins, spacing and page layout \PassOptionsToPackage{dvipsnames*,svgnames,table}{xcolor} -\usepackage[colorlinks=true]{hyperref} %(hyperref must be loaded before geometry) -\usepackage{geometry} +% \usepackage{geometry} % \geometry{top=2.5cm, bottom=3cm} % \setlength{\parindent}{0pt} %(to soppress indentation when starting a new paragraph) -% \frenchspacing %(to soppress additional space after a full stop) +\frenchspacing %(to suppress additional space after a full stop) %packages \usepackage{graphicx} @@ -60,7 +59,7 @@ \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 @@ -75,7 +74,7 @@ keywordstyle=\color{bluecv},%\bfseries, basicstyle=\small\ttfamily, %identifierstyle=\color{NavyBlue}, - commentstyle=\color{greencv}\ttfamily, + commentstyle=\color{grey}\ttfamily, stringstyle=\rmfamily, numbers=none,%left,% numberstyle=\scriptsize,%\tiny @@ -88,6 +87,25 @@ 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} @@ -99,9 +117,14 @@ \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{\Code}[1]{\lstinline!#1! } \newcommand{\moderncv}{\code{moderncv}} +\newcommand{\Moderncv}{\Code{moderncv}} +% current Code repository. +\newcommand{\moderncvGithub}{\url{https://github.com/moderncv/moderncv}} +\newcommand{\moderncvCTAN}{\url{https://ctan.org/pkg/moderncv}} %================== % DOCUMENT BEGINNING %================== @@ -109,17 +132,43 @@ \maketitle \begin{abstract} \noindent -\moderncv provides a document class for typesetting modern curriculum vitae and corresponding cover letters +\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{Installation instructions} +\section{How to read this manual} +Section \ref{section:gettingStarted} contains all information on how to get started with the \Moderncv +package. +It contains installation instructions and discusses the \Moderncv template and how to work with it. -\section{In the preamble} +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. + +\section{Getting started} +\label{section:gettingStarted} +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. + +\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} + + +\subsection{The \texorpdfstring{\Moderncv}{} template step by step.} +The easiest way to get started with \Moderncv is to adjust the template that comes with the package. +In case the template file does not +\subsubsection{In the preamble} At the very beginning of your preamble (that is the part before \verb|\begin{document}|) insert: @@ -130,25 +179,25 @@ At the very beginning of your preamble (that is the part before \verb|\begin{doc 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} + \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}. +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[]{casual} +\Moderncvtheme[]{casual} \end{verbatim} which is the default theme, or \begin{verbatim} -\moderncvtheme[]{classic} +\Moderncvtheme[]{classic} \end{verbatim} where the theme options are: @@ -156,13 +205,13 @@ 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}} + \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. + \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): @@ -191,7 +240,7 @@ Now we can get into the part most related to our curriculum vit\ae: our personal \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|\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} @@ -201,7 +250,7 @@ Finally you can suppress automatic page numbering for CVs longer than one page: \nopagenumbers{} \end{verbatim} -\subsection{Examples} +\subsubsection{Examples} In practice, you will type: @@ -209,7 +258,7 @@ In practice, you will type: \document class[11pt,a4paper]{moderncv} % moderncv themes -\moderncvtheme[green]{casual} +\Moderncvtheme[green]{casual} % character encoding \usepackage[utf8]{inputenc} @@ -244,7 +293,7 @@ to obtain a casual moderncv in green, as shown in figure \ref{fig:casual}, and y \begin{verbatim} % moderncv themes -\moderncvtheme[blue]{classic} +\Moderncvtheme[blue]{classic} \end{verbatim} to obtain a classic moderncv in blue, as shown in figure \ref{fig:classic}. @@ -264,13 +313,13 @@ to obtain a classic moderncv in blue, as shown in figure \ref{fig:classic}. \label{fig:classic} \end{figure} -\section{Customize sections} +\subsubsection{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} +\subsubsection{Section} The command to open a new section is: @@ -318,7 +367,7 @@ whose results is shown in figure \ref{fig:ex_sec}. \label{fig:ex_sec} \end{figure} -\subsection{Items} +\subsubsection{Items} Inside sections, you can choose between different kind of items depending on the purpose: @@ -362,7 +411,7 @@ where the last three arguments are optional \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}{}| + where the name of the section title can be changed by redefining the \Code{refname} with \verb|\renewcommand{\refname}{}| \end{itemize} \subsubsection*{Example} @@ -431,22 +480,22 @@ Let's put all together and see in figure \ref{fig:sections} what is the result: \label{fig:sections} \end{figure} -\section{More customizations} +\subsubsection{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}. +\subsubsection*{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: +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} + \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}. @@ -478,15 +527,15 @@ The different lengths used by moderncv are customizable by \begin{verbatim} \setlength{}{} \end{verbatim} -where \code{} 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}, +where \Code{} 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{}|, where \code{} is the desired length in a unit LaTeX understands - \item using \verb|\sethintscolumntowidth{}|, where \code{} is a string of the desired length (usually, the longest string that has to appear in the column) + \item using \verb|\sethintscolumnlength{}|, where \Code{} is the desired length in a unit LaTeX understands + \item using \verb|\sethintscolumntowidth{}|, where \Code{} is a string of the desired length (usually, the longest string that has to appear in the column) \end{itemize} -\subsection*{Additional commands} +\subsubsection*{Additional commands} There are commands to manage hypertextual links: \begin{itemize} \item[-] \verb|\link[optional text]{URL}| @@ -497,7 +546,7 @@ There are commands to manage hypertextual links: 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|: +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 @@ -506,16 +555,25 @@ Sometimes there is the need to add some lines at the end of the CV. For example, \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} -Internally, \moderncv loads the following packages: +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[unicode]{hyperref}, +\code{hyperref}, \code{graphicx}, \code{fancyhdr}, \code{tweaklist}, @@ -523,11 +581,24 @@ Internally, \moderncv loads the following packages: \code{xparse}, \code{microtype}, \code{expl3}, +\code{tikz}, +\code{changepage}, +\code{fontawesome5}, +\code{academicons}, +\code{tgpagella}, % +\code{ebgaramond}, % +\code{kurier}. % -and optionally -\code{lmodern} +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} -usually all just included in the \LaTeX\ distributions. \end{document}