commit 9d741b11c17471e85704beab3bb8ac20a7ab020c
parent 05f646ac08519d06047ab91d4c9c6308683b8bcc
Author: Mateusz Baran <mateusz.baran.sanok@gmail.com>
Date: Sat, 24 Jun 2023 11:46:07 +0200
feat: rename color names and fix typos
Diffstat:
M | README.md | | | 21 | +++++++++++---------- |
M | bubblecv.sty | | | 54 | +++++++++++++++++++++++++----------------------------- |
2 files changed, 36 insertions(+), 39 deletions(-)
diff --git a/README.md b/README.md
@@ -7,19 +7,20 @@ BubbleCV is designed to effectively showcase your skills, work experience, educa
<img src="assets/BubbleCV.png" alt="BubbleCV example" align="right" width="420" />
-- Personal Image -- The template allows you to include a personal image in your CV, adding a touch of professionalism and personalization.
+- Personal Image – The template allows you to include a personal image in your CV, adding a touch of professionalism and personalization.
-- Timeline -- You can use the timeline feature to display the dates of your employment history or educational background, providing a clear and organized overview.
+- Timeline – You can use the timeline feature to display the dates of your employment history or educational background, providing a clear and organized overview.
-- Fully Customizable -- With just a single parameter, you can change the size of all elements in the template. This flexibility allows you to manipulate your CV to accommodate all the necessary information on single page. Additionaly, all elements are parameterized, enabling you to adjust margins, spaces, and column ratio effortlessly.
+- Fully Customizable – With just a single parameter, you can change the size of all elements in the template. This flexibility allows you to manipulate your CV to accommodate all the necessary information on single page. Additionaly, all elements are parameterized, enabling you to adjust margins, spaces, and column ratio effortlessly.
-- Easy Extensibility -- You have the option to upload your own [resources](resources/), such as icons, to further personalize your CV and make it unique to your style.
+- Easy Extensibility – You have the option to upload your own [resources](resources/), such as icons, to further personalize your CV and make it unique to your style.
-- Configurable Colors -- The bubbles and icons in the template can be easily changed with a single line of code. By adjusting the RGB color parameters, you can customize the appearance to suit your preferences.
+- Configurable Colors – The bubbles and icons in the template can be easily changed with a single line of code. By adjusting the RGB color parameters, you can customize the appearance to suit your preferences.
-- Functionalities for Easy Content Management -- The template provides functions that facilitate the easy addition of features and the management of content, ensuring a seamless CV creation process.
+- Functionalities for Content Management – The template provides functions that facilitate the easy addition of features and the management of content, ensuring a seamless CV creation process.
Feel free to explore and make use of the BubbleCV Template to create a standout CV that captures the attention of potential employers or clients.
+Open the template in [Overleaf](https://www.overleaf.com/latex/templates/bubblecv/bcynnjktwqsx) and start working on your own resume.
## Functions
@@ -28,15 +29,15 @@ Feel free to explore and make use of the BubbleCV Template to create a standout
- `\cvsection[<icon>][<icon_scale>][<icon_color>]{<section_title>}`: Creates a new section with an optional icon, scale, and color parameters. It helps in organizing different parts of the CV, such as Profile, Work Experience, Education, etc.
-- `\begin{cvevent}[<start_year>][<end_year>]`: Begins a new work experience or educational event. Optional start and end years can be specified to indicate the duration of the event.
+- `\begin{cvevent}[<start_date>][<end_date>]`: Begins a new work experience or educational event. Optional start and end dates can be specified to indicate the duration of the event.
-- `\cvname{<name>}`: Displays the name of the individual in the CV.
+- `\cvname{<name>}`: Displays the name of the event.
- `\cvdescription{<description>}`: Provides a brief description of the work experience or educational event.
-- `\cvsidebar`: Changes the column from the main section to the sidebar.
+- `\cvsidebar`: Changes the column from the main to the sidebar.
-- `\cvitem[<fa_icon>][<fa_icon_scale>]`: Creates an item in the CV sidebar with an optional icon and scale parameter. The full list of FontAwesome icons is available at [this link](https://mirrors.ibiblio.org/CTAN/fonts/fontawesome/doc/fontawesome.pdf).
+- `\cvitem[<fa_icon>][<fa_icon_scale>]`: Creates an item in the sidebar with an optional icon and scale parameter. The full list of FontAwesome icons is available at [this link](https://mirrors.ibiblio.org/CTAN/fonts/fontawesome/doc/fontawesome.pdf).
- `\cvskill{<skill>}{<level_name>}{<level_value>}`: Displays a skill and its corresponding proficiency level.
diff --git a/bubblecv.sty b/bubblecv.sty
@@ -1,9 +1,9 @@
%========================================================================================
-% Parameters
+% PARAMETERS
%========================================================================================
%----------------------------------------------------------------------------------------
-% GLOBAL
+% CV SCALE
%----------------------------------------------------------------------------------------
\newcommand\cvscale{1}
@@ -58,7 +58,7 @@
\newcommand\cvsidebarspace{3}
\newcommand\cvsidebarbubbleradius{6}
\newcommand\cvsidebarbubbleborderwidth{1}
-\newcommand\cvsitebaroffset{2}
+\newcommand\cvsidebaroffset{2}
%----------------------------------------------------------------------------------------
% COLUMN
@@ -75,14 +75,11 @@
% COLORS
%----------------------------------------------------------------------------------------
\usepackage{xcolor}
-
-\definecolor{cvprimarycolor}{RGB}{20, 20, 20} % primary color
-\definecolor{cvalternativecolor}{RGB}{255, 255, 255} % alternative color
+\definecolor{cvcolor}{RGB}{20, 20, 20} % main color
+\definecolor{cviconcolor}{RGB}{255, 255, 255} % icon color
\definecolor{cvbordercolor}{RGB}{255, 255, 255} % border color
\definecolor{cvavatarbordercolor}{RGB}{255, 255, 255} % avatar border color
\definecolor{cvtimelinecolor}{RGB}{0, 0, 0} % timeline color
-\definecolor{cvaccentcolor}{RGB}{250, 150, 10} % accent color
-\definecolor{cvdarkcolor}{RGB}{70, 70, 70} % dark color
\definecolor{cvlightcolor}{RGB}{245, 245, 245} % light color
%========================================================================================
@@ -135,7 +132,6 @@
\usepackage{paracol}
\setlength{\columnsep}{\cvspacebetweencolumns mm} % space between columns
\newcommand\iscvsidebar{0} % flag if sidebar is active
-\newcommand\iscv{0} % flag if cv is active
%----------------------------------------------------------------------------------------
% FONTS & ICONS
@@ -157,13 +153,13 @@
\SetBgAngle{0}
\SetBgColor{cvtimelinecolor}
\SetBgContents{\rule{\cvtimelinewidth mm}{\textheight}}
+% start offset from left edge of a4 paper instead of center
\SetBgHshift{\dimexpr(\cvtimelineoffset mm - 105 mm)}
\newcommand{\timelinespace}{\the\numexpr\cvleftmargin - \cvtimelineoffset\relax}
%----------------------------------------------------------------------------------------
% FOOTNOTE
%----------------------------------------------------------------------------------------
-% \addtolength{\skip\footins}{-12pt}
\setlength{\skip\footins}{0.25\baselineskip}
%----------------------------------------------------------------------------------------
@@ -197,8 +193,8 @@
% Parameter 3 (optional): Image color in RGB.
% Parameter 4: Circle radius in millimeters.
% Parameter 5: Circle border width in millimeters.
-% Parameter 6: Circle color in RGB.
-% Parameter 7: Circle radius color in RGB.
+% Parameter 6: Circle background color in RGB.
+% Parameter 7: Circle border color in RGB.
\NewDocumentCommand{\drawcircle}{O{} O{1} O{} m m m m}{%
\ifthenelse{\equal{#3}{}}{}{%
\rgbtoarray{#3}\customdecodearray%
@@ -247,8 +243,8 @@
\hspace*{-\cvavatarradius mm}%
\begin{minipage}{\dimexpr(\cvavatarradius mm + \cvavatarradius mm)}%
\protect\ifthenelse{\equal{#1}{}}%
- {\drawcircle{\cvavatarradius}{\cvavatarborderwidth}{cvprimarycolor}{cvavatarbordercolor}}%
- {\drawcircle[resources/#1][#2][#3]{\cvavatarradius}{\cvavatarborderwidth}{cvprimarycolor}{cvavatarbordercolor}}%
+ {\drawcircle{\cvavatarradius}{\cvavatarborderwidth}{cvcolor}{cvavatarbordercolor}}%
+ {\drawcircle[resources/#1][#2][#3]{\cvavatarradius}{\cvavatarborderwidth}{cvcolor}{cvavatarbordercolor}}%
\end{minipage}%
\hspace*{\cvheaderoffset mm}%
\begin{minipage}{\dimexpr(\linewidth + \timelinespace mm - \cvavatarradius mm - \cvheaderoffset mm)}%
@@ -272,15 +268,15 @@
% Parameter 2 (optional): Icon scale.
% Parameter 3 (optional): Icon color in RGB.
% Parameter 4: Section title.
-\NewDocumentCommand{\cvsection}{O{} O{1} O{cvalternativecolor} m}{%
+\NewDocumentCommand{\cvsection}{O{} O{1} O{cviconcolor} m}{%
\ifthenelse{\equal{\iscvsidebar}{0}}{%
\vspace*{\cvmainspace mm}%
\hspace*{-\timelinespace mm}%
\hspace*{-\cvmainbubbleradius mm}%
\begin{minipage}{\dimexpr(\cvmainbubbleradius mm + \cvmainbubbleradius mm)}%
\ifthenelse{\equal{#1}{}}%
- {\protect\drawcircle{\cvmainbubbleradius}{\cvmainbubbleborderwidth}{cvprimarycolor}{cvbordercolor}}%
- {\protect\drawcircle[resources/#1][#2][#3]{\cvmainbubbleradius}{\cvmainbubbleborderwidth}{cvprimarycolor}{cvbordercolor}}%
+ {\protect\drawcircle{\cvmainbubbleradius}{\cvmainbubbleborderwidth}{cvcolor}{cvbordercolor}}%
+ {\protect\drawcircle[resources/#1][#2][#3]{\cvmainbubbleradius}{\cvmainbubbleborderwidth}{cvcolor}{cvbordercolor}}%
\end{minipage}%
\hspace*{\dimexpr(\timelinespace mm - \cvmainbubbleradius mm)}%
\begin{minipage}{\linewidth}%
@@ -292,11 +288,11 @@
\hspace*{-\cvsidebarbubbleradius mm}%
\begin{minipage}{\dimexpr(\cvsidebarbubbleradius mm + \cvsidebarbubbleradius mm)}%
\protect\ifthenelse{\equal{#1}{}}%
- {\drawcircle{\cvsidebarbubbleradius}{\cvsidebarbubbleborderwidth}{cvprimarycolor}{cvbordercolor}}%
- {\drawcircle[resources/#1][#2][#3]{\cvsidebarbubbleradius}{\cvsidebarbubbleborderwidth}{cvprimarycolor}{cvbordercolor}}%
+ {\drawcircle{\cvsidebarbubbleradius}{\cvsidebarbubbleborderwidth}{cvcolor}{cvbordercolor}}%
+ {\drawcircle[resources/#1][#2][#3]{\cvsidebarbubbleradius}{\cvsidebarbubbleborderwidth}{cvcolor}{cvbordercolor}}%
\end{minipage}%
- \hspace*{\cvsitebaroffset mm}%
- \begin{minipage}{\dimexpr(\linewidth - \cvsidebarbubbleradius mm - \cvsitebaroffset mm)}%
+ \hspace*{\cvsidebaroffset mm}%
+ \begin{minipage}{\dimexpr(\linewidth - \cvsidebarbubbleradius mm - \cvsidebaroffset mm)}%
\textscale{\cvsectionfontscale}{\textbf{#4}}%
\end{minipage}%
\cvseparator%
@@ -329,7 +325,7 @@
\end{center}%
\end{minipage}%
\begin{minipage}{\dimexpr(\cveventbubbleradius mm + \cveventbubbleradius mm)}%
- \protect\drawcircle{\cveventbubbleradius}{\cveventbubbleborderwidth}{cvprimarycolor}{cvbordercolor}%
+ \protect\drawcircle{\cveventbubbleradius}{\cveventbubbleborderwidth}{cvcolor}{cvbordercolor}%
\end{minipage}%
\hspace*{\dimexpr(\timelinespace mm - \cveventbubbleradius mm)}%
\begin{minipage}[t]{\linewidth}%
@@ -379,15 +375,15 @@
%----------------------------------------------------------------------------------------
% List item with a label.
% Parameter 1 (optional): Icon name from fontawesome package.
-% Parameter 2 (optional): Icon diameter in milimeters.
+% Parameter 2 (optional): Icon size in milimeters.
% Parameter 3: Content.
\NewDocumentEnvironment{cvitem}{O{Circle} O{2.5} +b}{%
\ifthenelse{\equal{\iscvsidebar}{1}}{%
\begin{minipage}{\cvscale\dimexpr#2mm\relax}%
- \makebox(0, 0){\textcolor{cvprimarycolor}{\fontsize{\cvscale\dimexpr#2mm\relax}{\cvscale\dimexpr#2mm\relax}\csname fa#1\endcsname}}%
+ \makebox(0, 0){\textcolor{cvcolor}{\fontsize{\cvscale\dimexpr#2mm\relax}{\cvscale\dimexpr#2mm\relax}\csname fa#1\endcsname}}%
\end{minipage}%
- \hspace*{\cvsitebaroffset mm}%
- \begin{minipage}{\dimexpr(\linewidth - \cvsitebaroffset mm - \cvscale\dimexpr#2mm\relax)}%
+ \hspace*{\cvsidebaroffset mm}%
+ \begin{minipage}{\dimexpr(\linewidth - \cvsidebaroffset mm - \cvscale\dimexpr#2mm\relax)}%
#3%
\end{minipage}%
}{%
@@ -402,15 +398,15 @@
% Parameter 1: Name of skill.
% Parameter 2: Skill level.
% Parameter 3: Percent of the progress-bar in range [0, 1].
-\newcommand{\cvskill}[3] {%
+\newcommand{\cvskill}[3]{%
\ifthenelse{\equal{\iscvsidebar}{1}}{%
\begin{tabularx}{\linewidth}{>{\raggedright\arraybackslash}X>{\raggedleft\arraybackslash}X}%
- \textcolor{black}{\textbf{#1}} & \textcolor{cvprimarycolor}{#2} \\%
+ \textcolor{black}{\textbf{#1}} & \textcolor{cvcolor}{#2}%
\end{tabularx}%
\begin{tikzpicture}[scale=1,rounded corners=\cvscale*0.5mm,very thin]%
\fill [cvlightcolor] (0,0) rectangle (\linewidth, 0.15*\cvscale);%
- \fill [cvprimarycolor] (0,0) rectangle (#3\linewidth, 0.15*\cvscale);%
+ \fill [cvcolor] (0,0) rectangle (#3\linewidth, 0.15*\cvscale);%
\end{tikzpicture}%
\cvseparator[2]%
}{%