evergreen-docs:dig_style_guide
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
evergreen-docs:dig_style_guide [2020/10/26 18:03] – [Use case] aneiman | evergreen-docs:dig_style_guide [2021/03/23 12:05] – [Use underline style headings instead of prefix/suffix style] aneiman | ||
---|---|---|---|
Line 13: | Line 13: | ||
<code asciidoc>: | <code asciidoc>: | ||
- | ==== Convert all headings from underline style to prefix/ | + | ==== Use prefix/ |
The basic reasons are: | The basic reasons are: | ||
Line 44: | Line 44: | ||
The above breaks down as follows: | The above breaks down as follows: | ||
- | * xref - indicates a cross reference | + | * '' |
- | * reports - indicates the folder in the docs/ | + | * '' |
- | * reporter_folder.adoc - indicates the specific file being referenced | + | * '' |
- | * reporter_creating_folders - indicates the subheading being linked to within the file | + | * '' |
- | * [Creating Folders] - the link text that is displayed | + | * '' |
For historical purposes, the old xref syntax is below | For historical purposes, the old xref syntax is below | ||
- | **DO NOT USE THIS!** | + | The below is an example of the now-deprecated cross reference style. |
<code asciidoc> | <code asciidoc> | ||
<< | << | ||
Line 181: | Line 181: | ||
* **Don' | * **Don' | ||
* **When replacing a screenshot**, | * **When replacing a screenshot**, | ||
+ | * Image syntax: '' | ||
===== Common Mistakes ===== | ===== Common Mistakes ===== | ||
* AsciiDoc lists (numbered or bulleted) need to be preceded by a blank line. If not, they will be absorbed into the previous paragraph of text, like this: | * AsciiDoc lists (numbered or bulleted) need to be preceded by a blank line. If not, they will be absorbed into the previous paragraph of text, like this: | ||
* '' | * '' | ||
+ | * Callouts should be formatted as ''< | ||
+ | * Images, text blocks, or code blocks that are part of a numbered lists need to have a '' | ||
+ | |||
+ | <code asciidoc> | ||
+ | To edit a Receipt: | ||
+ | |||
+ | . Select *Administration -> Workstation -> Print Templates*. | ||
+ | . Choose the Receipt in the drop down list. | ||
+ | . If you are using Hatch, you can choose different printers for different types | ||
+ | of receipts with the Force Content field. If not, leave that field blank. | ||
+ | Printer Settings can be set at *Administration -> Workstation -> Printer | ||
+ | Settings*. | ||
+ | + | ||
+ | image:: | ||
+ | + | ||
+ | . Make edits to the Receipt on the right hand side. | ||
+ | </ | ||
+ | |||
+ | Note how this preserves the numbering: | ||
+ | |||
+ | {{: | ||
===== Further Reading ===== | ===== Further Reading ===== |
evergreen-docs/dig_style_guide.txt · Last modified: 2023/06/01 12:22 by gmcharlton