1
0
Fork 0
org-cv/readme.org

8.9 KiB
Raw Blame History

Org exporter for curriculum vitae

Goal: Export backend for CV

This project aims to generate from an org-mode file with reasonably ordered items a latex file which compiles into a reasonably nice CV. In the same spirit the org-mode file must export to markdown so that it can be uses for web based CV.

Installation

This project is not on MELPA so you have to do a manual installation. First clone this git repository.

git clone https://gitlab.com/Titan-C/org-cv.git

There are various modules to perform the export. As of now ox-moderncv, ox-altacv, ox-hugocv. Choose any or all that you prefer for install. I use use-package to manage the installation for example of ox-moderncv.

(use-package ox-moderncv
    :load-path "path_to_repository/org-cv/"
    :init (require 'ox-moderncv))

Basic Org file

The basic structure of an org file containing your CV is shown next.

Personal contact information

TITLE and AUTHOR are standard org options. But on TITLE you put your foreseen job.

Field Description
TITLE Desired job
AUTHOR Who you are?
ADDRESS Mailing address, this can span over multiple lines
HOMEPAGE URL of your website
MOBILE Mobile phone
GITHUB GitHub user
GITLAB GitLab user
LINKEDIN Linkedin username
PHOTO path to photo file
#+TITLE: My dream job
#+AUTHOR: John Doe
#+email: john@doe.lost

#+ADDRESS: My Awesome crib
#+ADDRESS: Fantastic city -- Planet Earth
#+MOBILE: (+9) 87654321
#+HOMEPAGE: example.com
#+GITHUB: Titan-C
#+GITLAB: Titan-C
#+LINKEDIN: oscar-najera
#+PHOTO: smile.png

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 event, as LOCATION and EMPLOYER.

* Employement
** One job
:PROPERTIES:
:CV_ENV: cventry
:FROM:     <2014-09-01>
:TO:     <2017-12-07>
:LOCATION: a city, a country
:EMPLOYER: The employer
:END:

I write about awesome stuff I do.
** Other job
:PROPERTIES:
:CV_ENV: cventry
:FROM:     <2013-09-01>
:TO:     <2014-08-07>
:LOCATION: my city, your country
:EMPLOYER: The other employer
:END:

I write about awesome stuff I do.

* Other stuff I do
- I work a lot
- I sleep a lot
- I eat a lot

Latex Exporter

Using modern-cv

moderncv is a standard \(\LaTeX\) package that you can find in many of your latex distributions. For I maintain for personal purposes a fork of it to better 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 addition options in your org file.

# CV theme - options include: 'casual' (default), 'classic', 'oldstyle' and 'banking'
#+CVSTYLE: banking
# CV color - options include: 'blue' (default), 'orange', 'green', 'red', 'purple', 'grey' and 'black'
#+CVCOLOR: green

When exporting you can call the following function to get the latex file.

(org-export-to-file 'moderncv "moderncv.tex")
(org-latex-compile "moderncv.tex")

Using alta-cv

AltaCV is another project to generate a CV, you will need to install it yourself. I maintain a fork too at https://github.com/Titan-C/AltaCV.git because I need extra features and I encourage to use this fork on the sections branch.

The style of this CV is more involved and you need some configuration in your org file to get it to work. First define the margins, the large margin to the right is to allow for a second column.

#+LATEX_HEADER: \geometry{left=1cm,right=9cm,marginparwidth=7cm,marginparsep=1.2cm,top=1.25cm,bottom=1.25cm}

Content on the right column has the same structure of a org file, but you need to enclose it in the \marginpar{} command as shown next.

#+latex: \marginpar{
* Main Interests
- Free/Libre and Open Source Software (FLOSS)
- Free food
- Free beer

* Programming
- Python
- C/C++
- EmacsLisp
- Bash
- JavaScript
- PHP

* Languages

- *English*  Fluent
- *German*   Fluent
- *Spanish*  Native
- *French*   Intermediate
#+latex: }

When exporting you can call the following function to get the latex file.

(org-export-to-file 'altacv "altacv.tex")
(org-latex-compile "altacv.tex")

Docker container

Update readme

TODO examples [2/2]

DONE pictures

  • State "DONE" from "TODO" [2018-05-01 Tue 20:41]

The website generates the output pdfs, and the orgmode logo is just taken from wikipedia commons by link.

DONE scripts

  • State "DONE" from "TODO" [2018-05-01 Tue 20:40]

Now I can completely build a website from this readme and get the targeted CVs.

TODO Make a package

Complete the file with license and how to load it.

DONE Base environment

  • State "DONE" from "TODO" [2018-03-22 Thu 17:57]

I have the basic cv template that gets exported

DONE org-exporter for latex

  • State "DONE" from "TODO" [2018-04-05 Thu 03:04]

CLOCK: [2018-03-22 Thu 23:17][2018-03-23 Fri 03:25] => 4:08 CLOCK: [2018-03-22 Thu 17:58][2018-03-22 Thu 18:37] => 0:39

I'm comparing the contents of the template export function. It looks that this one give the genera document layout and this is where I shall insert them data. comparing ox-latex, ox-beamer, ox-koma

I learned quite a lot from the main latex and koma files. Currently I already reproduce latex export, which is not much as that was already a working output. But now I have the specific keywords for the personal information part.

DONE Process headings with properties into cventries

  • State "DONE" from "TODO" [2018-03-24 Sat 03:02]

CLOCK: [2018-03-23 Fri 22:54][2018-03-24 Sat 03:05] => 4:11 CLOCK: [2018-03-23 Fri 14:41][2018-03-23 Fri 19:05] => 4:24

I'm constructing the entries quite fine but somehow the intermedia function refuses to get written even when it appears that its output is correct.

I don't fully understand. But it appear that I need to call the exporter again within the exporting of the headings. This maybe is what helps getting down the subtrees and getting to the latex output.

DONE Incorporate from beamer how the do the theme settings

  • State "DONE" from "TODO" [2018-03-23 Fri 16:01]

This looks like a fancy way to avoid repetition. Have a look too trying to imitate that behavior for the other personal tags of social media,url,phones.

DONE Markdown exporter for integration with hugo blog

Local Variables   ARCHIVE