Resume Template

This package establishes a simple and easy-to-use LaTeX template for resume.

Getting Started

Dependencies

• LaTeX: The compilation is based on both XeLaTeX and LaTeXmk, please install TeX in advance.

• Python3: One needs to use Python3 to generate necessary tex files. To install the dependencies, please use

  conda env create -f environment.yml
  conda activate resume_xia

Updating Data

All data (e.g., personal information, education, publications, experiences) is separately recorded in yml format under raw_data. Please follow the following instructions, which provides a detailed explanations.

info.yml

info:
    name: Name in English
    name*: Name in Chinese
    school: School in English, omit if use `company`
    school*: School in Chinese, omit if use `company*`
    school-url: School website
    department: Department in English
    department*: Department in Chinese
    department-url: Department website
    phone: Phone number
    email: Email
    homepage: Homepage, omit if delete
    googlescholar: Google Scholar page, omit if delete
    linkedin: LinkedIn page, omit if delete
    company: Company in English, omit and use `school` if delete
    company*: Company in Chinese, omit and use `school*` if delete
    company-url: Company website

education.yml

education:
    # First education.
    - edu1:
        edu-school: School in English
        edu-school*: School in Chinese
        edu-time: School period in English
        edu-time*: School period in Chinese
        edu-location: School location in English
        edu-location*: School location in Chinese
        edu-intro: Brief intro in English, e.g., GPA, advisor, period
        edu-intro*: Brief intro in Chinese
        edu-detail: Detailed information in English, e.g., courses, omit if delete
        edu-detail*: Detailed information in Chinese, omit if delete

    # Second education.
    - edu2:
        edu-school: School in English
        edu-school*: School in Chinese
        edu-time: School period in English
        edu-time*: School period in Chinese
        edu-location: School location in English
        edu-location*: School location in Chinese
        edu-intro: Brief intro in English, e.g., GPA, advisor, period
        edu-intro*: Brief intro in Chinese
        edu-detail: Detailed information in English, e.g., courses, omit if delete
        edu-detail*: Detailed information in Chinese, omit if delete

publication.md and publication

WARNING: Current version DOES NOT support publication in Chinese.

One needs to first write yml file for each publication under publication, then summarize in the publication.md.

For each yml file, current version only supports UP TO 10 authors. One can set author-contrib-x to equal for equal contribution, and corresponding for corresponding author.

paper_abbr:
    pub-title: Title
    pub-location: Conference name or journal name
    pub-status: set `under` for under review, `oral` for oral, `spotlight` for spotlight, and otherwise delete or set to `none`
    pub-author-a: First author
    pub-contrib-a: equal
    pub-author-b: Second author
    pub-contrib-b: equal
    pub-author-c: Third author
    pub-author-d: Fourth author
    pub-contrib-d: corresponding

For publication.md, one needs to record publications as below, in which commented lines will be ignored. Here, paper_abbr is designed to figure out each paper easily and will not be in the resume.

# Selected Publications

- [paper_abbr1](publication/paper_abbr1.yml)
- [paper_abbr2](publication/paper_abbr2.yml)
<!-- - [paper_abbr3](publication/paper_abbr3.yml) -->
- [paper_abbr4](publication/paper_abbr4.yml)

experience.yml

experience:
    # First experience.
    - exp1:
        exp: Experience company in English
        exp*: Experience company in Chinese
        exp-type: Experience type in English
        exp-type*: Experience type in Chinese
        exp-location: Experience location in English
        exp-location*: Experience location in Chinese
        exp-intro: Experience intro in English, omit if delete
        exp-intro*: Experience intro in Chinese, omit if delete
        exp-time: Experience period in English
        exp-time*: Experience period in Chinese

    # Second experience.
    - exp2:
        exp: Experience company in English
        exp*: Experience company in Chinese
        exp-type: Experience type in English
        exp-type*: Experience type in Chinese
        exp-location: Experience location in English
        exp-location*: Experience location in Chinese
        exp-intro: Experience intro in English, omit if delete
        exp-intro*: Experience intro in Chinese, omit if delete
        exp-time: Experience period in English
        exp-time*: Experience period in Chinese

activity.yml

activity:
    # First activity.
    - act1:
        act: Activity in English
        act*: Activity in Chinese
        act-explanation: Explanation in English
        act-explanation*: Explanation in Chinese

    # Second activity.
    - act2:
        act: Activity in English
        act*: Activity in Chinese
        act-explanation: Explanation in English
        act-explanation*: Explanation in Chinese

honor.yml

honor:
    # First honor.
    - honor1:
        honor: Honor in English
        honor*: Honor in Chinese
        honor-affiliation: Affiliation in English
        honor-affiliation*: Affiliation in Chinese
        honor-time: Time in English
        honor-time*: Time in Chinese

    # Second honor.
    - honor2:
        honor: Honor in English
        honor*: Honor in Chinese
        honor-affiliation: Affiliation in English
        honor-affiliation*: Affiliation in Chinese
        honor-time: Time in English
        honor-time*: Time in Chinese

skill.yml

skill:
    # First skill.
    - skill1:
        skill: Skill in English
        skill*: Skill in Chinese
        skill-intro: Brief intro in English
        skill-intro*: Brief intro in Chinese

    # Second skill.
    - skill2:
        skill: Skill in English
        skill*: Skill in Chinese
        skill-intro: Brief intro in English
        skill-intro*: Brief intro in Chinese

    # Third skill.
    - skill3:
        skill: Skill in English
        skill*: Skill in Chinese
        skill-intro: Brief intro in English
        skill-intro*: Brief intro in Chinese

    # Fourth skill.
    - skill4:
        skill: Skill in English
        skill*: Skill in Chinese
        skill-intro: Brief intro in English
        skill-intro*: Brief intro in Chinese

Style Files

To better customize the resume, one can choose a style file under styles simply by passing the filename of the sty file, which is implemented by importing the sty file via \usepackage command.

Concretely, please set the STYLE_FILE argument through Makefile, in which the default value is mengfei_xia.sty.

# Default usage to generate `tex` files in English, which will load `mengfei_xia.sty`.
make data

# Generates `tex` files in Chinese by loading `name.sty`.
make data-chinese STYLE_FILE=name.sty

# Re-compile the resume in English by loading `name.sty`.
make rebuild STYLE_FILE=name.sty

# Default usage to re-compile the resume in Chinese, which will load `mengfei_xia.sty`.
make rebuild-chinese

Compilation Instructions

It is recommended to compile the package through Makefile, by simply executing

make [{data|data-chinese|resume|rebuild|rebuild-chinese|clean|clean-data|clean-all}]

• make data generates necessary tex files in English;
• make data-chinese generates necessary tex files in Chinese;
• make resume generates resume.pdf WITHOUT generating or updating all data, use only after make data or make data-chinese;
• make rebuild first generates necessary tex files in English BY FORCE, and then generates resume.pdf;
• make rebuild-chinese first generates necessary tex files in Chinese BY FORCE, and then generates resume.pdf;
• make clean deletes only intermediate temporary files by LaTeX;
• make clean-data deletes all intermediate temporary files by LaTeX, together with data files under data;
• make clean-all deletes all intermediate temporary files, together with resume.pdf and data files under data.

Customization

Customizing Your Own sty File

It is encouraged to design your own style file based on the following steps:

1. Define the global names of education, publications, etc;
2. Define the info style;
3. Define the environments for each content;
4. Define the render commands for each content.

Adding New Contents

Please feel free to add more contents to your resume. In order to do so, one needs to:

1. Define the namespace and empty function in resume_xia.cls;
2. Implement the data parser in generate_data.py;
3. Implement the content name, content environment, and render commands in ALL sty files under styles.

It is recommended to follow the implementation of the existing functionality.

TODOList

• Add more style files.

Acknowledgements

We sincerely appreciate Yujun Shen for offering his own resume, allowing diverse style files.