ecv.tex

%%
%% Copyright 2007-2011 Christoph P. Neumann, Bernd Haberstumpf
%%
%% This LaTeX class provides a simple interface for creating
%% a verfy fancy Curriculum Vitae. At the moment only CVs in
%% the german language are supported.
%%
%% This file is free property; as a special exception the author
%% gives unlimited permission to copy and/or distribute it, with
%% or without modifications, as long as this notice is
%% preserved.
%%
%% This file is distributed in the hope that it will be useful,
%% but WITHOUT ANY WARRANTY, to the extent permitted by law;
%% without even the implied warranty of MERCHANTABILITY or
%% FITNESS FOR A PARTICULAR PURPOSE.

\documentclass{ltxdoc}

\CodelineNumbered
\EnableCrossrefs
\CodelineIndex
\RecordChanges
\GetFileInfo{ecv.cls}

\parskip1.0ex
\parindent0.0ex

\begin{document}
\title{\textsf{ecv}\\
A fancy Curriculum Vitae Class}
\author{Christoph P.\ Neumann \texttt{$<$c.p.neumann@web.de$>$}, \\
Bernd Haberstumpf \texttt{$<$poldi@kabatrinker.de$>$}}
\maketitle
\PrintChanges

\begin{abstract}
The \texttt{ecv}--class provides a convenient environment for creating
a fancy tabular currriculum vitae. The class is oriented at the europass
(see: \texttt{http://europass.cedefop.eu.int}).
\end{abstract}

\section{Installation}

The \texttt{zip} or \texttt{tar.gz} file comes with a \texttt{ecv.ins}
and a \texttt{ecv.dtx} file included which contains the \LaTeX\ stuff.

To extract the class files call:

\begin{verbatim}
  $ latex ecv.ins
\end{verbatim}

This call will extract all \LaTeX\ specific files to the current
directory. You can either use the files for a single
cv project or you can integrate the files into your \TeX\ installation.

If you just want to use \textsf{ecv} for a single curriculum vitae
project, the simplest way is just to copy the generated files to the
folder of the project.

If you want to integrate \textsf{ecv} into  your \TeX\ installation,
create a directory \texttt{tex/latex/ecv} beneath your \TeX\ installation
(e.g.~beneath \texttt{/usr/share/texmf}) and copy all files from the
current directory there. Now call:

\begin{verbatim}
  $ mktexlsr
\end{verbatim}

to update the file--cache of \LaTeX.

Hint: The \textsf{ecv} distribution contains a sample docstrip configuration
in \texttt{docstrip.cfg} via which files can be distributed
automatically to their correct positions inside a \LaTeX\ installation.
Feel free to adapt this file to your environment and afterwards call
\texttt{latex ecv.ins} to install the package to its right place.

\section{Linux and Windows}

\textsf{Ecv} has been tested on Linux and also under Windows, using
MiXTeX and TeXnicCenter.

\section{Templates}

For a quick start the \textsf{ecv} distribution contains document
templates for a german and an english curriculum vitae. The templates
can be found in the \texttt{template.zip} file.

The \texttt{template} directory contains the templates

\begin{itemize}
\item \texttt{CV-template\_de.tex} for the german language
\item \texttt{CV-template\_en.tex} for the english language
\end{itemize}

and a \texttt{Makefile} to build the pdf. Just call:

\begin{verbatim}
  $ make
\end{verbatim}

to build the pdf. The file \texttt{porttrait.eps} contains a dummy
porttrait for the first page of the curriculum vitae.

\section{Structure}

The tex--file that contains the curriculum vitae will have roughly
the following structure:

\begin{verbatim}
\% The languages english and german are supported
\documentclass[german]{ecv}

\% Portrait to be used on the first page
\ecvPortrait{images/myPortrait}

\% Name to be use for the footer line
\ecvName{My Name}

\begin{document}

\% Start the tabular that contains the cv (this will print title
\% and portrait)
\begin{ecv}

\% Group entries with sections
\ecvSec{\ecvPerson}

\% Entries in the tabular
\ecvEPR{Name}   {\textsc{Name}, My}
\ecvEPR{Adresse}{Somewhere 13, Sometown}
\ecvEPR{Telefon}{(555) 555 / 555}
\ecvEPR{E-Mail} {\ecvHyperEMail{nobody@nowhere.com}}
\ecvEPR{Staatsangeh"origkeit}
                {Deutsch}
\ecvEPR{Geburtsdatum}
                {12.34.5678}
\end{ecv}

\ecvSig{Name, My}{Sometown}

\end{verbatim}

The example shows that some information is provided before the document
start like the name for the footer line and the portrait. The actual
cv is then written in the |ecv| environment. A curriculum vitae can be finialized with
a signature where the issuer can sign by hand.

\section{NLS support}

As the example in the last chapter suggests curriculum vitaes can be
written in either german or english language. Actually a curriculum
vitae--tex--file can contain both a german version and an english version.
Most commands of the class accept an optional parameter which defines
to which language the command applies. If the language does not match
the language define in the \texttt{documentclass} the command is ignored.

Example:

\begin{verbatim}
\ecvERP[german]{Staatsangeh"origkeit}{Deutsch}
\ecvERP[english]{nationality}{german}
\end{verbatim}

If the document is rendered with |\documentclass[german]{ecv}| the first
line is used, if the document is rendered with |\documentclass[english]{ecv}|
the second line is printed.

The class also provides with its package |ecvNLS.sty| some macros for
nationalized text--fragments like |ecvPerson| which prints |Zur Person|
in the german version and |Personal Information| in the english version.

\section{Documentclass}

\DescribeMacro{documentclass ecv}
This package provides the documentclass \texttt{ecv}. The documentclass
supports the following options:


\begin{itemize}
\item |german| Select language german
\item |english| Select language english
\item |empty| Do not print footer or header
\item |selinput| Use \texttt{selinput} package instead of \texttt{inputenc} if
       you encounter encoding problems and if you have \texttt{selinput} installed.
\end{itemize}

\section{Header}

Between the \texttt{documentclass} and the
\texttt{document}--environment two commands are supported:

\DescribeMacro{ecvName}
\DescribeMacro{ecvPortrait}
\begin{itemize}
\item |\ecvName|\marg{name} Sets the name of the author of the cv.
      The name is printed in the left--hand footer. If the name is not
      set, the left hand footer (\texttt{Curriculum Vitae} or
      \texttt{Lebenslauf}) is not printed.
\item |ecvPortrait|\marg{image--name} Sets the name of the image
      that should be used as the portrait right to the title of the
      curriculum vitae.
      A file--extension of \texttt{jpg} is appended to the
      \texttt{image-name}. The image is printed 40mm x 60mm. If the
      |ecvPortrait| command does not exist no image is shown.
\end{itemize}

\section{Footer}

After the curriculum vitae a field for the signature can be added. This
package provides the following command for this purpose:

\DescribeMacro{ecvSig}
\begin{itemize}
\item |\ecvSig|\marg{name}\marg{town} Creates a signature field beneath the
      curriculum vitae.
\end{itemize}

A signature looks the following way:

\noindent
MyTown, \today \\[18pt]

Name, My

\section{ecv Environment}

\DescribeEnv{ecv}
The |ecv| environment encloses the curriculum vitae. All entries of
the curriculum vitae must be inside an |ecv| environment. The |ecv|
environment prints a title (either |Lebenslauf| or |Curriculum Vitae|)
and the portrait (if one is defined) prior to the entries.

\DescribeEnv{ecv*}
In addition to the |ecv| environment the |ecv*| envrionment is provided.
This environment works exactly like the |ecv| environment but ommits the
title and the pricture.

\section{Entries}

The curriculum vitae is composed of entries which are composed of a tag (left hand
side) and a value (right hand side). Both tag and value can come in
different flavours.

For example you have different entries for a job:
``period of time'', ``branch of trade'', ``job title'' and ``job description''.
It is recommended to have the ``period of time'' entry with a special
preceeding symbol, like a blue triangle, and the other entries with
a common preceeding symbol, like a small bullet.

Note that in this example several jobs would be listed
under a section ``jobs''. In the description below the term
group relies to a single job with its several entries.

\DescribeMacro{\ecvTP}
\DescribeMacro{\ecvTF}
\DescribeMacro{\ecvTN}
Tags can be written with the following macros:

\begin{itemize}
\item |\ecvTF|\oarg{lang}\marg{text} or |\ecvTagFirst|\oarg{lang}\marg{text}
      A tag that starts a group of tags. The \texttt{text} is preceeded
      by a small blue triangle.
\item |\ecvTN|\oarg{lang}\marg{text} or |\ecvTagNext|\oarg{lang}\marg{text}
      A tag inside a group of tags. The \texttt{text} is preceeded
      by a small circle.
\item |\ecvTP|\oarg{lang}\marg{text} or |\ecvTagPlain|\oarg{lang}\marg{text}
      The most simple form of a tag. Just prints \texttt{text}, without a
      preceeded symbol.
\end{itemize}


\DescribeMacro{\ecvVR}
\DescribeMacro{\ecvVB}
Values can be written as ragged right or as justified text with the following macros:

\begin{itemize}
\item |\ecvVR|\oarg{lang}\marg{text} or |\ecvValueRagged|\oarg{lang}\marg{text}
      A value with a ragged right.
\item |\ecvVB|\oarg{lang}\marg{text} or |\ecvValueBlocked|\oarg{lang}\marg{text}
      A value with justified text.
\end{itemize}

\bigskip
Tags and values are separated by a \&:

\begin{verbatim}
\ecvTP{Name} & \ecvVR{Name, My}
\end{verbatim}

\DescribeMacro{\ecvEPR}
\DescribeMacro{\ecvEPB}
\DescribeMacro{\ecvEFR}
\DescribeMacro{\ecvEFB}
\DescribeMacro{\ecvENR}
\DescribeMacro{\ecvENB}
Normally we want to write whole entries. We do not want to separate tags
and values. Therefore, a convenient form for writing whole entries are
the following macros which are in fact a combination of the tag and value
macros. The name of the macros is composed of |ecvE| followed by the flavour
of the tag followed by the flavour of the value:

\begin{itemize}
\item |\ecvEPR|\oarg{lang}\marg{tag}\marg{value} writes a plain tag with
      a value with a ragged right.
\item |\ecvEPB|\oarg{lang}\marg{tag}\marg{value} writes a plain tag with
      a value with a blocked right.
\item |\ecvEFR|\oarg{lang}\marg{tag}\marg{value} writes a first tag with
      a value with a ragged right.
\item |\ecvEFB|\oarg{lang}\marg{tag}\marg{value} writes a first tag with
      a value with a blocked right.
\item |\ecvENR|\oarg{lang}\marg{tag}\marg{value} writes a next tag with
      a value with a ragged right.
\item |\ecvENB|\oarg{lang}\marg{tag}\marg{value} writes a next tag with
      a value with a blocked right.
\end{itemize}

Of course also these macros have a long form

\begin{quote}
|\ecvTagPlainValueRagged|\\
|\ecvTagPlainValueBlocked| \\
|\ecvTagFirstValueRagged|\\
|\ecvTagFirstValueBlocked| \\
|\ecvTagNextValueRagged|\\
|\ecvTagNextValueBlocked|\\
\end{quote}

\DescribeMacro{\ecvOVR}
\DescribeMacro{\ecvOnlyValueRagged}
\DescribeMacro{\ecvOVB}
\DescribeMacro{\ecvOnlyValueBlocked}
Two special macros are provided to only print the value part:


\begin{itemize}
\item |\ecvOVR|\oarg{lang}\marg{text} or |\ecvOnlyValueRagged|\oarg{lang}\marg{text}
      Print only the value with a ragged right.
\item |\ecvOVB|\oarg{lang}\marg{text} or |\ecvOnlyValueBlocked|\oarg{lang}\marg{text}
      Print only the value with a blocked right.
\end{itemize}

\section{Sections}

Entries in the curriculum vitae can be grouped by sections and
subsections. Sections are printed with blue letters in the left column in
a slightly bigger font--face. Subsections are printed in capital letters.


\DescribeMacro{\ecvSec}
\DescribeMacro{\ecvSection}
\DescribeMacro{\ecvBSec}
\DescribeMacro{\ecvBreakSection}
The Section command comes in two flavours: with and without additional
vertical space (6pt) beforehand:


\begin{itemize}
\item |\ecvSec|\oarg{lang}{text} or |\ecvSection|\oarg{lang}{text}
      Prints a section tag without additional vertical space beforehand.
\item |\ecvBSec|\oarg{lang}{text} or  |\ecvBreakSection|\oarg{lang}{text}
      Prints a section tag with additional vertical space beforehand.
\end{itemize}

At the moment we did not to try any automatization of the vertical space
insertion, but have just experienced the necessity to add them.
Feel free to eleminate the need for the \texttt{ecvB} commands by
using fancy automization rules, and and don't forget to provide your
superior \LaTeX\ macro knowledge to us.

\DescribeMacro{\ecvSub}
\DescribeMacro{\ecvBSub}
\DescribeMacro{\ecvERSub}
\DescribeMacro{\ecvBERSub}
\DescribeMacro{\ecvEBSub}
\DescribeMacro{\ecvBEBSub}
Subsections tags are printed like section tags in the first column
but in another font. In contrast to sections they can have a value
attached. Subsection commands therefore are provided in a version with
and a version without a value:

\begin{itemize}
\item |\ecvSub|\oarg{lang}\marg{text} Standard subsection (without
      additional vertical space).
\item |\ecvBSub|\oarg{lang}\marg{text} Subsection with additional
      vertical space (smallskip).
\end{itemize}
\begin{itemize}
\item |\ecvERSub|\oarg{lang}\marg{text}\marg{value} Subsection with a
      ragged right value (without additional vertical space).
\item |\ecvBERSub|\oarg{lang}\marg{text}\marg{value} Subsection with a
      ragged right value and with additional vertical space.
\end{itemize}
\begin{itemize}
\item |\ecvEBSub|\oarg{lang}\marg{text}\marg{value} Subsection with a
      blocked right value (without additional vertical space).
\item |\ecvBEBSub|\oarg{lang}\marg{text}\marg{value} Subsection with a
      blocked right value and with additional vertical space.
\end{itemize}

Also these command come with verbose forms:

\begin{quote}
|\ecvSubSection|\\
|\ecvBreakSubSection|\\
|\ecvEntryRaggedSubSection|\\
|\ecvBreakEntryRaggedSubSection|\\
|\ecvEntryBlockedSubSection|\\
|\ecvBreakEntryBlockedSubSection|\\
\end{quote}

\section{Layouting}

The ecv class provides some command to tweak the layout of the cv.


\DescribeMacro{\ecvPageBreak}
\DescribeMacro{\ecvNewPage}
The following two commands can be used to control page--breaks:

\begin{itemize}
\item |ecvPageBreak| Suggest a page--break.
\item |ecvNewPage| For a new page.
\end{itemize}

\DescribeMacro{\ecvBreakParagraphs}
The |\ecvBreakParagraphs| command can be used to add vertical space
between entries.

\DescribeMacro{\ecvNewLine}
The |\ecvNewLine| can be introduced to continue on a new--line.

\DescribeMacro{\ecvNewPara}
The |\ecvNewPara| begins a new paragraph with addtional vertical space
(smallskip).

\DescribeMacro{\ecvBold}
The command |\ecvBold|\marg{text} can be used to create bold written
text.

\section{Hyperlinks}


\DescribeMacro{\ecvURL}
\DescribeMacro{\ecvEMail}
\DescribeMacro{\ecvHyperLink}
\DescribeMacro{\ecvHyperEMail}
The curriculum vitae class provides some commands to render hyperlinks:

\begin{itemize}
\item |\ecvHyperLink|\marg{url} Format a clickable url.
\item |\ecvHyperEMail|\marg{email} Format a clickable email.
\end{itemize}

The above commands are based on the following non-clickable
commands, which provide the formating and which can
be used likewise:

\begin{itemize}
\item |\ecvURL|\marg{url} Format an unclickable url.
\item |\ecvEMail|\marg{email} Format an unclickable email.
\end{itemize}

\section{Localized Strings}

The following localized strings are provided for the german and english
languages:


\begin{itemize}
\item |\ecvPerson| Either |Zur Person| or |Personal Information|
\DescribeMacro{ecvPerson}
\item |\ecvProfession| Either |Beruf| or |Profession|
\DescribeMacro{ecvProfession}
\item |\ecvResearch| Either |Forschung| or |Research|
\DescribeMacro{ecvResearch}
\item |\ecvEducation| Either |Ausbildung| or |Scholarship|
\DescribeMacro{ecvEducation}
\item |\ecvPublications| Either |Publikationen| or |Publications|
\DescribeMacro{ecvPublications}
\item |\ecvAwards| Either |Auszeichungen| or |Awards|
\DescribeMacro{ecvAwards}
\item |\ecvScholarships| Either |Stipendien| or |Scholarships|
\DescribeMacro{ecvScholarships}
\item |\ecvJobs| Either |Arbeitserfahrung| or |Jobs|
\DescribeMacro{ecvJobs}
\item |\ecvLanguages| Either |Sprachen| or |Languages|
\DescribeMacro{ecvLanguages}
\item |\ecvLanguageTravels| Either |Sprachreisen| or |Language Travels|
\DescribeMacro{ecvLanguageTravels}
\item |\ecvAbilities| Either |F"ahigkeiten| or |Abilities|
\DescribeMacro{ecvAbilities}
\item |\ecvConferences| Either |Konferenzen| or |Conferences|
\DescribeMacro{ecvConferences}
\item |\ecvSpeeches| Either |Vortr"age| or |Speeches|
\DescribeMacro{ecvSpeeches}
\item |\ecvTraining| Either |Fortbildung| or |Trainig|
\DescribeMacro{ecvTrainig}
\item |\ecvAttachements| Either |Anh"ange| or |Attachements|
\DescribeMacro{ecvAttachements}
\end{itemize}

\section{Requirements}

We instrument several other \LaTeX\ packages for different purposes,
which must be available under your installation.

\begin{itemize}
\item geometry
\item longtable
\item pgf
\item paralist
\item helvet
\item color
\item fancyhdr
\item inputenc
\item fontenc
\item ae
\item aecompl
\item aeguill
\item textcomp
\item url
\item hyperref
\item babel
\end{itemize}

\end{document}