Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision |
evergreen-docs:dig_style_guide [2021/10/07 14:13] – [Other Formatting] jpringle | evergreen-docs:dig_style_guide [2022/02/10 13:34] – external edit 127.0.0.1 |
---|
* AsciiDoc code lines should be 80 characters long or shorter. (Occasionally, exceptions are necessary for correct syntax.) | * AsciiDoc code lines should be 80 characters long or shorter. (Occasionally, exceptions are necessary for correct syntax.) |
* 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 ==== |
* **Don't add a border or shadow** to the screenshot image. That can be done globally to all screenshots in the docs via CSS, if we want it. | * **Don't add a border or shadow** to the screenshot image. That can be done globally to all screenshots in the docs via CSS, if we want it. |
* **When replacing a screenshot**, if the intention of the image isn't changing, then create a new image with the same file name as the old image. However, if you are essentially removing a screenshot and adding a different one (with a different focus or purpose), it is better to use a different file name (and update the reference to it in the docs!), and probably to change the related text in the documentation also. | * **When replacing a screenshot**, if the intention of the image isn't changing, then create a new image with the same file name as the old image. However, if you are essentially removing a screenshot and adding a different one (with a different focus or purpose), it is better to use a different file name (and update the reference to it in the docs!), and probably to change the related text in the documentation also. |
* Image syntax: ''image::media/filename.png[alt text]''. If the image file is within the same module parent directory as the file containing the image link, you don't need to further enumerate the path. Please remember to include alt text for descriptive and accessibility reasons. | * Image syntax: ''image::ascii_doc_name/imagename.png[alt text]''. Starting with version 3.8 screenshots should be put into folders with the same name as the page the images appear on. For example, if your page is circulation_policies.adoc in the admin folder the image folder would be called circulation_policies and would be in admin -> assets -> images -> circulation_policies. |
| * 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, and is based on stock Evergreen. | * Screen shots can be from any installation of Evergreen, as long as it does not contain any personal identifiable information, and is based on stock Evergreen. |
===== Common Mistakes ===== | ===== Common Mistakes ===== |