docs: Correct additional link signatures in the documentation (#294)

Update the [User Guide], addressing #293:
- Add `httplink`, `httpslink`, and `emaillink` to the `emph` list.
- Replace incorrect signatures and an example with the relevant commands
  (`\httplink`, `\httpslink`, and `\emaillink`).
- Fix a grammatical error: "a email" to "an email".
- Update `CHANGELOG` with a summary of the changes and a reference to the issue
  they close.

[User Guide]:
  https://github.com/moderncv/moderncv/blob/master/manual/moderncv_userguide.pdf
This commit is contained in:
Alexander Edding 2026-06-18 23:54:26 +02:00 committed by GitHub
commit e65bc3ce72
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 11 additions and 10 deletions

View file

@ -10,6 +10,7 @@ version next
- Adds contributing guidelines for moderncv (#275)
- Fix incomplete social icons migration (Fontawesome 6) (#287)
- Complete the color and style listings in the documentation (#291)
- Correct additional link signatures in the documentation (#293)
version 2.5.1 (31 Jan 2026)

View file

@ -98,7 +98,7 @@
cvitem, cventry, cvdoubleentry, cvdoubleitem, cvtripleitem, 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,
recipient, subject, opening, closing, signature, postscript, enclosure, makelettertitle, makeletterclosing
recipient, subject, opening, closing, signature, postscript, enclosure, makelettertitle, makeletterclosing, httplink, httpslink, emaillink
},
emphstyle={\color{cvblue}},
emph={[2]
@ -969,32 +969,32 @@ Adjusting one column affects the other ones as the total width of the skill matr
\end{lstlisting}
\subsection{Additional link commands}%% adapted from Cristina Sambo's documentation
To create links to a website or a email address, use the following commands:
To create links to a website or an email address, use the following commands:
A general weblink with optional text.
A general weblink with optional text.
\begin{lstlisting}
\link[<text>]{<link>}
%% example
\link[name of the link]{ftp://ftp.somesite.org}
\end{lstlisting}
An HTTP link. The HTTP prefix is generated automatically and is not needed in the link argument.
An HTTP link. The \texttt{http://} prefix is generated automatically and is not needed in the link argument.
\begin{lstlisting}
\link[<text>]{<link>}
\httplink[<text>]{<link>}
%% example
\link[goto HTTP site]{www.somehttpsite.org}
\httplink[goto HTTP site]{www.somehttpsite.org}
\end{lstlisting}
A HTTPS link. The HTTPS prefix is generated automatically and is not needed in the link argument.
A HTTPS link. The \texttt{https://} prefix is generated automatically and is not needed in the link argument.
\begin{lstlisting}
\link[<text>]{<link>}
\httpslink[<text>]{<link>}
%% example
\httpslink[goto HTTPS site]{www.somesecuresite.org}
\end{lstlisting}
An email link. The mailto prefix is generated automatically and is not needed in the link argument.
An email link. The \texttt{mailto:} prefix is generated automatically and is not needed in the link argument.
\begin{lstlisting}
\link[<text>]{<link>}
\emaillink[<text>]{<link>}
%% example
\emaillink[my email]{jdoe@website.org}
\end{lstlisting}