feat: add documentation

brotkrueml · Nov 10, 2023 · 76b37bf · 76b37bf
1 parent e3a1887
commit 76b37bf
Show file tree

Hide file tree

Showing 12 changed files with 268 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,7 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [1.0.0] - 2023-10-xx
+## [1.0.0] - 2023-11-xx
 
 Initial release
 

diff --git a/Documentation/Changelog/Index.rst b/Documentation/Changelog/Index.rst
@@ -0,0 +1,17 @@
+.. _changelog:
+
+Changelog
+=========
+
+All notable changes to this project will be documented in this file.
+
+The format is based on `Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_\ ,
+and this project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
+
+`Unreleased <https://github.com/brotkrueml/typo3-info-hide-default-lang/compare/v1.0.0...HEAD>`_
+----------------------------------------------------------------------------------------------------
+
+`1.0.0 <https://github.com/brotkrueml/typo3-info-hide-default-lang/releases/tag/v1.0.0>`_ - 2023-11-xx
+----------------------------------------------------------------------------------------------------------
+
+Initial release
diff --git a/Documentation/Images/example.png b/Documentation/Images/example.png
diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt
@@ -0,0 +1,34 @@
+.. More information about this file:
+   https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
+
+.. ----------
+.. text roles
+.. ----------
+
+.. role:: aspect(emphasis)
+.. role:: bash(code)
+.. role:: html(code)
+.. role:: js(code)
+.. role:: php(code)
+.. role:: rst(code)
+.. role:: sep(strong)
+.. role:: sql(code)
+
+.. role:: tsconfig(code)
+   :class: typoscript
+
+.. role:: typoscript(code)
+.. role:: xml(code)
+   :class: html
+
+.. role:: yaml(code)
+
+.. default-role:: code
+
+.. ---------
+.. highlight
+.. ---------
+
+.. By default, code blocks use PHP syntax highlighting
+
+.. highlight:: php
diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -0,0 +1,57 @@
+.. include:: /Includes.rst.txt
+
+.. _start:
+
+=======================================
+Show info about "Hide default language"
+=======================================
+
+:Extension key:
+   info_hide_default_lang
+
+:Package name:
+   brotkrueml/typo3-info-hide-default-lang
+
+:Version:
+   |release|
+
+:Language:
+   en
+
+:Author:
+   Chris Müller
+
+:License:
+   This document is published under the `Creative Commons BY 4.0`_ license.
+
+:Rendered:
+   |today|
+
+----
+
+When using a multilingual TYPO3 website with a single page tree, the page with
+the default language can be disabled. By default, this is only visible in the
+page properties where this can be adjusted. This extension displays a hint on
+the backend page itself to make editors aware of this setting.
+
+----
+
+**Table of Contents:**
+
+.. toctree::
+   :maxdepth: 2
+   :titlesonly:
+
+   Introduction/Index
+   Installation/Index
+   Changelog/Index
+
+.. Meta Menu
+
+.. toctree::
+   :hidden:
+
+   Sitemap
+
+
+.. _Creative Commons BY 4.0: https://creativecommons.org/licenses/by/4.0/
diff --git a/Documentation/Installation/Index.rst b/Documentation/Installation/Index.rst
@@ -0,0 +1,30 @@
+.. include:: /Includes.rst.txt
+
+.. index:: Installation
+
+.. _installation:
+
+============
+Installation
+============
+
+Target group: **Administrators**
+
+.. note::
+   The extension in version |release| supports TYPO3 v12 LTS.
+
+The recommended way to install this extension is by using Composer. In your
+Composer-based TYPO3 project root, type:
+
+.. code-block:: bash
+
+   composer req brotkrueml/typo3-info-hide-default-lang
+
+and the recent stable version will be installed.
+
+You can also install the extension from the `TYPO3 Extension Repository (TER)`_.
+See :ref:`t3start:extensions_legacy_management` for a manual how to
+install an extension.
+
+
+.. _TYPO3 Extension Repository (TER): https://extensions.typo3.org/extension/info_hide_default_lang/
diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
@@ -0,0 +1,43 @@
+.. include:: /Includes.rst.txt
+
+.. _introduction:
+
+============
+Introduction
+============
+
+.. _what-it-does:
+
+What does it do?
+================
+
+When using a multilingual TYPO3 website with a single page tree, the page with
+the default language can be disabled. By default, this is only visible in the
+page properties where this can be adjusted. This extension displays a hint on
+the backend page itself to make editors aware of this setting:
+
+.. figure:: /Images/example.png
+   :alt: Display information that the default language of a page is deactivated
+   :class: with-shadow
+
+   Display information that the default language of a page is deactivated
+
+
+.. _release-management:
+
+Release management
+==================
+
+This extension uses `semantic versioning`_ which basically means for you, that
+
+*  Bugfix updates (for example, 1.0.0 => 1.0.1) just includes small bug fixes or
+   security relevant stuff without breaking changes.
+*  Minor updates (for example, 1.0.0 => 1.1.0) includes new features and smaller
+   tasks without breaking changes.
+*  Major updates (for example, 1.0.0 => 2.0.0) breaking changes which can be
+   refactorings, features or bug fixes.
+
+The changes between the different versions can be found in the
+:ref:`changelog <changelog>`.
+
+.. _semantic versioning: https://semver.org/
diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg
@@ -0,0 +1,63 @@
+# More information about this file:
+# https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg
+
+[general]
+
+project     = info_hide_default_lang
+version     = 1.0
+release     = 1.0.0-dev
+copyright   = since 2023 by Chris Müller
+
+[html_theme_options]
+
+# "Edit on GitHub" button
+github_repository    = brotkrueml/typo3-info-hide-default-lang
+github_branch        = main
+
+# Footer links
+project_contact      =
+project_discussions  =
+project_home         =
+project_repository   = brotkrueml/typo3-info-hide-default-lang
+project_issues       = brotkrueml/typo3-info-hide-default-lang/issues
+
+[intersphinx_mapping]
+
+# Official TYPO3 manuals
+# h2document     = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/
+# t3content      = https://docs.typo3.org/m/typo3/guide-contentandmarketing/main/en-us/
+# t3contribute   = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/
+# t3coreapi      = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/
+# t3editors      = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/
+# t3extexample   = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/
+# t3home         = https://docs.typo3.org/
+# t3sitepackage  = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/
+t3start        = https://docs.typo3.org/m/typo3/tutorial-getting-started/12.4/en-us/
+# t3tca          = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/
+# t3translate    = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/
+# t3tsconfig     = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/
+# t3tsref        = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/
+# t3ts45         = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/
+# t3viewhelper   = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/
+# t3upgrade      = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/
+
+# TYPO3 system extensions
+# ext_adminpanel     = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/
+# ext_core           = https://docs.typo3.org/c/typo3/cms-core/main/en-us/
+# ext_dashboard      = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/
+# ext_felogin        = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/
+# ext_form           = https://docs.typo3.org/c/typo3/cms-form/main/en-us/
+# ext_fsc            = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/
+# ext_impexp         = https://docs.typo3.org/c/typo3/cms-impexp/main/en-us/
+# ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/
+# ext_linkvalidator  = https://docs.typo3.org/c/typo3/cms-linkvalidator/main/en-us/
+# ext_lowlevel       = https://docs.typo3.org/c/typo3/cms-lowlevel/main/en-us/
+# ext_reactions      = https://docs.typo3.org/c/typo3/cms-reactions/main/en-us/
+# ext_recycler       = https://docs.typo3.org/c/typo3/cms-recycler/main/en-us/
+# ext_redirects      = https://docs.typo3.org/c/typo3/cms-redirects/main/en-us/
+# ext_reports        = https://docs.typo3.org/c/typo3/cms-reports/main/en-us/
+# ext_rte_ckeditor   = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/
+# ext_scheduler      = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/
+# ext_seo            = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/
+# ext_t3editor       = https://docs.typo3.org/c/typo3/cms-t3editor/main/en-us/
+# ext_workspaces     = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/
diff --git a/Documentation/Sitemap.rst b/Documentation/Sitemap.rst
@@ -0,0 +1,9 @@
+:template: sitemap.html
+
+.. include:: /Includes.rst.txt
+
+=======
+Sitemap
+=======
+
+.. The sitemap.html template will insert here the page tree automatically.
diff --git a/Makefile b/Makefile
@@ -1,5 +1,13 @@
 .PHONY: qa
-qa: cs yaml-lint
+qa: cs changelog yaml-lint
+
+# See: https://github.com/crossnox/m2r2
+.PHONY: changelog
+changelog:
+	m2r2 CHANGELOG.md && \
+	echo ".. _changelog:" | cat - CHANGELOG.rst > /tmp/CHANGELOG.rst && \
+	mv /tmp/CHANGELOG.rst Documentation/Changelog/Index.rst && \
+	rm CHANGELOG.rst
 
 .PHONY: cs
 cs: vendor

diff --git a/README.md b/README.md
@@ -7,5 +7,6 @@ the default language can be disabled. By default, this is only visible in the
 page properties where this can be adjusted. This extension displays a hint on
 the backend page itself to make editors aware of this setting.
 
+[Documentation](https://docs.typo3.org/p/brotkrueml/typo3-info-hide-default-lang/main/en-us/) |
 [Changelog](https://github.com/brotkrueml/typo3-info-hide-default-lang/blob/main/CHANGELOG.md) |
 [TYPO3 Extension Repository](https://extensions.typo3.org/extension/info_hide_default_lang)
diff --git a/composer.json b/composer.json
@@ -15,13 +15,14 @@
 	],
 	"support": {
 		"issues": "https://github.com/brotkrueml/typo3-info-hide-default-lang/issues",
-		"source": "https://github.com/brotkrueml/typo3-info-hide-default-lang"
+		"source": "https://github.com/brotkrueml/typo3-info-hide-default-lang",
+		"docs": "https://docs.typo3.org/p/brotkrueml/typo3-info-hide-default-lang/main/en-us/"
 	},
 	"require": {
 		"php": ">=8.1",
 		"typo3/cms-backend": "^12.4",
-        "typo3/cms-core": "^12.4",
-        "typo3/cms-fluid": "^12.4"
+		"typo3/cms-core": "^12.4",
+		"typo3/cms-fluid": "^12.4"
 	},
 	"require-dev": {
 		"brotkrueml/coding-standards": "~5.0.0",