diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dfec81a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Expected Behavior** + + +**Actual Behavior** + + +**Minimum Working Example to Reproduce the Problem** + +**Specifications** + - moderncv version and source: + - LaTeX compiler (pdfLaTeX, XeLaTeX, etc.) and version: + - Platform (operating system, LaTeX editor, etc.): + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/build-pdf.yml b/.github/workflows/build-pdf.yml index 4969d24..489834a 100644 --- a/.github/workflows/build-pdf.yml +++ b/.github/workflows/build-pdf.yml @@ -1,26 +1,35 @@ name: Build template -on: [push, pull_request] + +on: + push: + branches: + - master + pull_request: + registry_package: jobs: build-template: name: Build template - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest + container: + image: thomasweise/docker-texlive-full:latest + steps: - - name: Install TeX Live - run: sudo apt update && sudo apt install texlive-full fonts-font-awesome - name: Checkout code - uses: actions/checkout@v2 + uses: actions/checkout@v4 + - name: Build pdf run: latexmk -pdflua ./template.tex - - name: Scan log - run: texloganalyser -w ./template.log + - name: Upload pdf - uses: actions/upload-artifact@v2 + uses: actions/upload-artifact@v4 with: name: template.pdf path: ./template.pdf + - name: Upload log - uses: actions/upload-artifact@v2 + if: ${{ always() }} + uses: actions/upload-artifact@v4 with: name: template.log path: ./template.log diff --git a/.gitignore b/.gitignore index 9235563..2e83ea9 100644 --- a/.gitignore +++ b/.gitignore @@ -7,6 +7,8 @@ *.log *.out *.synctex.gz +*.xdv +*.toc # template.tex output # move to *.pdf once manual is done diff --git a/CHANGELOG b/CHANGELOG index 133d726..223f7bb 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,368 +1,413 @@ -Release: next +version next +- Change moderncvcolors.tex to a .sty file for MikTeX compatibility (#199) +- Fix error when omitting the photo in contemporary style (#201) +- Fix spacing between first and last name (#204) +- Include social icons in cover letter for styles classic, fancy and banking (#170) +- Update Oldstyle to use symbols instead of marvosym (#209) +- Fix spacing between first and last name again (#220) +- Make header details flush against sides for casual, classic, and contemporary + styles (#229) - partially fix orphaned section headers for singualar use of \section and \subsection commands and give users the new adjustable lengths \cvsectionstretchability and \subsectionstretchability. In case \section and \subsection are used directly one after the other, an orphaned section header might still occur. This is structural and should be solved by \newpage instead of increasing - \cvsectionstretchability. Closes #10. -- Systematize colors and make them user adjustable. See documentation for details. - this requires the \moderncvcolor to be issued BEFORE \moderncvstyle. -- all styles: make the head options 'details' and 'nodetails' available to the user. (previously they were hidden). Olystyle does not respond too well to nodetails. -- casual style: make the head options 'alternate', 'details' and 'nodetails' available to the user. (previously they were hidden). -- fix Researcher ID (still) doesn't display Issue #29. -- make options 'symbols' and 'nosymbols' available to all styles to toggle whether - symbols should be used or not. Include symbols in oldstyle by default. -- migrate older newcommand syntax in moderncvcollection.sty to the xparse syntax. + \cvsectionstretchability (#10/#226). + + +version 2.4.1 (18 Jul 2024) +- Fix commons/colors.tex not found in package (#194) + +version 2.4.0 (08 Jul 2024) +- Rewrote user guide, thanks to David Seus (#58, #106, #169). +- Fixed "Underfull \hbox (badness 10000)" warning in \makecvtitle (#162). +- Fixed unnecessary academicons warning when academicons aren't used (#161). +- Fixed page counts unnecessarily linking to the last page of the PDF (#159). +- Added support for an optional signature in the cover letter (#157). +- Added support for non-ASCII characters in links (#155). +- Added option to force a homepage link to use HTTP rather than HTTPS (#154). +- Passed unicode option directly to hyperref to avoid conflicts with the + inclusion of hyperref by other packages (#148). +- Fixed the sender block on the cover letter in banking style (#146). +- Added option to classic style to align header elements at the top (#144). +- Added Twitch, YouTube, TikTok, Instagram, SoundCloud, Steam, Xbox, PlayStation + and Battle.net social icons (#131). +- Removed extra dash in PDF metadata when CV title is empty (#116). +- Added support for an optional subject line in the cover letter (#114). +- Added Discord social icon (#112). +- Replace instances of ~~~ in codebase with \hspace to be more compatible with + babel for Spanish (#109). +- Added Codeberg and Mastodon social icons (#107). +- New \social options: arXiv, INSPIRE (#185) +- Systematize colors and make them user adjustable. See documentation for details. + This requires the \moderncvcolor to be issued BEFORE \moderncvstyle (#151). +- all styles: make the head options 'details' and 'nodetails' available to the user. (previously they were hidden). Oldstyle does not respond too well to nodetails (#150). +- casual style: make the head options 'alternate', 'details' and 'nodetails' available to the user. (previously they were hidden) (#150). +- Setting \listitemsymbolspace allows custom spacing between list symbol and text item (for \cvlistitem and \cvlistdoubleitem) (#74). +- Introducing \cvtripleitem command for items in three columns. Closing feature request #174. +- Fixed wrong cvlistitem vspace caused by multiline section titles in fancy style (#69). + +version 2.3.1 (21 Feb 2022) +- Fix duplicate GitLab icon (#105). +- Revert using detokenize in social links (#97). +- Fix broken compilation in classic style (#96). + +version 2.3.0 (16 Dec 2021) +- Remove font loading from class (#87). +- Add Matrix and Signal icon (#84). +- Improved symbol loading (#84). + +version: 2.2.0 (28 Jul 2021) +- Remove dot in \cventry when using moderncvbodyi. + +- Remove http baseurl in hyperref. +- Change font encoding to use fontspec with Latin Modern for LuaTeX and XeTeX, + else inputenc / fontenc / lmodern (https://tex.stackexchange.com/a/496643). +- Add birthdate field command. +- Add Social entries for WhatsApp, Signal and Matrix. +- Fix Researcher ID not showing (#29). +- Make options "symbols" and "nosymbols" available to all styles to toggle + whether symbols should be used or not. Include symbols in oldstyle by default. +- Migrate older newcommand syntax in moderncvcollection.sty to xparse syntax. - Fix resumé typo in template. Is now résumé. -- remove loading lmodern fonts in all styles as they can produce issues with - german characters, see https://tex.stackexchange.com/questions/496630/lualatex-problems-with-german-characters. -- remove loading inputenc package by default. Only load the package when pdflatex is - used. +- Various other minor fixes. version 2.1.0 (21 Jan 2021) -- maintainer change: now team maintained (https://github.com/moderncv), since - original repository is basically dead since 2016. -- new \social options: Xing, Skype, GitLab, Bitbucket, stack overflow, ORCID, - ResearcherID, ResearchGate, Telegram and Google Scholar -- hyperlinks in phone numbers -- switch from l3regex to expl3 -- new skill matrix feature -- move to fonawesome5 package -- default to https +- Maintainer change: now team maintained (https://github.com/moderncv), since + original repository has been basically dead since 2016. +- New \social options: Xing, Skype, GitLab, Bitbucket, stack overflow, ORCID, + ResearcherID, ResearchGate, Telegram and Google Scholar. +- Hyperlinks in phone numbers. +- Switch from l3regex to expl3. +- New skill matrix feature. +- Move to fontawesome5 package. +- Default to https. version 2.0.0 (28 Jul 2015) - - refactored the code into heads, body, foot and icon substyles. All styles - (classic, casual, banking and oldstyle) are just a combination of these and - some font selection. Mixing substyles (e.g., the banking header with the - classic body) is now trivial by using the \moderncvhead, \moderncvbody, - \moderncvfoot and \moderncvicons commands. Each of these take a substyle number - as argument. \moderncvcolor takes a color name as argument. - - added a new style, "fancy". - - added an optional argument to \moderncvstyle to specify style options, i.e. - \moderncvstyle[options]{style}. Below is a list of the available options per - style: - * classic - > to specify of one's name should appear left or right at the top: "left" - (default) or "right; - * casual - > to specify of one's name should appear left or right at the top: "left" - (default) or "right; - * banking - > to specify how the section- and subsectionrules should be set: - "fullrules", "shortrules", "mixedrules" (default; full rules for sections, - short rules for subsections), "centered" (fullrules with centered title) - and "norules" (norules, small caps font); - > to specify how the body should be aligned: left" (default), "center" or - "right"; - * oldstyle & fancy - n/a - - added a new color variant: "burgundy". - - corrected the color of \addressstyle to match the one effectively used - (color2). - - adjusted the bibliography spacing to handle entries with or without labels. - - added a check on the emptyness of \title when setting the hyperref document - properties. +- Refactored the code into heads, body, foot and icon substyles. All styles + (classic, casual, banking and oldstyle) are just a combination of these and + some font selection. Mixing substyles (e.g., the banking header with the + classic body) is now trivial by using the \moderncvhead, \moderncvbody, + \moderncvfoot and \moderncvicons commands. Each of these take a substyle + number as argument. \moderncvcolor takes a color name as argument. +- Added a new style: fancy. +- Added an optional argument to \moderncvstyle to specify style options, i.e. + \moderncvstyle[options]{style}. Below is a list of the available options per + style: + * classic + > to specify where at the top one's name should appear: "left" (default) or + "right; + * casual + > to specify where at the top one's name should appear: "left" (default) or + "right; + * banking + > to specify how the section and subsection rules should be set: + "fullrules", "shortrules", "mixedrules" (default; full rules for sections, + short rules for subsections), "centered" (fullrules with centered title) + and "norules" (norules, small caps font); + > to specify how the body should be aligned: left" (default), "center" or + "right"; + * oldstyle & fancy + > n/a +- Added a new color variant: "burgundy". +- Corrected \addressstyle color to match the one effectively used (color2). +- Adjusted the bibliography spacing to handle entries with or without labels. +- Added a check on the emptiness of \title when setting the hyperref document + properties. version 1.5.1 (29 Apr 2013) - - made sure that XeLaTeX or LuaLaTeX is in use before loading the awesome icon - set and if not, revert to the marvosym icon set. +- Made sure that XeTeX or LuaTeX is in use before loading the awesome icon set + and if not, revert to the marvosym icon set. version 1.5.0 (23 Apr 2013) - - added a command to showcase social accounts in one's personal information: - \social. The command currently handles automatically LinkedIn, Twitter and - Github accounts, and other links can be provided explicitly. - - added a new icon set: "awesome" (using the icons from the Font Awesome font). - - set the "awesome" icon set as the default for the "casual" and "banking" - style variants (can be changed back with \moderncvicons{marvosym}). - - forced all the icons of the "letters" icon set to be of the same width, for - alignment purpose. - - added a letter icon ("W") for the homepage of the "letters" icon set. - - forced some white space between the main text and the footer of the "casual" - style variant. - - removed the rule below the headings of the cvcolumns environment. +- Added a command to showcase social accounts in one's personal information: + \social. The command currently handles LinkedIn, Twitter and Github accounts + automatically, and other links can be provided explicitly. +- Added a new icon set: "awesome" (using the icons from the Font Awesome font). +- Set the "awesome" icon set as the default for the casual and banking styles + (can be changed back with \moderncvicons{marvosym}). +- Forced all the icons of the "letters" icon set to be of the same width, for + alignment purposes. +- Added a letter icon ("W") for the homepage of the "letters" icon set. +- Forced some whitespace between the main text and the footer of the casual + style. +- Removed the rule below the headings of the cvcolumns environment. version 1.4.0 (28 Mar 2013) - - deprecated \phone, \mobile and \fax in favour of \phone[], where - can be "fixed" (default), "mobile" or "fax". As part of the change, one can now - use each of these multiple times, to e.g. display multiple mobile phone numbers. - - deprecated \firstname and \familyname in favour of \name{}{}. - - added a new mechanism to select amongs different possible icon sets: - \moderncvicons{}, where can be "marvosym" (used by - default in the "banking", "casual" and "classic" style variants) or "letters" - (used by default in the "oldstyle" style variant). \moderncvicons should - always be called after \moderncvstyle in order to override the style variants - defaults. - - added a command to control the font of the page numbering: \pagenumberfont, - as requested by fr1a1nky (launchpad question #224496). - - removed the use of the suffix package. +- Deprecated \phone, \mobile and \fax in favour of \phone[], where + can be "fixed" (default), "mobile" or "fax". As part of the change, one can + now use each of these multiple times, e.g. to display multiple mobile phone + numbers. +- Deprecated \firstname and \familyname in favour of \name{}{}. +- Added a new mechanism to select amongs different possible icon sets: + \moderncvicons{}, where can be "marvosym" (used by + default in the banking, casual and classic styles) or "letters" (used by + default in the oldstyle style). \moderncvicons should always be called after + \moderncvstyle in order to override the styles' defaults. +- Added a command to control the font of the page numbering: \pagenumberfont, as + requested by fr1a1nky (launchpad question #224496). +- Removed the use of the suffix package. version 1.3.0 (09 Feb 2013) - - added a new environment to create multiple columns: cvcolumns. Each column - is then created by \cvcolumn[width]{header}{content}, where the optional width - is given as a fraction of the total width (between 0 and 1). The header and - content are robust and can contain any paragraph command (e.g., a nest itemize - environment). - - added a macro (\pdfpagemode) to control what is visible upon opening compiled - pdfs (assuming pdf reader support), as suggested by U. Stöhr. - Possible values include: "UseNone" (only the document), "UseThumbs" (show - thumbnails), "UseOutlines" (show bookmarks) and "FullScreen" (open in - fullscreen mode). - - added a 3rd, fully optional (can be omitted or left blank) argument to - \address to specify a country, as requested on launchpad (launchpad bug - #1063995). - - compacted list environments further. - - replaced the use of the xargs package by the xparse one. +- Added a new environment to create multiple columns: cvcolumns. Each column is + then created by \cvcolumn[width]{header}{content}, where the optional width is + given as a fraction of the total width (between 0 and 1). The header and + content are robust and can contain any paragraph command (e.g., a nested + itemize environment). +- Added a macro (\pdfpagemode) to control what is visible upon opening compiled + PDFs (assuming PDF reader support), as suggested by U. Stöhr. + Possible values include: "UseNone" (only the document), "UseThumbs" (show + thumbnails), "UseOutlines" (show bookmarks) and "FullScreen" (open in + fullscreen mode). +- Added a 3rd, fully optional (can be omitted or left blank) argument to + \address to specify a country, as requested on launchpad (launchpad bug + #1063995). +- Compacted list environments further. +- Replaced the use of the xargs package by the xparse one. version 1.2.1 (04 Dec 2012) - - fixed a regression bug introduced in version 1.2.0 in the header of the - "banking" style when no title is used, as reported on tex.stackexchange - (question #85427). +- Fixed a regression bug introduced in v1.2.0 in the header of the banking style + when no title is used, as reported on tex.stackexchange (question #85427). version 1.2.0 (31 Oct 2012) - - updated the "banking" style header to include the option to show a title. - - set the values of \arrayrulewidth and \doublerulesep to their standard values - (0.4pt and 2pt resp.) to enable the drawing of rules in tabulars and arrays by - default. - - modified the code of \makecvtitle and \makelettertitle of the "casual" style - to avoid it to cause horizontal alignment issues after and before itself. - - corrected a bug in \makelettertitle of most styles that displayed the current - date (\today) instead of the date given through the \date command, as reported - by B. Schlimmchen and S. Fnord. - - removed the need to set pdfpagelabels=false when loading hyperref, by putting - \pagenumbering{arabic} (to define \thepage) before loading hyperref, as figured - out by J. Wolf. - - corrected the line wrapping of \cvlistitem of the "banking" style. - - corrected a bug in \makecvtitle and \makelettertitle of the "banking" style. - - removed an unwanted space in the footer of the "casual" style. - - moved the font style definitions to moderncv.cls for better readability - (moderncv.cls is meant to be a sort of header file, implementing only some - macros shared by all styles and defining the macros that the style files need - to implement). +- Updated the banking style header to include the option to show a title. +- Set the values of \arrayrulewidth and \doublerulesep to their standard values + (0.4pt and 2pt, respectively) to enable the drawing of rules in tabulars and + arrays by default. +- Modified the code of \makecvtitle and \makelettertitle of the casual style to + avoid it causing horizontal alignment issues before and after itself. +- Corrected a bug in \makelettertitle of most styles that displayed the current + date (\today) instead of the date given through the \date command, as reported + by B. Schlimmchen and S. Fnord. +- Removed the need to set pdfpagelabels=false when loading hyperref by putting + \pagenumbering{arabic} (to define \thepage) before loading hyperref, as + figured out by J. Wolf. +- Corrected the line wrapping of \cvlistitem of the banking style. +- Corrected a bug in \makecvtitle and \makelettertitle of the banking style. +- Removed an unwanted space in the footer of the casual style. +- Moved the font style definitions to moderncv.cls for better readability + (moderncv.cls is meant to be a sort of header file, implementing only some + macros shared by all styles and defining the macros that the style files need + to implement). version 1.1.3 (10 Aug 2012) - - corrected a longstanding issue causing hyperref to issue two warnings - regarding its "pdfpagelabels" option, as pointed out and solved by P. Leifeld - (launchpad bug #1035466). +- Corrected a long-standing issue causing hyperref to issue two warnings about + its "pdfpagelabels" option, as pointed out and solved by P. Leifeld (launchpad + bug #1035466). version 1.1.2 (09 Aug 2012) - - fixed a regression bug introduced in version 1.0.0 in the footer of the - "casual" style, as discovered on tex.stackexchange (question #66316). +- Fixed a regression bug introduced in v1.0.0 in the footer of the casual style, + as discovered on tex.stackexchange (question #66316). version 1.1.1 (30 Jul 2012) - - fixed a compatibility issue introduced in version 1.0.0 when - \maketitlenamewidth was renamed to \makecvtitlenamewidth, as reported by Peppe - on launchpad (launchpad bug #1030802). The template now correctly uses - \makecvtitlenamewidth, and \maketitlenamewidth was created as an alias for - backward compatibility. +- Fixed a compatibility issue introduced in v1.0.0 when \maketitlenamewidth was + renamed to \makecvtitlenamewidth, as reported by Peppe on launchpad (launchpad + bug #1030802). The template now correctly uses \makecvtitlenamewidth, and + \maketitlenamewidth was created as an alias forbackward compatibility. version 1.1.0 (29 Jul 2012) - - fixed the switching from letter to resume, correcting spacing errors when a - letter is typeset before the resume, as noticed by U. Gabor. - - fixed the vertical alignment of the footers, as reported by T. Homa. - Footers are now aligned to the bottom and the letter and cv footers are - perfectly aligned in the "casual" style. - - prepared moderncv for fontspec font loading (still commented in code). - - changed the handling of the "sans" and "roman" class options, to be reflected - at the beginning of the document and override style font choices. - - turned unicode support in hyperref on by default. - - tweaked the use of \textbullet to avoid the fall-back to Computer Modern - fonts and prepared the use of symbols from the MarVoSym font for fontspec - (LauLaTeX or XeLaTeX). - - tweaked the \subsectionfill of the "banking" style to distribute extra space - evenly between leaders. - - added two options to change the "Enclosure" string used for the letter - enclosure: either specify another string as optional argument to \enclosure, - or redefine \enclname, as suggested by D. Wille. +- Fixed the switching from letter to resume, correcting spacing errors when a + letter is typeset before the resume, as noticed by U. Gabor. +- Fixed the vertical alignment of the footers, as reported by T. Homa. Footers + are now aligned to the bottom and the letter and CV footers are perfectly + aligned in the casual style. +- Prepared moderncv for fontspec font loading (still commented out in code). +- Changed the handling of the "sans" and "roman" class options, to be reflected + at the beginning of the document and override style font choices. +- Turned unicode support in hyperref on by default. +- Tweaked the use of \textbullet to avoid a fallback to Computer Modern fonts + and prepared the use of symbols from the MarVoSym font for fontspec (LuaTeX or + XeTeX). +- Tweaked the \subsectionfill of the banking style to distribute extra space + evenly between leaders. +- Added two options to change the "Enclosure" string used for the letter + enclosure: either specify another string as an optional argument to \enclosure + or redefine \enclname, as suggested by D. Wille. version 1.0.0 (26 Mar 2012) - - added commands to generate letters for every resume style: \recipient, \date, - \opening, \closing, \enclosure, \makelettertitle and \makeletterclosing. The - old \maketitle and \makefooter commands are now deprecated and replaced by - \makecvtitle and \makecvfooter. - - changed the alignment algorithm for the personal data display in the oldstyle - style, as to align on the baseline of the first line with the surrounding text. +- Added commands to generate letters for every resume style: \recipient, \date, + \opening, \closing, \enclosure, \makelettertitle and \makeletterclosing. The + old \maketitle and \makefooter commands are now deprecated and replaced by + \makecvtitle and \makecvfooter. +- Changed the alignment algorithm for the personal data display in the oldstyle + style, to align on the baseline of the first line with the surrounding text. version 0.19.0 (06 Feb 2012) - - reintroduced the ability to force the width reserved to display the name - in the resume header for the classic style (\maketitlenamewidth). - - improved the pdf metadata, as reported by S. Wunsch (launchpad bug #922476). - - fixed a footersymbol bug in the casual style when no mobile number was given, - as reported by S. Wunsch (launchpad bug #922470). - - fixed a display bug when an address was given without postcode/city, as - reported by O. Shaneh (launchpad bug #670263). +- Reintroduced the ability to force the width reserved to display the name in + the resume header for the classic style (\maketitlenamewidth). +- Improved the PDF metadata, as reported by S. Wunsch (launchpad bug #922476). +- Fixed a \footersymbol bug in the casual style when no mobile number was given, + as reported by S. Wunsch (launchpad bug #922470). +- Fixed a display bug when an address was given without postcode/city, as + reported by O. Shaneh (launchpad bug #670263). version 0.18.0 (05 Feb 2012) - - corrected the handling of pdf bookmarks, as suggested on stackexchange by - U. Fischer. - - improved the spacing between sections and subsections by using \addvspace - instead of \vspace. - - corrected the spacing between entries with nested itemize environments - (temporary solution working only for single line items). - - added a check in the oldstyle style for an empty 4th argument in the - \cvdoubleitem definition, to avoid printing a colon without preceding label. - - added a new style on top of classic, casual and oldstyle: banking. +- Corrected the handling of PDF bookmarks, as suggested on stackexchange by + U. Fischer. +- Improved the spacing between sections and subsections by using \addvspace + instead of \vspace. +- Corrected the spacing between entries with nested itemize environments + (temporary solution working only for single line items). +- Added a check in the oldstyle style for an empty 4th argument in the + \cvdoubleitem definition to avoid printing a colon without a preceding label. +- Added a new style on top of classic, casual and oldstyle: banking. version 0.17.0 (25 Jan 2012) - - changed the footer algorithm of style casual to avoid starting lines with - the footer symbol. - - aligned the space before and after the title across styles. - - added an optional title to the casual style. - - changed the definition of the font styles to avoid undesired extra spacing. - - added a Spanish template, kindly provided by I. Buitrón. - - corrected the vertical misalignment between the page number and the center - footer in the casual style. +- Changed the footer algorithm of the casual style to avoid starting lines with + the footer symbol. +- Aligned the space before and after the title across styles. +- Added an optional title to the casual style. +- Changed the definition of the font styles to avoid undesired extra spacing. +- Added a Spanish template, kindly provided by I. Buitrón. +- Corrected the vertical misalignment between the page number and the center + footer in the casual style. version 0.16.0 (15 Jan 2012) - - added starred versions of \section and \subsection (that are identical to - their non-starred version, to e.g. enable biblatex support as requested by - S. Verberkt (launchpad bug #913102). - - corrected a misalignment of the colored rule in front of the section titles - in the classic and casual styles, as reported by P. Neidhardt (launchpad bug - #915910). +- Added starred versions of \section and \subsection that are identical to their + non-starred versions (e.g. to enable BibLaTeX support) as requested by + S. Verberkt (launchpad bug #913102). +- Corrected a misalignment of the colored rule in front of the section titles in + the classic and casual styles, as reported by P. Neidhardt (launchpad bug + #915910). version 0.15.1 (23 December 2011) - - corrected a bug in the classic style causing the address font and color not - being carried over newlines, as reported by J. Smith. +- Corrected a bug in the classic style causing the address font and color to not + be carried over newlines, as reported by J. Smith. version 0.15.0 (19 December 2011) - - corrected list spacing. - - corrected inconsistent use of sans serif fonts in roman layout option. - - the lmodern fonts are now automatically loaded only if installed on the - system. The "nolmodern" option is now therefore obsolete. - - complete code refactoring separating themes in separate styles and colors. - - renamed \cvline to \cvitem, \cvlanguage to \cvitemwithcomment and \cvcomputer - to \cvdoubleitem (the old command name still work and redirect to the new ones, - but are deprecated). - - removed the arbitrary minipage widths of skill proficiency vs comment in - \cvitemwithcomments. The skill proficiency is now typeset exactly as given - (i.e. one one line if no linebreaks are implicitly given) and the comment uses - the remaining horizontal space. - - changed the optional argument of \cvlistitem and \cvlistdoubleitem to specify - the vertical skip after the item (as for \cvitem, cvitemwithcomments, etc). - The way to change the list symbol is to redefine \listitemsymbol. - - added a new style on top of classic and casual: oldstyle. - - loaded the microtype package to improve typography. +- Corrected list spacing. +- Corrected inconsistent use of sans serif fonts in roman layout option. +- The lmodern fonts are now automatically loaded only if they're installed on + the system. The "nolmodern" option is now therefore obsolete. +- Completed code refactoring separating themes in separate styles and colors. +- Renamed \cvline to \cvitem, \cvlanguage to \cvitemwithcomment and \cvcomputer + to \cvdoubleitem (the old command names still work and redirect to the new + ones, but are deprecated). +- Removed the arbitrary minipage widths of skill proficiency vs comment in + \cvitemwithcomments. The skill proficiency is now typeset exactly as given + (i.e. one one line if no linebreaks are implicitly given) and the comment uses + the remaining horizontal space. +- Changed the optional argument of \cvlistitem and \cvlistdoubleitem to specify + the vertical skip after the item (as for \cvitem, \cvitemwithcomments, etc). + The way to change the list symbol is to redefine \listitemsymbol. +- Added a new style on top of classic and casual: oldstyle. +- Loaded the microtype package to improve typography. version 0.14.0 (04 December 2011) - - added support for CJK, thanks to the help of P. D'Apice. - - the use of \recomputelengths after modifying any length in the preamble is - now unnecessary; \recomputelength is automatically called at the start of the - document. +- Added support for CJK, thanks to the help of P. D'Apice. +- The use of \recomputelengths after modifying any length in the preamble is now + unnecessary; \recomputelength is automatically called at the start of the + document. version 0.13.1 (11 November 2011) - - corrected a bug introduced by v0.13 in the classic style when no \photo is - used, as reported by S. Gislais (launchpad bug #888702). +- Corrected a bug introduced by v0.13 in the classic style when no \photo is + used, as reported by S. Gislais (launchpad bug #888702). version 0.13.0 (06 November 2011) - - added a "black" color option to render the resume in black & white, as - suggested by F. Bicarri. - - removed the pdflatex option when loading hyperref to enable other engines - (e.g., dvips, xetex), leftover from the v 0.11 cleanup, as reported by - K. Amaterasu and P. Mavrogiorgos (launchpad bugs #754693 and #859834). - - added a "purple" color option, as proposed by B. Ravel. - - added a 3rd optional argument to the \photo command to control the thickness - of the framebox. Setting it to 0pt will disable the frame around the photo, as - requested by T. Krennwallner (launchpad bug #664568). +- Added a "black" color option to render the resume in black & white, as + suggested by F. Bicarri. +- Removed the pdflatex option when loading hyperref to enable other engines + (e.g., dvips, XeTeX), leftover from the v0.11 cleanup, as reported by + K. Amaterasu and P. Mavrogiorgos (launchpad bugs #754693 and #859834). +- Added a "purple" color option, as proposed by B. Ravel. +- Added a 3rd optional argument to the \photo command to control the thickness + of the framebox. Setting it to 0pt will disable the frame around the photo, as + requested by T. Krennwallner (launchpad bug #664568). version 0.12.0 (03 August 2010) - - prevented pagebreaks after sections and subsections (launchpad bug #409902), - as originally reported by C. Gaspoz and fixed by launchpad user tentotwo). +- Prevented pagebreaks after sections and subsections (launchpad bug #409902), + as originally reported by C. Gaspoz and fixed by launchpad user tentotwo. version 0.11.0 (20 July 2010) - - removed the \ifpdf check when loading the graphicx package, as graphicx does - does check internally and this was preventing proper functionning with xelatex - and luatex, as reported by A. Trautmann. The same check was also removed - everywhere else in the document (i.e. when loading the color and hyperref - packages). +- Removed the \ifpdf check when loading the graphicx package, as graphicx + already does this check internally. This was preventing proper functioning + with XeTeX and LuaTeX, as reported by A. Trautmann. The same check was also + removed everywhere else in the document (i.e. when loading the color and + hyperref packages). version 0.10.0 (13 June 2010) - - fixed a compatibility issue with the natbib package (natbib uses \section* - to format the bibliography title, while only \section was defined by - moderncv), as reported on launchpad (launchpad bug #393920). - - fixed a compatibility issues with (any package relying on) the etoolbox - package, due to the double definition of \AtEndPreamble, as reported by - D. Becker. +- Fixed a compatibility issue with the natbib package (natbib uses \section* to + format the bibliography title, while only \section was defined by moderncv), + as reported on launchpad (launchpad bug #393920). +- Fixed compatibility issues with (any package relying on) the etoolbox package, + due to the double definition of \AtEndPreamble, as reported by D. Becker. version 0.9.0 (31 May 2010) - - added support for the itemize, enumerate and description environments. +- Added support for the itemize, enumerate and description environments. version 0.8.0 (24 May 2010) - - added support for multibib. Also modified the template to illustrate how to +- Added support for multibib. Also modified the template to illustrate how to show labels in the bibliography, as requested by Tom D. R. and Stefan K. - - added a command to indicate your personal homepage (\homepage{url}), as +- Added a command to indicate your personal homepage (\homepage{url}), as requested by J. de Jong and A. Pairet. - - corrected an alignment bug for text following a \quote with no immediate +- Corrected an alignment bug for text following a \quote with no immediate \section, as kindly reported by J. Vermeulen and L. Saliou. - - corrected a spacing bug when no blank line (or \par) is left after - \maketitle. Thanks to A. Menzel for reporting the strange behaviour. - - corrected the alignment of the extrainfo title part when no picture was - used, as reported by M. Bana. - - corrected the missplacement of pdf bookmarks as noticed by L. Fortunato. - - corrected several bugs linked to the code for checking for empty arguments - in \cventry, as reported by B. Ekran (launchpad bug #268768), L. Păncescu and +- Corrected a spacing bug when no blank line (or \par) is left after \maketitle. + Thanks to A. Menzel for reporting the strange behaviour. +- Corrected the alignment of the \extrainfo title part when no picture was used, + as reported by M. Bana. +- Corrected the misplacement of PDF bookmarks as noticed by L. Fortunato. +- Corrected several bugs linked to the code for checking for empty arguments in + \cventry, as reported by B. Ekran (launchpad bug #268768), L. Păncescu and E. Gregorio. version 0.7.0 (17 June 2008) - - corrected an outstanding spacing bug (space between cvlines longer - than 1 line). - - removed the need to use \closesection and \emptysection as internal - tabulars are now always closed. This allows she use of bibliography packages - such as bibunits. Thanks to S. Busch for pointing out the incompatibility and - helping testing out the bug correction. - - changed the definition of \photo: the first (optional) argument should - give the desired width of the picture, instead of its height - - corrected an alignment bug for \cvlistitems longer than 1 line, as - reported by S. Nikolopoulos. - - deprecated the commands \sethintscolumnlength and \sethintscolumntowidth. +- Corrected an outstanding spacing bug where the space between cvlines was + longer than 1 line. +- Removed the need to use \closesection and \emptysection as internal tabulars + are now always closed. This allows the use of bibliography packages such as + bibunits. Thanks to S. Busch for pointing out the incompatibility and helping + test out the bug correction. +- Changed the definition of \photo: the first (optional) argument should give + the desired width of the picture, instead of its height +- Corrected an alignment bug for \cvlistitems longer than 1 line, as reported by + S. Nikolopoulos. +- Deprecated the commands \sethintscolumnlength and \sethintscolumntowidth. Instead, just set \hintscolumnwidth to the desired length by using the regular \setlength or \settowidth commands, and call \recomputelengths. - - added the ability to control the width of the name placeholder in the - classic theme, by setting the length \maketitlenamewidth. Again, don't forget - to call \recomputelengths afterward. +- Added the ability to control the width of the name placeholder in the classic + theme, by setting the length \maketitlenamewidth. Again, don't forget to call + \recomputelengths afterward. version 0.6.0 (28 May 2007) - - corrected some spacing bugs and cleaned up the code. - - corrected a bug in the bibliography file of the examples spotted by +- Corrected some spacing bugs and cleaned up the code. +- Corrected a bug in the bibliography file of the examples spotted by U. Stöhr. +- Added color variants to the classic and casual styles, as suggested by U. Stöhr. - - added color variants to the classic and casual style, as suggested by - U. Stöhr. - - added a page counter for resumes running longer than 1 page, as requested by +- Added a page counter for resumes running longer than 1 page, as requested by A. Martin. It can be disabled by the command \nopagenumbers{}. - - added commands to include a mobile phone and fax number. - - made the symbols used for the phone number, the email, ... customizable. - To modify those symbols, just redefine \phonesymbol, emailsymbol, ... - - corrected the pdf information given to hyperref as pointed out by - C. Knuepfer. - - rewrote the examples. +- Added commands to include a mobile phone and fax number. +- Made the symbols used for the phone number, the email etc. customizable. To + modify those symbols, just redefine \phonesymbol, \emailsymbol etc. +- Corrected the PDF information given to hyperref as pointed out by C. Knuepfer. +- Rewrote the examples. version 0.5.0 (9 September 2006) - - added a \photo command to display a picture. That command takes the name of - the file with the picture as argument, and the desired height as optional - argument. - - implemented the needed commands to make moderncv compatible with BibTeX, as +- Added a \photo command to display a picture. This command takes the name of + the file with the picture as a required argument and the desired height as an + optional argument. +- Implemented the needed commands to make moderncv compatible with BibTeX, as suggested by J. Lie. This makes it possible to display one's publications, - stored in the BibTeX file 'publications.bib' - by using: + stored in the BibTeX file "publications.bib" by using: \nocite{*} \bibliographystyle{plain} \bibliography{publications} - As usual, the name of the section title can be changed by redefining the - command \refname. - - added the \today command, useful for example if one need to add the date the - resumé was produced with + As usual, the name of the section title can be changed by redefining \refname. +- Added the \today command, useful for example if one needs to add the date the + resume was produced with: \closesection{} \vfill{\hfill{\scriptsize Produced \today.}} at the end of your CV, as suggested by F. Hammann. version 0.4.0 (2 May 2006) - - removed the dependency on the geometry package, so that users can now invoke - it themselve, and easily change the geometry of the page. +- Removed the dependency on the geometry package so that users can now invoke it + themselves and easily change the geometry of the page. version 0.3.0 (10 April 2006) - - moderncv now uses the 'longtable' class, allowing cv sections to split - across multiple pages. - - the different lengths used by moderncv are now customizable! In particular, - the first column (the one containing the date in the examples), can now be set +- Moderncv now uses the longtable class, allowing CV sections to split across + multiple pages. +- The different lengths used by moderncv are now customizable! In particular, + the first column (the one containing the date in the examples) can now be set to any width, for people needing a smaller or larger one. To do that, either use \sethintscolumnlength{}, @@ -371,33 +416,32 @@ version 0.3.0 (10 April 2006) where is a string of the desired length (usually, the longest string that has to appear in the column). Thanks to A. Pöge for pointing out the need of such a feature. - - added the command \emptysection{}, which makes it possible to start a - section without name. In combination with \closesection{}, this makes it - possible to drop out of the layout of moderncv, and come back to it later. - This should make the inclusion of arbitrary elements not covered by moderncv - code possible. - - corrected a spacing problem in the cventry command, as pointed out and - solved by B. Eßmann. +- Added the command \emptysection{}, which makes it possible to start an unnamed + section. In combination with \closesection{}, this makes it possible to drop + out of the layout of moderncv, and come back to it later. This should make the + inclusion of arbitrary elements not covered by moderncv code possible. +- Corrected a spacing problem in the \cventry command, as pointed out and solved + by B. Eßmann. version 0.2.0 (6 March 2006) - - rewrite of the code to have the styles (fonts, colours, headers and footers) +- Rewrite of the code to have the styles (fonts, colours, headers and footers) be defined in different files than the class. The styles are now defined in a separate file per style, named moderncvstyle. It should now be easy to write your own style, starting from moderncvstyleempty.sty. If you feel you have created a nice style, just email it to me and I'll include it in the next version. - - due to the previous point, styles are now loaded by the command +- Due to the previous point, styles are now loaded by the command \moderncvstyle{style_name}. I couldn't figure out a way to preserve the old "casual" and "classic" class options, so these are now broken! Use \moderncvstyle{casual} or \moderncvstyle{classic} at the beginning of your - document. This should be the only incompatibility with version 0.1. - - added class option "nolmodern" for people without the latin modern fonts. - - corrected some English mistakes in the examples. Thanks to M. H. Prager for + document. This should be the only incompatibility with v0.1. +- Added class option "nolmodern" for people without the Latin Modern fonts. +- Corrected some English mistakes in the examples. Thanks to M. H. Prager for pointing them out. - - added a \cvlistitem to produce items with a bullet (or whatever is defined - in \listitemsymbol), and renamed \cvresume to \cvlistdoubleitem for - consistency purpose. For compatibility reasons, the command \cvresume still - works, but should be avoided. +- Added a \cvlistitem to produce items with a bullet (or whatever is defined in + \listitemsymbol), and renamed \cvresume to \cvlistdoubleitem for consistency + purposes. For compatibility reasons, the command \cvresume still works, but + should be avoided. version 0.1.0 (1 March 2006) - - first release. +- First release. diff --git a/KNOWN_BUGS b/KNOWN_BUGS index 15b86ec..25ef872 100644 --- a/KNOWN_BUGS +++ b/KNOWN_BUGS @@ -1,15 +1,12 @@ -- When using the "fancy" style, undesired space is added between the bibliography - head and the first entry, as well as after the last entry -- Moderncv is incompatible with biblatex. -- Footnotes generates errors (though the output seem correct when running with - "-interaction=nonstopmode") -- When using CJK, the last \clearpage required for fancyhdr to work properly kills - the "lastpage" counter, hence also the page numbering. -- Moderncv produces an error ("lonely \item--perhaps a missing list environment") - when used with bibentry, through the output is actually correct. Amongst other, - this causes compilation by LyX to stop. -- The space after a cventry gets eaten up when the last argument contains a nested - itemize environment. An ugly hack and incomplete solution was implemented by - including a \strut in every item label, but this doesn't solve the problem for - multi-line items. Ideally, the strut should end the item, but there seems to be - no way to do this. +- moderncv is incompatible with biber. +- moderncv is incompatible with BibLaTeX. +- moderncv is incompatible with babel in Spanish. + +- Skill matrices don't break automatically in fancy style. +- Long names break the oldstyle style and possibly other styles (needs testing). +- Long URLs in classic style can make the name break line. Fixed width for the address part must be implemented. +- When using the fancy style, undesired space is added between the bibliography head and the first entry, as well as after the last entry. +- Footnotes generate errors, but the output seems correct when running with "-interaction=nonstopmode" +- When using CJK, the last \clearpage required for the fancyhdr package to work properly kills the "lastpage" counter, and therefore also the page numbering. +- moderncv produces an error "lonely \item--perhaps a missing list environment" when used with the bibentry package, though the output is actually correct. Among other things, this causes compilation by LyX to stop. +- The space after a \cventry gets eaten up when the last argument contains a nested itemize environment. An ugly hack and incomplete solution was implemented by including a \strut in every item label, but this doesn't solve the problem for multi-line items. Ideally, the \strut should end the item, but there seems to be no way to do this. diff --git a/README.md b/README.md index d87ba73..19ff062 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,44 @@ # moderncv +[![Build template](https://github.com/moderncv/moderncv/actions/workflows/build-pdf.yml/badge.svg)](https://github.com/moderncv/moderncv/actions/workflows/build-pdf.yml) +[![CTAN](https://img.shields.io/ctan/v/moderncv.svg)](https://www.ctan.org/pkg/moderncv) +[![Matrix](https://img.shields.io/matrix/moderncv:matrix.org)](https://matrix.to/#/#moderncv:matrix.org) + ## A modern curriculum vitae class for LaTeX -**moderncv** provides a documentclass for typesetting curricula vitae in various styles. Moderncv aims to be both straightforward to use and customizable, providing five ready-made styles (classic, casual, banking, oldstyle and fancy) and allowing one to define his own by modifying colors, fonts, icons, etc. +The `moderncv` package provides a document class for typesetting applications (curricula vitae and cover letters) in various styles. `moderncv` aims to be both straightforward to use and customizable, providing five ready-made styles (classic, casual, banking, oldstyle and fancy) and allowing you to define your own by modifying colors, fonts, icons, etc. -Most commands are defined in such a way that arguments are optional. +## Getting started -Until a decent manual is written, one can always look in the `template.tex` file for an example. It can be compiled to pdf via `latexmk -pdf ./template.tex`. +### Installation +`moderncv` should already be included in your installed LaTeX distribution. +If not, you can get the tarball of the package from [CTAN](https://www.ctan.org/pkg/moderncv). +Alternatively, you can also build the package from source by cloning the its [GitHub repository](https://github.com/moderncv/moderncv) and compiling the included LaTeX files: +``` +latexmk -pdf ./template.tex manual/moderncv_userguide.tex +``` + +### Usage +To get started on your own CV, use and modify the template file `template.tex`. +The user guide can be found in the folder `manual` and contains additional information on what the document class offers. +Take a look at it to see if this package suits your needs. + +If you are using the [`academicons`](https://ctan.org/tex-archive/fonts/academicons) package in the template, you will need to use a Xe(La)TeX or Lua(La)TeX engine to render the icons. Otherwise, an alternative icon package will be used automatically. + +## Development + +As the main goal is to keep this package alive, it is maintained in a loosely structured team. +You can contact us in our matrix room [moderncv:matrix.org](https://matrix.to/#/#moderncv:matrix.org), feel free to join if you have questions or want to contribute. +Development takes place at [github.com/moderncv/moderncv](https://github.com/moderncv/moderncv). ## Licence -moderncv is licensed under the [LPPL-1.3c](https://spdx.org/licenses/LPPL-1.3c.html). + +`moderncv` is licensed under the [LPPL-1.3c](https://spdx.org/licenses/LPPL-1.3c.html). ## Origin -Original author: Xavier Danaux
-Original repository: https://github.com/xdanaux/moderncv
-This repository is a fork aiming to maintain moderncv inside CTAN, since upstream is dead since 2016. + +Original author: Xavier Danaux +
+Original repository: https://github.com/xdanaux/moderncv + +This repository is a fork aiming to maintain `moderncv` inside CTAN, since upstream has been dead since 2016. diff --git a/create-release-tarball.sh b/create-release-tarball.sh index b46b7cd..9066c00 100755 --- a/create-release-tarball.sh +++ b/create-release-tarball.sh @@ -9,10 +9,10 @@ TARBALL=moderncv-$VERSION.tar rm -f $TARBALL $TARBALL.gz # create tar with all files in git repo -git archive HEAD > $TARBALL +git archive --prefix=moderncv/ HEAD > $TARBALL # remove git specific files -tar -f $TARBALL --delete .github/ .gitignore create-release-tarball.sh +tar -f $TARBALL --delete moderncv/.github/ moderncv/.gitignore moderncv/create-release-tarball.sh # compress gzip $TARBALL diff --git a/manual/moderncv_userguide.pdf b/manual/moderncv_userguide.pdf index cadbefe..0468a22 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 384544b..feb6f31 100644 --- a/manual/moderncv_userguide.tex +++ b/manual/moderncv_userguide.tex @@ -1,699 +1,959 @@ -%% moderncv_userguide.tex (compiled with pdfLaTeX) -%% Copyright 2007 Cristina Sambo +%% moderncv_userguide.tex as shipped with 2024-07-18 v2.4.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.4.1}% +} +% Cristina Sambo, +\author{% + Package by Xavier Danaux\\ + and\\ + moderncv community\\ + {\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} % To get the spacing after macros right -\usepackage{mparhack} % To get marginpar right +\usepackage{scrhack} % Fix warnings when using KOMA with listings package +\usepackage{xspace} % Fix spacing after macros +\usepackage{mparhack} % Fix marginpar \usepackage{microtype} -%**************************************************************************************************** -% Setup code listings -% **************************************************************************************************** +\usepackage{multicol} % Multicolumn text for long lists + +% 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{cvblue},%\bfseries, +% \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}, + % identifierstyle=\color{NavyBlue}, commentstyle=\color{gray}\ttfamily, stringstyle=\rmfamily, - numbers=none,%left,% - numberstyle=\scriptsize,%\tiny + numbers=none, % left, + numberstyle=\scriptsize, % \tiny stepnumber=5, numbersep=8pt, showstringspaces=false, breaklines=true, - %frameround=ftff, - %frame=single, - belowcaptionskip=.75\baselineskip, -% frame=L, - emph={cvitem,cventry,cvdoubleentry,cvdoubleitem,moderncvstyle,moderncvcolor,% - cvskill,cvskilllegend,cvskillplainlegend,cvskillhead,cvskillentry,nopagenumbers,% - name,address,email,link,social,phone,homepage,extrainfo,photo,quote,section,subsection,setlength,NewDocumentCommand},% - 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,% - researcheridsocialsymbol,telegramsocialsymbol,googlescholarsocialsymbol,cvstretchability},% + % frameround=ftff, + % frame=single, + belowcaptionskip=0.75\baselineskip, + % frame=L, + emph={ + 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, enclosure + }, + 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}, } -%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) +% 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, } -%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} +% 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{