Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add full userguide #58

Closed

Conversation

cryptointerest
Copy link

Add the new user guide.

cryptointerest and others added 30 commits May 1, 2021 00:03
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
@ShadowMitia
Copy link

What is the status on this?

@cryptointerest
Copy link
Author

the status is that I wrote this user guide and while doing this succesively changed the code base but was not entirely clean with my commits.
I also introduced a makefile for which Stephan requested changes.

The problem is, I still have tendinitis issues in both arms and absolutely cannot (or rather must not) code in my free time.
It bugs me because the work is done, but I can't work on cleaning up my commit history atm.
I'll try to see if I can do it over Christmas

@ShadowMitia
Copy link

Take time to rest and recuperate!
Let us know what we can do to help.

If it's just rebase/squashing commits maybe I can do it for you? If it's not too complicated to explain for you.
Otherwise there is no hurry, it just seemed like it was all done and could possibly be merged.

@cryptointerest
Copy link
Author

I'll have to have a look. If I remember correctly, I was not clean with my commits in the sense that i staged changes to the code AND the guide (Thought it was a good idea at the time. Still learning, I guess).
So to clean up things some work needs to be done.

\cvlistdoubleitem{<Item_1>}{Item_2>}
\end{lstlisting}

\paragraph{\code{cvcolumns.}} Environment to tipeset multi-column cvitems. This can be combined with the itemize environment.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo - should be typeset

Some of the lengths in moderncv can be adjusted.
The hints column can be adjusted by issuing
\begin{lstlisting}
\setlength{\hintscolumnwidth}{3cm}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

showing the default for each length in this section (as you do for \cvsectionstretchability) would be beneficial

tianyizheng02 pushed a commit to tianyizheng02/moderncv that referenced this pull request Jun 10, 2023
Squash commits for adding user guide (moderncv#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. (moderncv#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 <stephanlachnit@debian.org>

Remove baseurl in hyperref

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

Fix footskip for fancyhdr in template

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

Remove dot in cventry

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

CI: don't update sources

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

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

CI: scan for horizontal and vertical bad boxes

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

Release v2.2.0

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

Mimic previous fontawesome look with fontawesome5 (moderncv#70)

See: moderncv#67
@tianyizheng02 tianyizheng02 mentioned this pull request Jun 10, 2023
@stephanlachnit
Copy link
Member

Closing in favor of #106.

LLdaniel pushed a commit that referenced this pull request Apr 17, 2024
* 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 <stephanlachnit@debian.org>

Remove baseurl in hyperref

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

Fix footskip for fancyhdr in template

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

Remove dot in cventry

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

CI: don't update sources

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

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

CI: scan for horizontal and vertical bad boxes

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

Release v2.2.0

Signed-off-by: Stephan Lachnit <stephanlachnit@debian.org>

Mimic previous fontawesome look with fontawesome5 (#70)

See: #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 <forenkram@gmx.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants