From 0a8a7c3702dbf3756ff6061bb0815e5c3c97bc1b Mon Sep 17 00:00:00 2001 From: David Date: Thu, 21 Jan 2021 15:31:19 +0100 Subject: [PATCH] Rebase user guide additions onto master Squash commits for adding user guide (#58) merge typo fixes from github.com/ig0774/moderncv set document encoding to utf8 move to inputenx package, remove pdflatex specific configurations to make everything compilable with lualatex get documentation compilable with xelatex get rough structure down and write how to read this manual finish getting started section and give template description its own section modify introduction to section two get basic setup section done add section on editing personal data adjust code indendation of listings. Get rid of obsolete examples rename some of the section headings to make them more consistent. fix some typos add version information to template and userguide remove pdfs completely from repo due to the new Makefile the pdf files have become obsolete in the repo. The new release rule of the make file creates all templates and the user guide and includes them into the tarball. In this way even users for which the linux based Makefile does not work can download precompiled examples and and the manual start section on fine tuning styles fix depricated comment explaining usage of \cvlistitem and \cvlistdoubleitem add section explaining how to adjust symbols and itemize lables add version information in title fix formulations and typos update package list with skillmatrix packages explain previously hidden options for casual style add bugs to known_bugs add explanation on how to use babel to guide add color explanation section explain orphaned section problem clean up old sections refine color section add macro descriptions of templates to user guide add instructions how to add signature and subject fix typo in changelog add missing social links in section describing personal data add missing social links in section describing how to change symbols first user guide version update README to latest local version fix(moderncvheadiii.sty): remove /null at the end of the address header. (#60) This removes the unnecesary newline there. Move space after title into conditional Don't break the title and quote formatting Correct font loading Signed-off-by: Stephan Lachnit Remove baseurl in hyperref Signed-off-by: Stephan Lachnit Fix footskip for fancyhdr in template Signed-off-by: Stephan Lachnit Remove dot in cventry Signed-off-by: Stephan Lachnit CI: don't update sources This only takes time and there aren't any relevant updates for us anyway. Signed-off-by: Stephan Lachnit CI: scan for horizontal and vertical bad boxes Signed-off-by: Stephan Lachnit Release v2.2.0 Signed-off-by: Stephan Lachnit Mimic previous fontawesome look with fontawesome5 (#70) See: https://github.com/moderncv/moderncv/issues/67 --- .gitignore | 2 + KNOWN_BUGS | 3 + README.md | 52 +- manual/moderncv_userguide.tex | 1302 +++++++++++++++++++++++---------- moderncv.cls | 4 +- template.tex | 1 - 6 files changed, 973 insertions(+), 391 deletions(-) diff --git a/.gitignore b/.gitignore index 84f231c..3212bef 100644 --- a/.gitignore +++ b/.gitignore @@ -15,3 +15,5 @@ template.pdf # release tarballs moderncv-*.tar.gz + +examples/ diff --git a/KNOWN_BUGS b/KNOWN_BUGS index 15b86ec..05cb6af 100644 --- a/KNOWN_BUGS +++ b/KNOWN_BUGS @@ -1,3 +1,6 @@ +- skillmatrix does not break automatically in fancystyle. +- long names break the oldstyle and possibly other styles (needs testing). +- long urls in classic style can make the name break line. Fixed width for the adresspart 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 - Moderncv is incompatible with biblatex. diff --git a/README.md b/README.md index 7a78a30..eeec599 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,55 @@ ## 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. +`moderncv` provides a documentclass 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 one to define his own by modifying colors, fonts, icons, etc. -Most commands are defined in such a way that arguments are optional. +### Getting started +Once you clone this repo have a look at some examples and build the manual to see if this package suits your needs. +This can be done by issuing +```make +make userguide +``` +in a terminal. After completion of the compilation precompiled versions of the template in all styles can be found in the folder `examples` and +the user guide in the folder `manual`. +Alternatively get the tar ball from [CTAN](https://ctan.org/pkg/moderncv?lang=de). The examples as well as the documentation are already prebuilt in that tarball. + +To start working on your own application 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. + +### Makefile +The `Makefile` supports the following rules. + +#### Rules for building templates and the user guide +* `template:` Build the `moderncv` template `template.tex` with `LuaLaTeX`. This rule can be called in one of two ways: + * `make template`: Build the template in default style. + * `make template STYLE=