--- title: "Writing Style Guide" manual: "Content and Marketing Guide" version: "main" permalink: "https://docs.typo3.org/permalink/t3content:writing-style-guide" source: "Content/WritingStyleGuide.rst" rendered: "2026-09-18T09:38:37+00:00" --- # Writing Style Guide {#writing-style-guide-1} **By using this style guide we ensure that all written texts have the same general grammar and writing style — even when many people contribute. This guide should be easy to use, and it is based on the existing proto house style used at typo3.org.** Style guides can become very, very long. We keep this guide short to make sure you read it, but it means we only cover the most important topics. If you would like to read more about style and usage, check out [Jack Lynch’s Guide to Grammar and Style](http://jacklynch.net/Writing/), read the [Google Developer Documentation Style Guide](https://developers.google.com/style/), or buy the [Chicago Manual of Style](http://www.chicagomanualofstyle.org/) (after all, it is abbreviated CMS). **Table of Contents** - [General Assumptions](https://docs.typo3.org/permalink/t3content:general-assumptions) - [Buttons](https://docs.typo3.org/permalink/t3content:buttons-1) - [Commas in Lists](https://docs.typo3.org/permalink/t3content:commas-in-lists) - [Currency](https://docs.typo3.org/permalink/t3content:currency-1) - [Dashes](https://docs.typo3.org/permalink/t3content:dashes-1) - [Dates](https://docs.typo3.org/permalink/t3content:dates-1) - [Extensions](https://docs.typo3.org/permalink/t3content:extensions-1) - [Links (Prioritizing)](https://docs.typo3.org/permalink/t3content:links-prioritizing-1) - [Links (Inline)](https://docs.typo3.org/permalink/t3content:links-inline-1) - [Numbers](https://docs.typo3.org/permalink/t3content:numbers-1) - [Emphasis](https://docs.typo3.org/permalink/t3content:emphasis-1) - [Place Names](https://docs.typo3.org/permalink/t3content:place-names) - [Portmanteaus With Single-Letter Prefix](https://docs.typo3.org/permalink/t3content:portmanteaus-with-single-letter-prefix) - [Quotes](https://docs.typo3.org/permalink/t3content:quotes-1) - [Title Case](https://docs.typo3.org/permalink/t3content:title-case-1) ## General Assumptions {#general-assumptions} ### Spelling {#spelling-1} We use American (US) spelling. That means we write color, rather than *colour, and use -ize endings, rather than* -ise. ### Dictionary {#dictionary-1} If the spelling of a word is disputed, [Merriam-Webster’s Dictionary](https://www.merriam-webster.com/) has the correct answer. ## Buttons {#buttons-1} Buttons are capitalized using Title Case. ## Commas in Lists {#commas-in-lists} We use the so-called Oxford (or serial) comma, setting a comma before the final “and” or “or” in a list with three or more items. ### Examples: {#examples} Apples, orange, grapes, and bananas. I eat Chinese gooseberries and pineapples. Would you like potatoes, carrots, or leeks? ## Currency {#currency-1} Currency values are written using the three-letter ISO code, followed by a space, followed by the value written according to our number style. Currency symbols, such as € and $ can be used as a shortened form. They are placed in front of the value, with no space separating them. ### Examples: {#examples-1} The tickets cost EUR 1,000. We made a profit of exactly USD 25,060.17. Grab it now, for just €1. ## Dashes {#dashes-1} We use an em-dashes with spaces around to mark parenthesis. We use n-dashes without spaces around to mark from–to in a number series. ### Examples: {#examples-2} TYPO3 — not any other CMS — is my favorite. There are 20–25 options available. ## Dates {#dates-1} We prefer the international date style: day, month, and year. We always write the month name. Dates written as numbers only will cause confusion for our international audience. Years are always written in four digits. Month names are normally written in full, but can be abbreviated if you lack space, as rendered by the PHP function date('M.'): Jan., Feb., Mar., Apr., May., Jun., Jul., Aug., Sep., Oct., Nov., and Dec. ### Examples: {#examples-3} 24 December 2018 12 Sep. 2009 ## Extensions {#extensions-1} All extensions have a proper name in addition to the lowercase extension key. For example: - Name: AWS SDK for PHP - Key: aws_sdk_php When we write about extensions, we use the proper name with the convention: "The \[proper name\] extension...". On the first instance of the extension name in the text, we include the key in paranthesis immediately following the proper name. For example, "The AWS SDK for PHP (aws_sdk_php) extension...". Where appropriate, on the first instance of the extension name in the text, we also include the link to the extension's page in the [TYPO3 Extension Repository](https://extensions.typo3.org/). When we want to refer just to the key, for example in procedural or highly technical content, we prepend the key name with "EXT" in upper case, and we apply code formatting style to the text. For example, `EXT:aws_sdk_php`. ### Examples: {#examples-4} The [AWS SDK for PHP](https://extensions.typo3.org/extension/aws_sdk_php) extension (aws_sdk_php) makes the [Amazon Web Services (AWS) SDK for PHP](https://github.com/aws/aws-sdk-php) available for TYPO3. The kreXX Debugger extension (includekrexx) offers advanced debugging features such as... ## Links (Prioritizing) {#links-prioritizing-1} We prioritize links according to these rules: - Always prioritize links to TYPO3's own web properties. - Only link to external websites when no suitable alternative can be found and it is a benefit to the reader. - Link to a site’s domain or main page unless deep linking is a benefit to the reader. - Link to explanations of terms, technologies, and products when it is a benefit to the reader. - Use links to neutral and non-profit sites like Wikipedia over biased or commercial interests. - Link to content in the same language whenever possible. - Commercial sites can be linked as an acknowledgement for contribution to TYPO3. - Do not link to external content advertising commercial or paid products/services unless an official TYPO3 endorsement exists. As a guideline, we prioritize links within TYPO3's web properties according to this list: 1. Same site 1. typo3.com 1. news.typo3.com, typo3.community, and typo3.org 1. Other properties (docs.typo3.org, extensions.typo3.org, talk.typo3.org, etc.) See also the entry on [extensions](https://docs.typo3.org/permalink/t3content:extensions). ## Links (Inline) {#links-inline-1} Our inline links should: - Be descriptive, concise, and logically integrated into the text. - Contain relevant keywords that semantically describe the content of the page they link to. - Be further contextualized in surrounding content, for example by including relevant conclusions. It follows that links with terms like "click here" and "this" are discouraged. ### Examples: {#examples-5} The [development roadmap](https://docs.typo3.org/permalink/t3content:writing-style-guide-1) contains information about features, PHP compatibility, and end-of-life dates. Discover impactful projects created by our [global network of partner agencies](https://docs.typo3.org/permalink/t3content:writing-style-guide-1). Last year's [TYPO3 Association budget](https://docs.typo3.org/permalink/t3content:writing-style-guide-1) increased by 20 billion. ## Numbers {#numbers-1} Numbers are written using a dot “.” as a decimal separator and comma “,” as a thousands separator. We normally use max two decimals. The number of decimals used should reflect the text's need for accuracy. The thousands separator can be omitted for numbers 1,000–9,999. A zero should be included before the dot in numbers less than 1.0. Very large integer numbers (those above 999,999) should be written using million, billion, or trillion, replacing the last six or nine digits. Numbers less than ten are spelt out, unless they are dates or part of a list with larger values. ## Emphasis {#emphasis-1} We use *italics* for emphasis on single words or compound words. **Bold** text is used to increase visibility on words, compound words, parts of sentences, and sentences. We never use underlined text. ### Examples: {#examples-6} Becoming a member is *very* important. This year’s **accounts are looking very good**. This text is *not* underlined for emphasis. ### Examples: {#examples-7} The Association has 12,481 members. The function nesting limit is set to 1000. That is exactly 99.96% true. The file has more than 30 million lines. All of the three million TYPO3 users are geniuses. I need at least five developers. Choose between the numbers 4, 42, and 64. The difference is less than 0.5. ## Place Names {#place-names} English spelling is used for placenames. When an English spelling is not available, the name is transliterated using the [Unicode Transliteration Guidelines](https://cldr.unicode.org/index/cldr-spec/transliteration-guidelines). Acceptable transliterations can be found on [Wikipedia](https://en.wikipedia.org) and [OpenStreetMap's Nominatim Search](https://nominatim.openstreetmap.org) Keeping diacritics is preferred, but not required. Place names should always be introduced with their country. State or region is optional, but recommended where it can avoid misunderstanding. When not otherwise explained in context, the country and state/region is postfixed, separated by comma(s): \[Place Name\], \[State/Region, \]\[Country\]. Names of states and regions are never abbreviated. > [!WARNING] > Please note that transliterations are language-dependent. Both Japanese and Chinese use similar characters, so the characters for the Japanese town of Ōzora (大空町) is transliterated *Ōzora-chō*, while an errouneous Chinese transliteration may be *\*dakongting*. TYPO3's built-in transliterator uses German transliteration, which is different to most English. In slugs, Gümüşhane in Turkey will erroneously be transliterated as *\*guemueshane*, rather than *gumushane*. ### Examples: {#examples-8} There are more than a hundred TYPO3 agencies in Munich, Germany. New York, Lincolnshire, United Kingdom Düsseldorf is the capital city of North Rhine-Westphalia, Germany. The Swedish city of Gothenburg is north of Malmö. Have you ever been to Ozora? You'll find there's more than one Kandovan in Iran. ## Portmanteaus With Single-Letter Prefix {#portmanteaus-with-single-letter-prefix} Except for the word *email*, portmanteaus with single-letter prefixes, such as *e-commerce* and *e-governance* must be written with a dash separating the prefix from the rest of the word. For product names and trademarks, the spelling and capitalization used by the owner should be used. ### Examples: {#examples-9} e-commerce e-governance email E-Governance In Title Case eMac ## Quotes {#quotes-1} Exact quotes are written between double quotation marks. Quotes within quotes are written between single quotes. For long quoted sections, we use indented block quotations without quotation marks. Periods and commas are placed within quotation marks. Colons and semicolons are placed outside of quotation marks. Changes and omissions within quotes are \[in brackets\]. ### Examples: {#examples-10} I felt great each time he said “I love TYPO3.” “I love TYPO3,” he said enthusiastically. He said he “ha\[d\] no idea why people said ‘hello’ all the \[…\] time.” The poem goes: > Roses are red > Violets are blue ## Title Case {#title-case-1} We capitalize all principal words of a title, including the first and the last words. We do not capitalize articles, prepositions or conjunctions that have fewer than four letters, such as: - a - an - and - at - but - by - for - in - nor - of - on - or - so - the - to - up - yet To make things easy, use *AP* capitalization at [capitalizemytitle.com](https://capitalizemytitle.com/), and be aware that we are using a somewhat simplified rule. ### Examples: {#examples-11} TYPO3 Is Great How to Configure Your Development Environment