Merge pull request #16 from lahovniktadej/main

README, grammar

README.md

@@ -1,17 +1,35 @@
-# A cover letter template for a journal paper submission in LaTex
-[![CTAN](https://img.shields.io/ctan/v/jourcl.svg)](https://ctan.org/pkg/jourcl)
-![GitHub repo size](https://img.shields.io/github/repo-size/firefly-cpp/cover-letter-latex?style=flat-square)
-[![GitHub license](https://img.shields.io/github/license/firefly-cpp/cover-letter-latex.svg)](https://github.com/firefly-cpp/cover-letter-latex/blob/master/LICENSE)
-[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
-
 <p align="center">
   <img alt="logo" width="300" src="imgs/logo.png">
 </p>
 
-## Description 📋
+<h1 align="center">
+  A cover letter template for a journal paper submission in LaTex
+</h1>
+
+<p align="center">
+  <a href="https://ctan.org/pkg/jourcl">
+    <img alt="CTAN" src="https://img.shields.io/ctan/v/jourcl.svg" />
+  </a>
+  <img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/firefly-cpp/cover-letter-latex" />
+  <a href="https://github.com/firefly-cpp/cover-letter-latex/blob/master/LICENSE">
+    <img alt="GitHub license" src="https://img.shields.io/github/license/firefly-cpp/cover-letter-latex.svg" />
+  </a>
+  <a href="#-contributors">
+    <img alt="All Contributors" src="https://img.shields.io/badge/all_contributors-4-orange.svg" />
+  </a>
+</p>
+
+<p align="center">
+  <a href="#-key-features">✨ Key features</a> •
+  <a href="#-installation">📦 Installation</a> •
+  <a href="#-related-templates">🔗 Related templates</a> •
+  <a href="#-license">🔑 License</a> •
+  <a href="#-contributors">🫂 Contributors</a>
+</p>
+
 Paper submission in a journal is usually accompanied by a cover letter. 📝 The repository hosts a cover letter template for journal submissions written in LaTeX. The template is minimalistic in one way while pre-defined with several commands that drastically speed up the process of preparing a cover letter for journal submission. ✉️
 
-## Key features of this template ✨
+## ✨ Key features
 - Minimalistic design 🎨
 - Include the custom logo of the affiliation 🏢
 - Predefined commands for a journal name, author, date, etc. 📅
@@ -23,17 +41,17 @@ Paper submission in a journal is usually accompanied by a cover letter. 📝 The
 - Custom greeting (e.g., "Dear Editor" or "Dear Editor-in-Chief" for regular submission, etc.) 👋
 - Option to add custom Signature (i.e. an image of your hand-written signature) ✍️
 
-## Download/Install 📦
-Please install the `jourcl` package through the package manager of your TeX distribution or download it directly from: [CTAN](https://www.ctan.org/pkg/jourcl).
+## 📦 Installation
+Please install the `jourcl` package through the package manager of your TeX distribution or download it directly from [CTAN](https://www.ctan.org/pkg/jourcl).
 
-## Related templates 🔗
+## 🔗 Related templates
 
-[A LaTeX template for a journal rebuttal letter (response to editors/reviewers)](https://github.com/firefly-cpp/latex-response-reviewers)
+- [A LaTeX template for a journal rebuttal letter (response to editors/reviewers)](https://github.com/firefly-cpp/latex-response-reviewers)
 
 ## Disclaimer
 This software is provided as-is, and there are no guarantees that it fits your purposes or that it is bug-free. Use it at your own risk!
 
-## License
+## 🔑 License
 Material in this folder is licensed under a
 [Creative Commons Attribution-ShareAlike 4.0 International License][cc-by-sa].
 
@@ -43,7 +61,7 @@ Material in this folder is licensed under a
 [cc-by-sa-image]: https://licensebuttons.net/l/by-sa/4.0/88x31.png
 [cc-by-sa-shield]: https://img.shields.io/badge/License-CC%20BY--SA%204.0-lightgrey.svg
 
-## Contributors
+## 🫂 Contributors
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
 <!-- prettier-ignore-start -->

jourcl.cls

@@ -12,7 +12,7 @@
 \RequirePackage[iso,american]{isodate}
 \RequirePackage{fontawesome5}
 
-% no indent for whole document
+% no indent for the whole document
 \setlength\parindent{0pt}
 
 \DeclareOption*{\PassOptionsToClass{\CurrentOption}{article}}
@@ -23,7 +23,7 @@
 
 % Top position of reviewers
 \DeclareOption{top}{%
-    \newcommand{\addreviewersPosition}{1}
+    \newcommand{\addreviewersPosition}{1}
 }
 % Top position of reviewers
 \DeclareOption{afterToEditor}{%
@@ -46,7 +46,7 @@
 % process options
 \ProcessOptions\relax
 
-% styling of document
+% styling of the document
 %----------------------------------------------------------------------
 
 % load class
@@ -62,7 +62,7 @@
 \setlength{\headheight}{84.0pt}
 \addtolength{\textheight}{1in}
 
-% set a little indendation for paragraphs
+% set a little indentation for paragraphs
 \setlength{\parindent}{0.1em}
 
 % space between paragraphs
@@ -75,7 +75,7 @@
 \newcommand{\pImagePath}{\@ImagePath}
 
 %----------------------------------------------------------------------
-% new command for the information of author
+% new command for the information of the author
 \newcommand{\aboutme}[1]{
 %\noindent
 \fancyfoot{}
@@ -100,48 +100,48 @@
 
 % Recommended persons
 %----------------------------------------------------------------------
-% Custom Role of first recommended person
+% Custom Role of the first recommended person
 \def\FirstRecommended#1{\def\@FirstRecommended{#1}}
 \newcommand{\pFirstRecommended}{\@FirstRecommended}
-% name, surname of first recommended person
+% name, the surname of the first recommended person
 \def\FirstNameSurname#1{\def\@FirstNameSurname{#1}}
 \newcommand{\pFirstNameSurname}{\@FirstNameSurname}
-% institution of of first recommended person
+% institution of the first recommended person
 \def\FirstInstitution#1{\def\@FirstInstitution{#1}}
 \newcommand{\pFirstInstitution}{\@FirstInstitution}
-% email of of first recommended person
+% email of the first recommended person
 \def\FirstEmail#1{\def\@FirstEmail{#1}}
 \newcommand{\pFirstEmail}{\@FirstEmail}
 
-% Custom Role of second recommended person
+% Custom Role of the second recommended person
 \def\SecondRecommended#1{\def\@SecondRecommended{#1}}
 \newcommand{\pSecondRecommended}{\@SecondRecommended}
-% name, surname of second recommended person
+% name, the surname of the second recommended person
 \def\SecondNameSurname#1{\def\@SecondNameSurname{#1}}
 \newcommand{\pSecondNameSurname}{\@SecondNameSurname}
-% institution of second recommended person
+% institution of the second recommended person
 \def\SecondInstitution#1{\def\@SecondInstitution{#1}}
 \newcommand{\pSecondInstitution}{\@SecondInstitution}
-% email of second recommended person
+% email of the second recommended person
 \def\SecondEmail#1{\def\@SecondEmail{#1}}
 \newcommand{\pSecondEmail}{\@SecondEmail}
 
-% Custom Role of third recommended person
+% Custom Role of the third recommended person
 \def\ThirdRecommended#1{\def\@ThirdRecommended{#1}}
 \newcommand{\pThirdRecommended}{\@ThirdRecommended}
-% name, surname of third recommended person
+% name, the surname of the third recommended person
 \def\ThirdNameSurname#1{\def\@ThirdNameSurname{#1}}
 \newcommand{\pThirdNameSurname}{\@ThirdNameSurname}
-% institution of third recommended person
+% institution of the third recommended person
 \def\ThirdInstitution#1{\def\@ThirdInstitution{#1}}
 \newcommand{\pThirdInstitution}{\@ThirdInstitution}
-% email of third recommended person
+% email of the third recommended person
 \def\ThirdEmail#1{\def\@ThirdEmail{#1}}
 \newcommand{\pThirdEmail}{\@ThirdEmail}
 %----------------------------------------------------------------------
 % \RecommendedPerson{Role}{Name Surname}{Institution}{Email}
 %----------------------------------------------------------------------
-% command to render recommended person - check if empty, check if string is only whitespace, else table
+% command to render recommended person - check if empty, check if the string is only whitespace, else table
 \def \RecommendedPerson#1#2#3#4{ \ifempty{#1} % empty
     \else 
     \sbox0{#1}%
@@ -176,7 +176,7 @@
 % name of the institution
 \def\InstitutionName#1{\def\@InstitutionName{#1}}
 \newcommand{\pInstitutionName}{\@InstitutionName}
-% Street and House No.      
+% Street and House No.
 \def\StreetNo#1{\def\@StreetNo{#1}}
 \newcommand{\pStreetNo}{\@StreetNo}
 % Postal code, City, Country

jourcl.tex

@@ -76,10 +76,10 @@
 \Introduction{We submit our paper titled: \pTitle, which we would like to be considered for publication in \pJournalName. Our paper belongs to the special issue \pSpecialIssue}
 
 % ending
-\final{We believe that an interesting new perspective created by our paper would deserve the attention of a broad scientific audience. We hope that the manuscript will find your interest and that you will consider it for publication in \pJournalName.}
+\final{We believe that an interesting new perspective created by our paper would deserve the attention of a broad scientific audience. We hope the manuscript will capture your interest and that you will consider it for publication in \pJournalName.}
 
 % original work declaration
-\declaration{This manuscript is the authors' original work and has not been published nor has it been submitted simultaneously elsewhere. All authors have checked the manuscript and have agreed to the submission.}
+\declaration{This manuscript is the author's original work and has not been published or submitted simultaneously elsewhere. All authors have reviewed the manuscript and agreed to its submission.}
 
 % no conflicts of interest
 \conflictofinterest{We have no conflicts of interest to disclose.}
@@ -126,7 +126,7 @@
 Abstract: \pabstract
 \end{framed}
 
-% Improved macro to ensure more freedom for the users. Place it in the position, where you want the reviewers
+% Improved macro to ensure more freedom for the users. Place it in the position where you want the reviewers
 \showreviewers 
 
 \vspace{-.7cm}