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/27 10:49] – [Changes to cross-reference structure] aneiman | evergreen-docs:dig_style_guide [2021/10/27 16:12] – [General] jpringle | ||
---|---|---|---|
Line 9: | Line 9: | ||
==== Add a Table of Contents to the top of each AsciiDoc file ==== | ==== Add a Table of Contents to the top of each AsciiDoc file ==== | ||
- | This simply means adding this AsciiDoc line near the top of each '' | + | This simply means adding this AsciiDoc line near the top of each '' |
- | <code asciidoc>: | ||
- | ==== Use underline | + | <code asciidoc> |
+ | : | ||
+ | |||
+ | |||
+ | |||
+ | ==== Use prefix/ | ||
The basic reasons are: | The basic reasons are: | ||
Line 52: | Line 56: | ||
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. **DO NOT USE THIS!** |
<code asciidoc> | <code asciidoc> | ||
<< | << | ||
Line 67: | Line 71: | ||
* AsciiDoc code lines should be 80 characters long or shorter. (Occasionally, | * AsciiDoc code lines should be 80 characters long or shorter. (Occasionally, | ||
* Screenshots should be smaller than 1050 pixels wide (when possible). | * Screenshots should be smaller than 1050 pixels wide (when possible). | ||
+ | * Rather than recreating documentation text in multiple adoc files, instead link directly to the main adoc for the feature. | ||
===== Formatting ===== | ===== Formatting ===== | ||
==== Headers ==== | ==== Headers ==== | ||
Line 103: | Line 108: | ||
* This allows AsciiDoc to auto-number the items as needed. | * This allows AsciiDoc to auto-number the items as needed. | ||
* **Ampersands** should be left as is (&). Don't use an HTML entity (which ironically causes errors in our HTML generator). | * **Ampersands** should be left as is (&). Don't use an HTML entity (which ironically causes errors in our HTML generator). | ||
+ | * If an ampersand appears in the staff client or OPAC use the ampersand in the documentation. | ||
* Any **code and command line commands** should be marked as +code+ or `code` | * Any **code and command line commands** should be marked as +code+ or `code` | ||
* If the code or command is hard to read when included in the paragraph, consider using a code block: | * If the code or command is hard to read when included in the paragraph, consider using a code block: | ||
Line 181: | Line 187: | ||
* **Don' | * **Don' | ||
* **When replacing a screenshot**, | * **When replacing a screenshot**, | ||
+ | * Image syntax: '' | ||
+ | * Alt text: Please remember to include alt text in the image syntax for descriptive and accessibility reasons. | ||
+ | * Screen shots can be from any installation of Evergreen, as long as it does not contain any personal identifiable information, | ||
===== 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 ''< | + | * Callouts should be formatted as ''< |
* Images, text blocks, or code blocks that are part of a numbered lists need to have a '' | * Images, text blocks, or code blocks that are part of a numbered lists need to have a '' | ||
evergreen-docs/dig_style_guide.txt · Last modified: 2023/06/01 12:22 by gmcharlton