Splinter Capitalization Guidelines
Use these guidelines to ensure consistency when writing new Splinter documentation and updating existing content.
-
Follow the capitalization rules for American English.
-
See the Google style guide word list for capitalization of standard technical terms.
-
For software products, companies, and brands, use the official capitalization (see the official website or check Wikipedia).
-
For titles and headings, follow the Chicago Manual of Style’s title rules. (Tip: Use capitalizemytitle.com and select “Chicago”.)
-
Capitalize the first and the last word, nouns, pronouns, adjectives, verbs, adverbs, and subordinate conjunctions (such as Because, Once, Therefore, When, and Unless).
-
Lowercase articles (a, an, the), coordinating conjunctions, prepositions, and the “to” in infinitive verbs.
-
-
Avoid starting a sentence or title with a lowercase term, such as Splinter commands (CLIs), daemons, and services (such as
splinterd
). Instead, rewrite to start with “The” or some other word. -
To form the plural of an all-uppercase term, add a lowercase “s” with no apostrophe, such as CLIs, IDs, and REST APIs.
A - B - C - D - E - F - G - H - I - J - K - L - M - N - O - P - Q - R - S - T - U - V - W - X - Y - Z
A
- admin service
- API, APIs
- application auth handler (or application authorization handler)
B
- Biome
C
- Canopy
- CLI, CLIs
- consensus
G
- Gameroom (example application)
- gameroom (circuit in Gameroom)
-
gameroomd
(daemon; always lowercase) - Grid
-
gridd
(daemon; always lowercase)
I
- ID, IDs
J
- JavaScript
- JSON
K
- key registry (obsolete; use “registry” or “Splinter registry”)
L
-
libsplinter
(always lowercase)
M
- Markdown
- Merkle
- Merkle-Radix tree
N
- node
- node registry (obsolete; use “registry” or “Splinter registry”)
O
- OK
- orchestrator
P
- PDF (not “pdf” or “.pdf”)
- Pike smart contract
- Private Counter (obsolete; this example has been removed from Splinter)
- Private XO (obsolete; this example has been removed from Splinter)
- Product smart contract
R
- README, READMEs
- registry (at first use: “Splinter registry”)
- REST API
- Rust
S
- Sabre (at first use: Sawtooth Sabre)
- sapling
- Sawtooth (at first use: Sawtooth)
- scabbard service
-
scabbard
command (always lowercase) - SCAR file - smart contract archive file (not “scar file” or “.scar file”)
- Schema smart contract
- SDK, SDKs
- Seth (at first use: Sawtooth Seth)
- service names: admin service, scabbard service
- smart contract
- Splinter
-
splinter
command (always lowercase) -
splinter
Rust crate (always lowercase) -
splinterd
(daemon; always lowercase) - state
- state delta export
T
- tic-tac-toe (with two hyphens)
- TOML file (not “toml file” or “.toml file”)
- Transact
- two-phase commit protocol (or “consensus”, depending on context) (avoid “2PC”)
W
- WASM (at first use: “WebAssembly (WASM)”)
- WebAssembly
X
- XO smart contract
-
xo
Sawtooth command (always lowercase)
Y
- YAML file, YAML format (not “yaml file” or “.yaml file”)
Z
- ZeroMQ, ZMQ, 0MQ, ØMQ