You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: template.md
+17-8Lines changed: 17 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Symbiota Docs Documentation Style Guide
2
-
Please refer to and update this style guide to help maintain consistency across the user documentation for [Symbiota](https://github.com/BioKIC/Symbiota).
2
+
Please refer to and update this style guide to help maintain consistency and readability across the user documentation for [Symbiota](https://github.com/BioKIC/Symbiota).
3
3
4
4
## Page-level Frontmatter
5
-
Each page in Symbiota Docs should contain the following elements, some of which format the citation that appears at the bottom of each page:
5
+
Each page in Symbiota Docs should contain the following elements, some of which format the citations on the bottom of each page:
6
6
```
7
7
title: "Page Title in Title Case"
8
8
date: 20XX-MM-DD
@@ -12,7 +12,7 @@ authors: ["Firstname Lastname"]
12
12
keywords: ["x", "y", "z", "etc"]
13
13
```
14
14
-`date` should refer to the first day that the page was created, not modified (see below).
15
-
- Title values shoule be succicent and often reflect an action, e.g. "Deleting Records".
15
+
- Title values should be succicent and often reflect an action using a gerund, e.g. "Deleting Records".
16
16
17
17
If a page is modified, add values for `lastmod` and `editors`:
18
18
```
@@ -40,10 +40,10 @@ Or to add tips:
40
40
{{</ notice >}}
41
41
```
42
42
43
-
Use _italics_ for
43
+
Use _italics_ for:
44
44
- Filenames, e.g. _identifications.csv_
45
45
- Names of columns/fields, e.g. _Additional Identifier Value_ or _basisOfRecord_
46
-
- File and navigation paths, paired with carrots, e.g. _My Profile > Occurrence Management > Administration Control Panel_ or _Sitemap > Additional Resources > Glossary_
46
+
- File and navigation paths paired with carrots, e.g. _My Profile > Occurrence Management > Administration Control Panel_ or _Sitemap > Additional Resources > Glossary_
47
47
48
48
Use quotation marks `"..."` when referencing:
49
49
- Example values, e.g. "PreservedSpecimen"
@@ -56,9 +56,18 @@ Use capitalization for:
56
56
Use **bold** for:
57
57
- emphasis, e.g. "Before batch editing, remember to **backup your dataset**".
58
58
59
+
For code and commands:
60
+
- Format shorter code snippets with \`...\`, e.g. `bundle exec jekyll serve`.
61
+
- More extensive code and commands can be recorded à la:
62
+
```
63
+
{{< highlight batchfile >}}
64
+
cd Documents/symbiota-docs/
65
+
hugo server -D
66
+
{{< /highlight >}}
67
+
```
68
+
59
69
Additionally:
60
-
- Top-level headings within documentation pages should use `##` and should generally use title case.
61
-
- Format code snippets with \`...\`, e.g. `bundle exec jekyll serve`.
70
+
- Top-level headings within documentation pages should use `##` and generally should be written in title case.
62
71
- File extensions written as part of a filename are lowercase, e.g. *example.jpg*, but when written alone are uppercase, e.g. "The file should be a JPG."
63
72
64
73
## Including Media
@@ -94,5 +103,5 @@ Image files should be named descriptively in lowercase. Do not use any character
0 commit comments