---
title: Content standardization
description: Guide to use consistent terminology in content writing
lang: en
---
This style guide aims to standardize certain aspects of writing content to make the contribution process smoother.
## Use American English {#american-english}
For words that have multiple spellings, use American English over British English.
**For example:**
- "decentralized" over "decentralised"
- "color" over "colour"
- "analyze" over "analyse"
## Terminology {#terminology}
### Ethereum {#ethereum}
Ethereum is a proper noun and should always be capitalized.
- "Ethereum" not "ethereum"
### Ether {#ether}
Ether is a common noun and should not be capitalized unless at the beginning of a sentence. ETH, on the other hand, is a currency abbreviation (and ticker symbol) and should always be capitalized.
- "ether" not "Ether"
- "ETH" not "eth or Eth"
### Mainnet {#mainnet}
When referring to the Ethereum Mainnet (i.e., not referring to a testnet) use the proper noun. Proper nouns help avoid confusion and build greater understanding.
**Correct usage:**
- Mainnet
- Ethereum Mainnet
**Incorrect usage:**
- main net
- mainnet
- Main net
- Ethereum mainnet
### Proof-of-work / Proof-of-stake {#proof-of}
Proof-of-work should be capitalized only when at the beginning of a sentence. In any other instance, all letters should be lower case. In either case, proof-of-work should be hyphenated between each word.
**Correct usage:**
- Proof-of-work
- proof-of-work
**Incorrect usage:**
- Proof-of-Work
- Proof of work
- proof of work
The same rules we apply to proof-of-work are applicable to proof-of-stake, proof-of-authority, proof-of-humanity, proof-of-individuality, etc.
### Smart contract {#smart-contract}
Smart contract is a common noun and should only be capitalized at the beginning of a sentence. In any other instance, all letters should be lowercase.
**Correct usage:**
- Smart contract
- smart contract
**Incorrect usage:**
- Smart Contract
### The Merge {#the-merge}
When referring to The Merge, treat it as a proper noun. Always capitalize the first letter in each word.
**Correct usage:**
- The Merge
**Incorrect usage:**
- The merge
- the Merge
### Zero-knowledge {#zero-knowledge}
Zero-knowledge is a common noun and should only be capitalized at the beginning of a sentence. In any other instance, all letters should be lowercase. In either case, zero-knowledge should be hyphenated between each word.
**Correct usage:**
- Zero-knowledge
- zero-knowledge
**Incorrect usage:**
- Zero-Knowledge
- Zero knowledge
- zero knowledge
### ZK-proof {#zk-proof}
When using the abbreviated form of zero-knowledge proof you should shorten zero-knowledge to ZK, and hyphenate the abbreviation.
**Correct usage:**
- ZK-proof
**Incorrect usage:**
- Zk-proof
- zK-proof
- zk-proof
- Zk proof
- zK proof
- zk proof
### ZK-rollup {#zk-rollup}
When using the abbreviated form of zero-knowledge rollup you should shorten zero-knowledge to ZK, and hyphenate the abbreviation.
**Correct usage:**
- ZK-rollup
**Incorrect usage:**
- Zk-rollup
- zK-rollup
- zk-rollup
- Zk rollup
- zK rollup
- zk rollup
## Writing style guidelines {#writing-style-guidelines}
### Use active voice {#use-active-voice}
Sentences using active voice are more concise and efficient, making your writing more engaging and easier to comprehend.
**Active voice sentence:** an actor acts on a target
> _"The man bought a car."_
**Passive voice sentence:** a target acts on an actor
> _"The car was bought by a man."_
[Read more on active voice](https://www.grammarly.com/blog/active-vs-passive-voice/)
_This isn't an easy one, especially for non-native English speakers. If you aren't sure, don't worry. We'll help with any of these._
### Date format {#date-format}
When including dates in markdown content across Ethereum documentation, it is essential to maintain a consistent and clear presentation. In order to achieve this, we recommend the following guidelines:
**Format:**
Use the "D-Mon-YYYY" format for dates. This format eliminates ambiguity between the month and day, providing a standardized and easily understandable representation.
**Examples:**
- Preferred: 2-Nov-2023, 11-Feb-2023
- Avoid: Nov-2-2023, 2/11/2023, 11/2/2023
By adhering to these guidelines, we create a unified approach to presenting dates, fostering clarity and comprehension throughout Ethereum documentation.
### Linking to internal pages {#internal-links}
When linking to another page on ethereum.org, use the relative path over the absolute path. Do not hard-code the language path (i.e., `/en/`) in any links, and do not include the `https://ethereum.org` domain. This maintains consistent functionality across different language versions of the site.
```md
Read more about [smart contracts](/developers/docs/smart-contracts/)
Read more about [smart contracts](/en/developers/docs/smart-contracts)
Read more about [smart contracts](/developers/docs/smart-contracts)
Read more about [smart contracts](https://ethereum.org/developers/docs/smart-contracts)
```
Please also add a trailing slash to all links. This keeps links consistent and avoids redirects, which hurts site performance.
```md
Read more about [smart contracts](/docs/developers/smart-contracts/)
Read more about [smart contracts](/docs/developers/smart-contracts)
```
### Linking to images {#images}
When adding an image to a page, the image should be downloaded and placed in the same folder as the markdown file. You can reference the image like this:
``
```md
```
This helps us ensure the image will be available.
### Using emojis {#images-2}
Everyone loves emojis To standardize the appearance of all Emojis across browsers, ethereum.org uses an `` React component.
```md
<--- Good --->
The London Upgrade is live
The London Upgrade is live
<--- Bad --->
The London Upgrade is live 🎉
```
### Header casing {#header-casing}
This site uses **sentence casing** for header names as a convention. Only the first word and proper nouns are capitalized. This applies to all markdown files on lines that begin with hashes (#).
```md
## Minting your NFT
### Setting up your wallet
### Get enough ether
## Minting Your NFT
### Setting Up Your Wallet
### Getting Enough ether
```
### Article authors {#authors}
When citing articles from a specific author or organization, use the article's name as a link, followed by a dash, then the author's name italicized.
```md
<--- Good --->
- [A rollup-centric ethereum roadmap](https://ethereum-magicians.org/t/a-rollup-centric-ethereum-roadmap/4698) — _Vitalik Buterin_
- [The History of Ethereum Testnets](https://consensys.net/blog/news/the-history-of-ethereum-testnets/) – _ConsenSys_
<--- Bad--->
- [A rollup-centric ethereum roadmap by Vitalik Buterin](https://ethereum-magicians.org/t/a-rollup-centric-ethereum-roadmap/4698)
- [ConsenSys on The History of Ethereum Testnets](https://consensys.net/blog/news/the-history-of-ethereum-testnets/) – _ConsenSys_
```
### Onchain and offchain {#onchain-offchain}
Similar to "online" or "offline", the terms "onchain" and "offchain" should be written as one word, without a space or hyphenation.
```md
<--- Good --->
Discussion was held in an offchain forum, and the vote was performed onchain.
<--- Bad--->
Discussion was held in an off-chain forum, and the vote was performed on-chain.
```
### Hyphen (-), en dash (–), and em dash (—): usage guide {#dash-usage-guide}
For further reading, see [Merriam-Webster: How to Use Em Dashes, En Dashes, and Hyphens](https://www.merriam-webster.com/grammar/em-dash-en-dash-how-to-use)
#### Hyphen (-) {#hyphen}
- **Purpose:** Joins words or parts of words.
- **Use for:** Compound words (well-known), prefixes (re-enter), word breaks at line ends.
- **Example:** state-of-the-art, self-aware
- **How to type:**
- Mac: `-` key
- Windows: `-` key
- Linux: `-` key
```md
state-of-the-art solution
re-enter your password
state of the art solution
reenter your password
```
#### En dash (–) {#en-dash}
- **Purpose:** Indicates ranges or relationships.
- **Use for:** Ranges (dates, numbers), connections (geographical, partnerships).
- **Example:** 2010–2020, New York–London flight
- **How to type:**
- Mac: `Option` + `-`
- Windows: `Alt` + `0150`
- Linux: `Ctrl` + `Shift` + `u`, then type `2013`, then press `Space` or `Enter`
```md
The event runs 10–12 June.
The Paris–Berlin flight was delayed.
The event runs 10-12 June.
The Paris - Berlin flight was delayed.
```
#### Em dash (—) {#em-dash}
- **Purpose:** Creates a strong break, sets off information, or shows interruption.
- **Use for:** Parenthetical statements, abrupt changes, emphasis.
- **Example:** She was late—again.
- **How to type:**
- Mac: `Option` + `Shift` + `-`
- Windows: `Alt` + `0151`
- Linux: `Ctrl` + `Shift` + `u`, then type `2014`, then press `Space` or `Enter`
```md
He was sure of one thing—he would not give up.
The results—despite initial doubts—were impressive.
He was sure of one thing — he would not give up.
The results -- despite initial doubts -- were impressive.
```
### Examples (e.g.,) and restatements (i.e.,) {#examples-restatements}
When using examples (e.g.,) or restatements (i.e.,) it should include the comma after the second period.
**Usage:**
- i.e., (that is) introduces a word or phrase that restates what has already been stated.
- e.g., (for example) is used similarly to "for example" preceding an item or list of items.
This usage will allow for consistency and presentation across the documentation.
**Examples:**
- Preferred: i.e., or e.g.,
- Avoid: i.e. ie. e.g. or eg.
#### Spacing {#dash-spacing}
No spaces should appear before or after any dash—hyphen, en dash, or em dash—in standard usage.
#### Quick reference table {#dash-reference-table}
| Mark | Symbol | Main use | Example |
| ------- | ------ | ------------------- | ------------------------- |
| Hyphen | - | Compound words | well-known author |
| En dash | – | Ranges, connections | pages 10–20, Paris–Berlin |
| Em dash | — | Breaks, emphasis | He was late—again. |
**Tip:** Use each dash for its specific purpose, follow spacing rules, and use the correct input method for clear, professional writing.