Skip to content
Snippets Groups Projects
Commit 9feedc6f authored by W. Spencer Smith's avatar W. Spencer Smith
Browse files

Additional notes on 80 column width and possible ways to do it

parent 8fed4a06
No related branches found
No related tags found
No related merge requests found
No preview for this file type
......@@ -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}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment