├── report.pdf ├── examplefigure.jpg ├── exampletable.png ├── examplesignature.jpg ├── README.md ├── report.tex └── pd2.sty /report.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snario/pd2report/HEAD/report.pdf -------------------------------------------------------------------------------- /examplefigure.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snario/pd2report/HEAD/examplefigure.jpg -------------------------------------------------------------------------------- /exampletable.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snario/pd2report/HEAD/exampletable.png -------------------------------------------------------------------------------- /examplesignature.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snario/pd2report/HEAD/examplesignature.jpg -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | pd2report 2 | ========= 3 | 4 | A PD2 report template that incorporates all formatting necessary for students in the course, so that they can focus on the actual content instead of worrying about less important details. To begin, simply compile `report.tex` following the instructions in the comments. 5 | 6 | # How to Begin 7 | 8 | ## Prerequisites 9 | 10 | You need to have _LaTeX_ installed on your computer _or_ you can use an online tool such as [ShareLatex](https://www.sharelatex.com/). If you're using ShareLatex, then you need to download this project as a `.zip` and then upload that as a new project on their website. 11 | 12 | If you don't have LaTeX installed, then you need to install it on your computer: 13 | 14 | * [TeX Live for Linux](http://www.tug.org/texlive/) 15 | * [MacTeX for Mac](http://www.tug.org/mactex/) 16 | * [ProTeXt for Windows](http://www.tug.org/protext/) 17 | 18 | ## Instructions 19 | 20 | Open `report.tex` and follow the instructions in sequence from the beginning of the file. Start by entering some information like your faculty, name, term, student id number, etc. Right now the file has a lot of random gibberish just to show what the final product will look like with your report inside of it, just remove all of the lipsum lines it tells you to. Also, as far as adding tables go, right now you can use a custom command called `\myTable` and a link to an image of a table, but you may want to learn proper Latex syntax to do a proper looking table. 21 | 22 | If the course ever changes its guidelines or rubric, just make a pull request and I'll add whatever changes you want to make to this project. 23 | 24 | Hope this helps! :) 25 | -------------------------------------------------------------------------------- /report.tex: -------------------------------------------------------------------------------- 1 | \documentclass[12pt]{article} 2 | \usepackage{pd2} 3 | \usepackage{lipsum} % remove this 4 | 5 | % Your information 6 | % Enter your report information here 7 | \faculty{Faculty of Mathematics} 8 | \reporttitle{Lorem Ipsum} 9 | \fullname{Liam Horne} 10 | \term{2A} 11 | \program{Computer Science} 12 | \studentid{20465555} 13 | \address{123 Apple Street} 14 | \city{Cambridge, Ontario} 15 | \postalcode{A1X B2Y} 16 | \pdtitle{PD2: Critical Reflection and Report Writing} 17 | \supervisor{Mr.}{Tim}{Paci} 18 | 19 | % Title Page (ignore) 20 | % Creates the title page based on your information above 21 | \newcommand{\createtitlepage} { 22 | \pagenumbering{roman} 23 | \waterlootitlepage 24 | {\myFaculty} 25 | {\myTitle} 26 | {\myPD \\ \UwLocation} 27 | {\myName \\ \myTerm \ \myProgram \\ ID \myIdNumber \\ \today} 28 | } 29 | 30 | % Letter of Submittal 31 | % Write your letter of submittal below, the header, salutation, 32 | % and signature (except the image) are done for you already 33 | \newcommand{\letterofsubmittal} { 34 | \waterlooletterofsubmittal 35 | {\myAddress}{\myCity}{\myPostalCode}{\supervisorAddress}{\supervisorSalutation}{\myName}{\myIdNumber} 36 | { 37 | 38 | \lipsum[1] % remove this line 39 | 40 | % Write your letter here 41 | 42 | } 43 | { 44 | % Attach an image of your signature 45 | % The first number is a scale factor 46 | % (if you can't, just delete this and uncomment next line) 47 | \scalebox{0.1}{\includegraphics{examplesignature.jpg}} 48 | % \myName 49 | } 50 | } 51 | 52 | % Table of Contents 53 | % The table of contents will be generated for you 54 | 55 | % Summary 56 | % Write your summary here 57 | \newcommand{\summary}{ 58 | \tocsection{Summary} 59 | { 60 | 61 | \lipsum[10-11] % remove this line 62 | 63 | % Write your summary here 64 | 65 | } 66 | \newpage 67 | } 68 | 69 | % Introduction 70 | % Write an introduction here 71 | \newcommand{\introduction}{ 72 | \fancyhf{} 73 | \pagestyle{fancy} 74 | \renewcommand{\headrulewidth}{0pt} 75 | \rfoot{\thepage} 76 | \pagenumbering{arabic} 77 | \mySection{Introduction} 78 | { 79 | 80 | \lipsum[8-9] % remove this line 81 | 82 | % Write your introduction here 83 | 84 | } 85 | \newpage 86 | } 87 | 88 | % Analysis (body) 89 | % Write the body of your report here 90 | % Section Headers: 91 | % \mySection{ title }{ ... } will create a new section block 92 | % \mySubSection{ title }{ ... } will create a new subsection block 93 | % \mySubSubSection{ title }{ ... } will create a new subsubsection block 94 | % Bullet Points: 95 | % \bulletpoints{ 96 | % \item bullet point 1 97 | % \item bullet point 2 (and so on) 98 | % } 99 | % For Figures: 100 | % \myFigure{ scaling factor }{ image.jpg }{ caption } adds a figure 101 | % For Tables: 102 | % \myTable{ scaling factor }{ table.jpg }{ caption } 103 | % (if your table is an image) or you need to learn normal LaTeX syntax 104 | % Read this for help: http://en.wikibooks.org/wiki/LaTeX/Tables 105 | \newcommand{\analysis}{ 106 | 107 | % Write your body here 108 | 109 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 110 | %%%%%%% This is an example, remove this entire block %%%%%%%%% 111 | \mySection{My Amazing Section}{ 112 | \lipsum[2] 113 | \mySubSection{My Amazing SubSection} { 114 | \lipsum[12] 115 | \bulletpoints{ 116 | \item first item 117 | \item second item 118 | } 119 | \mySubSubSection{My Amazing SubSubSection} { 120 | \lipsum[10] 121 | \myFigure{0.10}{examplefigure.jpg}{Hello, World} 122 | \lipsum[11-12] 123 | \myTable{0.3}{exampletable.png}{Hello, Table} 124 | } 125 | } 126 | } 127 | \mySection{My Amazing Section}{ 128 | \lipsum[2] 129 | \mySubSection{My Amazing SubSection} { 130 | \lipsum[12] 131 | \mySubSubSection{My Amazing SubSubSection} { 132 | \lipsum[18-21] 133 | } 134 | } 135 | } 136 | %%%%%%% This is an example, remove this entire block %%%%%%%%% 137 | %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 138 | 139 | \newpage % This creates a new page, your may or may not want this, remove at your own discretion 140 | 141 | } 142 | 143 | % Conclusions 144 | % Write your Conclusions 145 | \newcommand{\conclusions}{ 146 | \section{Conclusions} 147 | { 148 | 149 | \lipsum[33-35] % remove this line 150 | 151 | % Write your conclusions here 152 | 153 | } 154 | } 155 | 156 | % Recommendations 157 | % Write your Recommendations here 158 | \newcommand{\recommendations}{ 159 | \section{Recommendations} 160 | { 161 | 162 | \lipsum[37-39] % remove this line 163 | 164 | % Write your recommendations here 165 | 166 | } 167 | } 168 | 169 | % References 170 | % Add your own References 171 | \newcommand{\references}{ 172 | \makereferences{ 173 | % Add each reference like this, with some label for each item 174 | \bibitem{labelName} 175 | Champion, R., Paci, T. \& Vardon, J. (2012). PD 2: Critical Reflection and Report Writing. Retrieved 1 March, 2012 from https://learn.uwaterloo.ca/d2l/le/content/80224/viewContent/605550/View 176 | } 177 | } 178 | 179 | % Appendices 180 | % Add your appendices 181 | \newcommand{\myappendix}{ 182 | \addanappendix{Appendix A: Lorem Ipsum}{ 183 | \lipsum[50] % remove this line 184 | } 185 | \newpage 186 | \addanappendix{Appendix B: PD2 Report Checlist}{\addchecklistappendix} 187 | } 188 | 189 | \begin{document} 190 | \createtitlepage 191 | \letterofsubmittal 192 | \mytableofcontents 193 | \summary 194 | \introduction 195 | \analysis 196 | \conclusions 197 | \recommendations 198 | \references 199 | \myappendix 200 | \end{document} 201 | -------------------------------------------------------------------------------- /pd2.sty: -------------------------------------------------------------------------------- 1 | \usepackage{setspace} 2 | \usepackage{url} 3 | \usepackage{graphicx} 4 | \usepackage{tocloft} 5 | \usepackage{color} 6 | \usepackage{scrextend} 7 | \usepackage{titletoc} 8 | \usepackage{sectsty} 9 | \usepackage{fancyhdr} 10 | \usepackage[utf8]{inputenc} 11 | \usepackage[hmargin=1.5in, vmargin=1.5in]{geometry} 12 | 13 | % This is the styles files, you don't need to edit this whatsoever unless you 14 | % want to change the format of the report. As it is now, it conforms exactly 15 | % to the Spring 2013 PD2 Report Writing Guidelines 16 | 17 | 18 | \sectionfont{\normalsize} 19 | \subsectionfont{\normalsize} 20 | \subsubsectionfont{\normalsize} 21 | 22 | \newcommand{\faculty}[1]{ 23 | \newcommand{\myFaculty}{#1} 24 | } 25 | 26 | \newcommand{\reporttitle}[1] { 27 | \newcommand{\myTitle}{#1} 28 | } 29 | 30 | \newcommand{\fullname}[1] { 31 | \newcommand{\myName}{#1} 32 | } 33 | 34 | \newcommand{\term}[1] { 35 | \newcommand{\myTerm}{#1} 36 | } 37 | 38 | \newcommand{\program}[1] { 39 | \newcommand{\myProgram}{#1} 40 | } 41 | 42 | \newcommand{\studentid}[1] { 43 | \newcommand{\myIdNumber}{#1} 44 | } 45 | 46 | \newcommand{\address}[1] { 47 | \newcommand{\myAddress}{#1} 48 | } 49 | 50 | \newcommand{\city}[1] { 51 | \newcommand{\myCity}{#1} 52 | } 53 | 54 | \newcommand{\postalcode}[1] { 55 | \newcommand{\myPostalCode}{#1} 56 | } 57 | 58 | \newcommand{\pdtitle}[1] { 59 | \newcommand{\myPD}{#1} 60 | } 61 | 62 | \newcommand{\UwLocation}{Waterloo, Ontario} 63 | 64 | \newcommand{\supervisor}[3] { 65 | \newcommand{\supervisorAddress}{#1 #2 #3} 66 | \newcommand{\supervisorSalutation}{#1 #3} 67 | } 68 | 69 | \newlength\mylen 70 | \settowidth\mylen{Figure\ } 71 | \addtolength\cftfignumwidth{\mylen} 72 | \addtolength\cfttabnumwidth{\mylen} 73 | \renewcommand*{\cftfigfont}{Figure } 74 | \renewcommand*{\cfttabfont}{Table \hspace{0.075in}} 75 | 76 | \doublespacing 77 | \addtolength{\parskip}{\baselineskip} 78 | \setlength{\parindent}{0pt} 79 | \setlength{\cftsecnumwidth}{25pt} 80 | \setlength{\parskip}{1em} 81 | 82 | \newcommand{\waterlootitlepage}[4] { 83 | 84 | \titlecontents{section} 85 | [0pt] 86 | {}% 87 | {\contentsmargin{0pt} 88 | \thecontentslabel\enspace% 89 | } 90 | {\contentsmargin{0pt}} 91 | {\titlerule*[.5pc]{.}\contentspage} 92 | [] 93 | 94 | \begin{singlespace} 95 | \begin{titlepage} 96 | \begin{center} 97 | \textbf{\MakeUppercase{University of Waterloo}} \\ 98 | #1 99 | \vfill 100 | { 101 | \textsc{\textbf{\MakeUppercase{#2}}} 102 | } 103 | \vfill 104 | #3 105 | \vfill 106 | Prepared by \\ 107 | #4 108 | \end{center} 109 | \end{titlepage} 110 | \end{singlespace} 111 | 112 | 113 | } 114 | 115 | \newcommand{\waterlooletterofsubmittal}[9] { 116 | \begin{waterlooletter} 117 | #1 \\ 118 | #2 \\ 119 | #3 \\ \\ 120 | \today \\ \\ 121 | #4, PD2 Instructor \\ 122 | Professional Development Program \\ 123 | University of Waterloo \\ 124 | 200 University Avenue West \\ 125 | Waterloo, Ontario \\ 126 | N2L 3G1 \\ \\ 127 | Dear #5: \\ 128 | 129 | #8 130 | 131 | Sincerely, \\ \\ 132 | #9 \\ 133 | #6 \\ 134 | ID #7 135 | \end{waterlooletter} 136 | } 137 | 138 | \newenvironment{waterlooletter}{ 139 | \begin{singlespace}}{ 140 | \end{singlespace} 141 | \thispagestyle{empty} 142 | \newpage 143 | } 144 | 145 | \makeatletter 146 | \renewcommand\@biblabel[1]{#1} % No brackets for the references 147 | \renewenvironment{thebibliography}[1] 148 | {\section*{\refname}% 149 | \@mkboth{\MakeUppercase\refname}{\MakeUppercase\refname}% 150 | \list{\@biblabel{\@arabic\c@enumiv}}% 151 | {\settowidth\labelwidth{\@biblabel{#1}}% 152 | \leftmargin\labelwidth 153 | \advance\leftmargin20pt% change 20 pt according to your needs 154 | \advance\leftmargin\labelsep 155 | \setlength\itemindent{-20pt}% change using the inverse of the length used before 156 | \@openbib@code 157 | \usecounter{enumiv}% 158 | \let\p@enumiv\@empty 159 | \renewcommand\theenumiv{\@arabic\c@enumiv}}% 160 | \sloppy 161 | \clubpenalty4000 162 | \@clubpenalty \clubpenalty 163 | \widowpenalty4000% 164 | \sfcode`\.\@m} 165 | {\def\@noitemerr 166 | {\@latex@warning{Empty `thebibliography' environment}}% 167 | \endlist} 168 | \renewcommand\newblock{\hskip .11em\@plus.33em\@minus.07em} 169 | \makeatother 170 | 171 | \newcommand{\makereferences}[1]{ 172 | \newpage 173 | \addcontentsline{toc}{section}{References} 174 | \begin{thebibliography}{99\kern\bibindent} 175 | #1 176 | \end{thebibliography} 177 | \newpage 178 | } 179 | 180 | \newcommand{\addchecklistappendix}{ 181 | Your report must: 182 | \begin{itemize} 183 | \item $\left[ Y \right]$ Include 4-6 pages of body content. Figures or tables that are included in the body are excluded in the 4-6 page count. (Example: 8 pages of content that includes a one-page figure and a half-page table counts as 6.5 pages of body content.) Adherence to the 3Cs (clarity, conciseness, and coherence) will allow you to meet this page limit. 184 | \item $\left[ Y \right]$ Include at least one table (Place the table in the body of your report if you discuss it in detail; place the table in an appendix if your analysis refers to it only briefly.) 185 | \item $\left[ Y \right]$ Include at least one figure (Place the figure in the body of your report if you discuss it in detail; place the figure in an appendix if your analysis refers to it only briefly.) 186 | \item $\left[ Y \right]$ Use a 12-point serif font 187 | \item $\left[ Y \right]$ Be double-spaced 188 | \item $\left[ Y \right]$ Be written in formal, standard English, with no contractions 189 | \item $\left[ Y \right]$ Be spell checked and proofread 190 | \item $\left[ Y \right]$ Include pages numbered according to the conventions described in the Report Resources tab. 191 | \end{itemize} 192 | Your report must conform to the format and conventions described in the Report Resources page. You do not have to bind your report or include a front cover because you will submit your report to us online. Your report will include the following pages and sections: 193 | \begin{itemize} 194 | \item $\left[ Y \right]$ Title page 195 | \item $\left[ Y \right]$ Letter of submittal (addressed to the PD 2 course instructor) 196 | \item $\left[ Y \right]$ Table of contents 197 | \item $\left[ Y \right]$ List of figures and tables, if appropriate (Figures or tables in an appendix should not be listed on the List of figures and tables; figures or tables elsewhere in your report are required to be on this list.) 198 | \item $\left[ Y \right]$ Summary 199 | \item $\left[ Y \right]$ Introduction 200 | \item $\left[ Y \right]$ Body (that includes both an objective analytical component and a reflective component) 201 | \item $\left[ Y \right]$ Conclusions (the section is "conclusions" as in "findings", not "conclusion") 202 | \item $\left[ Y \right]$ Recommendations (specific, measurable, and attainable) 203 | \item $\left[ Y \right]$ References 204 | \item $\left[ Y \right]$ Appendices (you need at least one appendix which includes this checklist) 205 | \end{itemize} 206 | } 207 | 208 | \newcommand{\addanappendix}[2]{ 209 | \tocsection{#1} 210 | #2 211 | } 212 | 213 | \makeatletter 214 | \renewcommand\ext@table{lof} 215 | \makeatother 216 | 217 | \renewcommand\cftfigpresnum{Figure } 218 | \renewcommand\cfttabpresnum{Table } 219 | 220 | \newcommand{\mytableofcontents} { 221 | \tableofcontents 222 | \newpage 223 | \begin{center} 224 | \tocsection{List of Tables and Figures} 225 | \end{center} 226 | \listoffigures 227 | \newpage 228 | } 229 | 230 | \newcommand{\mySection}[2] { 231 | \section{#1} 232 | #2 233 | } 234 | 235 | \newcommand{\mySubSection}[2] { 236 | \begin{addmargin}[1.5em]{0em} 237 | \subsection{#1} 238 | #2 239 | \end{addmargin} 240 | } 241 | 242 | \newcommand{\mySubSubSection}[2] { 243 | \begin{addmargin}[1.5em]{0em} 244 | \subsubsection{#1} 245 | #2 246 | \end{addmargin} 247 | } 248 | 249 | \newcommand{\myFigure}[3] { 250 | \begin{figure} 251 | \centering 252 | \scalebox{#1}{\includegraphics{#2}} 253 | \caption{#3} 254 | \end{figure} 255 | } 256 | 257 | \newcommand{\myTable}[3] { 258 | \begin{table} 259 | \centering 260 | \scalebox{#1}{\includegraphics{#2}} 261 | \caption{#3} 262 | \end{table} 263 | } 264 | 265 | \def\thesection{\arabic{section}.0 } 266 | \def\thesubsection{\arabic{section}.\arabic{subsection}} 267 | 268 | \renewcommand{\contentsname} { 269 | \begin{center} 270 | Table of Contents 271 | \end{center} 272 | } 273 | 274 | \newcommand{\bulletpoints}[1]{ 275 | \begin{spaceditemize} 276 | #1 277 | \end{spaceditemize} 278 | } 279 | 280 | \renewcommand{\listfigurename}{} 281 | \renewcommand{\cftsecleader}{\bfseries\cftdotfill{\cftdotsep}} 282 | \renewcommand{\cftfigpresnum}{Figure } 283 | \renewcommand{\cftfigaftersnum}{ --- } 284 | \renewcommand{\cftfignumwidth}{65pt} 285 | \newcommand{\tocsection}[1]{ 286 | \section*{#1} 287 | \addcontentsline{toc}{section}{#1} 288 | } 289 | 290 | \newenvironment{spaceditemize}{ 291 | \begin{list}{$\bullet$} 292 | { 293 | \setlength{\parskip}{0pt} 294 | }} 295 | {\end{list}\bigskip 296 | } 297 | 298 | 299 | 300 | --------------------------------------------------------------------------------