Compare commits

..

3 commits

Author SHA1 Message Date
Óscar Nájera
5e34c09388 refactor contact 2020-06-02 00:11:17 +02:00
Óscar Nájera
edfe13f3af Refactor ox-hugo 2020-06-02 00:11:17 +02:00
Óscar Nájera
0a20ce2b00 Social becomes a section instead of document property
First it changes the entries to categories. That is CV_ENV is now category
for everything. Then cventry continues to behave as before, but CATEGORY
social comes in.

For the moment it creates a formatted block
2020-06-02 00:11:17 +02:00
21 changed files with 203 additions and 1688 deletions

2
.gitignore vendored
View file

@ -1,2 +0,0 @@
*.elc
/dev.org

View file

@ -8,24 +8,22 @@ before_script:
test:
script:
- emacs --batch -Q --script genfiles.el
- cd doc; hugo
- emacs --batch -Q --script genfiles.el
- cd doc; hugo
except:
- master
- master
artifacts:
paths:
- doc/public
- org-cv-exports
when: always
pages:
script:
- emacs --batch -Q --script genfiles.el
- cd doc; hugo
- mv public/ ../public/ # Because I remain now in the doc folder
- emacs --batch -Q --script genfiles.el
- cd doc; hugo
- mv public/ ../public/ # Because I remain now in the doc folder
artifacts:
paths:
- public
only:
- master
- master

View file

@ -2,16 +2,10 @@ baseURL = "https://titan-c.gitlab.io/org-cv/"
languageCode = "en-us"
title = "Org CV"
theme = "project-landing-page"
[markup.goldmark.renderer]
unsafe = true
[markup.goldmark.parser.attribute]
title = true
block = true
[params]
description = "Org-mode backend exporters for Curriculum Vita"
author_url = "http://oscarnajera.com"
author_url = "http://blog.oscarnajera.com"
author = "Titan-C"
project_url = "https://gitlab.com/Titan-C/org-cv/"
logo = "https://upload.wikimedia.org/wikipedia/commons/a/a6/Org-mode-unicorn.svg"

View file

@ -14,6 +14,7 @@ The basic structure of an org file containing your CV is shown next.
put your foreseen job.
<div class="ox-hugo-table table table-striped">
<div></div>
| Field | Description |
|----------|----------------------------------------------------|
@ -31,10 +32,9 @@ put your foreseen job.
</div>
```org
#+TITLE: My dream job an ORG-CV example
#+TITLE: My dream job
#+AUTHOR: John Doe
#+email: john@doe.lost
#+options: tags:nil
#+ADDRESS: My Awesome crib
#+ADDRESS: Fantastic city -- Planet Earth
@ -47,22 +47,14 @@ put your foreseen job.
```
You can use org-modes hierarchical structure to describe your CV. To make a
specific subtree an item describing an experience point (Job you have, degree
you pursued, etc.) you use the org properties drawer and with the `:CV_ENV:
cventry` property. You should also include the `FROM` and `TO` properties
defining the span of the entry, as well as `LOCATION` and `EMPLOYER`.
Because work isn't everything we do, it is more meaningful to label differently
the host of those other events like studies, events, certifications, etc. Thus
`HOST`, `ORGANIZATION`, `INSTITUTION`, `SCHOOL`, `EMPLOYER` or `EVENT` are all
equivalent and the first match in that order has precedence.
`DATE` is a shortcut for `FROM` and `TO` when you have a single date in mind
instead of a range. Both `FROM` and `TO` override `DATE`.
specific subtree an item describing an experience point (Job you have,
degree you pursued, etc.) you use the org properties drawer and with the
`:CV_ENV: cventry` property. You should also include the `FROM` and `TO`
properties defining the span of the event, as `LOCATION` and `EMPLOYER`.
```org
* Employement :cventries:
** One job :cventry:
* Employement
** One job
:PROPERTIES:
:CV_ENV: cventry
:FROM: <2014-09-01>
@ -72,8 +64,9 @@ instead of a range. Both `FROM` and `TO` override `DATE`.
:END:
I write about awesome stuff I do.
** Other job :cventry:
** Other job
:PROPERTIES:
:CV_ENV: cventry
:FROM: <2013-09-01>
:TO: <2014-08-07>
:LOCATION: my city, your country

View file

@ -16,43 +16,4 @@ exclude some tags during export.
(org-export-to-file 'hugocv "hugocv.md"))
```
You are responsible for styling your website. Use all the CSS magic you know.
Each entry is inside a `div` container and each element of the properties has
its own class.
Make sure that your hugo config has the markup parser attributes active and allows
for html rendering.
```yaml
markup:
goldmark:
renderer:
unsafe: true
parser:
attribute:
title: true
block: true
```
You can also use an awards section for a different styling. Here you tag each
entry with `cvhonor`.
```org
* Awards
** First place :cvhonor:
:PROPERTIES:
:CV_ENV: cventry
:DATE: <2014-09-01>
:LOCATION: a city, a country
:EVENT: The RACE
:END:
** Sport Scholarship :cvhonor:
:PROPERTIES:
:DATE: <2013-09-01>
:LOCATION: my city, your country
:ORGANIZATION: The nice millionaire
:END:
```
Next is the rendered result for the special entries with styling.
You are responsible for styling your website.

View file

@ -12,7 +12,7 @@ latex distributions. I maintain a fork of it, to work with my use case at
<https://github.com/Titan-C/moderncv.git> Feel free to use any or even your
personal fork for your desired use case.
To configure the export for moderncv you need the additional options in your
To configure the export for moderncv you need the addition options in your
org file.
```org
@ -92,229 +92,3 @@ When exporting you can call the following function to get the latex file.
<object data="altacv.org.pdf" type="application/pdf" width="100%" height="500px">
<p>Alternative text - include a link <a href="altacv.org.pdf">to the PDF!</a></p>
</object>
## Using AwesomeCV {#using-awesomecv}
[AwesomeCV](https://github.com/posquit0/Awesome-CV) is another LaTeX template for producing nice-looking
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">
| 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>
### 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">
| Field | Description |
|-----------|----------------------------------------------------------------------|
| FROM | Start date of the entry |
| TO | End date of the entry |
| DATE | Shortcut to specify both `FROM` and `TO` as the same date. |
| | Both `FROM` and `TO` override `DATE`. |
| EMPLOYER | Employer or organization, can also be specified |
| | as `ORGANIZATION`, `SCHOOL`, `EVENT` or `POSITION` (different |
| | names make more sense depending on the type of environment) |
| LABEL | In `cvsubentry` environments, adds the given text to the left |
| | of the date range, can be used to add additional information |
| | to the entry. |
| RIGHT_IMG | path to an image to include floating to the right of a `cventry`, |
| | a `cvsubentry` or `cvschool` entry. Meant to be used to show a logo. |
| PAGEBREAK | Causes a LaTeX `\clearpage` statement to be inserted in the |
| | exported output before the heading. |
</div>
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
[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">
| 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>

View file

@ -2,11 +2,11 @@
title = "License"
author = ["Óscar Nájera"]
draft = false
weight = 1007
weight = 1006
+++
> org-cv
> Copyright (C) 2018-2023 Óscar Nájera
> Copyright (C) 2018-2020 Óscar Nájera
>
> This program is free software: you can redistribute it and/or modify
> it under the terms of the GNU General Public License as published by

View file

@ -2,7 +2,7 @@
title = "Tips"
author = ["Óscar Nájera"]
draft = false
weight = 1008
weight = 1007
+++
If you have found this project useful. Please consider giving back. You can

View file

@ -1,38 +0,0 @@
<!doctype html>
<html>
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description" content="" />
<meta name="author" content="" />
<base href="{{ .Site.BaseURL }}" />
<title>{{ .Title }}</title>
<!-- Bootstrap Core CSS -->
<link
rel="stylesheet"
href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.1/css/bootstrap.min.css"
integrity="sha384-WskhaSGFgHYWDcbwN70/dfYBj47jz9qbsMId/iRN3ewGhXQFZCSftd1LZCfmhktB"
crossorigin="anonymous"
/>
<!-- Custom CSS -->
<link href="css/landing-page.css" rel="stylesheet" />
<link href="css/cv.css" rel="stylesheet" />
<link
rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/all.min.css"
/>
<!-- Custom Fonts -->
<link
href="https://fonts.googleapis.com/css?family=Lato:300,400,700,300italic,400italic,700italic"
rel="stylesheet"
type="text/css"
/>
<style>
{{ printf "%v" (partial "template.css" . ) | safeCSS }}
</style>
</head>
</html>

125
doc/static/css/cv.css vendored
View file

@ -1,125 +0,0 @@
.cv-entry .cv-host,
.cv-entry .cv-date,
.cv-entry .cv-location,
.cv-honor .cv-host,
.cv-honor .cv-date,
.cv-honor .cv-location {
margin: 0;
}
.cv-entry .cv-host::before,
.cv-honor .cv-host::before {
font-family: "Font Awesome 6 Free";
content: "\f1ad";
font-weight: 900;
margin: 0 0.5rem;
}
.cv-entry .cv-location::before,
.cv-honor .cv-location::before {
font-family: "Font Awesome 6 Free";
content: "\f041";
font-weight: 900;
margin: 0 0.5rem;
}
.cv-entry .cv-role::before {
content: "";
position: absolute;
width: 2rem;
height: 2rem;
background-color: #79c753;
border-radius: 50%;
transform: translateX(-50%);
left: 0;
}
.cv-entry .cv-date::before {
font-family: "Font Awesome 6 Free";
content: "\f133";
font-weight: 900;
margin: 0 0.5rem;
}
.cv-honor .cv-role {
margin-left: 5.5rem;
}
.cv-honor .cv-date {
position: absolute;
left: 0;
top: 0.05rem;
font-size: 1.25rem;
}
.cv-honor .cv-date::before {
font-family: "Font Awesome 6 Free";
color: #ffb700;
content: "\f559";
font-weight: 900;
margin: 0 0.5rem;
}
.cv-entry {
border-left-style: solid;
border-left-width: 1px;
border-color: #ccc;
}
.cv-honor .cv-host,
.cv-honor .cv-location,
.cv-entry .cv-date,
.cv-entry .cv-location {
display: inline-block;
}
.cv-entry .cv-host,
.cv-entry .cv-date,
.cv-entry .cv-location,
.cv-honor .cv-host,
.cv-honor .cv-date,
.cv-honor .cv-location {
font-weight: 300;
}
.cv-entry .cv-host,
.cv-entry .cv-date,
.cv-entry .cv-location,
.cv-honor .cv-host,
.cv-honor .cv-date,
.cv-honor .cv-location {
color: #555;
}
.cv-entry .cv-host,
.cv-entry .cv-date,
.cv-entry .cv-location,
.cv-honor .cv-host,
.cv-honor .cv-date,
.cv-honor .cv-location {
padding: 0;
}
.cv-entry,
.cv-honor {
padding-left: 2rem;
padding-bottom: 0.5rem;
margin-left: 1rem;
position: relative;
}
.cv-entry p,
.cv-entry ul,
.cv-honor p,
.cv-honor ul {
padding-top: 0.25rem;
padding-bottom: 0.25rem;
margin-top: 0.25rem;
margin-bottom: 0.25rem;
font-size: 1rem;
}
.cv-entry .cv-role {
font-size: 1.5rem;
font-size: 1.25rem;
}

@ -1 +1 @@
Subproject commit 5da34f691d936bb5e9ce8b5b898b74deca54eb23
Subproject commit 55a73ff9c1b7a674d8aa6ee20a52f8ce9f481882

View file

@ -1,58 +1,34 @@
(defvar cv-cwd default-directory
"remember the current directory, find-file changes it")
(defvar cv-workdir (expand-file-name "org-cv-exports/"))
(toggle-debug-on-error)
(with-current-buffer (find-file-noselect "/tmp/install-org.el")
(eval-buffer))
;; remember the current directory, find-file changes it
(defvar cwd default-directory)
(defvar workdir "/tmp/org-cv-exports/")
(find-file "/tmp/install-org.el")
(eval-buffer)
(use-package ox-hugo
:ensure t
:pin melpa
:after ox)
(add-to-list 'load-path cwd)
(use-package ox-moderncv
:load-path cv-cwd
:ensure dash
:init
(require 'ox-altacv)
(require 'ox-hugocv)
(require 'ox-awesomecv)
(require 'ox-awesomecv2))
(require 'ox-moderncv)
(defun export-with (backend file ext)
(let ((workfile (concat cv-workdir file))
(outfile (concat cv-workdir file ext)))
(message (format "%s exists: %s" workfile (file-exists-p workfile)))
(with-current-buffer
(find-file-noselect workfile)
(org-mode)
(message "back %S, out %S" backend outfile)
(org-export-to-file backend outfile))
outfile))
(require 'ox-altacv)
(let ((readme (concat cwd "readme.org")))
(find-file readme)
(make-directory workdir t)
(cd workdir)
(org-babel-tangle))
(copy-file (concat cwd "doc/smile.png") workdir)
(defun export-latex (backend file)
(let ((outfile (export-with backend file ".tex"))
(pdffile (concat cv-workdir file ".pdf")))
(cd cv-workdir)
(message (format "%s exists: %s" outfile (file-exists-p outfile)))
(shell-command (format "xelatex --output-directory=%s %s" cv-workdir outfile) "*Messages*" "*Messages*")
(message (format "%s exists: %s" pdffile (file-exists-p pdffile)))
(copy-file pdffile (concat cv-cwd "/doc/static/" (concat file ".pdf")) t)))
(let ((workfile (concat workdir file))
(outfile (concat workdir file ".tex")))
(message (format "%s exists: %s" workfile (file-exists-p workfile)))
(find-file workfile)
(org-mode)
(org-export-to-file backend outfile)
(shell-command (format "pdflatex %s" outfile) "*Messages*" "*Messages*")
(copy-file (concat file ".pdf") (concat cwd "/doc/static/" (concat file ".pdf")))
))
(let ((readme (concat cv-cwd "readme.org")))
(make-directory cv-workdir t)
(with-current-buffer
(find-file-noselect readme)
(cd cv-workdir)
(org-babel-tangle)))
(copy-file (concat cv-cwd "doc/smile.png") cv-workdir t)
(make-directory (concat cv-cwd "/doc/static/") t)
(make-directory (concat cwd "/doc/static/") t)
(export-latex 'altacv "altacv.org")
(export-latex 'moderncv "moderncv.org")
(export-latex 'awesomecv2 "awesomecv.org")
(export-latex 'awesomecv "awesomecv.org")
(export-latex 'awesomecv "awesome-letter.org")
(copy-file
(export-with 'hugocv "hugocv.org" ".md")
(concat cv-cwd "/doc/content/post/cv.md"))

View file

@ -1,14 +1,11 @@
#!/usr/bin/env bash
wget https://github.com/gohugoio/hugo/releases/download/v0.100.2/hugo_0.100.2_Linux-64bit.deb
wget https://github.com/gohugoio/hugo/releases/download/v0.39/hugo_0.39_Linux-64bit.deb
dpkg -i hugo*.deb
echo "Installed Hugo:"
hugo version
# These installs could be moved to the Dockerfile
apt-get update && apt-get --no-install-recommends install -y texlive-luatex fonts-font-awesome
# Latex
latexdir=/root/texmf/tex/latex
mkdir -p $latexdir
@ -18,6 +15,3 @@ unzip -j sections.zip -d $latexdir/AltaCV
echo "Install moderncv"
wget https://github.com/Titan-C/moderncv/archive/master.zip
unzip -j master.zip -d $latexdir/moderncv
echo "Install AwesomeCV"
wget -O awesomecv.zip https://github.com/posquit0/Awesome-CV/archive/refs/heads/master.zip
unzip awesomecv.zip -d $latexdir

View file

@ -28,55 +28,43 @@
;;; Code:
(require 'org)
(require 'ox)
(require 'org-element)
(defun org-cv-utils-org-timestamp-to-shortdate (date_str)
"Format orgmode timestamp DATE_STR into a short form date.
"Format orgmode timestamp DATE_STR into a short form date.
Other strings are just returned unmodified
e.g. <2012-08-12 Mon> => Aug 2012
e.g. <2002-08-12 Mon> => Aug 2012
today => today"
(if (string-match (org-re-timestamp 'all) date_str)
(let* ((dte (org-parse-time-string date_str))
(if (string-match (org-re-timestamp 'active) date_str)
(let* ((abbreviate 't)
(dte (org-parse-time-string date_str))
(month (nth 4 dte))
(year (nth 5 dte))) ;;'(02 07 2015)))
(concat
(calendar-month-name month 'abbreviate) " " (number-to-string year)))
(calendar-month-name month abbreviate) " " (number-to-string year)))
date_str))
(defun org-cv-utils--format-time-window (from-date to-date)
"Join date strings in a time window.
"Join date strings in a time window.
FROM-DATE -- TO-DATE
in case TO-DATE is nil return Present.
If both dates are the same, return just FROM-DATE"
(let ((from (org-cv-utils-org-timestamp-to-shortdate from-date))
(to (if (not to-date) "Present"
(org-cv-utils-org-timestamp-to-shortdate to-date))))
(if (or (string= from to))
from
(concat from " -- " to))))
in case TO-DATE is nil return Present"
(concat
(org-cv-utils-org-timestamp-to-shortdate from-date)
" -- "
(if (not to-date) "Present"
(org-cv-utils-org-timestamp-to-shortdate to-date))))
(defun org-cv-utils--parse-cventry (headline info)
"Return alist describing the entry in HEADLINE.
INFO is a plist used as a communication channel."
(let* ((title (org-export-data (org-element-property :title headline) info))
(date (org-element-property :DATE headline))
(from-date (or (org-element-property :FROM headline)
date
(user-error "No FROM property provided for cventry %s" title)))
(to-date (or (org-element-property :TO headline) date))
(host (or (org-element-property :HOST headline)
(org-element-property :ORGANIZATION headline)
(org-element-property :INSTITUTION headline)
(org-element-property :SCHOOL headline)
(org-element-property :EMPLOYER headline)
(org-element-property :EVENT headline) "")))
"Return alist describing the entry
INFO is a plist used
as a communication channel."
(let ((title (org-export-data (org-element-property :title headline) info)))
`((title . ,title)
(date . , (org-cv-utils--format-time-window from-date to-date))
(host . ,host)
(location . ,(or (org-element-property :LOCATION headline) ""))
(image . ,(org-element-property :IMAGE headline)))))
(from-date . ,(or (org-element-property :FROM headline)
(error "No FROM property provided for cventry %s" title)))
(to-date . ,(org-element-property :TO headline))
(employer . ,(org-element-property :EMPLOYER headline))
(location . ,(or (org-element-property :LOCATION headline) "")))))
(provide 'org-cv-utils)
;;; org-cv-utils.el ends here
;;; org-cv-utils ends here

View file

@ -37,7 +37,7 @@
(add-to-list 'org-latex-classes
'("altacv"
"\\documentclass{altacv}"
("\n\\section{%s}" . "\n\\section*{%s}")
("\\section{%s}" . "\\section*{%s}")
("\\subsection{%s}" . "\\subsection*{%s}")
("\\subsubsection{%s}" . "\\subsubsection*{%s}"))))
@ -83,7 +83,8 @@
colorlinks=true,
urlcolor=olive!50!black!30!green,
}
")
"
)
;;;; Template
;;
;; Template used is similar to the one used in `latex' back-end,
@ -194,10 +195,11 @@ CONTENTS holds the contents of the headline. INFO is a plist used
as a communication channel."
(let* ((entry (org-cv-utils--parse-cventry headline info))
(divider (if (org-export-last-sibling-p headline info) "\n" "\\divider")))
(format "\n\\cvevent{%s}{%s}{%s}{%s}%s\n%s\n\n"
(format "\n\\cvevent{%s}{%s}{%s}{%s}%s\n%s"
(alist-get 'title entry)
(alist-get 'host entry)
(alist-get 'date entry)
(alist-get 'employer entry)
(org-cv-utils--format-time-window (alist-get 'from-date entry)
(alist-get 'to-date entry))
(alist-get 'location entry) contents divider)))
;;;; Headline
@ -206,11 +208,11 @@ as a communication channel."
CONTENTS is the contents of the headline. INFO is a plist used
as a communication channel."
(unless (org-element-property :footnote-section-p headline)
(let ((environment (cons (org-element-property :CV_ENV headline)
(org-export-get-tags headline info))))
(let ((environment (let ((env (org-element-property :CV_ENV headline)))
(or (org-string-nw-p env) "block"))))
(cond
;; is a cv entry
((member "cventry" environment)
((equal environment "cventry")
(org-altacv--format-cventry headline contents info))
((org-export-with-backend 'latex headline contents info))))))

View file

@ -1,445 +0,0 @@
;;; ox-awesomecv.el --- LaTeX awesomecv Back-End for Org Export Engine -*- lexical-binding: t; -*-
;; Copyright (C) 2018 Free Software Foundation, Inc.
;; Author: Diego Zamboni <diego@zzamboni.org> based on work by Oscar Najera <hi AT oscarnajera.com DOT com>
;; Keywords: org, wp, tex
;; This file is not part of GNU Emacs.
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;; Commentary:
;;
;; This library implements a LaTeX awesomecv back-end, derived from the
;; LaTeX one.
;;; Code:
(require 'ox-latex)
(require 'org-cv-utils)
;; Install a default set-up for awesomecv export.
(unless (assoc "awesomecv" org-latex-classes)
(add-to-list 'org-latex-classes
'("awesomecv"
"\\documentclass{awesome-cv}\n[NO-DEFAULT-PACKAGES]"
("\\cvsection{%s}" . "\\cvsection{%s}")
("\\cvsubsection{%s}" . "\\cvsubsection{%s}")
("\\subsection{%s}" . "\\subsection*{%s}")
("\\subsubsection{%s}" . "\\subsubsection*{%s}")
("\\cvparagraph{%s}" . "\\cvparagraph{%s}"))))
;;; User-Configurable Variables
(defgroup org-export-cv nil
"Options specific for using the awesomecv class in LaTeX export."
:tag "Org awesomecv"
:group 'org-export
:version "25.3")
;;; Define Back-End
(org-export-define-derived-backend 'awesomecv 'latex
; :menu-entry
; (?l 1
; ((?w "AwesomeCV format" (lambda (a s v b) (org-export-to-file 'awesomecv (org-export-output-file-name ".tex"))))))
:options-alist
'((:latex-class "LATEX_CLASS" nil "awesomecv" t)
(:cvstyle "CVSTYLE" nil "classic" t)
(:cvcolor "CVCOLOR" nil "awesome-red" t)
(:cvcolorizelinks "CVCOLORIZELINKS" nil nil t)
(:cvunderlinelinks "CVUNDERLINELINKS" nil nil t)
(:mobile "MOBILE" nil nil parse)
(:homepage "HOMEPAGE" nil nil parse)
(:address "ADDRESS" nil nil newline)
(:photo "PHOTO" nil nil t)
(:photostyle "PHOTOSTYLE" nil nil t)
(:gitlab "GITLAB" nil nil parse)
(:github "GITHUB" nil nil parse)
(:leanpub "LEANPUB" nil nil parse)
(:linkedin "LINKEDIN" nil nil parse)
(:twitter "TWITTER" nil nil parse)
(:stackoverflow "STACKOVERFLOW" nil nil split)
(:extrainfo "EXTRAINFO" nil nil parse)
(:with-email nil "email" t t)
(:fontdir "FONTDIR" nil "fonts/" t)
(:latex-title-command "LATEX_TITLE" nil "\\makecvheader" t)
(:cvhighlights "CVHIGHLIGHTS" nil "true" t)
(:quote "QUOTE" nil nil t)
(:firstname "FIRSTNAME" nil nil t)
(:lastname "LASTNAME" nil nil t)
(:cvfooter_left "CVFOOTER_LEFT" nil nil t)
(:cvfooter_middle "CVFOOTER_MIDDLE" nil nil t)
(:cvfooter_right "CVFOOTER_RIGHT" nil nil t))
:translate-alist '((template . org-awesomecv-template)
(headline . org-awesomecv-headline)
(plain-list . org-awesomecv-plain-list)
(item . org-awesomecv-item)
(property-drawer . org-awesomecv-property-drawer)))
;;;; Template
;;
;; Template used is similar to the one used in `latex' back-end,
;; excepted for the table of contents and awesomecv themes.
(defun org-awesomecv-template (contents info)
"Return complete document string after LaTeX conversion.
CONTENTS is the transcoded contents string. INFO is a plist
holding export options."
(let ((title (org-export-data (plist-get info :title) info))
(spec (org-latex--format-spec info)))
(concat
;; Time-stamp.
(and (plist-get info :time-stamp-file)
(format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
;; LaTeX compiler.
(org-latex--insert-compiler info)
;; Document class and packages.
(org-latex-make-preamble info nil t)
;; Possibly limit depth for headline numbering.
(let ((sec-num (plist-get info :section-numbers)))
(when (integerp sec-num)
(format "\\setcounter{secnumdepth}{%d}\n" sec-num)))
(format "\\fontdir[%s]\n" (plist-get info :fontdir))
(format "\\colorlet{awesome}{%s}\n" (plist-get info :cvcolor))
(format "\\setbool{acvSectionColorHighlight}{%s}\n" (plist-get info :cvhighlights))
(let ((cvcolorizelinks (plist-get info :cvcolorizelinks))
(cvunderlinelinks (plist-get info :cvunderlinelinks)))
(concat
(when (and (org-string-nw-p cvcolorizelinks)
(not (string-equal cvcolorizelinks "false")))
(format "\\colorizelinks%s\n"
(if (not (string-equal cvcolorizelinks "true"))
(format "[%s]" cvcolorizelinks) "")))
(when (and (org-string-nw-p cvunderlinelinks)
(not (string-equal cvunderlinelinks "false")))
(format "\\underlinelinks%s\n"
(if (not (string-equal cvunderlinelinks "true"))
(format "[%s]" cvunderlinelinks) "")))))
;; Author. If FIRSTNAME or LASTNAME are not given, try to deduct
;; their values by splitting AUTHOR on white space.
(let* ((author (split-string (org-export-data (plist-get info :author) info)))
(first-name-prop (org-export-data (plist-get info :firstname) info))
(last-name-prop (org-export-data (plist-get info :lastname) info))
(first-name (or (org-string-nw-p first-name-prop) (car author)))
(last-name (or (org-string-nw-p last-name-prop) (cadr author))))
(format "\\name{%s}{%s}\n" first-name last-name))
;; Title
(format "\\position{%s}\n" title)
;; photo
(let* ((photo (plist-get info :photo))
(photo-style (plist-get info :photostyle))
(style-str (if photo-style (format "[%s]" photo-style) "")))
(when (org-string-nw-p photo) (format "\\photo%s{%s}\n" style-str photo)))
;; address
(let ((address (org-export-data (plist-get info :address) info)))
(when (org-string-nw-p address)
(format "\\address{%s}\n" (mapconcat (lambda (line)
(format "%s" line))
(split-string address "\n") " -- "))))
;; email
(let ((email (and (plist-get info :with-email)
(org-export-data (plist-get info :email) info))))
(when (org-string-nw-p email)
(format "\\email{%s}\n" email)))
;; Other pieces of information
(mapconcat (lambda (info-key)
(let ((info (org-export-data (plist-get info info-key) info)))
(when (org-string-nw-p info) (format "\\%s{%s}\n"
(substring (symbol-name info-key) 1)
info))))
'(:mobile
:homepage
:github
:gitlab
:leanpub
:linkedin
:twitter
:skype
:reddit
:extrainfo)
"")
;; Stack overflow requires two values: ID and name
(let* ((so-list (plist-get info :stackoverflow))
(so-id (when so-list (car so-list)))
(so-name (when so-list (cadr so-list))))
(when (and (org-string-nw-p so-id) (org-string-nw-p so-name))
(format "\\stackoverflow{%s}{%s}\n" so-id so-name)))
;; Hyperref options.
(let ((template (plist-get info :latex-hyperref-template)))
(and (stringp template)
(format-spec template spec)))
;; quote
(let ((quote (plist-get info :quote)))
(when quote
(format "\\quote{%s}\n" quote)))
;; Document start.
"\\begin{document}\n\n"
;; Title command.
(let* ((title-command (plist-get info :latex-title-command))
(command (and (stringp title-command)
(format-spec title-command spec))))
(org-element-normalize-string
(cond ((not (plist-get info :with-title)) nil)
((string= "" title) nil)
((not (stringp command)) nil)
((string-match "\\(?:[^%]\\|^\\)%s" command)
(format command title))
(t command))))
;; Footer command
(let* ((footer-left (format-spec (or (plist-get info :cvfooter_left) "") spec))
(footer-mid (format-spec (or (plist-get info :cvfooter_middle) "") spec))
(footer-right (format-spec (or (plist-get info :cvfooter_right) "") spec)))
(when (not (string= "" (concat footer-left footer-mid footer-right)))
(format "\\makecvfooter{%s}{%s}{%s}\n" footer-left footer-mid footer-right)))
;; Document's body.
contents
;; Creator.
(and (plist-get info :with-creator)
(concat (plist-get info :creator) "\n"))
;; Document end.
"\\end{document}")))
;;;; Produce latex code for a right-float image
(defun org-awesomecv--cventry-right-img-code (file)
(if file
(format "\\begin{wrapfigure}{r}{0.15\\textwidth}
\\raggedleft\\vspace{-4.0mm}
\\includegraphics[width=0.1\\textwidth]{%s}
\\end{wrapfigure}" file) ""))
;;;; Individual cventry/cvsubentry/cvemployer/cvschool headlines
(defun org-awesomecv--format-cventry (headline contents info)
"Format HEADLINE as as cventry.
CONTENTS holds the contents of the headline. INFO is a plist used
as a communication channel."
(let* ((entrytype
(cl-find-if (lambda (s) (or (string-prefix-p "cv" s)
(string-prefix-p "letter" s)))
(cons (org-element-property :CV_ENV headline)
(org-export-get-tags headline info))))
(title (org-export-data (org-element-property :title headline) info))
(date (org-element-property :DATE headline))
(from-date (or (org-element-property :FROM headline) date))
(to-date (or (org-element-property :TO headline) date))
(employer (or (org-element-property :ORGANIZATION headline)
(org-element-property :SCHOOL headline)
(org-element-property :EMPLOYER headline)
(org-element-property :EVENT headline)
(org-element-property :POSITION headline) ""))
(location (or (org-element-property :LOCATION headline) ""))
(right-img (org-element-property :RIGHT_IMG headline))
(label (or (org-element-property :LABEL headline) nil))
(label-str (if label (format "%s\\hfill{}" label) ""))
;; Other Coverletter properties
(recipient (or (org-element-property :RECIPIENT headline) ""))
(letter-dateformat (org-element-property :DATEFORMAT headline))
(letter-date
(format "\\letterdate{%s}"
(if date
(format "%s" (org-awesomecv-org-timestamp-to-dateformat date letter-dateformat t))
"\\today")))
(letter-opening (if (org-element-property :LETTER_OPENING headline)
(format "\\letteropening{%s}" (org-element-property :LETTER_OPENING headline))
""))
(letter-closing (if (org-element-property :LETTER_CLOSING headline)
(format "\\letterclosing{%s}" (org-element-property :LETTER_CLOSING headline))
""))
(letter-signature (if (org-element-property :LETTER_SIGNATURE headline)
(format "\\lettersignature{%s}" (org-element-property :LETTER_SIGNATURE headline))
""))
(letter-attached (if (org-element-property :LETTER_ATTACHED headline)
(format "\\letterenclosure[Attached]{%s}" (org-element-property :LETTER_ATTACHED headline))
"")))
(cond
((string= entrytype "cvemployer")
(format "\n\\cventry{%s}{%s}{}{}{}\n%s\n"
title
(format "%s\\hfill %s" (org-cv-utils--format-time-window from-date to-date) location)
contents)
)
((string= entrytype "cventry")
(format "\n\\cventry\n{%s}\n{%s}\n{%s}\n{%s}\n{%s%s}\n"
title
employer
location
(org-cv-utils--format-time-window from-date to-date)
(org-awesomecv--cventry-right-img-code right-img)
contents))
((string= entrytype "cvsubentry")
(format "\n\\cvsubentry\n{%s}\n{%s}\n{%s%s}\n"
title
(format "%s%s" label-str (org-cv-utils--format-time-window from-date to-date))
(org-awesomecv--cventry-right-img-code right-img)
contents))
((string= entrytype "cvschool")
(format "\n\\cventry\n{%s}\n{%s}\n{%s}\n{%s}\n{%s%s}\n"
title
location
employer
(org-cv-utils--format-time-window from-date to-date)
(org-awesomecv--cventry-right-img-code right-img)
contents))
((string= entrytype "cvhonor")
(format "\n\\cvhonor\n{%s}\n{%s}\n{%s}\n{%s}\n"
title
employer
location
(org-cv-utils--format-time-window from-date to-date)))
;; Coverletter sections
((string= entrytype "letterheader")
(format "\\recipient\n {%s}\n {%s%s%s}\n\n%s\n%s\n%s\n%s\n%s\n"
recipient
employer
(if (and employer location) "\\\\" "")
location
letter-date
letter-opening
letter-closing
letter-signature
letter-attached))
((string= entrytype "cvletter")
(format "\n\\lettertitle{%s}\n\\makelettertitle\n\n\\begin{cvletter}\n%s\n\\end{cvletter}\n\\makeletterclosing"
title
contents))
((string= entrytype "cvletter_notitle")
(format "\n\\makelettertitle\n\n\\begin{cvletter}\n%s\n\\end{cvletter}\n\\makeletterclosing"
contents))
((string= entrytype "lettersection")
(format "\n\\lettersection{%s}\n%s"
title
contents)))))
;;;; Headlines of type "cventries"
(defun org-awesomecv--format-cvenvironment (environment headline contents info)
"Format HEADLINE as as a cventries/cvhonors environment.
CONTENTS holds the contents of the headline. INFO is a plist used
as a communication channel."
(format "%s\n\\begin{%s}\n%s\\end{%s}\n"
(org-export-with-backend 'latex headline nil info)
environment contents environment))
;;;; Headline
(defun org-awesomecv-headline (headline contents info)
"Transcode HEADLINE element into awesomecv code.
CONTENTS is the contents of the headline. INFO is a plist used
as a communication channel."
(unless (org-element-property :footnote-section-p headline)
(let ((environment (cons (org-element-property :CV_ENV headline)
(org-export-get-tags headline info)))
(pagebreak (org-string-nw-p (org-element-property :PAGEBREAK headline))))
(concat
(when pagebreak "\\clearpage\n")
(cond
;; is a cv entry or subentry
((seq-intersection environment '("cventry"
"cvsubentry"
"cvemployer"
"cvschool"
"cvhonor"
"cvletter"
"cvletter_notitle"
"lettersection"
"letterheader"))
(org-awesomecv--format-cventry headline contents info))
((seq-intersection environment '("cventries" "cvhonors"))
(org-awesomecv--format-cvenvironment
(car (seq-intersection environment '("cventries" "cvhonors"))) headline contents info))
((org-export-with-backend 'latex headline contents info)))))))
;;;; Plain List, to intercept and transform "cvskills" lists
(defun org-awesomecv-plain-list (plain-list contents info)
"Transcode a PLAIN-LIST element from Org to LaTeX.
CONTENTS is the contents of the list. INFO is a plist holding
contextual information."
(let* ((cv-env (org-entry-get (org-element-property :begin plain-list) "CV_ENV" nil))
(parent-type (car (org-element-property :parent plain-list))))
(cond
((string= cv-env "cvskills")
(format "\\begin{cvskills}\n%s\\end{cvskills}" contents))
((and (eq parent-type 'section) (or (string= cv-env "cventry") (string= cv-env "cvsubentry") (string= cv-env "cvschool")))
(format "\\begin{cvitems}\n%s\\end{cvitems}" contents))
(t
(org-latex-plain-list plain-list contents info)))))
;;;; Item, to intercept and transform "cvskills" lists
(defun org-awesomecv-item (item contents info)
(let* ((cv-env (org-entry-get (org-element-property :begin item) "CV_ENV" t))
(tag (let ((tag (org-element-property :tag item)))
(and tag (org-export-data tag info)))))
(if (and (string= cv-env "cvskills") tag)
(format "\\cvskill{%s}{%s}\n" tag (org-trim contents))
(org-latex-item item contents info))
)
)
;;;; Property Drawer, to avoid exporting them even when the option is set
(defun org-latex-property-drawer (property-drawer contents info)
"Transcode a PROPERTY-DRAWER element from Org to AwesomeCV.
This does not make sense in the AwesomeCV format, so it only
returns an empty string."
nil)
(defun org-awesomecv-org-timestamp-to-dateformat (date_str &optional FORMAT-STRING ORDINAL)
"Format orgmode timestamp DATE_STR into a date format FORMAT-STRING.
ORDINAL returns the date as an ordinal number, specified as %E in format.
Uses defaults that are consistent with awesomecv.
Other strings are just returned unmodified
e.g. <2002-08-12 Mon> => August 12th, 2012
today => today"
(if (string-match (org-re-timestamp 'active) date_str)
(let* ((dte (org-parse-time-string date_str))
(time (encode-time dte))
(day-format (if ORDINAL "%E" "%e"))
(format-string-0 (or FORMAT-STRING
(if (eql calendar-date-style 'american)
(format "%%B %s, %%Y" day-format)
(format "%s %%B, %%Y" day-format))))
(day-raw (format-time-string "%eth" time))
(day-ordinal
(let ((r0 "\\([04-9]\\|1[0-9]\\)th$")
(r1 "\\([1]\\)th$" )
(r2 "\\([2]\\)th$" )
(r3 "\\([3]\\)th$" )
)
(cond
((string-match r0 day-raw) (replace-regexp-in-string r0 "\\1th" day-raw))
((string-match r1 day-raw) (replace-regexp-in-string r1 "\\1st" day-raw))
((string-match r2 day-raw) (replace-regexp-in-string r2 "\\1nd" day-raw))
((string-match r3 day-raw) (replace-regexp-in-string r3 "\\1rd" day-raw )))))
(format-string (replace-regexp-in-string "%E" day-ordinal format-string-0 't)))
(format-time-string format-string time))
date_str))
(provide 'ox-awesomecv)
;;; ox-awesomecv ends here

View file

@ -1,307 +0,0 @@
;;; ox-awesomecv2.el --- LaTeX awesomecv Back-End for Org Export Engine -*- lexical-binding: t; -*-
;; Copyright (C) 2018 Free Software Foundation, Inc.
;; Author: Oscar Najera <hi AT oscarnajera.com DOT com>
;; Maintainer: Óscar Nájera <hi@oscarnajera.com>
;; This file is not part of GNU Emacs.
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;;
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;; Commentary:
;;
;; This library implements a LaTeX awesomecv back-end, derived from the
;; LaTeX one.
;;; Code:
(require 'ox-latex)
(require 'org-cv-utils)
;; Install a default set-up for awesomecv export.
(unless (assoc "awesomecv" org-latex-classes)
(add-to-list 'org-latex-classes
'("awesomecv"
"\\documentclass{awesome-cv}\n[NO-DEFAULT-PACKAGES]"
("\n\\cvsection{%s}" . "\n\\cvsection{%s}")
("\\cvsubsection{%s}" . "\\cvsubsection{%s}")
("\\subsection{%s}" . "\\subsection*{%s}")
("\\subsubsection{%s}" . "\\subsubsection*{%s}")
("\\cvparagraph{%s}" . "\\cvparagraph{%s}"))))
;;; User-Configurable Variables
(defgroup org-export-cv nil
"Options specific for using the awesomecv class in LaTeX export."
:tag "Org awesomecv"
:group 'org-export
:version "25.3")
;;; Define Back-End
(org-export-define-derived-backend 'awesomecv2 'latex
;; :menu-entry
;; (?l 1
;; ((?w "AwesomeCV format" (lambda (a s v b) (org-export-to-file 'awesomecv (org-export-output-file-name ".tex"))))))
:options-alist
'((:latex-class "LATEX_CLASS" nil "awesomecv" t)
(:cvstyle "CVSTYLE" nil "classic" t)
(:cvcolor "CVCOLOR" nil "awesome-red" t)
(:cvcolorizelinks "CVCOLORIZELINKS" nil nil t)
(:cvunderlinelinks "CVUNDERLINELINKS" nil nil t)
(:mobile "MOBILE" nil nil parse)
(:homepage "HOMEPAGE" nil nil parse)
(:address "ADDRESS" nil nil newline)
(:photo "PHOTO" nil nil t)
(:photostyle "PHOTOSTYLE" nil nil t)
(:gitlab "GITLAB" nil nil parse)
(:github "GITHUB" nil nil parse)
(:leanpub "LEANPUB" nil nil parse)
(:linkedin "LINKEDIN" nil nil parse)
(:twitter "TWITTER" nil nil parse)
(:stackoverflow "STACKOVERFLOW" nil nil split)
(:extrainfo "EXTRAINFO" nil nil parse)
(:with-email nil "email" t t)
(:fontdir "FONTDIR" nil "fonts/" t)
(:latex-title-command "LATEX_TITLE" nil "\\makecvheader" t)
(:cvhighlights "CVHIGHLIGHTS" nil "true" t)
(:quote "QUOTE" nil nil t)
(:firstname "FIRSTNAME" nil nil t)
(:lastname "LASTNAME" nil nil t)
(:cvfooter_left "CVFOOTER_LEFT" nil nil t)
(:cvfooter_middle "CVFOOTER_MIDDLE" nil nil t)
(:cvfooter_right "CVFOOTER_RIGHT" nil nil t))
:translate-alist '((template . org-cv-awesome2-template)
(headline . org-cv-awesome2-headline)
(plain-list . org-cv-awesome2-plain-list)
(item . org-cv-awesome2-item)
(property-drawer . ignore)))
;;;; Template
;;
;; Template used is similar to the one used in `latex' back-end,
;; excepted for the table of contents and awesomecv themes.
(defun org-cv-awesome2-template (contents info)
"Return complete document string after LaTeX conversion.
CONTENTS is the transcoded contents string. INFO is a plist
holding export options."
(let ((title (org-export-data (plist-get info :title) info))
(spec (org-latex--format-spec info)))
(concat
;; Time-stamp.
(and (plist-get info :time-stamp-file)
(format-time-string "%% Created %Y-%m-%d %a %H:%M\n"))
;; LaTeX compiler.
(org-latex--insert-compiler info)
;; Document class and packages.
(org-latex-make-preamble info nil t)
;; Possibly limit depth for headline numbering.
(let ((sec-num (plist-get info :section-numbers)))
(when (integerp sec-num)
(format "\\setcounter{secnumdepth}{%d}\n" sec-num)))
(format "\\fontdir[%s]\n" (plist-get info :fontdir))
(format "\\colorlet{awesome}{%s}\n" (plist-get info :cvcolor))
(format "\\setbool{acvSectionColorHighlight}{%s}\n" (plist-get info :cvhighlights))
(let ((cvcolorizelinks (plist-get info :cvcolorizelinks))
(cvunderlinelinks (plist-get info :cvunderlinelinks)))
(concat
(when (and (org-string-nw-p cvcolorizelinks)
(not (string-equal cvcolorizelinks "false")))
(format "\\colorizelinks%s\n"
(if (not (string-equal cvcolorizelinks "true"))
(format "[%s]" cvcolorizelinks) "")))
(when (and (org-string-nw-p cvunderlinelinks)
(not (string-equal cvunderlinelinks "false")))
(format "\\underlinelinks%s\n"
(if (not (string-equal cvunderlinelinks "true"))
(format "[%s]" cvunderlinelinks) "")))))
;; Author. If FIRSTNAME or LASTNAME are not given, try to deduct
;; their values by splitting AUTHOR on white space.
(let* ((author (split-string (org-export-data (plist-get info :author) info)))
(first-name-prop (org-export-data (plist-get info :firstname) info))
(last-name-prop (org-export-data (plist-get info :lastname) info))
(first-name (or (org-string-nw-p first-name-prop) (car author)))
(last-name (or (org-string-nw-p last-name-prop) (cadr author))))
(format "\\name{%s}{%s}\n" first-name last-name))
;; Title
(format "\\position{%s}\n" title)
;; photo
(let* ((photo (plist-get info :photo))
(photo-style (plist-get info :photostyle))
(style-str (if photo-style (format "[%s]" photo-style) "")))
(when (org-string-nw-p photo) (format "\\photo%s{%s}\n" style-str photo)))
;; address
(let ((address (org-export-data (plist-get info :address) info)))
(when (org-string-nw-p address)
(format "\\address{%s}\n" (mapconcat (lambda (line)
(format "%s" line))
(split-string address "\n") " -- "))))
;; email
(let ((email (and (plist-get info :with-email)
(org-export-data (plist-get info :email) info))))
(when (org-string-nw-p email)
(format "\\email{%s}\n" email)))
;; Other pieces of information
(mapconcat (lambda (info-key)
(let ((info (org-export-data (plist-get info info-key) info)))
(when (org-string-nw-p info) (format "\\%s{%s}\n"
(substring (symbol-name info-key) 1)
info))))
'(:mobile
:homepage
:github
:gitlab
:leanpub
:linkedin
:twitter
:skype
:reddit
:extrainfo)
"")
;; Stack overflow requires two values: ID and name
(let* ((so-list (plist-get info :stackoverflow))
(so-id (when so-list (car so-list)))
(so-name (when so-list (cadr so-list))))
(when (and (org-string-nw-p so-id) (org-string-nw-p so-name))
(format "\\stackoverflow{%s}{%s}\n" so-id so-name)))
;; Hyperref options.
(let ((template (plist-get info :latex-hyperref-template)))
(and (stringp template)
(format-spec template spec)))
;; Document start.
"\\begin{document}\n\n"
;; Title command.
(let* ((title-command (plist-get info :latex-title-command))
(command (and (stringp title-command)
(format-spec title-command spec))))
(org-element-normalize-string
(cond ((not (plist-get info :with-title)) nil)
((string= "" title) nil)
((not (stringp command)) nil)
((string-match "\\(?:[^%]\\|^\\)%s" command)
(format command title))
(t command))))
;; Footer command
(let* ((footer-left (format-spec (or (plist-get info :cvfooter_left) "") spec))
(footer-mid (format-spec (or (plist-get info :cvfooter_middle) "") spec))
(footer-right (format-spec (or (plist-get info :cvfooter_right) "") spec)))
(when (not (string= "" (concat footer-left footer-mid footer-right)))
(format "\\makecvfooter{%s}{%s}{%s}\n" footer-left footer-mid footer-right)))
;; Document's body.
contents
;; Creator.
(and (plist-get info :with-creator)
(concat (plist-get info :creator) "\n"))
;; Document end.
"\\end{document}")))
;;;; Produce latex code for a right-float image
(defun org-cv-awesome2--cventry-right-img-code (file)
"Include the image on FILE."
(if file
(format "\\begin{wrapfigure}{r}{0.15\\textwidth}
\\raggedleft\\vspace{-4.0mm}
\\includegraphics[width=0.1\\textwidth]{%s}
\\end{wrapfigure}" file) ""))
;;;; Individual cventry/cvsubentry/cvemployer/cvschool headlines
(defun org-cv-awesome2--entry (headline contents info)
"Format HEADLINE as as cventry.
CONTENTS holds the contents of the headline. INFO is a plist used
as a communication channel."
(let* ((entrytags (org-element-property :tags headline))
(element (cl-find-if (lambda (s) (string-prefix-p "cv" s)) entrytags))
(entry (org-cv-utils--parse-cventry headline info)))
;; Usage: \cvhonor{<position>}{<title>}{<location>}{<date>}
;; Usage: \cventry{<position>}{<title>}{<location>}{<date>}{<description>}
(if (member element '("cventry" "cvhonor"))
(format "\n\\%s%s%s\n"
element
(mapconcat (lambda (s) (format "{%s}" (alist-get s entry)))
'(title host location date)
"")
(if (string= "cventry" element)
(concat "{" contents "}")
""))
(user-error "Incorrect section %s" (alist-get 'title entry)))))
;;;; Headlines of type "cventries"
(defun org-cv-awesome2--format-cvenvironment (environment headline contents info)
"Format HEADLINE as a cventries/cvhonors ENVIRONMENT.
CONTENTS holds the contents of the headline. INFO is a plist used
as a communication channel."
(format "%s\n\\begin{%s}\n%s\\end{%s}\n"
(org-export-with-backend 'latex headline nil info)
environment contents environment))
;;; Headline
(defun org-cv-awesome2-headline (headline contents info)
"Transcode HEADLINE element into moderncv code.
CONTENTS is the contents of the headline. INFO is a plist used
as a communication channel."
(unless (org-element-property :footnote-section-p headline)
(let ((environment (cons (org-element-property :CV_ENV headline)
(org-export-get-tags headline info))))
(cond
;; is a cv entry
((seq-intersection environment '("cventries" "cvhonors"))
(org-cv-awesome2--format-cvenvironment
(car (seq-intersection environment '("cventries" "cvhonors"))) headline contents info))
((seq-intersection environment '("cventry" "cvhonor"))
(org-cv-awesome2--entry headline contents info))
((org-export-with-backend 'latex headline contents info))))))
;;;; Plain List, to intercept and transform "cvskills" lists
(defun org-cv-awesome2-plain-list (plain-list contents info)
"Transcode a PLAIN-LIST element from Org to LaTeX.
CONTENTS is the contents of the list. INFO is a plist holding
contextual information."
(let* ((type (org-element-property :type plain-list))
(tags (org-export-get-tags plain-list info nil 'inherited))
(parent-type (car (org-element-property :parent plain-list))))
(cond
((and (eq type 'descriptive) (member "skills" tags))
(format "\\begin{cvskills}\n%s\\end{cvskills}" contents))
((and (eq parent-type 'section) (seq-intersection tags '("cventry" "cvsubentry" "cvschool")))
(format "\\begin{cvitems}\n%s\\end{cvitems}" contents))
(t
(org-latex-plain-list plain-list contents info)))))
;;;; Item, to intercept and transform "skills" lists
(defun org-cv-awesome2-item (item contents info)
"Transcode an ITEM element from Org to awesomecv LaTeX.
CONTENTS holds the contents of the item. INFO is a plist holding
contextual information."
(let* ((env-tags (org-export-get-tags item info nil 'inherited))
(label (let ((tag (org-element-property :tag item)))
(and tag (org-export-data tag info)))))
(if (and (member "skills" env-tags) label)
(format "\\cvskill{%s}{%s}\n" label (org-trim contents))
(org-latex-item item contents info))))
(provide 'ox-awesomecv2)
;;; ox-awesomecv2.el ends here

View file

@ -1,6 +1,5 @@
;;; ox-hugocv.el --- LaTeX hugocv Back-End for Org Export Engine -*- lexical-binding: t; -*-
;; Package-Requires: ((emacs "28.1") (dash "2.19.1"))
;; Copyright (C) 2018 Free Software Foundation, Inc.
;; Author: Oscar Najera <hi AT oscarnajera.com DOT com>
@ -30,13 +29,12 @@
;;; Code:
(require 'ox-hugo)
(require 'dash)
(require 'org-cv-utils)
;;; User-Configurable Variables
(defgroup org-export-hugocv nil
"Options for exporting Org mode files to Hugo-compatible Markdown."
"Options for exporting Org mode files to Hugo-compatible Markdown"
:tag "Org Export Hugo CV"
:group 'org-export
:version "25.3")
@ -44,51 +42,89 @@
;;; Define Back-End
(org-export-define-derived-backend 'hugocv 'hugo
:options-alist
'((:mobile "MOBILE" nil nil parse)
'(
(:mobile "MOBILE" nil nil parse)
(:homepage "HOMEPAGE" nil nil parse)
(:address "ADDRESS" nil nil newline)
(:photo "PHOTO" nil nil parse)
(:gitlab "GITLAB" nil nil parse)
(:github "GITHUB" nil nil parse)
(:linkedin "LINKEDIN" nil nil parse)
(:with-email nil "email" t t))
:translate-alist '((headline . org-hugocv-headline)))
(:with-email nil "email" t t)
)
:translate-alist '((headline . org-hugocv-headline)
(inner-template . org-hugocv-inner-template)))
(defun org-hugocv--entry-with-icon (field entry)
"HTML entry for given FIELD when it is specified in ENTRY."
(cl-ecase field
(host
(-some->> (alist-get 'host entry)
(org-string-nw-p)
(format "%s\n{.cv-host}")))
(date
(-some->>
(alist-get 'date entry)
(format "%s\n{.cv-date}")))
(location
(-some->> (alist-get 'location entry)
(org-string-nw-p)
(format "%s\n{.cv-location}")))))
(setq org-hugocv--recognized-social-networks
'((:url "https://www.github.com/"
:icon "fa-github")
(:url "https://www.gitlab.com/"
:icon "fa-gitlab")
(:url "https://www.linkedin.com/in/"
:icon "fa-linkedin")
(:url "https://twitter.com/"
:icon "fa-twitter")
(:url "https://facebook.com/"
:icon "fa-facebook")
(:url "https://www.instagram.com/"
:icon "fa-instagram")))
(defun org-hugocv--crop-edges (x)
"String is <X> so remove first and last chars."
(let ((le (- (length x) 1)))
(substring x 1 le)))
(defun org-hugocv--format-cventry (headline contents info)
"Format HEADLINE as as cventry.
CONTENTS holds the contents of the headline. INFO is a plist used
as a communication channel."
(let* ((environment (org-export-get-tags headline info))
(env-class (replace-regexp-in-string "^cv" "" (cl-find-if (lambda (s) (string-prefix-p "cv" s)) environment)))
(entry (org-cv-utils--parse-cventry headline info))
(let* ((entry (org-cv-utils--parse-cventry headline info))
(loffset (string-to-number (plist-get info :hugo-level-offset))) ;"" -> 0, "0" -> 0, "1" -> 1, ..
(level (org-export-get-relative-level headline info))
(title (concat (make-string (+ loffset level) ?#) " "
(alist-get 'title entry)
" {.cv-role}")))
(format "<div class=\"cv-%s\">\n\n%s\n\n%s\n\n%s\n</div>"
env-class
title
(mapconcat (lambda (field) (org-hugocv--entry-with-icon field entry))
'(host date location)
"\n")
contents)))
(title (concat (make-string (+ loffset level) ?#) " " (alist-get 'title entry))))
(format "\n%s
<ul class=\"cventry\">
<li class=\"fa fa-building\"> %s</li>
<li class=\"fa fa-map-marker\"> %s</li>
<li class=\"fa fa-calendar\"> %s</li>
</ul>
%s
" title
(alist-get 'employer entry)
(alist-get 'location entry)
(org-cv-utils--format-time-window (alist-get 'from-date entry) (alist-get 'to-date entry))
contents)))
(defun social-entry (icon url handle)
(let* ((nw-handle (string-trim handle))
(icon-wrap (if (org-string-nw-p icon)
(format "<i class=\"fa %s\"> %s</i>" icon nw-handle) nw-handle)))
(format "<a href=\"%s%s\">%s</a>" url nw-handle icon-wrap)))
(defun org-hugocv--unknown-social-channels (headline contents info)
(let ((icon (org-export-data (org-element-property :ICON headline) info))
(url (org-export-data (org-element-property :URL headline) info))
(handle (org-export-data contents info)))
(concat
(if (org-string-nw-p icon) ""
(concat (org-export-data (org-element-property :title headline) info) " : "))
(social-entry icon url handle))))
(defun org-hugocv--pick-social-network (channel contents)
(-any (lambda (network)
(when (string-match-p channel (plist-get network :url))
(social-entry (plist-get network :icon)
(plist-get network :url)
contents)))
recognized-social-networks))
(defun org-hugocv--format-socialchannels (headline contents info)
(let* ((channel (downcase (org-export-data (org-element-property :title headline) info)))
(entry (org-hugocv--pick-social-network channel contents)))
(cond (entry entry)
((org-element-property :URL headline)
(org-hugocv--unknown-social-channels headline contents info))
((org-export-with-backend 'hugo headline contents info)))))
;;;; Headline
(defun org-hugocv-headline (headline contents info)
@ -96,15 +132,33 @@ as a communication channel."
CONTENTS is the contents of the headline. INFO is a plist used
as a communication channel."
(unless (org-element-property :footnote-section-p headline)
(let ((environment (cons (org-element-property :CV_ENV headline)
(org-export-get-tags headline info))))
(let ((environment (let ((env (org-export-get-category headline info)))
(or (org-string-nw-p env) "block"))))
(cond
((cl-find-if (lambda (s) (and (string-prefix-p "cv" s)
;; avoid conflict with awesomecv block environments
(not (member s '("cventries" "cvhonors")))))
environment)
;; is a cv entry
((equal environment "cventry")
(org-hugocv--format-cventry headline contents info))
((equal environment "social")
(org-hugocv--format-socialchannels headline contents info))
((org-export-with-backend 'hugo headline contents info))))))
(defun org-hugocv-inner-template (contents info)
"Return body of document after converting it to Hugo-compatible Markdown.
CONTENTS is the transcoded contents string. INFO is a plist
holding export options."
(concat "<ul id=\"cvcontacts\">\n"
;; email
(let ((email (and (plist-get info :with-email)
(org-export-data (plist-get info :email) info))))
(when (org-string-nw-p email)
(social-entry "fa-envelope" "mailto:" email)))
;; homepage
(let ((homepage (org-hugocv--crop-edges (org-export-data (plist-get info :homepage) info))))
(when (org-string-nw-p homepage)
(social-entry "fa-globe" "" homepage)))
"</ul>\n\n"
(org-hugo-inner-template contents info)))
(provide 'ox-hugocv)
;;; ox-hugocv.el ends here
;;; ox-hugocv ends here

View file

@ -55,7 +55,7 @@
:options-alist
'((:latex-class "LATEX_CLASS" nil "moderncv" t)
(:cvstyle "CVSTYLE" nil "classic" t)
(:cvcolor "CVCOLOR" nil "blue" t)
(:cvcolor "CVCOLOR" nil nil t)
(:mobile "MOBILE" nil nil parse)
(:homepage "HOMEPAGE" nil nil parse)
(:address "ADDRESS" nil nil newline)
@ -185,10 +185,12 @@ CONTENTS holds the contents of the headline. INFO is a plist used
as a communication channel."
(let* ((entry (org-cv-utils--parse-cventry headline info))
(note (or (org-element-property :NOTE headline) "")))
(format "\\cventry{%s}{%s}{%s}{%s}{%s}{%s}\n"
(alist-get 'date entry)
(format "\\cventry{\\textbf{%s}}{%s}{%s}{%s}{%s}{%s}\n"
(org-cv-utils--format-time-window (alist-get 'from-date entry)
(alist-get 'to-date entry))
(alist-get 'title entry)
(alist-get 'host entry)
(alist-get 'employer entry)
(alist-get 'location entry)
note contents)))
@ -198,11 +200,11 @@ as a communication channel."
CONTENTS is the contents of the headline. INFO is a plist used
as a communication channel."
(unless (org-element-property :footnote-section-p headline)
(let ((environment (cons (org-element-property :CV_ENV headline)
(org-export-get-tags headline info))))
(let ((environment (let ((env (org-element-property :CV_ENV headline)))
(or (org-string-nw-p env) "block"))))
(cond
;; is a cv entry
((member "cventry" environment)
((equal environment "cventry")
(org-moderncv--format-cventry headline contents info))
((org-export-with-backend 'latex headline contents info))))))

View file

@ -66,10 +66,9 @@ put your foreseen job.
| PHOTO | path to photo file |
#+BEGIN_SRC org :tangle basic_cv.org
,#+TITLE: My dream job an ORG-CV example
,#+TITLE: My dream job
,#+AUTHOR: John Doe
,#+email: john@doe.lost
,#+options: tags:nil
,#+ADDRESS: My Awesome crib
,#+ADDRESS: Fantastic city -- Planet Earth
@ -82,22 +81,13 @@ put your foreseen job.
#+END_SRC
You can use org-modes hierarchical structure to describe your CV. To make a
specific sub-tree an item describing an experience point (Job you have, degree
you pursued, etc.) you use the org properties drawer and with the =:CV_ENV:
cventry= property. You should also include the =FROM= and =TO= properties
defining the span of the entry, as well as =LOCATION= and =EMPLOYER=.
Because work isn't everything we do, it is more meaningful to label differently
the host of those other events like studies, events, certifications, etc. Thus
=HOST=, =ORGANIZATION=, =INSTITUTION=, =SCHOOL=, =EMPLOYER= or =EVENT= are all
equivalent and the first match in that order has precedence.
=DATE= is a shortcut for =FROM= and =TO= when you have a single date in mind
instead of a range. Both =FROM= and =TO= override =DATE=.
specific subtree an item describing an experience point (Job you have,
degree you pursued, etc.) you use the org properties drawer and with the
=:CV_ENV: cventry= property. You should also include the =FROM= and =TO=
properties defining the span of the event, as =LOCATION= and =EMPLOYER=.
#+BEGIN_SRC org :tangle workcontent.org
,* Employement :cventries:
,** One job :cventry:
,* Employement
,** One job
:PROPERTIES:
:CV_ENV: cventry
:FROM: <2014-09-01>
@ -107,8 +97,9 @@ instead of a range. Both =FROM= and =TO= override =DATE=.
:END:
I write about awesome stuff I do.
,** Other job :cventry:
,** Other job
:PROPERTIES:
:CV_ENV: cventry
:FROM: <2013-09-01>
:TO: <2014-08-07>
:LOCATION: my city, your country
@ -133,7 +124,7 @@ latex distributions. I maintain a fork of it, to work with my use case at
https://github.com/Titan-C/moderncv.git Feel free to use any or even your
personal fork for your desired use case.
To configure the export for moderncv you need the additional options in your
To configure the export for moderncv you need the addition options in your
org file.
#+BEGIN_SRC org :tangle moderncv.org
# CV theme - options include: 'casual' (default), 'classic', 'oldstyle' and 'banking'
@ -225,219 +216,6 @@ When exporting you can call the following function to get the latex file.
</object>
#+END_EXPORT
** Using AwesomeCV
[[https://github.com/posquit0/Awesome-CV][AwesomeCV]] is another LaTeX template for producing nice-looking
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 |
|-----------------+-------------------------------------------------------------|
| 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) |
*** 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 |
|-----------+----------------------------------------------------------------------|
| FROM | Start date of the entry |
| TO | End date of the entry |
| DATE | Shortcut to specify both =FROM= and =TO= as the same date. |
| | Both =FROM= and =TO= override =DATE=. |
| EMPLOYER | Employer or organization, can also be specified |
| | as =ORGANIZATION=, =SCHOOL=, =EVENT= or =POSITION= (different |
| | names make more sense depending on the type of environment) |
| LABEL | In =cvsubentry= environments, adds the given text to the left |
| | of the date range, can be used to add additional information |
| | to the entry. |
| RIGHT_IMG | path to an image to include floating to the right of a =cventry=, |
| | a =cvsubentry= or =cvschool= entry. Meant to be used to show a logo. |
| PAGEBREAK | Causes a LaTeX =\clearpage= statement to be inserted in the |
| | exported output before the heading. |
All the supported values of =CV_ENV= for CVs are described below.
**** =cventries=
Enclose all the subheaders in a =cventries= environment. Subheaders can
be of type =cventry=, =cvschool=, or =cvemployer=.
**** =cvhonors=
Enclose all the subheaders in a =cvhonors= environment. Subheaders must
be of type =cvhonor=
**** =cventry=
Converts to a =\cventry= command. Supports attributes =FROM=, =TO=, =DATE=,
=EMPLOYER=, =LOCATION=, =RIGHT_IMG=.
**** =cvsubentry=
Converts to a =\cvsubentry= command. Supports attributes =FROM=, =TO=, =DATE=,
=LABEL= =RIGHT_IMG=.
**** =cvemployer=
Converts to a =\cventry= with only the title line. Supports attributes
=FROM=, =TO=, =DATE= and =LOCATION=.
**** =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=
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=
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.
#+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
*** 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 :exports none :tangle awesome-letter.org
#+include: basic_cv.org
#+END_SRC
#+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 |
| 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=
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.
#+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=
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
@ -453,66 +231,15 @@ exclude some tags during export.
(org-export-to-file 'hugocv "hugocv.md"))
#+END_SRC
You are responsible for styling your website. Use all the CSS magic you know.
Each entry is inside a =div= container and each element of the properties has
its own class.
You are responsible for styling your website.
Make sure that your hugo config has the markup parser attributes active and allows
for html rendering.
#+begin_src yaml
markup:
goldmark:
renderer:
unsafe: true
parser:
attribute:
title: true
block: true
#+end_src
# Next block is to generate exports
#+BEGIN_SRC org :exports none :tangle hugocv.org
,#+hugo_custom_front_matter: :weight 1006
,#+include: basic_cv.org
,#+include: workcontent.org
# (org-export-to-file 'hugocv "doc/content/post/cv.md")
#+END_SRC
You can also use an awards section for a different styling. Here you tag each
entry with =cvhonor=.
#+BEGIN_SRC org :tangle hugocv.org
,* Awards
,** First place :cvhonor:
:PROPERTIES:
:CV_ENV: cventry
:DATE: <2014-09-01>
:LOCATION: a city, a country
:EVENT: The RACE
:END:
,** Sport Scholarship :cvhonor:
:PROPERTIES:
:DATE: <2013-09-01>
:LOCATION: my city, your country
:ORGANIZATION: The nice millionaire
:END:
#+END_SRC
Next is the rendered result for the special entries with styling.
* CV
:PROPERTIES:
:EXPORT_FILE_NAME: cv
:END:
Place holder stuff
* License
:PROPERTIES:
:EXPORT_FILE_NAME: license
:END:
#+begin_quote
org-cv
Copyright (C) 2018-2023 Óscar Nájera
Copyright (C) 2018-2020 Óscar Nájera
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by

View file

@ -1,31 +0,0 @@
;;; test-org-cv.el --- Test Org-cv -*- lexical-binding: t; -*-
;;
;; Copyright (C) 2022 Óscar Nájera
;;
;; Author: Óscar Nájera <hi@oscarnajera.com>
;; Maintainer: Óscar Nájera <hi@oscarnajera.com>
;; Created: August 19, 2022
;; Modified: August 19, 2022
;; Version: 0.0.1
;; Keywords: abbrev bib c calendar comm convenience data docs emulations extensions faces files frames games hardware help hypermedia i18n internal languages lisp local maint mail matching mouse multimedia news outlines processes terminals tex tools unix vc wp
;; Homepage: https://github.com/titan/test-org-cv
;; Package-Requires: ((emacs "24.3"))
;;
;; This file is not part of GNU Emacs.
;;
;;; Commentary:
;;
;; Test Org-cv
;;
;;; Code:
(require 'org-cv-utils)
(ert-deftest test-org-cv-utils-org-timestamp-to-shortdate ()
(pcase-dolist (`(,input ,expected)
'(("<2002-08-12 Mon>" "Aug 2002")
("[2012-05-24]" "May 2012")
("today" "today")))
(should (string= (org-cv-utils-org-timestamp-to-shortdate input) expected))))
(provide 'test-org-cv)
;;; test-org-cv.el ends here