sergiodj/org-cv
1
0
Fork 0
forked from mirrors/org-cv
Code Pull requests Activity

Added AwesomeCV documentation and examples

Browse source 
awesomecv.org and awesome-letter.org are now generated from readme.org,
as for the other exporters.
This commit is contained in:
Diego Zamboni 2021-07-07 10:31:49 +02:00
parent 4df7fa67a9
commit 30c4a660e2
2 changed files with 267 additions and 62 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

179
doc/content/post/latex_export.md
View file

@ -97,34 +97,59 @@ When exporting you can call the following function to get the latex file.
## Using AwesomeCV {#using-awesomecv}
[AwesomeCV](https://github.com/posquit0/Awesome-CV) is another LaTeX template for producing nice-looking
CVs. In addition to the regular document attributes, the following are supported:
CVs and cover letters. This style also supports some additional options. For example:
```org
# CV color - options include: 'awesome-red (default), 'awesome-emerald,
# 'awesome-skyblue', 'awesome-pink', 'awesome-orange', 'awesome-nephritis',
# 'awesome-concrete' and 'awesome-darknight', plus any standard color names.
#+CVCOLOR: awesome-red
# Specify the position and style of the photo
#+PHOTOSTYLE: right,noedge
```
When exporting you can call the following function to get the latex file.
```emacs-lisp
(org-export-to-file 'awesomecv "awesomecv.tex")
(org-latex-compile "awesomecv.tex")
```
Note that AwesomeCV uses the `fontspec` package, so you need to set `org-latex-compiler` to `lualatex` or `xelatex` for it to work.
In addition to the regular document attributes, the following are supported:
<div class="ox-hugo-table table table-striped">
<div></div>
| Field | Description |
|------------------|-----------------------------------------------------------|
| PHOTOSTYLE | Style of photo to use. Comma-separated values can include |
| | circle/rectangle,edge/noedge,left/right. |
| CVCOLOR | Color of highlights. |
| STACKOVERFLOW | Stack overflow, must be specified as `ID username` |
| FONTDIR | Directory where the fonts can be found, defaults |
| | to `fonts/` (as in the standard AwesomeCV) |
| CVHIGHLIGHTS | Whether to colorize highlights. Defaults to true |
| QUOTE | Optional quote to include at the top of the CV |
| FIRSTNAME | First name to be shown in the CV. By default the first |
| | space-separated part of AUTHOR is used. |
| LASTNAME | Last name to be shown in the CV. By default the second |
| | space-separated part of AUTHOR is used. |
| CVFOOTER\_LEFT | Text to include in the left footer. None by default |
| CVFOOTER\_MIDDLE | Text to include in the middle footer. None by default. |
| CVFOOTER\_RIGHT | Text to include in the right footer. None by default. |
| Field | Description |
|------------------|-------------------------------------------------------------|
| PHOTOSTYLE | Style of photo to use. Comma-separated values can include |
| | circle/rectangle,edge/noedge,left/right. |
| CVCOLOR | Color of highlights. |
| STACKOVERFLOW | Stack overflow info, must be specified as "`ID username`" |
| FONTDIR | Directory where the fonts can be found, defaults |
| | to `fonts/` (as in the standard AwesomeCV) |
| CVHIGHLIGHTS | Whether to colorize highlights. Defaults to true |
| QUOTE | Optional quote to include at the top of the CV |
| FIRSTNAME | First name to be shown in the CV. By default the first |
| | space-separated part of AUTHOR is used. |
| LASTNAME | Last name to be shown in the CV. By default the second |
| | space-separated part of AUTHOR is used. |
| CVFOOTER\_LEFT | Text to include in the left footer. None by default |
| CVFOOTER\_MIDDLE | Text to include in the middle footer. None by default. |
| CVFOOTER\_RIGHT | Text to include in the right footer. None by default. |
| LATEX\_TITLE | Text to use as the title section. \makecvheader by default. |
| | (Can specify \makecvheader[R] to justify to the right) |
</div>
AwesomeCV supports a few additional types of environment types in
`CV_ENV`, including `cvemployer`, `cvskills`, `cvhonors` and `cvschool`. Some of
these support additional property fields:
### CV environments {#cv-environments}
AwesomeCV supports a few additional types of environment types in `CV_ENV`,
including `cvemployer`, `cvskills`, `cvhonors` and `cvschool` (see full list below).
Some of these support additional property fields:
<div class="ox-hugo-table table table-striped">
<div></div>
@ -148,47 +173,47 @@ these support additional property fields:
</div>
All the supported values of `CV_ENV` are described below.
All the supported values of `CV_ENV` for CVs are described below.
### `cventries` {#cventries}
#### `cventries` {#cventries}
Enclose all the subheaders in a `cventries` environment. Subheaders can
be of type `cventry`, `cvschool`, or `cvemployer`.
### `cvhonors` {#cvhonors}
#### `cvhonors` {#cvhonors}
Enclose all the subheaders in a `cvhonors` environment. Subheaders must
be of type `cvhonor`
### `cventry` {#cventry}
#### `cventry` {#cventry}
Converts to a `\cventry` command. Supports attributes `FROM`, `TO`, `DATE`,
`EMPLOYER`, `LOCATION`, `RIGHT_IMG`.
### `cvsubentry` {#cvsubentry}
#### `cvsubentry` {#cvsubentry}
Converts to a `\cvsubentry` command. Supports attributes `FROM`, `TO`, `DATE`,
`LABEL` `RIGHT_IMG`.
### `cvemployer` {#cvemployer}
#### `cvemployer` {#cvemployer}
Converts to a `\cventry` with only the title line. Supports attributes
`FROM`, `TO`, `DATE` and `LOCATION`.
### `cvschool` {#cvschool}
#### `cvschool` {#cvschool}
Converts to a `\cventry`. The headline should contain the degree
obtained, shown as the main title. Supports attributes `LOCATION`,
`SCHOOL`, `FROM`, `TO`, `DATE` and `RIGHT_IMG`.
### `cvhonor` {#cvhonor}
#### `cvhonor` {#cvhonor}
Converts to a `\cvhonor` command (must be inside a `cvhonors`
headline). Supports attributes `LOCATION`, `EMPLOYER` (in this case `EVENT`
@ -196,9 +221,103 @@ or `POSITION` might be more semantically accurate, and can also be
used), `FROM`, `TO`, `DATE`.
### `cvskills` {#cvskills}
#### `cvskills` {#cvskills}
Converts to a `\cvskills` environment. The headline must contain a
[description list](https://orgmode.org/manual/Plain-lists.html), which gets converted into a sequence of `\cvskill`
commands, with the term as the skill title and the description as its
contents.
<object data="awesomecv.org.pdf" type="application/pdf" width="100%" height="500px">
<p>Alternative text - include a link <a href="awesomecv.org.pdf">to the PDF!</a></p>
</object>
### Cover letter environments {#cover-letter-environments}
AwesomeCV also supports generating cover letters. For this, `CV_ENV` can have a few additional values, shown below.
#### `letterheader` {#letterheader}
This environment provides heading/signature information for a cover letter. Supports attributes `RECIPIENT`. `EMPLOYER`, `LOCATION`, `LETTER_OPENING`, `LETTER_CLOSING`, `LETTER_ATTACHED`, `DATE`, `DATEFORMAT`.
Note that the text within the heading is not exported! You can use this, for example, to keep notes about your application or the employer. For example:
```org
* Recipient
:PROPERTIES:
:CV_ENV: letterheader
:RECIPIENT: International Recruiting team
:EMPLOYER: Employer Co.
:LOCATION: Someplace, the world
:LETTER_OPENING: Dear International Recruiting team
:LETTER_CLOSING: Kind regards,
:LETTER_ATTACHED: Curriculum Vitae
:END:
Title and content are not exported.
Add any notes about the recipient here
They will *not* be exported.
```
<div class="ox-hugo-table table table-striped">
<div></div>
| Field | Description |
|------------------|----------------------------------------------------------------------------------|
| RECIPIENT | Addressee E.g. Company Recruitment Team |
| EMPLOYER | Company name |
| LOCATION | Company address |
| LETTER\_OPENING | Letter opening, E.g. Dear Ms./Mr./Dr. LastName |
| LETTER\_CLOSING | Letter closing, E.g. Yours Sincerely, |
| DATE | The date used for the letter, uses \\\today as default if unspecified |
| DATEFORMAT | Specify an alternative date format for the letter header |
| | E.g. %e %M %Y might provide 19 March 2021 |
| LETTER\_ATTACHED | Attachments to the letter, will be listed at the bottom. E.g. "Curriculum Vitae" |
</div>
#### `cvletter` {#cvletter}
Converts to a `\cvletter` environment. This holds the content of a cover letter. The body can be subdivided using `lettersection` headings. The heading title is converted to a title line at the top of the letter.
```org
* Application for the position of /Awesome Job/ (job reference #123456)
:PROPERTIES:
:CV_ENV: cvletter
:END:
** About Me
:PROPERTIES:
:CV_ENV: lettersection
:END:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis ullamcorper neque sit amet lectus facilisis sed luctus nisl iaculis. Vivamus at neque arcu, sed tempor quam. Curabitur pharetra tincidunt tincidunt. Morbi volutpat feugiat mauris, quis tempor neque vehicula volutpat. Duis tristique justo vel massa fermentum accumsan. Mauris ante elit, feugiat vestibulum tempor eget, eleifend ac ipsum. Donec scelerisque lobortis ipsum eu vestibulum. Pellentesque vel massa at felis accumsan rhoncus.
** Why Employer Co.?
:PROPERTIES:
:CV_ENV: lettersection
:END:
Suspendisse commodo, massa eu congue tincidunt, elit mauris pellentesque orci, cursus tempor odio nisl euismod augue. Aliquam adipiscing nibh ut odio sodales et pulvinar tortor laoreet. Mauris a accumsan ligula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse vulputate sem vehicula ipsum varius nec tempus dui dapibus. Phasellus et est urna, ut auctor erat. Sed tincidunt odio id odio aliquam mattis. Donec sapien nulla, feugiat eget adipiscing sit amet, lacinia ut dolor. Phasellus tincidunt, leo a fringilla consectetur, felis diam aliquam urna, vitae aliquet lectus orci nec velit. Vivamus dapibus varius blandit.
** Why me?
:PROPERTIES:
:CV_ENV: lettersection
:END:
Duis sit amet magna ante, at sodales diam. Aenean consectetur porta risus et sagittis. Ut interdum, enim varius pellentesque tincidunt, magna libero sodales tortor, ut fermentum nunc metus a ante. Vivamus odio leo, tincidunt eu luctus ut, sollicitudin sit amet metus. Nunc sed orci lectus. Ut sodales magna sed velit volutpat sit amet pulvinar diam venenatis.
```
#### `cvletter_notitle` {#cvletter-notitle}
Same as `cvletter`, but does not include a letter title at the top.
#### `lettersection` {#lettersection}
Converts to a `\lettersection` command. These are the headline portions of a cover letter.
<object data="awesome-letter.org.pdf" type="application/pdf" width="100%" height="500px">
<p>Alternative text - include a link <a href="awesome-letter.org.pdf">to the PDF!</a></p>
</object>

150
readme.org
View file

@ -216,7 +216,33 @@ When exporting you can call the following function to get the latex file.
** Using AwesomeCV
[[https://github.com/posquit0/Awesome-CV][AwesomeCV]] is another LaTeX template for producing nice-looking
CVs. In addition to the regular document attributes, the following are supported:
CVs and cover letters. This style also supports some additional options. For example:
#+BEGIN_SRC org :tangle awesomecv.org
# CV color - options include: 'awesome-red (default), 'awesome-emerald,
# 'awesome-skyblue', 'awesome-pink', 'awesome-orange', 'awesome-nephritis',
# 'awesome-concrete' and 'awesome-darknight', plus any standard color names.
,#+CVCOLOR: awesome-red
# Specify the position and style of the photo
,#+PHOTOSTYLE: right,noedge
#+END_SRC
# Next block is to generate exports
#+BEGIN_SRC org :exports none :tangle awesomecv.org
#+include: basic_cv.org
#+include: sideactivities.org
#+include: workcontent.org
#+END_SRC
When exporting you can call the following function to get the latex file.
#+BEGIN_SRC emacs-lisp
(org-export-to-file 'awesomecv "awesomecv.tex")
(org-latex-compile "awesomecv.tex")
#+END_SRC
Note that AwesomeCV uses the =fontspec= package, so you need to set =org-latex-compiler= to =lualatex= or =xelatex= for it to work.
In addition to the regular document attributes, the following are supported:
#+attr_html: :class table table-striped
| Field | Description |
@ -224,9 +250,9 @@ CVs. In addition to the regular document attributes, the following are supported
| PHOTOSTYLE | Style of photo to use. Comma-separated values can include |
| | circle/rectangle,edge/noedge,left/right. |
| CVCOLOR | Color of highlights. |
| STACKOVERFLOW | Stack overflow, must be specified as =ID username= |
| STACKOVERFLOW | Stack overflow info, must be specified as "=ID username=" |
| FONTDIR | Directory where the fonts can be found, defaults |
| | to =fonts/= (as in the standard AwesomeCV) |
| | to =fonts/= (as in the standard AwesomeCV) |
| CVHIGHLIGHTS | Whether to colorize highlights. Defaults to true |
| QUOTE | Optional quote to include at the top of the CV |
| FIRSTNAME | First name to be shown in the CV. By default the first |
@ -237,11 +263,13 @@ CVs. In addition to the regular document attributes, the following are supported
| CVFOOTER_MIDDLE | Text to include in the middle footer. None by default. |
| CVFOOTER_RIGHT | Text to include in the right footer. None by default. |
| LATEX_TITLE | Text to use as the title section. \makecvheader by default. |
| | (Can specify \makecvheader[R] to justify to the right) |
| | (Can specify \makecvheader[R] to justify to the right) |
AwesomeCV supports a few additional types of environment types in
=CV_ENV=, including =cvemployer=, =cvskills=, =cvhonors= and =cvschool=. Some of
these support additional property fields:
*** CV environments
AwesomeCV supports a few additional types of environment types in =CV_ENV=,
including =cvemployer=, =cvskills=, =cvhonors= and =cvschool= (see full list below).
Some of these support additional property fields:
#+attr_html: :class table table-striped
| Field | Description |
@ -261,81 +289,139 @@ these support additional property fields:
| PAGEBREAK | Causes a LaTeX =\clearpage= statement to be inserted in the |
| | exported output before the heading. |
All the supported values of =CV_ENV= are described below.
All the supported values of =CV_ENV= for CVs are described below.
*** =cventries=
**** =cventries=
Enclose all the subheaders in a =cventries= environment. Subheaders can
be of type =cventry=, =cvschool=, or =cvemployer=.
*** =cvhonors=
**** =cvhonors=
Enclose all the subheaders in a =cvhonors= environment. Subheaders must
be of type =cvhonor=
*** =cventry=
**** =cventry=
Converts to a =\cventry= command. Supports attributes =FROM=, =TO=, =DATE=,
=EMPLOYER=, =LOCATION=, =RIGHT_IMG=.
*** =cvsubentry=
**** =cvsubentry=
Converts to a =\cvsubentry= command. Supports attributes =FROM=, =TO=, =DATE=,
=LABEL= =RIGHT_IMG=.
*** =cvemployer=
**** =cvemployer=
Converts to a =\cventry= with only the title line. Supports attributes
=FROM=, =TO=, =DATE= and =LOCATION=.
*** =cvschool=
**** =cvschool=
Converts to a =\cventry=. The headline should contain the degree
obtained, shown as the main title. Supports attributes =LOCATION=,
=SCHOOL=, =FROM=, =TO=, =DATE= and =RIGHT_IMG=.
*** =cvhonor=
**** =cvhonor=
Converts to a =\cvhonor= command (must be inside a =cvhonors=
headline). Supports attributes =LOCATION=, =EMPLOYER= (in this case =EVENT=
or =POSITION= might be more semantically accurate, and can also be
used), =FROM=, =TO=, =DATE=.
*** =cvskills=
**** =cvskills=
Converts to a =\cvskills= environment. The headline must contain a
[[https://orgmode.org/manual/Plain-lists.html][description list]], which gets converted into a sequence of =\cvskill=
commands, with the term as the skill title and the description as its
contents.
*** =letterheader=
#+BEGIN_EXPORT md
<object data="awesomecv.org.pdf" type="application/pdf" width="100%" height="500px">
<p>Alternative text - include a link <a href="awesomecv.org.pdf">to the PDF!</a></p>
</object>
#+END_EXPORT
Provides heading information for a cover letter. Supports attributes =RECIPIENT=. =EMPLOYER=, =LOCATION=, =LETTER_OPENING=, =LETTER_CLOSING=, =LETTER_ATTACHED=, =DATE=, =DATEFORMAT=.
*** Cover letter environments
AwesomeCV also supports generating cover letters. For this, =CV_ENV= can have a few additional values, shown below.
**** =letterheader=
This environment provides heading/signature information for a cover letter. Supports attributes =RECIPIENT=. =EMPLOYER=, =LOCATION=, =LETTER_OPENING=, =LETTER_CLOSING=, =LETTER_ATTACHED=, =DATE=, =DATEFORMAT=.
Note that the text within the heading is not exported! You can use this, for example, to keep notes about your application or the employer. For example:
#+begin_src org :tangle awesome-letter.org
,* Recipient
:PROPERTIES:
:CV_ENV: letterheader
:RECIPIENT: International Recruiting team
:EMPLOYER: Employer Co.
:LOCATION: Someplace, the world
:LETTER_OPENING: Dear International Recruiting team
:LETTER_CLOSING: Kind regards,
:LETTER_ATTACHED: Curriculum Vitae
:END:
Title and content are not exported.
Add any notes about the recipient here
They will *not* be exported.
#+end_src
#+attr_html: :class table table-striped
| Field | Description |
|----------------+---------------------------------------------------------------------------|
| RECIPIENT | Addressee E.g. Company Recruitment Team |
| EMPLOYER | Company name, E.g. Google Inc |
| LOCATION | Company address, E.g. 1600 Amphitheatre Parkway\\Mountain View, CA 94043 |
| LETTER_OPENING | Letter opening, E.g. Dear Ms./Mr./Dr. LastName |
| LETTER_CLOSING | Letter closing, E.g. Yours Sincerely, |
| DATE | The date used for the letter, uses \\today as default if unspecified. |
| DATEFORMAT | Specify an alternative date format for the letter header. |
| | E.g. %e %M %Y might provide 19 March 2021 |
| Field | Description |
|-----------------+-----------------------------------------------------------------------------------|
| RECIPIENT | Addressee E.g. Company Recruitment Team |
| EMPLOYER | Company name |
| LOCATION | Company address |
| LETTER_OPENING | Letter opening, E.g. Dear Ms./Mr./Dr. LastName |
| LETTER_CLOSING | Letter closing, E.g. Yours Sincerely, |
| DATE | The date used for the letter, uses \\today as default if unspecified |
| DATEFORMAT | Specify an alternative date format for the letter header |
| | E.g. %e %M %Y might provide 19 March 2021 |
| LETTER_ATTACHED | Attachments to the letter, will be listed at the bottom. E.g. "Curriculum Vitae" |
*** =cvletter=
**** =cvletter=
Converts to a =\cvletter= environment. This holds the content of a cover letter.
Converts to a =\cvletter= environment. This holds the content of a cover letter. The body can be subdivided using =lettersection= headings. The heading title is converted to a title line at the top of the letter.
*** =cvletter_notitle=
#+begin_src org :tangle awesome-letter.org
,* Application for the position of /Awesome Job/ (job reference #123456)
:PROPERTIES:
:CV_ENV: cvletter
:END:
,** About Me
:PROPERTIES:
:CV_ENV: lettersection
:END:
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis ullamcorper neque sit amet lectus facilisis sed luctus nisl iaculis. Vivamus at neque arcu, sed tempor quam. Curabitur pharetra tincidunt tincidunt. Morbi volutpat feugiat mauris, quis tempor neque vehicula volutpat. Duis tristique justo vel massa fermentum accumsan. Mauris ante elit, feugiat vestibulum tempor eget, eleifend ac ipsum. Donec scelerisque lobortis ipsum eu vestibulum. Pellentesque vel massa at felis accumsan rhoncus.
,** Why Employer Co.?
:PROPERTIES:
:CV_ENV: lettersection
:END:
Suspendisse commodo, massa eu congue tincidunt, elit mauris pellentesque orci, cursus tempor odio nisl euismod augue. Aliquam adipiscing nibh ut odio sodales et pulvinar tortor laoreet. Mauris a accumsan ligula. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Suspendisse vulputate sem vehicula ipsum varius nec tempus dui dapibus. Phasellus et est urna, ut auctor erat. Sed tincidunt odio id odio aliquam mattis. Donec sapien nulla, feugiat eget adipiscing sit amet, lacinia ut dolor. Phasellus tincidunt, leo a fringilla consectetur, felis diam aliquam urna, vitae aliquet lectus orci nec velit. Vivamus dapibus varius blandit.
,** Why me?
:PROPERTIES:
:CV_ENV: lettersection
:END:
Duis sit amet magna ante, at sodales diam. Aenean consectetur porta risus et sagittis. Ut interdum, enim varius pellentesque tincidunt, magna libero sodales tortor, ut fermentum nunc metus a ante. Vivamus odio leo, tincidunt eu luctus ut, sollicitudin sit amet metus. Nunc sed orci lectus. Ut sodales magna sed velit volutpat sit amet pulvinar diam venenatis.
#+end_src
**** =cvletter_notitle=
Same as =cvletter=, but does not include a letter title at the top.
*** =lettersection=
**** =lettersection=
Converts to a =\lettersection= command. These are the headline portions of a cover letter.
#+BEGIN_EXPORT md
<object data="awesome-letter.org.pdf" type="application/pdf" width="100%" height="500px">
<p>Alternative text - include a link <a href="awesome-letter.org.pdf">to the PDF!</a></p>
</object>
#+END_EXPORT
* Markdown Hugo Exporter
:PROPERTIES:
:EXPORT_FILE_NAME: hugo_export