checklist before releasing a draft

[bhpayne]

• check for poor wording using ./report_common_errors.sh
• did I include eveything that I meant to? See ./compare_includes_to_files.sh
• generate DOCX, PDF, HTML, EPUB versions using ./make all
• review content using https://www.grammarly.com/
• in each of the PDFs,
  • verify the index in each artifact is sorted correctly. See index not sorted, also not including all instances #16 and https://www.ams.org/arc/tex/howto/index/0index-notes.pdf
  • look for headers that exceed the page width. See https://tex.stackexchange.com/a/26236/235813 and https://tex.stackexchange.com/a/6866/235813; more details on https://www.overleaf.com/learn/latex/Articles/How_does_LaTeX_typeset_headers_and_footers%3F#Exploring_the_book_class
  • review start-of-chapter pages to see where page number is at bottom of page
  • look for margin comments that run off the page. "see page" and ">>"
  • footnote in section 6.8 on Robert's Rules of Order is long.
  • chapter 3 has a footnote on the start-of-chapter page
• click on links in the PDF/HTML/EPUB to ensure links are working
• in the generated HTML
  • search for " ," (space followed by comma) and correct instances by removing the space.
  • search for "page " and remove instances
  • search the HTML source code for

[a-z]</p>
<p>

to find unintended spaces in the PDF.

• tag the release in git

[bhpayne]

clean-up for the HTML generated by Pandoc:

• add "Bibliography"
• in the appendix "Task Distribution in a Flat Organization" some tables do not render correctly in HTML and are left as \left\{ \begin{tabular}. See pandoc conversion of latex tabular to html table fails #27
• the "Back to the Main Table of Contents" at each chapter don't anchor to the TOC and instead hit the Preface
• links that point to main.html#sec:take-blame (which anchors to the TOC) should instead be main.html#take-blame

[bhpayne]

Find glossary entries that aren't in the text and thus don't get rendered in the PDF:

1. find all the glossary entries in the glossary_entries.tex file
2. check that each one appears in the .gls file
3. An entry that never appears in the .gls is because the entry wasn't referenced outside the glossary.

rm -rf commands_to_run.sh; rm -rf keywords

cat latex/glossary_entries.tex | grep newgloss | sed 's/\\newglossaryentry{/"/' | sed 's/}{/"/' > keywords

echo "set -eux" > commands_to_run.sh

while read p; do  echo grep "$p" latex/main_pdf_85x11_electronic_single_sided.gls; done < keywords >> commands_to_run.sh

chmod u+x commands_to_run.sh
./commands_to_run.sh 2&> results

# look for two adjacent lines that both start with "++"
awk '{/\+\+/?f++:f=0} f==2' results

source: https://stackoverflow.com/a/22644713/1164295

but what I really care about is the first line with ++, not the second