From 19e58651e433cf99a092d2b7ce2689d7e573677f Mon Sep 17 00:00:00 2001 From: LLdaniel Date: Sat, 4 May 2024 13:30:49 +0200 Subject: [PATCH] manually copied the current version user guide form master --- manual/moderncv_userguide.tex | 1372 ++++++++++++++++++++------------- 1 file changed, 823 insertions(+), 549 deletions(-) diff --git a/manual/moderncv_userguide.tex b/manual/moderncv_userguide.tex index 68f9d96..46076ae 100644 --- a/manual/moderncv_userguide.tex +++ b/manual/moderncv_userguide.tex @@ -1,702 +1,976 @@ -%% moderncv_userguide.tex (compiled with pdfLaTeX) -%% Copyright 2007 Cristina Sambo +%% moderncv_userguide.tex as shipped with 2022/02/21 v2.3.1 modern curriculum vitae and letter document class (moderncv) +%% 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} +\documentclass[a4paper, 11pt]{article} -\title{\bfseries Moderncv -- v. 0.6} -\author{Package by Xavier Danaux \\ \begin{small}Documentation by Cristina Sambo \end{small}} -\date{} +\title{% + \texttt{moderncv} User Guide\\ + {\small Package v2.3.1}% +} +% Cristina Sambo, +\author{% + Package by Xavier Danaux\\ + {\small Documentation by David Seus}% +} +\date{\today} -%language and encoding options +% Language and encoding options \usepackage[english]{babel} -\usepackage[T1]{fontenc} -\usepackage[latin1]{inputenc} +\usepackage{ifxetex, ifluatex} +\newif\ifxetexorluatex +\ifxetex + \xetexorluatextrue +\else + \ifluatex + \xetexorluatextrue + \else + \xetexorluatexfalse + \fi +\fi -%font options +% 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 + \usepackage[utf8]{inputenx} % Uncomment if using pdflatex, comment if using lualatex +\fi +\PassOptionsToPackage{T1}{fontenc} % T2A for Cyrillic +\usepackage[T1]{fontenc} + +% Font options \usepackage{txfonts} \usepackage{marvosym} \usepackage{pifont} -%margins, spacing and page layout -\usepackage[pdftex,colorlinks=true]{hyperref} %(hyperref must be loaded before geometry) -\usepackage[pdftex]{geometry} +% Margins, spacing and page layout +\usepackage[pdftex, colorlinks=true]{hyperref} % hyperref must be loaded before geometry +\usepackage[pdftex, marginparwidth=50pt]{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) +\usepackage{parskip} % Replace paragraph indentation with vertical spacing +\frenchspacing % Suppress additional space after a full stop +\renewcommand{\arraystretch}{1.1} -%packages -\usepackage[pdftex]{graphicx} -\usepackage[pdftex]{xcolor} -\usepackage[labelfont=sl,font=small,width=0.9\textwidth]{caption} +% 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} % Fix spacing after macros +\usepackage{mparhack} % Fix marginpar +\usepackage{microtype} +\usepackage{multicol} % Multicolumn text for long lists -%pdfLaTeX options -\pdfpagewidth=\paperwidth -\pdfpageheight=\paperheight -\pdfimageresolution=150 -\pdfinfo{ - /Title (Moderncv -- v. 0.6) - /Author (Cristina Sambo) - /Subject (Moderncv package user's guide) - /Keywords (curriculum vitae, LaTeX) +% Code listings +\usepackage{listings} +% \lstset{emph={trueIndex, root}, emphstyle=\color{BlueViolet}}% \underbar} % Special keywords +\lstset{% + language=[LaTeX]Tex, % C++, + morekeywords={PassOptionsToPackage, selectlanguage}, + keywordstyle=\color{cvblue}, % \bfseries, + basicstyle=\small\ttfamily, + % identifierstyle=\color{NavyBlue}, + commentstyle=\color{gray}\ttfamily, + stringstyle=\rmfamily, + numbers=none, % left, + numberstyle=\scriptsize, % \tiny + stepnumber=5, + numbersep=8pt, + showstringspaces=false, + breaklines=true, + % frameround=ftff, + % frame=single, + belowcaptionskip=0.75\baselineskip, + % frame=L, + emph={ + cvitem, cventry, cvdoubleentry, cvdoubleitem, cvlistitem, cvlistdoubleitem, cvcolumns, moderncvstyle, moderncvcolor, + cvskill, cvskilllegend, cvskillplainlegend, cvskillhead, cvskillentry, nopagenumbers, + name, born, address, email, link, social, phone, homepage, extrainfo, photo, quote, section, subsection, setlength, NewDocumentCommand, definecolor, colorlet, cvitemwithcomment + }, + emphstyle={\color{cvblue}}, + emph={[2] + familydefault, sfdefault, rmdefault, inputenc, moderncv, document, bibliographyitemlabel, + addresssymbol, mobilephonesymbol, fixedphonesymbol, faxphonesymbol, emailsymbol, homepagesymbol, linkedinsocialsymbol, + xingsocialsymbol, twittersocialsymbol, githubsocialsymbol, gitlabsocialsymbol, + stackoverflowsocialsymbol, bitbucketsocialsymbol, skypesocialsymbol, orcidsocialsymbol, researchgatesocialsymbol, arxivsocialsymbol, inspiresocialsymbol, + researcheridsocialsymbol, telegramsocialsymbol, whatsappsocialsymbol, signalsocialsymbol, matrixsocialsymbol, googlescholarsocialsymbol, cvstretchability, bornsymbol + }, + emphstyle={[2]\color{cvblue!60!cvgrey}\bfseries}, + literate={{é}{{\'e}}1}, } -%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} +% Hyperlinks +\usepackage{hyperref} +\hypersetup{ + unicode=true, + % draft, % Draft mode for printing (see below) + colorlinks=true, linktocpage=true, pdfstartpage=3, pdfstartview=FitV, + % colorlinks=false, linktocpage=false, pdfstartpage=3, pdfstartview=FitV, pdfborder={0 0 0}, % Black links (e.g., for printing) + breaklinks=true, pageanchor=true, + pdfpagemode=UseNone, + % pdfpagemode=UseOutlines, + plainpages=false, bookmarksnumbered, bookmarksopen=true, bookmarksopenlevel=1, + hypertexnames=true, pdfhighlight=/O, % nesting=true, frenchlinks, + urlcolor=cvblue, linkcolor=cvblue, citecolor=cvblue, % 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, +} -%================== +% Colors +\definecolor{cvblue}{rgb}{0.22, 0.45, 0.70} +\definecolor{cvgreen}{rgb}{0.35, 0.70, 0.30} +\definecolor{cvred}{rgb}{0.95, 0.20, 0.20} +\definecolor{cvorange}{rgb}{0.95, 0.55, 0.15} +\definecolor{cvgrey}{rgb}{0.75, 0.75, 0.75} +\definecolor{cvburgundy}{rgb}{0.596078, 0, 0} % burgundy: 139/255 (0.545098) or 152/255 (0.596078) +\definecolor{cvgrey}{rgb}{0.55, 0.55, 0.55} +\definecolor{cvpurple}{rgb}{0.50, 0.33, 0.80} + +% Macros +\newcommand{\todo}[1]{\marginpar{\raggedright \textcolor{red}{[\textbf{TODO:} #1]}}} +\newcommand{\todox}[1]{\textcolor{red}{[\textbf{TODO:} #1]}} +\newcommand{\note}{\paragraph{Note.}} +\newcommand{\code}[1]{\lstinline!#1!} +\newcommand{\moderncv}{\code{moderncv}} +\newcommand{\Moderncv}{\moderncv~} +\newcommand{\github}{GitHub} +\newcommand{\Github}{\github~} +\newcommand{\ctan}{CTAN} +\newcommand{\Ctan}{\ctan~} +\newcommand{\cvtemplate}{\code{template.tex}} +\newcommand{\Cvtemplate}{\cvtemplate~} +\newcommand{\Latex}{\LaTeX~} +\newcommand{\biblatex}{BibLaTeX} +\newcommand{\Biblatex}{\biblatex~} +\newcommand{\cvdoccolorbox}[1]{{\color{#1}\rule{4ex}{2ex}}} +\newcommand{\moderncvGithub}{\url{https://github.com/moderncv/moderncv}} +\newcommand{\moderncvCtan}{\url{https://ctan.org/pkg/moderncv}} + + + + + +% ================== % DOCUMENT BEGINNING -%================== +% ================== \begin{document} \maketitle - \begin{abstract} -\noindent \texttt{Moderncv}, as its author says in the readme file, provides a documentclass for typesetting modern curriculum vitaes in various styles. It is fairly customizable, allowing you to define your own style by changing the colors, the fonts, \dots\ and provides two default styles: classic and casual. + \noindent + The \Moderncv package provides a document class for typesetting modern curriculum vit\ae{} and cover letters in various styles. + Five predefined styles are available, each of which can be adjusted through various options for headings, footers and colors. + It is fairly customizable, allowing the user to adjust the look and feel of each style to their liking. + Several macros allow the user to add content to the CV and format it in a consistent way. + A letter of motivation consistent with the style is part of the template as well. \end{abstract} +\tableofcontents -\section{Introduction} -When I saw for the first time this class I was amazing: ``Here it is what I need'', I thought. Using the very clear examples, was easy to make my first curriculum. -Indeed the class is very simple to use, in this documentation I will only put together all the things to help users to have all on hand. -\smallskip -\texttt{Moderncv} requires the following packages: \texttt{ifthen}, \texttt{ifpdf}, \texttt{color}, \texttt{lmodern}, \texttt{marvosym}, \texttt{url}, \texttt{hyperref}, \texttt{longtable}, \texttt{graphicx}, \texttt{fancyhdr}, usually all just included in the \LaTeX\ distributions. -\section{In the preamble} +\section{Getting started} +\subsection{How to read this manual} +This manual is organized as follows. +The current section explains on how to get started with the \Moderncv package, i.e. how to install required packages. +% \emph{Note that it is assumed that you know how to install \Latex packages in case some are missing.} +Section \ref{section:moderncvTemplate} explains how to work with the \Moderncv template file step by step. +Section \ref{section:customization} details the customizations that the user can make: the different styles, their options, colors and tips and tricks. +Section \ref{section:implementationDetails} details the packages that \Moderncv uses, known problems and possible solutions to those problems. -At the very beginning of your preamble (that is the part before \verb|\begin{document}|) insert: +\subsection{Installation instructions} +If the \Moderncv package does not ship with your \Latex distribution or if the installed version is too old, grab the \Moderncv code from \Ctan or \github: -\begin{verbatim} -\documentclass[]{moderncv} -\end{verbatim} +\begin{tabular}{l} + \moderncvCtan \\% [.5ex] + \moderncvGithub +\end{tabular} -where the options are: +\note Depending on your \Latex distribution, you may have to install some additional packages. +Section \ref{section:implementationDetails:requiredPackages} lists all the packages that \Moderncv requires to be installed on your system. -\begin{description} - \item[paper size options:] \texttt{a4paper}, \texttt{a5paper}, \texttt{b5paper}, \texttt{letterpaper}, \texttt{legalpaper}, \texttt{ex\-ec\-u\-tive\-pa\-per}, \texttt{landscape} - \item[font size options:] \texttt{10pt}, \texttt{11pt}, \texttt{12pt} - \item[font option:] \texttt{nolmodern}, for people without the latin modern fonts - \item[color option:] \texttt{nocolor}, to have all in black and white - \item[draft/final options:] \texttt{draft}, \texttt{final} -\end{description} -The default options are: \texttt{a4paper}, \texttt{11pt}, \texttt{color}, \texttt{final}. -After the documentclass specification, choose the theme for your curriculum vit\ae: +\section{The \texttt{moderncv} template step by step} +This section is a quick reference to the \Moderncv package and should contain enough information to typeset a first working CV. +\label{section:moderncvTemplate} +The easiest way to get started with \Moderncv is to use the template that comes with the package. +If \Moderncv is part of your \Latex distribution, search for the folder \Moderncv on your system, which should contain all the files for the package. +In this folder, there should be a file called \cvtemplate. +If you downloaded the package from \Github or \ctan, look for \Cvtemplate in the folder of the newly downloaded (and possibly extracted) package. -\begin{verbatim} -\moderncvtheme[]{casual} -\end{verbatim} +\note If you downloaded \Moderncv from \Github or \Ctan and moved \Cvtemplate to another folder, make sure to adjust the \code{TEXINPUTS} variable to find the newly downloaded package. +Otherwise, either the package version provided by your \Latex distribution gets used or \Latex throws an error if there is no other version installed. -which is the default theme, or +Test your setup by compiling \Cvtemplate and looking at the result. -\begin{verbatim} -\moderncvtheme[]{classic} -\end{verbatim} +\note The \Moderncv package should compile with \code{pdflatex}, \code{lualatex} and \code{xelatex}. +However, not all icons are available when using \code{pdflatex}, so using either \code{lualatex} or \code{xelatex} \emph{is highly recommended.} -where the theme options are: +\subsection{Basic setup} +A document using the \Moderncv document class is set up like any other document class. +We will go through the template step by step. -\begin{description} - \item[color options:] you can choose between five color: - \begin{itemize} - \item[\texttt{blue}] {\color{bluecv}\rule{1cm}{2ex}} (default color) - \item[\texttt{green}] {\color{greencv}\rule{1cm}{2ex}} - \item[\texttt{red}] {\color{redcv}\rule{1cm}{2ex}} - \item[\texttt{orange}] {\color{orangecv}\rule{1cm}{2ex}} - \item[\texttt{grey}] {\color{greycv}\rule{1cm}{2ex}} - \end{itemize} - \item[roman option:] \texttt{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} +\subsubsection*{Configuring document class options} +The \Moderncv document class is loaded as per usual, by +\begin{lstlisting} + \documentclass[]{moderncv} +\end{lstlisting} +where at most one value for each option can be passed to the document class: -Then you have to specify the character encoding (utf8, latin1, and so on): +\begin{tabular}{r@{\hspace{2ex}}p{0.55\textwidth}} + \textbf{\code{paper}:} & \code{a4paper} (default), \code{a5paper}, \code{b5paper}, \code{letterpaper}, + \code{legalpaper}, \code{executivepaper}, \code{landscape} \\ + \textbf{\code{font family}:} & \code{sans}, \code{roman} \\ + \textbf{\code{font size}:} & \code{10pt}, \code{11pt} (default), \code{12pt} \\ + \textbf{\code{draft/final}:} & \code{draft}, \code{final} (default) +\end{tabular} -\begin{verbatim} -\usepackage[]{inputenc} -\end{verbatim} +\subsubsection*{Choosing a \texttt{moderncv} style and color} +Choose a \Moderncv style and color by adjusting the commands +\begin{lstlisting} + \moderncvstyle{