commit b6b984d8d08074884b8d705562c168aeb571007b Author: rzmk Date: Sat Feb 26 13:21:15 2022 -0500 :rocket: Initial upload of report-template is complete! diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1e4ddbc --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +venv +_minted-report +*.aux +*.fdb_latexmk +*.fls +*.log +*.out +*.synctex(busy) diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..68ff569 --- /dev/null +++ b/Makefile @@ -0,0 +1,5 @@ +report: report.tex awe-homework.cls + xelatex -shell-escape report + +clean: + rm -rf *.pdf *.log *.aux *.dvi *.out *.cpt _minted-* diff --git a/Overleaf_Template_Tutorial.gif b/Overleaf_Template_Tutorial.gif new file mode 100644 index 0000000..5adeba3 Binary files /dev/null and b/Overleaf_Template_Tutorial.gif differ diff --git a/README.md b/README.md new file mode 100644 index 0000000..7e09630 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ + +
+
+ + Papers + + +

report-template

+
+ Build your report on Overleaf! ยป +
+
+
+ +# LaTeX Report Template + +A homework/report template in LaTeX with multiple features (local environment files). + +![Report](preview.png) + +## Overleaf Template + +[**Click here** to go to the Overleaf template](https://www.overleaf.com/read/nghcfhgrsztp) which you can make a copy of and work on it within your browser. Once registered or signed into Overleaf, you can follow the steps below to build your copy. + +![Overleaf Template Tutorial](Overleaf_Template_Tutorial.gif) + +## Some Features + +- Code blocks +- Inline code +- Hyperlinks + +## Acknowledgements + +- [Initial template from this GitHub repository](https://github.com/WorcesterSociety/HomeworkTemplate). diff --git a/awe-homework.cls b/awe-homework.cls new file mode 100644 index 0000000..1e2a973 --- /dev/null +++ b/awe-homework.cls @@ -0,0 +1,135 @@ +% --------------------------------------------------------------------- +% Identification +% --------------------------------------------------------------------- + +\ProvidesClass{awe-homework} +\NeedsTeXFormat{LaTeX2e} + +% --------------------------------------------------------------------- +% Class Options +% --------------------------------------------------------------------- + +% Inherit options of article. +\DeclareOption*{% + \PassOptionsToClass{\CurrentOption}{article} +} +\ProcessOptions\relax +\LoadClass{article} + +% --------------------------------------------------------------------- +% Package Dependencies +% --------------------------------------------------------------------- + +% Math symbols. +\RequirePackage{amsmath} +% More math symbols. +\RequirePackage{amssymb} +% Colored text. +\RequirePackage{color} +% Better enumerations. +\RequirePackage{enumerate} +% More customization for enumerations. +\RequirePackage{enumitem} +% Fancy headers and footers! +\RequirePackage{fancyhdr} +% Configure page layout. +\RequirePackage{geometry} +% Automatic hyperlinks! +\RequirePackage{hyperref} +% Configure text hyphenation. +\RequirePackage{hyphenat} +% Even more math symbols. +\RequirePackage{mathabx} +% Typesetting formulas and inference rules. +\RequirePackage{mathpartir} +% Space saving efforts. +\RequirePackage{microtype} +% Syntax highlighting. +\RequirePackage{minted} +% Support for multicolumn, used for lists. +\RequirePackage{multicol} +% Used for Tikz pictures, e.g. for finite state machines. +\RequirePackage{tikz} + +% --------------------------------------------------------------------- +% Color Definitions +% --------------------------------------------------------------------- + +\definecolor{belize-hole}{RGB}{41, 128, 185} +\definecolor{code}{RGB}{241, 240, 236} + +% --------------------------------------------------------------------- +% Configuration Commands +% --------------------------------------------------------------------- + +% Setters +\newcommand*{\name}[1]{\def\@name{#1}} +\newcommand*{\doctitle}[1]{\def\@doctitle{#1}} +\newcommand*{\course}[1]{\def\@course{#1}} + +% Getters +\newcommand*{\getname}{\@name} +\newcommand*{\getdoctitle}{\@doctitle} +\newcommand*{\getcourse}{\@course} + +% --------------------------------------------------------------------- +% Layout Setup +% --------------------------------------------------------------------- + +% Margins +\geometry{margin=1in} + +% Header and footer +\pagestyle{fancy} +\lhead{\getdoctitle} +\rhead{\getname} +\cfoot{\thepage} + +% Hyperlinks +\hypersetup{ + colorlinks=true, + linkcolor=black, + citecolor=black, + filecolor=black, + urlcolor=belize-hole +} + +% Footnote style +\renewcommand{\thefootnote}{[\arabic{footnote}]} + +% Non-bold description enumerations +\setlist[description]{font=\normalfont} + +% Syntax highlighting +\setminted{autogobble, bgcolor=code} +\setmintedinline{bgcolor=white} + +% --------------------------------------------------------------------- +% Layout Commands +% --------------------------------------------------------------------- + + +\SetEnumitemKey{twocol}{% + before=\raggedcolumns\begin{multicols}{2}, + after=\end{multicols} +} + +\SetEnumitemKey{threecol}{% + before=\raggedcolumns\begin{multicols}{3}, + after=\end{multicols} +} + +\newcommand*{\makeheader}{% + \thispagestyle{plain} + \begin{center} + {\Large \getdoctitle} \\ + \getcourse \\ + \getname \\ + \end{center} +} + +\newcommand*{\question}[2]{% + \vspace{.25in}\hrule\vspace{0.5em} + \noindent{\bf#1.} #2\vspace{0.5em} + \hrule\vspace{.25in} +} diff --git a/papers.svg b/papers.svg new file mode 100644 index 0000000..6ac3c9a --- /dev/null +++ b/papers.svg @@ -0,0 +1,145 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/preview.png b/preview.png new file mode 100644 index 0000000..7447120 Binary files /dev/null and b/preview.png differ diff --git a/report.pdf b/report.pdf new file mode 100644 index 0000000..1d363ca Binary files /dev/null and b/report.pdf differ diff --git a/report.tex b/report.tex new file mode 100644 index 0000000..08bc975 --- /dev/null +++ b/report.tex @@ -0,0 +1,85 @@ +\documentclass[11pt]{awe-homework} + +% Configuration +\doctitle{My Epic Homework Assignment/Report} +\name{Your Name} +\course{CS 101 Latex Fundamentals, Spring 2022} + +\begin{document} + +\makeheader + +% Question 1 +\question{1}{ +Enter your question 1 description here. +} +% Answer 1 +Enter your answer 1 here. + +You can make a code block/environment like this: +\begin{minted}{python} +class MyClass: + def __init__(self): + self.x = 0 + +def main(): + my_object = MyClass() + print(my_object.x) +\end{minted} + +You can add inline code using \textbackslash mintinline like this: \mintinline{js}{console.log("Hello world!")}. + +Try out some links too, like \href{https://google.com}{going to Google}. + +Inline math works too: $\frac{1}{2} = 0.5$. + +You can display inline math more clearly with \textbackslash{displaystyle}, like shown: $\displaystyle\frac{1}{2} = 0.5$. + +Maybe try a math block/environment: + +$$ +\begin{aligned} + \int_0^1 x^2 dx = \frac{1}{3} +\end{aligned} +$$ + +You can also write it using \textbackslash [ (your equation here)\textbackslash ] like this: + +\[ \int_0^1 x^2 dx = \frac{1}{3} \] + +Feel free to change your \textcolor{red}{text color}. + +Or maybe try some \textbf{bold} or \textit{italic} text. + +How about an \underline{underline}? + +% Question 2 +\question{2}{ +Enter your question 2 description here.\footnote{This is a footnote.} +} +% Answer 2 +Enter your answer 2 here. +\begin{itemize} + \item Here's a list. + \item You can add more to the list with \textbackslash item. + \begin{enumerate} + \item Feel free to start a nested list too. + \item You can use enumerate for an ordered list. + \begin{enumerate}[label=(\alph*)] + \item And check out this alphabetical list! + \item I wonder what happens after Z... + \end{enumerate} + \end{enumerate} +\end{itemize} + +\section*{Acknowledgements \& Links} + +\begin{itemize} + \item \href{https://github.com/WorcesterSociety/HomeworkTemplate}{WorcesterSociety on GitHub for their \textbf{awe-homework} LaTeX template} as the base template with a CC0-1.0 License. + \item \href{https://www.overleaf.com/read/nghcfhgrsztp}{View the Overleaf version of this template and create your own copy to work with!} + \item \href{https://github.com/rzmk/report-template}{This GitHub repository} is where a local version of the template is hosted. Learn more details by going here. + \item \href{https://www.overleaf.com/learn/latex/Code_Highlighting_with_minted}{This Overleaf article} lists all the supported programming languages for the minted package with syntax highlighting at the bottom of the page. + \item \href{https://www.overleaf.com/learn/latex/Inserting_Images}{Insert images in your report} by reading this article on Overleaf. +\end{itemize} + +\end{document} diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..17f51ba --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +Pygments==2.11.2