Chapter Self-Review of All Chapters

After you’ve finished revising your chapters, and before you send your documents to the Lead Author for final review, each author completes a Chapter Self-Review for each chapter they wrote. Do this last, because any revisions to content can introduce new issues to resolve.

Use the Chapter Self-Review list below to get your chapters ready to be used by students. We recommend making multiple passes through your work, doing one task at a time. For example, if you wrote two chapters, check all headers in both chapters at once, then add all markup at once, and so on.

1. Headers
   1. Chapter title is H1; chapter sections are H2; chapter subsections are H3. Headers must go in order (example: H4 must not follow an H2).
   2. Remove stacked heads – back-to-back headings that do not have text between them. Add content, or delete one of the headings.
   3. Check that paragraphs and images in the text body aren’t accidentally marked as headers.
2. Markup around sections of text that indicate Pressbooks formatting requests
   1. Use [box] [/box] around content that will go inside a blue box. Boxes must start with an H3 header and can include figures.
   2. Use [sidebar] [/sidebar] around content that will go inside a golden box. Sidebars are for short text that is independent of running text (e.g. ancillary, non-recurring, or emphasized content). Sidebars do not need a header and cannot include figures.
   3. Use [feature] [/feature] around content that will go inside a golden box in your online book, and will go into a full page with a shaded golden background in your print book. Features are for long text that is independent of running text. Features must start with an H3 header and can include figures.
   4. Use [epigraph] [/epigraph] for a short quote at the beginning of a chapter or section.
   5. Use [blockquote] [/blockquote] for quotations of over 40 words.
3. Figures, including images, tables, and any other media
   1. Each figure has a figure caption below it.
   2. Figures are numbered in order.
   3. All figure captions start with the word “Figure” followed by the number, regardless of what type of media they are.
   4. All figures will default to full size. If you want a figure to be small, select the figure and add a comment that says “small.”
   5. Remove any titles above figures, and move all information about the figure into the figure caption.
4. Images
   1. Images include alternative text descriptions in the alt text field and, if needed, long descriptions in the {Course #} Image Descriptions Folder.
   2. Images do not rely on color alone to convey information.
5. Embedded Multimedia
   1. Videos have transcripts in the {Course #} Transcript Folder.
   2. All videos include edited audio captions of all speech content and relevant non-speech content.
   3. All videos with contextual visuals (graphs, charts, etc.) are described audibly in the video.
6. Tables
   1. Tables include row and/or column headers.
   2. Tables are not wider than one header column + 4 body columns (all of our formats have a vertical orientation). Wide tables should be adapted to focus on only the most important information for students.
7. Links
   1. The link anchor describes the destination of the link (not the word “here”).
   2. The link includes the destination format in square brackets. Avoid names of companies: Pressbook, Canvas, YouTube, etc. We use:
      1. Streaming Video
      2. Online PDF, JPG, PNG, etc.
      3. Download PDF, JPG, PNG, ZIP, etc.
      4. Website
      5. Podcast
      6. Google Doc, Google Sheet, Google Folder, etc.
8. Licenses and Attributions
   1. There is an H3 for Licenses and Attributions at the end of each H2 section.
   2. Original content has an open license statement.
   3. Content from other sources used under an open license or under fair use is attributed using the Attribution Style Guide [Website].
9. References
   1. There is an H2 for References at the end of each chapter.
   2. The reference list consistently follows the author team’s agreed-upon citation style.
   3. Each reference list entry corresponds to an in-text citation, and each in-text citation has a reference list entry.
   4. Each reference list entry is a single paragraph. Do not manually use the “enter” key and space bar to force a hanging indent paragraph style.
10. Internal links to other chapters/sections in your book
    1. Highlight the text that you want linked and add a comment that starts with CROSSREF.
    2. To link to an entire chapter, just add the number of the chapter.
    3. To link to a chapter section, add the number of the chapter and the name of the section (this can be an H2 or H3).
11. Unsupported elements
    1. Footnotes: if you’ve added footnotes, determine whether the information is essential and incorporate it into the text if so. If not, cut!