diff --git a/CHANGELOG b/CHANGELOG index 903dc1a..8de1d2f 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -12,6 +12,7 @@ version next - Add contemporary CV header style to cover letter, which also makes icons visible (#186) - Fix minor horizontal spacing issue in 'contemporary' style header +- Document how to set custom strings for social command (#239) version 2.4.1 (18 Jul 2024) - Fix commons/colors.tex not found in package (#194) diff --git a/manual/moderncv_userguide.pdf b/manual/moderncv_userguide.pdf index 2b3284f..094f8a5 100644 Binary files a/manual/moderncv_userguide.pdf and b/manual/moderncv_userguide.pdf differ diff --git a/manual/moderncv_userguide.tex b/manual/moderncv_userguide.tex index ab7ba7f..0f5371d 100644 --- a/manual/moderncv_userguide.tex +++ b/manual/moderncv_userguide.tex @@ -104,7 +104,7 @@ emph={[2] familydefault, sfdefault, rmdefault, inputenc, moderncv, document, bibliographyitemlabel, addresssymbol, mobilephonesymbol, fixedphonesymbol, faxphonesymbol, emailsymbol, homepagesymbol, linkedinsocialsymbol, - xingsocialsymbol, twittersocialsymbol, githubsocialsymbol, gitlabsocialsymbol, + xingsocialsymbol, twittersocialsymbol, githubsocialsymbol, gitlabsocialsymbol, mastodonsocialsymbol, codebergsocialsymbol, discordsocialsymbol, twitchsocialsymbol, youtubesocialsymbol, tiktoksocialsymbol, instagramsocialsymbol, soundcloudsocialsymbol, steamsocialsymbol, xboxsocialsymbol, playstationsocialsymbol, battlenetsocialsymbol, simplexsocialsymbol, threemasocialsymbol, stackoverflowsocialsymbol, bitbucketsocialsymbol, skypesocialsymbol, orcidsocialsymbol, researchgatesocialsymbol, arxivsocialsymbol, inspiresocialsymbol, researcheridsocialsymbol, telegramsocialsymbol, whatsappsocialsymbol, signalsocialsymbol, matrixsocialsymbol, googlescholarsocialsymbol, cvstretchability, bornsymbol }, @@ -330,7 +330,7 @@ Takes the platform as an optional argument. \begin{lstlisting} \social[]{} \end{lstlisting} -The following values are supported for \code{}: +The following values are supported for \code{} (see also \ref{icon:usage}): \begin{itemize} \begin{multicols}{4} \item \code{arxiv} @@ -750,17 +750,9 @@ If an even finer control over the color scheme of the style is desired, the foll \subsection{Modifying symbols and icons} -\subsubsection{Icons} +\subsubsection{Icons}\label{icon:usage} As stated in section \ref{section:customization:stylesAndOptions}, the use of icons is toggled by the \code{symbols} option that can be passed to \code{\\moderncvstyle}. -The icons used in the display of the personal data (phone numbers, email, fax, social media accounts, etc.) can be customized by redefining the internal commands for the symbols: -\begin{lstlisting} - \renewcommand*{<\symbolcommand>}{{\small<\symbol>}~} -\end{lstlisting} -Using \code{\\small} is optional, but the default behavior is to render all icons using \code{\\small}. -Use \code{\\small} if one merely wishes to replace an icon/symbol while keeping the size consistent with the default icons/symbols. -The tilde ensures proper spacing after the symbols and is recommended as well. - Currently \Moderncv supports the following commands as \code{<\\symbolcommand>}: \begin{itemize} \begin{multicols}{2} @@ -770,27 +762,49 @@ Currently \Moderncv supports the following commands as \code{<\\symbolcommand>}: \item \code{\\faxphonesymbol} \item \code{\\emailsymbol} \item \code{\\homepagesymbol} + \item \code{\\bornsymbol} \item \code{\\linkedinsocialsymbol} \item \code{\\xingsocialsymbol} \item \code{\\twittersocialsymbol} + \item \code{\\mastodonsocialsymbol} \item \code{\\githubsocialsymbol} \item \code{\\gitlabsocialsymbol} \item \code{\\stackoverflowsocialsymbol} - \item \code{\\googlescholarsocialsymbol} + \item \code{\\bitbucketsocialsymbol} + \item \code{\\skypesocialsymbol} + \item \code{\\orcidsocialsymbol} + \item \code{\\researchgatesocialsymbol} + \item \code{\\researcheridsocialsymbol} \item \code{\\telegramsocialsymbol} \item \code{\\whatsappsocialsymbol} \item \code{\\signalsocialsymbol} \item \code{\\matrixsocialsymbol} - \item \code{\\orcidsocialsymbol} - \item \code{\\researchgatesocialsymbol} - \item \code{\\researcheridsocialsymbol} - \item \code{\\bitbucketsocialsymbol} - \item \code{\\skypesocialsymbol} - \item \code{\\bornsymbol} + \item \code{\\googlescholarsocialsymbol} + \item \code{\\codebergsocialsymbol} + \item \code{\\discordsocialsymbol} + \item \code{\\twitchsocialsymbol} + \item \code{\\youtubesocialsymbol} + \item \code{\\tiktoksocialsymbol} + \item \code{\\instagramsocialsymbol} + \item \code{\\soundcloudsocialsymbol} + \item \code{\\steamsocialsymbol} + \item \code{\\xboxsocialsymbol} + \item \code{\\playstationsocialsymbol} + \item \code{\\battlenetsocialsymbol} \item \code{\\arxivsocialsymbol} \item \code{\\inspiresocialsymbol} + \item \code{\\simplexsocialsymbol} + \item \code{\\threemasocialsymbol} \end{multicols} \end{itemize} + +The general usage is \code{\\social\[\\]\{\\}}. Usually only the profile dependent url fragment has to be used as the common url parts are already defined in \texttt{moderncv.cls}. +As an alternative the appearing link and string after the symbol can be customized when using the following command instead: +\begin{lstlisting} + \social[][]{} +\end{lstlisting} + +\paragraph{Note.} The possible options for \code{<\\symbol>} depend on the package that is used. By default, the \code{marvosym} package is loaded if \code{pdflatex} is used, and the \code{academicons} and \code{fontawesome5} packages are loaded if either \code{lualatex} or \code{xelatex} is used. Full lists of all available symbols and icons can be found in the documentation of each respective package: @@ -801,13 +815,21 @@ Full lists of all available symbols and icons can be found in the documentation \url{https://ctan.org/pkg/academicons} \end{tabular} +\paragraph{Redefinition.}The icons used in the display of the personal data (phone numbers, email, fax, social media accounts, etc.) can be customized by redefining the internal commands for the symbols: +\begin{lstlisting} + \renewcommand*{<\symbolcommand>}{{\small<\symbol>}~} +\end{lstlisting} +Using \code{\\small} is optional, but the default behavior is to render all icons using \code{\\small}. +Use \code{\\small} if one merely wishes to replace an icon/symbol while keeping the size consistent with the default icons/symbols. +The tilde ensures proper spacing after the symbols and is recommended as well. + \paragraph{Example.} If one wanted to use the dingbat fonts to replace the default phone symbol, one should load the \code{pifont} package in the preamble and then substitute the default symbol with the dingbat symbol \ding{38}\ with \begin{lstlisting} \renewcommand*{\fixedphonesymbol}{\ding{38}~} \end{lstlisting} -\paragraph{Alternative to icons} +\paragraph{Alternative to icons.} In case you do not want \texttt{symbols} (default) for the icons, there is also the option to replace icons with \texttt{letters} instead. This is set by the macro \code{\\moderncvicons}, which must be called after setting the style in the preamble. \begin{lstlisting} \moderncvicons{}