Update user guide (#169)

* Rebase user guide additions onto master

Squash commits for adding user guide (xdanaux#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. (xdanaux#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 <[email protected]>

Remove baseurl in hyperref

Signed-off-by: Stephan Lachnit <[email protected]>

Fix footskip for fancyhdr in template

Signed-off-by: Stephan Lachnit <[email protected]>

Remove dot in cventry

Signed-off-by: Stephan Lachnit <[email protected]>

CI: don't update sources

This only takes time and there aren't any relevant updates for us anyway.

Signed-off-by: Stephan Lachnit <[email protected]>

CI: scan for horizontal and vertical bad boxes

Signed-off-by: Stephan Lachnit <[email protected]>

Release v2.2.0

Signed-off-by: Stephan Lachnit <[email protected]>

Mimic previous fontawesome look with fontawesome5 (xdanaux#70)

See: moderncv#67

* Fix compile errors and warnings in user guide

* Remove trailing whitespace

* Overhaul README
Restructure README to remove references to the non-existent makefile

* Clean up user guide
- Fixes for spelling, wording, grammar, formatting, etc.
- Minor refactoring for code consistency

* Remove non-existent examples directory from gitignore

* Fix a space before a comma

* Update user guide PDF

* Cleaned up formatting and rewrote some sections

* Update changelog

Update changelog with changes made by all PRs merged since the last
tagged version, except for those invisible to the end user (changes to
CI workflow, changes overwritten by newer PRs, etc.)

Fixed formatting in changelog to be more consistent

Fixed grammar and punctuation in changelog

---------

Co-authored-by: David <[email protected]>

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.

README.md

@@ -1,27 +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
+```
 
-If using [`academicons`](https://ctan.org/tex-archive/fonts/academicons) in the template, you need to use a Xe(La)TeX or Lua(La)TeX engine for them to render. Otherwise an alternative will be used automatically.
+### 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.
 
-## Development
+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.
 
-[![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)
+## 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).
+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 <[email protected]><br/>
-Original repository: https://github.com/xdanaux/moderncv<br/>
-This repository is a fork aiming to maintain moderncv inside CTAN, since upstream is dead since 2016.
+
+Original author: Xavier Danaux <[email protected]>
+<br/>
+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.