summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/tidyres
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2023-02-12 03:01:46 +0000
committerNorbert Preining <norbert@preining.info>2023-02-12 03:01:46 +0000
commitf76939750d63d6088b9bdeac794ce3fdf33d1269 (patch)
tree0cd0d327b53fe3a657722ae4188983b8b100468d /macros/latex/contrib/tidyres
parent73abb311c03e955ad9f7b7464390a5722b20b915 (diff)
CTAN sync 202302120301
Diffstat (limited to 'macros/latex/contrib/tidyres')
-rw-r--r--macros/latex/contrib/tidyres/README.md29
-rw-r--r--macros/latex/contrib/tidyres/tidyres-doc.pdfbin0 -> 211638 bytes
-rw-r--r--macros/latex/contrib/tidyres/tidyres-doc.tex210
-rw-r--r--macros/latex/contrib/tidyres/tidyres.sty53
4 files changed, 292 insertions, 0 deletions
diff --git a/macros/latex/contrib/tidyres/README.md b/macros/latex/contrib/tidyres/README.md
new file mode 100644
index 0000000000..d9a29c957c
--- /dev/null
+++ b/macros/latex/contrib/tidyres/README.md
@@ -0,0 +1,29 @@
+#### Package Name
+
+`tidyres` (Please read the documentation on CTAN for detailed usage.)
+
+
+
+#### Author
+
+Yifan Liang (Github User Name: futurelyf)
+You may contact me via Github.
+
+
+
+#### Basic Functions
+
+This `tidyres` package aims to provide users with a simple interface to create multi-column formal resume.
+
+The `\restitle` command helps users produce the title of the resume.
+
+The `ressection` environment helps users create multi-column sections (e.g., Education, Experience, etc.)
+
+The `\ressep` command helps users to add small vertical space between sub-items in a section.
+
+
+
+#### License
+
+This work is licensed under Creative Commons ”Attribution 4.0 International” license.
+For detailed information about the license, please visit the Creative Commons’ website. \ No newline at end of file
diff --git a/macros/latex/contrib/tidyres/tidyres-doc.pdf b/macros/latex/contrib/tidyres/tidyres-doc.pdf
new file mode 100644
index 0000000000..9fa4ac0ed0
--- /dev/null
+++ b/macros/latex/contrib/tidyres/tidyres-doc.pdf
Binary files differ
diff --git a/macros/latex/contrib/tidyres/tidyres-doc.tex b/macros/latex/contrib/tidyres/tidyres-doc.tex
new file mode 100644
index 0000000000..0fad9a2a69
--- /dev/null
+++ b/macros/latex/contrib/tidyres/tidyres-doc.tex
@@ -0,0 +1,210 @@
+\documentclass[a4paper,10pt]{article}
+% packages %
+\usepackage[margin=1in]{geometry}
+\usepackage{amsmath,amssymb}
+\usepackage[dvipsnames]{xcolor}
+\usepackage{hologo}
+\usepackage[hidelinks]{hyperref}
+\usepackage[type={CC},modifier={by},version={4.0}]{doclicense}
+\usepackage{tidyres}
+\usepackage{cprotect}
+\usepackage{listings}
+\usepackage[most]{tcolorbox}
+\usepackage{changepage}
+\hypersetup{colorlinks=True,allcolors=cyan}
+\renewcommand{\contentsname}{\centering Table of Contents}
+% info %
+\title{{\tt tidyres} for Tidy Formal Resume}
+\author{\itshape Yifan Liang}
+\date{v1.0.0 2023-02-10}
+
+\definecolor{codegreen}{rgb}{0,0.6,0}
+\definecolor{codegray}{rgb}{0.5,0.5,0.5}
+\definecolor{backcolour}{rgb}{0.95,0.95,0.92}
+\lstdefinestyle{mystyle}{
+ language=[LaTeX]{TeX},
+ backgroundcolor=\color{backcolour},
+ commentstyle=\color{codegreen},
+ numberstyle=\small\color{codegray},
+ basicstyle=\ttfamily\normalsize,
+ breakatwhitespace=false,
+ breaklines=true,
+ keepspaces=true,
+ numbers=left,
+ numbersep=5pt,
+ showspaces=false,
+ showstringspaces=false,
+ showtabs=false,
+ tabsize=2,
+ texcsstyle=*\color{blue},
+}
+\lstset{style=mystyle}
+
+
+% document %
+\begin{document}
+
+\maketitle
+\tableofcontents
+\thispagestyle{empty}
+
+\newpage
+\setcounter{page}{1}
+\pagestyle{plain}
+
+\section{Introduction}
+\subsection{Basic Functions}
+This {\tt tidyres} package aims to provide users with a simple interface to create multi-column style formal resume. The package is comprised of three major commands/environments:
+
+\begin{enumerate}[label=\textbullet,leftmargin=6ex,topsep=4ex]
+ \item \verb+\restitle+ command
+ \item \verb+ressection+ environment
+ \item \verb+\ressep+ command
+\end{enumerate}
+
+Users can also incorporate other packages such as \verb+enumitem+ to make bullet point in the resume.
+
+\vspace{1cm}
+
+\subsection{License}
+This work is licensed under \href{https://creativecommons.org/licenses/by/4.0/}{Creative Commons "Attribution 4.0 International" license}.\\
+\\
+For detailed information about the license, please visit the Creative Commons' website by clicking the \textcolor{Cyan}{cyan text above} or the license image below.
+\\
+\begin{flushright}
+ \doclicenseImage
+\end{flushright}
+
+\newpage
+
+\section{General Setup Tips}
+\subsection{Page Margin}
+For a typical resume, depending on the font style and font size you use, it is suggested that you set the page margin between {\bf 0.5 inch} to {\bf 1 inch}.\\
+~\\
+You can set the margin with the {\tt geometry} package using the following code:
+\begin{lstlisting}
+\usepackage[margin=0.5in]{geometry}
+\end{lstlisting}
+
+\vspace{1cm}
+
+\subsection{Font Size}
+Typically, a resume would use {\bf 9pt} to {\bf 11pt} font.\\
+~\\
+I would suggest using the {\tt extarticle} class to set the font size globally:
+
+\begin{lstlisting}
+\documentclass[9pt]{extarticle}
+% The extarticle class supports at least 8pt font size.
+\end{lstlisting}
+\newpage
+
+\section{Resume Title}
+
+\subsection{Goal}
+The \verb+\restitle+ command helps user to print the title of the resume, which contains key information such as name, location, email, phone, and Linkedin ID.\\
+
+\subsection{Example Code}
+\begin{lstlisting}
+\restitle{My Name}{Location}{Email}{Phone}{LinkedinID}{http://linkedin.com}
+\end{lstlisting}
+
+\vspace{1cm}
+
+{\it will produce (on the top of the page):}
+
+\vspace{1cm}
+
+\begin{tcolorbox}[standard jigsaw,opacityback=0.1,colback=gray,boxrule=0.5pt]
+\restitle{My Name}{Location}{Email}{Phone}{ID}{http://linkedin.com}
+\end{tcolorbox}
+
+\vspace{1cm}
+
+\subsection{Note}
+The hyperlink color of Linkedin can be set via {\tt hyperref} package. If you wish to set it in black, you may use the following code:
+
+\begin{lstlisting}
+\usepackage[hidelinks]{hyperref}
+\end{lstlisting}
+
+\newpage
+
+\section{Resume Section}
+
+\subsection{Goal}
+The \verb+ressection+ environment helps users set the sections (e.g., Education, Experience, Certifications, etc.) of the resume.\\
+~\\
+You may use {\tt enumerate} or the {\tt itemize} environment within the {\tt ressection} environment to create bullet points to specify the specific experience/event.\\
+~\\
+The \verb+\ressep+ command separates the experience/event within a section.
+
+\newpage
+
+\subsection{Example Code}
+\begin{lstlisting}
+\begin{ressection}[Education]
+ {\bf ABC University}, {\sl College of Arts \& Science}, New York, NY
+ \hfill
+ Feb 2023 - Present
+
+ \begin{enumerate}
+ \item Bachelor of Arts in Economics (Minor in Mathematics)
+ \item Cumulative GPA: 4.0/4.0
+ \item Honors \& Societies: ABC Economics Society
+ \item Related Coursework: ABC Economics 101, ABC Statistics 101
+ \end{enumerate}
+
+ \ressep
+
+ {\bf XYZ High School}, New Jersey, NY
+ \hfill
+ Jan 2021 - Feb 2023
+
+ \begin{enumerate}
+ \item General High School Diploma
+ \item Cumulative GPA: 3.7/4.0
+ \item Honors \& Societies: XYZ Poem Society
+ \end{enumerate}
+\end{ressection}
+\end{lstlisting}
+
+\vspace{1cm}
+
+{\it will produce:}
+
+\vspace{1cm}
+\begin{ressection}[Education]
+ {\bf ABC University}, {\sl College of Arts \& Science}, New York, NY
+ \hfill
+ Feb 2023 - Present
+
+ \begin{enumerate}
+ \item Bachelor of Arts in Economics (Minor in Mathematics)
+ \item Cumulative GPA: 4.0/4.0
+ \item Honors \& Societies: ABC Economics Society
+ \item Related Coursework: ABC Economics 101, ABC Statistics 101
+ \end{enumerate}
+
+ \ressep
+
+ {\bf XYZ High School}, New Jersey, NY
+ \hfill
+ Jan 2021 - Feb 2023
+
+ \begin{enumerate}
+ \item General High School Diploma
+ \item Cumulative GPA: 3.7/4.0
+ \item Honors \& Societies: XYZ Poem Society
+ \end{enumerate}
+\end{ressection}
+
+\vspace{-6cm}
+
+\begin{adjustwidth}{-15pt}{-15pt}
+\begin{tcolorbox}[standard jigsaw,opacityback=0.1,colback=gray,boxrule=0.5pt]
+ \vspace{5cm}
+\end{tcolorbox}
+\end{adjustwidth}
+
+\end{document} \ No newline at end of file
diff --git a/macros/latex/contrib/tidyres/tidyres.sty b/macros/latex/contrib/tidyres/tidyres.sty
new file mode 100644
index 0000000000..45860b3f4a
--- /dev/null
+++ b/macros/latex/contrib/tidyres/tidyres.sty
@@ -0,0 +1,53 @@
+\NeedsTeXFormat{LaTeX2e}
+\ProvidesPackage{tidyres}[2023-02-10 v1.0.0]
+
+% packages %
+\RequirePackage{paracol}
+\RequirePackage{tabularray}
+\RequirePackage{enumitem}
+\RequirePackage{amsmath}
+\RequirePackage{amssymb}
+\RequirePackage[dvipsnames]{xcolor}
+\RequirePackage{hologo}
+\RequirePackage{setspace}
+\RequirePackage[hidelinks]{hyperref}
+\RequirePackage{fontawesome}
+
+% format %
+\setlength{\parindent}{0pt}
+\setlength{\columnsep}{2em}
+\columnratio{0.12,0.88}
+\setlist{label=\textbullet,leftmargin=*,nolistsep}
+\linespread{1.25}
+\pagestyle{empty}
+
+% font %
+% \newfontfamily\textcm{CMU Serif}
+
+% definition %
+\newcommand{\restitle}[6]
+{\begin{spacing}{1.15}
+\begin{tblr}{
+ column{1} = {l},
+ column{2} = {r},
+ column{3} = {l},
+ cell{1}{1} = {r=4}{},
+ colspec = {X[5]X[2.8]X[2.2]}
+}
+\hspace{6mm}{\fontsize{22}{22}\selectfont \sc #1}
+& \faLocationArrow
+& #2 \\
+& \faAt
+& {\sl #3} \\
+& \faPhone
+& #4 \\
+& \faLinkedinSquare
+& \href{#6}{Linkedin - {\sl #5}}\\
+\hline
+\end{tblr}\end{spacing}\vspace{7mm}}
+
+\newenvironment{ressection}[2][Section]
+{\begin{paracol}{2} {\sc #1} \switchcolumn {#2}}
+{\end{paracol}\vspace{5mm}}
+
+\newcommand{\ressep}[0]{\vspace{2mm}} \ No newline at end of file