diff --git a/BlankProjectTemplate/docs/Writing-Checklist.pdf b/BlankProjectTemplate/docs/Writing-Checklist.pdf index aa665c9558ebc83d3ff960febce01ead216927ca..a27c331f4e7c246461d1d4ed04ea8ac1ca290b8f 100644 Binary files a/BlankProjectTemplate/docs/Writing-Checklist.pdf and b/BlankProjectTemplate/docs/Writing-Checklist.pdf differ diff --git a/BlankProjectTemplate/docs/Writing-Checklist.tex b/BlankProjectTemplate/docs/Writing-Checklist.tex index 7d8308690f6bd0722c7794bf5550d6954ef52ed7..c4236c990fa31481341f46593599ce20fe2b1b93 100644 --- a/BlankProjectTemplate/docs/Writing-Checklist.tex +++ b/BlankProjectTemplate/docs/Writing-Checklist.tex @@ -51,7 +51,8 @@ tex files. Please be sure to include the \texttt{Comments.tex} file in your repo and in your tex files. \item Text lines should be 80 characters wide. That is, the text has a hard-wrap at - 80 characters. This is done to facilitate meaingful diffs between different commits. + 80 characters. This is done to facilitate meaingful diffs between different + commits. (Some ideas on how to do this are given below.) \item Template comments (plt) do not show in the pdf version, either by removing them, or by turning them off. \item References and labels are used so that maintenance is feasible @@ -112,4 +113,21 @@ \end{itemize} +\subsubsection*{Fixed Width \LaTeX{} Text} + +Having the \LaTeX{} text at a fixed width (hard-wrap) is useful when the source +is under version control. The fixed line lengths help with isolating the +changes between diffs. + +Although the checklist mentions an 80 column width, any reasonable fixed width +is fine. + +The hard-wrap shouldn't be done manually. Most editors will have some facility +for fixed width. In emacs it is called auto-fill. Some advice from previous +and current students: + +\begin{itemize} +\item In TEXMaker, you can do: User $>$ Run script $>$ hardwordwrap +\item Wrapping is easy in VSCode, Emacs, and Vim +\end{itemize} \end{document}