Editing
Bulleted & Numbered Lists
- All bulleted lists should start with a capital letter. Bullets should not end with periods or semicolons, but rather all with nothing or all with periods. Use periods only when at least one of the bullets is a complete sentence.
Example
These include:
– impedance at increasing speed,
– leakage flux probe for shorted turns,
– running Hipot and insulation resistance tests.
Corrected
These include:
– Impedance at increasing speed
– Leakage flux probe for shorted turns
– Running Hipot and insulation resistance tests
Title with a Subtitle on the Acknowledgements and Executive Summary Pages
- To avoid double colons in the full title (title+subtitle) please replace the second one with an em dash:
Example
Advanced Nuclear Technology: New Nuclear Plant Project Development and Execution: Project Planning Guideline
Corrected
Advanced Nuclear Technology: New Nuclear Plant Project Development and Execution—Project Planning Guideline
Cover Info
- Check the Programs and Core TI Funding fields. If either field indicates TI, add Program on Technology Innovation: to the beginning of the report title in all locations.
- Export controlled documents or DOESA = Part 810 text; use template Part 810 cover (purple – pages 6 and 14).
- Also – if Public, remove the export control on the back cover.
Additional Info
*QMP means the same as Nuclear Non-NQA (meaning that it applies to 99.9% of Nuclear reports).
If the report is Nuclear (any program beginning in 41), check if EPRI Nuclear Quality Management Program (QMP) or one of the two NQA categories and use the correct cover, title, and disclaimer.
Layout
Bulleted & Numbered Lists
- All bulleted lists should start with a capital letter. Bullets should not end with periods or semicolons, but rather all with nothing or all with periods. Use periods only when at least one of the bullets is a complete sentence.
Example
These include:
– impedance at increasing speed,
– leakage flux probe for shorted turns,
– running Hipot and insulation resistance tests.
Corrected
These include:
– Impedance at increasing speed
– Leakage flux probe for shorted turns
– Running Hipot and insulation resistance tests
Miscellaneous Layout Notes:
-
Search the EPRI website using the TR number for full reference. Go to: https://www.epri.com to find: https://www.epri.com/research/products/000000003002030678
Example
EPRI report 3002030678, “Considerations for Justifying Generator Rewinds”Corrected
Considerations for Justifying Generator Rewinds. EPRI, Palo Alto, CA: 2024. 3002030678. - The word Figure should always be spelled out (do not use Fig 1 or Fig. 1, etc. – it should be Figure 1)
Example
Change Figs 2-17 and 2-18 below are from this paper:
Corrected
Figure 2-17 and Figure 2-18 are from this paper.
- Titles should not be in all caps – change to Title Case
- Number ranges should have en dashes (not dashes) with no spaces around them
Example
2.3 – 3.5 kV/mm (58.4 – 88.9 V/mil)
Corrected
2.3–3.5 kV/mm (58.4–88.9 V/mil)
- Remove the words “below” and “above” when referring to a figure or table in the text, and the sentence should not end with a colon.
Example
This is illustrated in Figure 1 below:
Corrected
This is illustrated in Figure 1.
- Punctuation should be inside of quotation marks, and EPRI reports should be in italics:
Example
For more information on transpositions, see “Generator Rewind Technology and Efficiency Improvements”, Moore, Tarrant, and Melaia, Powergen South Africa 2015, and EPRI report 3002018610 “Best Practices to Avoid Problems During Generator Stator Rewinds”.
Corrected
For more information on transpositions, see “Generator Rewind Technology and Efficiency Improvements,” Moore, Tarrant, and Melaia, Powergen South Africa 2015, and EPRI report 3002018610, Best Practices to Avoid Problems During Generator Stator Rewinds.
- There should always be a space between a number and its units.
Example
50g (0.11lb)
Corrected
50 g (0.11 lb)
- There should not be any spaces around an em dash.
Example
Essentially, the rotor bends like a simple beam — the center of the shaft bows out while the ends pivot.
Corrected
Essentially, the rotor bends like a simple beam—the center of the shaft bows out while the ends pivot.
- Headers should be in title case.
Example
3.7.5 Final testing – Wound Stator
Corrected
3.7.5 Final Testing – Wound Stator
- In text, “Section” should be capitalized.
Example
Copper testing as per section 2.2 Copper Considerations
Corrected
Copper testing as per Section 2.2 Copper Considerations
Inserting Cross-References
Insert Reference Cross-Links
- Highlight the text you want to link which is just the number (not the bracket)
- Go to the Insert tab on the ribbon.
- In the Links group, click Cross-reference.
- In the Cross-reference dialog box, select “Numbered item” from the Reference type dropdown menu.
- Choose what you want to “Insert reference to.” Choose “Paragraph number”.
- Select the specific numbered item you want to link to from the list that appears.
- Check the box for Insert as hyperlink if you want it to be clickable.
- Click Insert and then Close.
Insert Figure or Table Cross-Links
- Highlight the text you want to link
- Go to the Insert tab on the ribbon.
- In the Links group, click Cross-reference.
- In the Cross-reference dialog box, choose “Figure” or “Table” from the “Reference type” dropdown menu.
- Select how you want the reference to appear from the “Insert reference to” dropdown. Choose “Only label and number” (e.g., “Figure 1”)
- In the “For which caption” list, select the specific figure or table you want to link to.
- Click Insert and then Close.