Skip to content

Commit

Permalink
[FEATURE] Add style guide entry for extension names (#14)
Browse files Browse the repository at this point in the history
  • Loading branch information
flicstar authored Dec 3, 2024
1 parent 7ba7242 commit 9ca0fa3
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions Documentation/Content/WritingStyleGuide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,33 @@ Examples:

12 Sep. 2009

.. _extensions:

Extensions
==========

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``.

.. _extensions-examples:

Examples:
---------

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...

.. _numbers:

Numbers
Expand Down

0 comments on commit 9ca0fa3

Please sign in to comment.