├── Documentation ├── Images │ ├── BackendView.png │ └── IntroductionPackage.png ├── Localization.de_DE │ ├── Images │ │ ├── BackendView.png │ │ └── IntroductionPackage.png │ ├── Sitemap.rst │ ├── Templates │ │ ├── Examples.rst │ │ ├── Index.rst │ │ ├── ViewHelpers.rst │ │ └── Override.rst │ ├── Configuration │ │ ├── Index.rst │ │ ├── TypoScriptReference │ │ │ ├── Setup.rst │ │ │ ├── Index.rst │ │ │ └── Constants.rst │ │ ├── General.rst │ │ └── TSconfig.rst │ ├── Installation │ │ └── Index.rst │ ├── KnownProblems │ │ └── Index.rst │ ├── Includes.rst.txt │ ├── Editor │ │ └── Index.rst │ ├── guides.xml │ ├── Introduction │ │ └── Index.rst │ ├── Developer │ │ └── Index.rst │ └── Index.rst ├── Localization.fr_FR │ ├── Images │ │ ├── BackendView.png │ │ └── IntroductionPackage.png │ ├── Sitemap.rst │ ├── Templates │ │ ├── Examples.rst │ │ ├── Index.rst │ │ ├── ViewHelpers.rst │ │ └── Override.rst │ ├── Configuration │ │ ├── Index.rst │ │ ├── TypoScriptReference │ │ │ ├── Setup.rst │ │ │ ├── Index.rst │ │ │ └── Constants.rst │ │ ├── General.rst │ │ └── TSconfig.rst │ ├── Installation │ │ └── Index.rst │ ├── KnownProblems │ │ └── Index.rst │ ├── Includes.rst.txt │ ├── Editor │ │ └── Index.rst │ ├── guides.xml │ ├── Introduction │ │ └── Index.rst │ ├── Developer │ │ └── Index.rst │ └── Index.rst ├── Sitemap.rst ├── Templates │ ├── Examples.rst │ ├── Index.rst │ ├── ViewHelpers.rst │ └── Override.rst ├── Configuration │ ├── Index.rst │ ├── TypoScriptReference │ │ ├── Setup.rst │ │ ├── Index.rst │ │ └── Constants.rst │ ├── General.rst │ └── TSconfig.rst ├── Installation │ └── Index.rst ├── KnownProblems │ └── Index.rst ├── Includes.rst.txt ├── Editor │ └── Index.rst ├── guides.xml ├── Introduction │ └── Index.rst ├── Developer │ └── Index.rst └── Index.rst ├── composer.json ├── README.rst ├── .gitignore ├── .github └── workflows │ └── test-documentation.yml ├── .editorconfig ├── Makefile └── CONTRIBUTING.rst /Documentation/Images/BackendView.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/HEAD/Documentation/Images/BackendView.png -------------------------------------------------------------------------------- /Documentation/Images/IntroductionPackage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/HEAD/Documentation/Images/IntroductionPackage.png -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Images/BackendView.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/HEAD/Documentation/Localization.de_DE/Images/BackendView.png -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Images/BackendView.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/HEAD/Documentation/Localization.fr_FR/Images/BackendView.png -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Images/IntroductionPackage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/HEAD/Documentation/Localization.de_DE/Images/IntroductionPackage.png -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Images/IntroductionPackage.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/HEAD/Documentation/Localization.fr_FR/Images/IntroductionPackage.png -------------------------------------------------------------------------------- /Documentation/Sitemap.rst: -------------------------------------------------------------------------------- 1 | :template: sitemap.html 2 | 3 | .. include:: /Includes.rst.txt 4 | 5 | ======= 6 | Sitemap 7 | ======= 8 | 9 | .. The sitemap.html template will insert here the page tree automatically. 10 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Sitemap.rst: -------------------------------------------------------------------------------- 1 | :template: sitemap.html 2 | 3 | .. include:: /Includes.rst.txt 4 | 5 | ======= 6 | Sitemap 7 | ======= 8 | 9 | .. The sitemap.html template will insert here the page tree automatically. 10 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Sitemap.rst: -------------------------------------------------------------------------------- 1 | :template: sitemap.html 2 | 3 | .. include:: /Includes.rst.txt 4 | 5 | ======= 6 | Sitemap 7 | ======= 8 | 9 | .. The sitemap.html template will insert here the page tree automatically. 10 | -------------------------------------------------------------------------------- /Documentation/Templates/Examples.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: Templates; Examples 3 | .. _templates-examples: 4 | 5 | =================== 6 | Templating examples 7 | =================== 8 | 9 | You can provide some examples here... 10 | -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "typo3/guide-example-extension-manual", 3 | "type": "typo3-cms-documentation", 4 | "description": "TYPO3 Example Extension Manual", 5 | "license": "CC-BY-NC-SA-4.0", 6 | "require": { 7 | "typo3/cms-core": "^11.4" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Templates/Examples.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: Templates; Examples 3 | .. _templates-examples: 4 | 5 | =================== 6 | Templating examples 7 | =================== 8 | 9 | You can provide some examples here... 10 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Templates/Examples.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: Templates; Examples 3 | .. _templates-examples: 4 | 5 | =================== 6 | Templating examples 7 | =================== 8 | 9 | You can provide some examples here... 10 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | .. warning:: 2 | This repository is archived. Use the init command of the Docker rendering 3 | containter to generate to create a new documentation guide instead. 4 | 5 | `How to document an extension `_ 6 | -------------------------------------------------------------------------------- /Documentation/Configuration/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _configuration: 4 | 5 | ============= 6 | Configuration 7 | ============= 8 | 9 | .. toctree:: 10 | :maxdepth: 5 11 | :titlesonly: 12 | 13 | General 14 | TypoScriptReference/Index 15 | TSconfig 16 | 17 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Configuration/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _configuration: 4 | 5 | ============= 6 | Configuration 7 | ============= 8 | 9 | .. toctree:: 10 | :maxdepth: 5 11 | :titlesonly: 12 | 13 | General 14 | TypoScriptReference/Index 15 | TSconfig 16 | 17 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Configuration/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _configuration: 4 | 5 | ============= 6 | Configuration 7 | ============= 8 | 9 | .. toctree:: 10 | :maxdepth: 5 11 | :titlesonly: 12 | 13 | General 14 | TypoScriptReference/Index 15 | TSconfig 16 | 17 | -------------------------------------------------------------------------------- /Documentation/Templates/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: ! Templates 3 | .. _templates: 4 | 5 | ========= 6 | Templates 7 | ========= 8 | 9 | This chapter is all about templating EXT:myextension 10 | 11 | .. toctree:: 12 | :maxdepth: 5 13 | :titlesonly: 14 | 15 | Override 16 | ViewHelpers 17 | Examples 18 | -------------------------------------------------------------------------------- /Documentation/Installation/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _installation: 4 | 5 | ============ 6 | Installation 7 | ============ 8 | 9 | * How is the extension installed? 10 | * Are there any dependencies that need to be resolved? 11 | 12 | References to general TYPO3 documentation are possible, 13 | for example the :ref:`t3upgrade:start`. 14 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Templates/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: ! Templates 3 | .. _templates: 4 | 5 | ========= 6 | Templates 7 | ========= 8 | 9 | This chapter is all about templating EXT:myextension 10 | 11 | .. toctree:: 12 | :maxdepth: 5 13 | :titlesonly: 14 | 15 | Override 16 | ViewHelpers 17 | Examples 18 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Templates/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: ! Templates 3 | .. _templates: 4 | 5 | ========= 6 | Templates 7 | ========= 8 | 9 | This chapter is all about templating EXT:myextension 10 | 11 | .. toctree:: 12 | :maxdepth: 5 13 | :titlesonly: 14 | 15 | Override 16 | ViewHelpers 17 | Examples 18 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Installation/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _installation: 4 | 5 | ============ 6 | Installation 7 | ============ 8 | 9 | * How is the extension installed? 10 | * Are there any dependencies that need to be resolved? 11 | 12 | References to general TYPO3 documentation are possible, 13 | for example the :ref:`t3upgrade:start`. 14 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Installation/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _installation: 4 | 5 | ============ 6 | Installation 7 | ============ 8 | 9 | * How is the extension installed? 10 | * Are there any dependencies that need to be resolved? 11 | 12 | References to general TYPO3 documentation are possible, 13 | for example the :ref:`t3upgrade:start`. 14 | -------------------------------------------------------------------------------- /Documentation/KnownProblems/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _known-problems: 4 | 5 | ============== 6 | Known problems 7 | ============== 8 | 9 | Use this section for informing about any type of of problem. 10 | 11 | This extension does not offer anything ... and it is not in the scope of intended usage.. 12 | 13 | Find a list of `open issues on Github 14 | `__. 15 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Git global ignore file 2 | # for local exclude patterns please edit .git/info/exclude 3 | # Example file see https://github.com/TYPO3-Documentation/T3DocTeam/blob/main/.gitignore 4 | 5 | # ignore generated documentation 6 | *GENERATED* 7 | 8 | # ignore typical clutter of IDEs and editors (this could be added in .git/info/exclude, 9 | # but we add it here for convenience) 10 | *~ 11 | *.bak 12 | *.idea 13 | *.project 14 | *.swp 15 | .project 16 | .webprj 17 | nbproject 18 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/KnownProblems/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _known-problems: 4 | 5 | ============== 6 | Known problems 7 | ============== 8 | 9 | Use this section for informing about any type of of problem. 10 | 11 | This extension does not offer anything ... and it is not in the scope of intended usage.. 12 | 13 | Find a list of `open issues on Github 14 | `__. 15 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/KnownProblems/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _known-problems: 4 | 5 | ============== 6 | Known problems 7 | ============== 8 | 9 | Use this section for informing about any type of of problem. 10 | 11 | This extension does not offer anything ... and it is not in the scope of intended usage.. 12 | 13 | Find a list of `open issues on Github 14 | `__. 15 | -------------------------------------------------------------------------------- /Documentation/Configuration/TypoScriptReference/Setup.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: typoscript 3 | .. index:: 4 | TypoScript; Setup 5 | .. _configuration-typoscript-setup: 6 | 7 | Setup 8 | ===== 9 | 10 | Enable / disable some options 11 | ----------------------------- 12 | 13 | .. confval:: enableThat 14 | 15 | :type: bool, stdWrap 16 | :Default: 0 17 | 18 | If :typoscript:`1` then something is enabled... 19 | 20 | 21 | Example:: 22 | 23 | plugin.tx_example.settings { 24 | enableThis.field = xyz 25 | } 26 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Configuration/TypoScriptReference/Setup.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: typoscript 3 | .. index:: 4 | TypoScript; Setup 5 | .. _configuration-typoscript-setup: 6 | 7 | Setup 8 | ===== 9 | 10 | Enable / disable some options 11 | ----------------------------- 12 | 13 | .. confval:: enableThat 14 | 15 | :type: bool, stdWrap 16 | :Default: 0 17 | 18 | If :typoscript:`1` then something is enabled... 19 | 20 | 21 | Example:: 22 | 23 | plugin.tx_example.settings { 24 | enableThis.field = xyz 25 | } 26 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Configuration/TypoScriptReference/Setup.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: typoscript 3 | .. index:: 4 | TypoScript; Setup 5 | .. _configuration-typoscript-setup: 6 | 7 | Setup 8 | ===== 9 | 10 | Enable / disable some options 11 | ----------------------------- 12 | 13 | .. confval:: enableThat 14 | 15 | :type: bool, stdWrap 16 | :Default: 0 17 | 18 | If :typoscript:`1` then something is enabled... 19 | 20 | 21 | Example:: 22 | 23 | plugin.tx_example.settings { 24 | enableThis.field = xyz 25 | } 26 | -------------------------------------------------------------------------------- /.github/workflows/test-documentation.yml: -------------------------------------------------------------------------------- 1 | name: test documentation 2 | 3 | on: [ push, pull_request ] 4 | 5 | jobs: 6 | tests: 7 | name: documentation 8 | runs-on: ubuntu-latest 9 | steps: 10 | - name: Checkout 11 | uses: actions/checkout@v4 12 | 13 | - name: Test if the documentation will render without warnings 14 | run: | 15 | mkdir -p Documentation-GENERATED-temp \ 16 | && docker run --rm --pull always -v $(pwd):/project \ 17 | ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log 18 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | # EditorConfig is awesome: http://EditorConfig.org 2 | # 3 | # Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/master/.editorconfig 4 | 5 | # top-most EditorConfig file 6 | root = true 7 | 8 | [{*.rst,*.rst.txt}] 9 | charset = utf-8 10 | end_of_line = lf 11 | insert_final_newline = true 12 | trim_trailing_whitespace = true 13 | indent_style = space 14 | indent_size = 4 15 | max_line_length = 80 16 | 17 | # MD-Files 18 | [*.md] 19 | charset = utf-8 20 | end_of_line = lf 21 | insert_final_newline = true 22 | trim_trailing_whitespace = true 23 | indent_style = space 24 | indent_size = 4 25 | max_line_length = 80 26 | 27 | # Makefile 28 | [{Makefile,**.mk}] 29 | # Use tabs for indentation (Makefiles require tabs) 30 | indent_style = tab -------------------------------------------------------------------------------- /Documentation/Configuration/TypoScriptReference/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. _configuration-typoscript: 3 | 4 | TypoScript reference 5 | ==================== 6 | 7 | Possible subsections: Reference of TypoScript options. 8 | The construct below show the recommended structure for TypoScript properties listing and description. 9 | 10 | When detailing data types or standard TypoScript features, 11 | don't hesitate to cross-link to the TypoScript Reference as shown below. 12 | 13 | See :ref:`h2document:how-to-document-hyperlinks` for information about how to use cross-references. 14 | 15 | See the :file:`guides.xml` file for the declaration of cross-linking keys. 16 | 17 | .. toctree:: 18 | :maxdepth: 5 19 | :titlesonly: 20 | 21 | Constants 22 | Setup 23 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Configuration/TypoScriptReference/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. _configuration-typoscript: 3 | 4 | TypoScript reference 5 | ==================== 6 | 7 | Possible subsections: Reference of TypoScript options. 8 | The construct below show the recommended structure for TypoScript properties listing and description. 9 | 10 | When detailing data types or standard TypoScript features, 11 | don't hesitate to cross-link to the TypoScript Reference as shown below. 12 | 13 | See :ref:`h2document:how-to-document-hyperlinks` for information about how to use cross-references. 14 | 15 | See the :file:`guides.xml` file for the declaration of cross-linking keys. 16 | 17 | .. toctree:: 18 | :maxdepth: 5 19 | :titlesonly: 20 | 21 | Constants 22 | Setup 23 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Configuration/TypoScriptReference/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. _configuration-typoscript: 3 | 4 | TypoScript reference 5 | ==================== 6 | 7 | Possible subsections: Reference of TypoScript options. 8 | The construct below show the recommended structure for TypoScript properties listing and description. 9 | 10 | When detailing data types or standard TypoScript features, 11 | don't hesitate to cross-link to the TypoScript Reference as shown below. 12 | 13 | See :ref:`h2document:how-to-document-hyperlinks` for information about how to use cross-references. 14 | 15 | See the :file:`guides.xml` file for the declaration of cross-linking keys. 16 | 17 | .. toctree:: 18 | :maxdepth: 5 19 | :titlesonly: 20 | 21 | Constants 22 | Setup 23 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: help 2 | help: ## Displays this list of targets with descriptions 3 | @echo "The following commands are available:\n" 4 | @grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}' 5 | 6 | .PHONY: docs 7 | docs: ## Generate projects documentation (from "Documentation" directory) 8 | mkdir -p Documentation-GENERATED-temp 9 | docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation 10 | 11 | .PHONY: test-docs 12 | test-docs: ## Test the documentation rendering 13 | mkdir -p Documentation-GENERATED-temp 14 | docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log -------------------------------------------------------------------------------- /Documentation/Includes.rst.txt: -------------------------------------------------------------------------------- 1 | .. More information about this file: 2 | https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt 3 | 4 | .. ---------- 5 | .. text roles 6 | .. ---------- 7 | 8 | .. role:: aspect(emphasis) 9 | .. role:: bash(code) 10 | .. role:: html(code) 11 | .. role:: js(code) 12 | .. role:: php(code) 13 | .. role:: rst(code) 14 | .. role:: sep(strong) 15 | .. role:: sql(code) 16 | 17 | .. role:: tsconfig(code) 18 | :class: typoscript 19 | 20 | .. role:: typoscript(code) 21 | .. role:: xml(code) 22 | :class: html 23 | 24 | .. role:: yaml(code) 25 | 26 | .. default-role:: code 27 | 28 | .. --------- 29 | .. highlight 30 | .. --------- 31 | 32 | .. By default, code blocks use PHP syntax highlighting 33 | 34 | .. highlight:: php 35 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Includes.rst.txt: -------------------------------------------------------------------------------- 1 | .. More information about this file: 2 | https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt 3 | 4 | .. ---------- 5 | .. text roles 6 | .. ---------- 7 | 8 | .. role:: aspect(emphasis) 9 | .. role:: bash(code) 10 | .. role:: html(code) 11 | .. role:: js(code) 12 | .. role:: php(code) 13 | .. role:: rst(code) 14 | .. role:: sep(strong) 15 | .. role:: sql(code) 16 | 17 | .. role:: tsconfig(code) 18 | :class: typoscript 19 | 20 | .. role:: typoscript(code) 21 | .. role:: xml(code) 22 | :class: html 23 | 24 | .. role:: yaml(code) 25 | 26 | .. default-role:: code 27 | 28 | .. --------- 29 | .. highlight 30 | .. --------- 31 | 32 | .. By default, code blocks use PHP syntax highlighting 33 | 34 | .. highlight:: php 35 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Includes.rst.txt: -------------------------------------------------------------------------------- 1 | .. More information about this file: 2 | https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt 3 | 4 | .. ---------- 5 | .. text roles 6 | .. ---------- 7 | 8 | .. role:: aspect(emphasis) 9 | .. role:: bash(code) 10 | .. role:: html(code) 11 | .. role:: js(code) 12 | .. role:: php(code) 13 | .. role:: rst(code) 14 | .. role:: sep(strong) 15 | .. role:: sql(code) 16 | 17 | .. role:: tsconfig(code) 18 | :class: typoscript 19 | 20 | .. role:: typoscript(code) 21 | .. role:: xml(code) 22 | :class: html 23 | 24 | .. role:: yaml(code) 25 | 26 | .. default-role:: code 27 | 28 | .. --------- 29 | .. highlight 30 | .. --------- 31 | 32 | .. By default, code blocks use PHP syntax highlighting 33 | 34 | .. highlight:: php 35 | -------------------------------------------------------------------------------- /Documentation/Configuration/TypoScriptReference/Constants.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: typoscript 3 | 4 | .. index:: 5 | TypoScript; Constants 6 | .. _configuration-typoscript-constants: 7 | 8 | Constants 9 | ========= 10 | 11 | Enable / disable some options 12 | ----------------------------- 13 | 14 | .. confval:: enableThis 15 | 16 | :type: bool 17 | :Default: 0 18 | 19 | If :typoscript:`1` then something is enabled. 20 | 21 | Example:: 22 | 23 | plugin.tx_example.settings { 24 | enableThis = 1 25 | } 26 | 27 | Configure page ids 28 | ------------------ 29 | 30 | .. confval:: storageId 31 | 32 | :type: int 33 | :Default: 0 34 | 35 | The id of the page storing the records 36 | 37 | 38 | Example:: 39 | 40 | plugin.tx_example.settings { 41 | storageId = 42 42 | } 43 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Configuration/TypoScriptReference/Constants.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: typoscript 3 | 4 | .. index:: 5 | TypoScript; Constants 6 | .. _configuration-typoscript-constants: 7 | 8 | Constants 9 | ========= 10 | 11 | Enable / disable some options 12 | ----------------------------- 13 | 14 | .. confval:: enableThis 15 | 16 | :type: bool 17 | :Default: 0 18 | 19 | If :typoscript:`1` then something is enabled. 20 | 21 | Example:: 22 | 23 | plugin.tx_example.settings { 24 | enableThis = 1 25 | } 26 | 27 | Configure page ids 28 | ------------------ 29 | 30 | .. confval:: storageId 31 | 32 | :type: int 33 | :Default: 0 34 | 35 | The id of the page storing the records 36 | 37 | 38 | Example:: 39 | 40 | plugin.tx_example.settings { 41 | storageId = 42 42 | } 43 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Configuration/TypoScriptReference/Constants.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: typoscript 3 | 4 | .. index:: 5 | TypoScript; Constants 6 | .. _configuration-typoscript-constants: 7 | 8 | Constants 9 | ========= 10 | 11 | Enable / disable some options 12 | ----------------------------- 13 | 14 | .. confval:: enableThis 15 | 16 | :type: bool 17 | :Default: 0 18 | 19 | If :typoscript:`1` then something is enabled. 20 | 21 | Example:: 22 | 23 | plugin.tx_example.settings { 24 | enableThis = 1 25 | } 26 | 27 | Configure page ids 28 | ------------------ 29 | 30 | .. confval:: storageId 31 | 32 | :type: int 33 | :Default: 0 34 | 35 | The id of the page storing the records 36 | 37 | 38 | Example:: 39 | 40 | plugin.tx_example.settings { 41 | storageId = 42 42 | } 43 | -------------------------------------------------------------------------------- /Documentation/Templates/ViewHelpers.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: html 3 | .. index:: Templates; ViewHelper 4 | .. _templates-viewhelpers: 5 | 6 | ================== 7 | Custom ViewHelpers 8 | ================== 9 | 10 | If your extension provides custom ViewHelpers you can describe their usage here. 11 | 12 | If you want to use ViewHelpers from other extensions you need to add the namespace 13 | declaration at the beginning of the template. The namespace declaration for the 14 | example extension is:: 15 | 16 | {namespace x=MyCompany\MyExtension\ViewHelpers} 17 | 18 | Now you can use a ViewHelper of news with a code like:: 19 | 20 | 21 | 22 | All ViewHelpers 23 | ================ 24 | 25 | exampleTag 26 | ---------- 27 | 28 | ViewHelper to do something 29 | 30 | 31 | Examples 32 | ^^^^^^^^ 33 | 34 | Basic Example 35 | """"""""""""" 36 | 37 | Render the content of the VH as page title 38 | 39 | Code: :: 40 | 41 | {myRecord.title} 42 | 43 | 44 | Output: :: 45 | 46 | TYPO3 is awesome 47 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Templates/ViewHelpers.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: html 3 | .. index:: Templates; ViewHelper 4 | .. _templates-viewhelpers: 5 | 6 | ================== 7 | Custom ViewHelpers 8 | ================== 9 | 10 | If your extension provides custom ViewHelpers you can describe their usage here. 11 | 12 | If you want to use ViewHelpers from other extensions you need to add the namespace 13 | declaration at the beginning of the template. The namespace declaration for the 14 | example extension is:: 15 | 16 | {namespace x=MyCompany\MyExtension\ViewHelpers} 17 | 18 | Now you can use a ViewHelper of news with a code like:: 19 | 20 | 21 | 22 | All ViewHelpers 23 | ================ 24 | 25 | exampleTag 26 | ---------- 27 | 28 | ViewHelper to do something 29 | 30 | 31 | Examples 32 | ^^^^^^^^ 33 | 34 | Basic Example 35 | """"""""""""" 36 | 37 | Render the content of the VH as page title 38 | 39 | Code: :: 40 | 41 | {myRecord.title} 42 | 43 | 44 | Output: :: 45 | 46 | TYPO3 is awesome 47 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Templates/ViewHelpers.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: html 3 | .. index:: Templates; ViewHelper 4 | .. _templates-viewhelpers: 5 | 6 | ================== 7 | Custom ViewHelpers 8 | ================== 9 | 10 | If your extension provides custom ViewHelpers you can describe their usage here. 11 | 12 | If you want to use ViewHelpers from other extensions you need to add the namespace 13 | declaration at the beginning of the template. The namespace declaration for the 14 | example extension is:: 15 | 16 | {namespace x=MyCompany\MyExtension\ViewHelpers} 17 | 18 | Now you can use a ViewHelper of news with a code like:: 19 | 20 | 21 | 22 | All ViewHelpers 23 | ================ 24 | 25 | exampleTag 26 | ---------- 27 | 28 | ViewHelper to do something 29 | 30 | 31 | Examples 32 | ^^^^^^^^ 33 | 34 | Basic Example 35 | """"""""""""" 36 | 37 | Render the content of the VH as page title 38 | 39 | Code: :: 40 | 41 | {myRecord.title} 42 | 43 | 44 | Output: :: 45 | 46 | TYPO3 is awesome 47 | -------------------------------------------------------------------------------- /Documentation/Configuration/General.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: Configuration 3 | .. _configuration-general: 4 | 5 | ===================== 6 | General configuration 7 | ===================== 8 | 9 | How is the extension configured? 10 | Aim to provide simple instructions detailing how the extension is configured. 11 | Always assume that the user has no prior experience of using the extension. 12 | 13 | Try and provide a typical use case for your extension 14 | and detail each of the steps required to get the extension running. 15 | 16 | 17 | .. index:: 18 | Configuration; Example 19 | Configuration; Typical 20 | .. _configuration_example: 21 | .. _configuration_typical: 22 | 23 | Typical example 24 | =============== 25 | 26 | * Does the integrator need to include a static template? 27 | * For example add a code snippet with comments 28 | 29 | Minimal example of TypoScript: 30 | 31 | * Code-blocks have support for syntax highlighting 32 | * Use any supported language 33 | 34 | .. code-block:: typoscript 35 | 36 | plugin.tx_myextension.settings { 37 | # configure basic email settings 38 | email { 39 | subject = Some subject 40 | from = someemail@example.org 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Configuration/General.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: Configuration 3 | .. _configuration-general: 4 | 5 | ===================== 6 | General configuration 7 | ===================== 8 | 9 | How is the extension configured? 10 | Aim to provide simple instructions detailing how the extension is configured. 11 | Always assume that the user has no prior experience of using the extension. 12 | 13 | Try and provide a typical use case for your extension 14 | and detail each of the steps required to get the extension running. 15 | 16 | 17 | .. index:: 18 | Configuration; Example 19 | Configuration; Typical 20 | .. _configuration_example: 21 | .. _configuration_typical: 22 | 23 | Typical example 24 | =============== 25 | 26 | * Does the integrator need to include a static template? 27 | * For example add a code snippet with comments 28 | 29 | Minimal example of TypoScript: 30 | 31 | * Code-blocks have support for syntax highlighting 32 | * Use any supported language 33 | 34 | .. code-block:: typoscript 35 | 36 | plugin.tx_myextension.settings { 37 | # configure basic email settings 38 | email { 39 | subject = Some subject 40 | from = someemail@example.org 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Configuration/General.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: Configuration 3 | .. _configuration-general: 4 | 5 | ===================== 6 | General configuration 7 | ===================== 8 | 9 | How is the extension configured? 10 | Aim to provide simple instructions detailing how the extension is configured. 11 | Always assume that the user has no prior experience of using the extension. 12 | 13 | Try and provide a typical use case for your extension 14 | and detail each of the steps required to get the extension running. 15 | 16 | 17 | .. index:: 18 | Configuration; Example 19 | Configuration; Typical 20 | .. _configuration_example: 21 | .. _configuration_typical: 22 | 23 | Typical example 24 | =============== 25 | 26 | * Does the integrator need to include a static template? 27 | * For example add a code snippet with comments 28 | 29 | Minimal example of TypoScript: 30 | 31 | * Code-blocks have support for syntax highlighting 32 | * Use any supported language 33 | 34 | .. code-block:: typoscript 35 | 36 | plugin.tx_myextension.settings { 37 | # configure basic email settings 38 | email { 39 | subject = Some subject 40 | from = someemail@example.org 41 | } 42 | } 43 | -------------------------------------------------------------------------------- /CONTRIBUTING.rst: -------------------------------------------------------------------------------- 1 | ================================= 2 | Contribute to TYPO3 Documentation 3 | ================================= 4 | 5 | Create Issues 6 | ============= 7 | 8 | * If you find something missing or something is wrong in this repository, you are welcome to write an 9 | `issue `__ 10 | describing the problem. 11 | * If you can, please try to fix the problem yourself. 12 | * For minor changes, it is not necessary to create an issue first. 13 | 14 | Make changes 15 | ============ 16 | 17 | In order to make changes on this repository, either directly edit on GitHub or fork and clone 18 | the repository, make the change and create a pull request. 19 | 20 | See the GitHub documentation `Create a pull request `__. 21 | 22 | Get help 23 | ======== 24 | 25 | If you need help with contributing to the docs, see 26 | `Help & Support `__. 27 | 28 | Contribute to TYPO3 Core 29 | ======================== 30 | 31 | See `TYPO3 Contribution Guide - Core Development `__. 32 | 33 | General TYPO3 Support 34 | ===================== 35 | 36 | If you have some general TYPO3 support questions or need help with TYPO3, please see https://typo3.org/help. 37 | -------------------------------------------------------------------------------- /Documentation/Editor/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _for-editors: 4 | 5 | =========== 6 | For Editors 7 | =========== 8 | 9 | How to use the extension from the perspective of an editor. 10 | 11 | Think of common tasks that an editor is likely to perform: 12 | 13 | * How do they complete them? 14 | * What problems are they likely to encounter? 15 | * What access do they require? 16 | * What configuration options are available to them? 17 | 18 | One example could be adding a frontend plugin to a page and then configuring it. 19 | 20 | Language should be non-technical, aim to avoid using acronyms where possible. 21 | 22 | Be mindful that editors typically don't have administrative access to the installation. 23 | 24 | .. tip:: 25 | 26 | Take a break from time to time. 27 | 28 | Admonitions should be used to warn the users about potential pitfalls. 29 | Attract their attention to important elements, 30 | or add some notes for for information (further reading, for example). 31 | 32 | Do not overuse admonitions like notes, important, etc.! 33 | 34 | Provide screenshots as needed for making things clear. 35 | When creating screenshots, try using the Official Introduction Package. 36 | 37 | .. figure:: /Images/BackendView.png 38 | :class: with-shadow 39 | :alt: Backend view 40 | 41 | Default Backend view (caption of the image) 42 | 43 | Do not use huge full-screen images, unless it is necessary and serves a good purpose. 44 | 45 | .. _editor-faq: 46 | 47 | FAQ 48 | === 49 | 50 | Possible subsection: FAQ 51 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Editor/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _for-editors: 4 | 5 | =========== 6 | For Editors 7 | =========== 8 | 9 | How to use the extension from the perspective of an editor. 10 | 11 | Think of common tasks that an editor is likely to perform: 12 | 13 | * How do they complete them? 14 | * What problems are they likely to encounter? 15 | * What access do they require? 16 | * What configuration options are available to them? 17 | 18 | One example could be adding a frontend plugin to a page and then configuring it. 19 | 20 | Language should be non-technical, aim to avoid using acronyms where possible. 21 | 22 | Be mindful that editors typically don't have administrative access to the installation. 23 | 24 | .. tip:: 25 | 26 | Take a break from time to time. 27 | 28 | Admonitions should be used to warn the users about potential pitfalls. 29 | Attract their attention to important elements, 30 | or add some notes for for information (further reading, for example). 31 | 32 | Do not overuse admonitions like notes, important, etc.! 33 | 34 | Provide screenshots as needed for making things clear. 35 | When creating screenshots, try using the Official Introduction Package. 36 | 37 | .. figure:: /Images/BackendView.png 38 | :class: with-shadow 39 | :alt: Backend view 40 | 41 | Default Backend view (caption of the image) 42 | 43 | Do not use huge full-screen images, unless it is necessary and serves a good purpose. 44 | 45 | .. _editor-faq: 46 | 47 | FAQ 48 | === 49 | 50 | Possible subsection: FAQ 51 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Editor/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _for-editors: 4 | 5 | =========== 6 | For Editors 7 | =========== 8 | 9 | How to use the extension from the perspective of an editor. 10 | 11 | Think of common tasks that an editor is likely to perform: 12 | 13 | * How do they complete them? 14 | * What problems are they likely to encounter? 15 | * What access do they require? 16 | * What configuration options are available to them? 17 | 18 | One example could be adding a frontend plugin to a page and then configuring it. 19 | 20 | Language should be non-technical, aim to avoid using acronyms where possible. 21 | 22 | Be mindful that editors typically don't have administrative access to the installation. 23 | 24 | .. tip:: 25 | 26 | Take a break from time to time. 27 | 28 | Admonitions should be used to warn the users about potential pitfalls. 29 | Attract their attention to important elements, 30 | or add some notes for for information (further reading, for example). 31 | 32 | Do not overuse admonitions like notes, important, etc.! 33 | 34 | Provide screenshots as needed for making things clear. 35 | When creating screenshots, try using the Official Introduction Package. 36 | 37 | .. figure:: /Images/BackendView.png 38 | :class: with-shadow 39 | :alt: Backend view 40 | 41 | Default Backend view (caption of the image) 42 | 43 | Do not use huge full-screen images, unless it is necessary and serves a good purpose. 44 | 45 | .. _editor-faq: 46 | 47 | FAQ 48 | === 49 | 50 | Possible subsection: FAQ 51 | -------------------------------------------------------------------------------- /Documentation/Templates/Override.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: Templates; Override 3 | .. _templates-override: 4 | 5 | Overriding templates 6 | ==================== 7 | 8 | EXT:myextension is using Fluid as template engine. 9 | 10 | This documentation won't bring you all information about Fluid but only the 11 | most important things you need for using it. You can get 12 | more information in the section :ref:`Fluid templates of the Sitepackage tutorial 13 | `. A complete reference of Fluid ViewHelpers 14 | provided by TYPO3 can be found in the :ref:`ViewHelper Reference ` 15 | 16 | 17 | .. index:: Templates; TypoScript 18 | 19 | Change the templates using TypoScript constants 20 | ----------------------------------------------- 21 | 22 | As any Extbase based extension, you can find the templates in the directory 23 | :file:`Resources/Private/`. 24 | 25 | If you want to change a template, copy the desired files to the directory 26 | where you store the templates. 27 | 28 | We suggest that you use a sitepackage extension. Learn how to 29 | :ref:`Create a sitepackage extension `. 30 | 31 | .. code-block:: typoscript 32 | 33 | plugin.tx_myextension { 34 | view { 35 | templateRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Templates/ 36 | partialRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Partials/ 37 | layoutRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Layouts/ 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Templates/Override.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: Templates; Override 3 | .. _templates-override: 4 | 5 | Overriding templates 6 | ==================== 7 | 8 | EXT:myextension is using Fluid as template engine. 9 | 10 | This documentation won't bring you all information about Fluid but only the 11 | most important things you need for using it. You can get 12 | more information in the section :ref:`Fluid templates of the Sitepackage tutorial 13 | `. A complete reference of Fluid ViewHelpers 14 | provided by TYPO3 can be found in the :ref:`ViewHelper Reference ` 15 | 16 | 17 | .. index:: Templates; TypoScript 18 | 19 | Change the templates using TypoScript constants 20 | ----------------------------------------------- 21 | 22 | As any Extbase based extension, you can find the templates in the directory 23 | :file:`Resources/Private/`. 24 | 25 | If you want to change a template, copy the desired files to the directory 26 | where you store the templates. 27 | 28 | We suggest that you use a sitepackage extension. Learn how to 29 | :ref:`Create a sitepackage extension `. 30 | 31 | .. code-block:: typoscript 32 | 33 | plugin.tx_myextension { 34 | view { 35 | templateRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Templates/ 36 | partialRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Partials/ 37 | layoutRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Layouts/ 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Templates/Override.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. index:: Templates; Override 3 | .. _templates-override: 4 | 5 | Overriding templates 6 | ==================== 7 | 8 | EXT:myextension is using Fluid as template engine. 9 | 10 | This documentation won't bring you all information about Fluid but only the 11 | most important things you need for using it. You can get 12 | more information in the section :ref:`Fluid templates of the Sitepackage tutorial 13 | `. A complete reference of Fluid ViewHelpers 14 | provided by TYPO3 can be found in the :ref:`ViewHelper Reference ` 15 | 16 | 17 | .. index:: Templates; TypoScript 18 | 19 | Change the templates using TypoScript constants 20 | ----------------------------------------------- 21 | 22 | As any Extbase based extension, you can find the templates in the directory 23 | :file:`Resources/Private/`. 24 | 25 | If you want to change a template, copy the desired files to the directory 26 | where you store the templates. 27 | 28 | We suggest that you use a sitepackage extension. Learn how to 29 | :ref:`Create a sitepackage extension `. 30 | 31 | .. code-block:: typoscript 32 | 33 | plugin.tx_myextension { 34 | view { 35 | templateRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Templates/ 36 | partialRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Partials/ 37 | layoutRootPath = EXT:mysitepackage/Resources/Private/Extensions/myextension/Layouts/ 38 | } 39 | } 40 | -------------------------------------------------------------------------------- /Documentation/Configuration/TSconfig.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: typoscript 3 | .. index:: 4 | TSconfig 5 | .. _configuration-tsconfig: 6 | 7 | TSconfig reference 8 | ================== 9 | 10 | If your extension uses TSconfig you can document it here. 11 | 12 | This section covers all configurations which can be set with TSconfig. 13 | Every configuration starts with :typoscript:`tx_myextension.`. 14 | 15 | .. note:: 16 | Just for clarification: TSconfig is in TYPO3 only used for configurations 17 | inside the backend! 18 | 19 | .. index:: 20 | TSconfig; Page 21 | .. _configuration-tsconfig_page: 22 | 23 | User TSconfig 24 | ============= 25 | 26 | .. confval values will be added automatically to the index. 27 | 28 | .. confval:: enableSomething 29 | 30 | :type: bool 31 | :Default: 0 32 | 33 | If :typoscript:`1` then something is enabled. 34 | 35 | Example:: 36 | 37 | tx_myextension.enableSomething = 1 38 | 39 | 40 | .. index:: 41 | TSconfig; Page 42 | .. _configuration-tsconfig_user: 43 | 44 | Page TSconfig 45 | ============= 46 | 47 | .. confval:: limitSomething 48 | 49 | :type: int 50 | :Default: 5 51 | 52 | This value limits something. If it is set to :typoscript:`0` something will 53 | be unlimited. 54 | 55 | 56 | Example, limit something to 10:: 57 | 58 | tx_myextension.limitSomething = 10 59 | 60 | .. confval:: someImportantPages 61 | 62 | :type: list 63 | :Default: '' 64 | 65 | Comma-list of fields from the pages-table. These fields are ... 66 | 67 | 68 | Example, limit something to 10:: 69 | 70 | tx_myextension.someImportantPages = 4, 7, 42 71 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Configuration/TSconfig.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: typoscript 3 | .. index:: 4 | TSconfig 5 | .. _configuration-tsconfig: 6 | 7 | TSconfig reference 8 | ================== 9 | 10 | If your extension uses TSconfig you can document it here. 11 | 12 | This section covers all configurations which can be set with TSconfig. 13 | Every configuration starts with :typoscript:`tx_myextension.`. 14 | 15 | .. note:: 16 | Just for clarification: TSconfig is in TYPO3 only used for configurations 17 | inside the backend! 18 | 19 | .. index:: 20 | TSconfig; Page 21 | .. _configuration-tsconfig_page: 22 | 23 | User TSconfig 24 | ============= 25 | 26 | .. confval values will be added automatically to the index. 27 | 28 | .. confval:: enableSomething 29 | 30 | :type: bool 31 | :Default: 0 32 | 33 | If :typoscript:`1` then something is enabled. 34 | 35 | Example:: 36 | 37 | tx_myextension.enableSomething = 1 38 | 39 | 40 | .. index:: 41 | TSconfig; Page 42 | .. _configuration-tsconfig_user: 43 | 44 | Page TSconfig 45 | ============= 46 | 47 | .. confval:: limitSomething 48 | 49 | :type: int 50 | :Default: 5 51 | 52 | This value limits something. If it is set to :typoscript:`0` something will 53 | be unlimited. 54 | 55 | 56 | Example, limit something to 10:: 57 | 58 | tx_myextension.limitSomething = 10 59 | 60 | .. confval:: someImportantPages 61 | 62 | :type: list 63 | :Default: '' 64 | 65 | Comma-list of fields from the pages-table. These fields are ... 66 | 67 | 68 | Example, limit something to 10:: 69 | 70 | tx_myextension.someImportantPages = 4, 7, 42 71 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Configuration/TSconfig.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: typoscript 3 | .. index:: 4 | TSconfig 5 | .. _configuration-tsconfig: 6 | 7 | TSconfig reference 8 | ================== 9 | 10 | If your extension uses TSconfig you can document it here. 11 | 12 | This section covers all configurations which can be set with TSconfig. 13 | Every configuration starts with :typoscript:`tx_myextension.`. 14 | 15 | .. note:: 16 | Just for clarification: TSconfig is in TYPO3 only used for configurations 17 | inside the backend! 18 | 19 | .. index:: 20 | TSconfig; Page 21 | .. _configuration-tsconfig_page: 22 | 23 | User TSconfig 24 | ============= 25 | 26 | .. confval values will be added automatically to the index. 27 | 28 | .. confval:: enableSomething 29 | 30 | :type: bool 31 | :Default: 0 32 | 33 | If :typoscript:`1` then something is enabled. 34 | 35 | Example:: 36 | 37 | tx_myextension.enableSomething = 1 38 | 39 | 40 | .. index:: 41 | TSconfig; Page 42 | .. _configuration-tsconfig_user: 43 | 44 | Page TSconfig 45 | ============= 46 | 47 | .. confval:: limitSomething 48 | 49 | :type: int 50 | :Default: 5 51 | 52 | This value limits something. If it is set to :typoscript:`0` something will 53 | be unlimited. 54 | 55 | 56 | Example, limit something to 10:: 57 | 58 | tx_myextension.limitSomething = 10 59 | 60 | .. confval:: someImportantPages 61 | 62 | :type: list 63 | :Default: '' 64 | 65 | Comma-list of fields from the pages-table. These fields are ... 66 | 67 | 68 | Example, limit something to 10:: 69 | 70 | tx_myextension.someImportantPages = 4, 7, 42 71 | -------------------------------------------------------------------------------- /Documentation/guides.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 18 | 23 | 26 | 29 | 32 | 35 | 36 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/guides.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 18 | 23 | 26 | 29 | 32 | 35 | 36 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/guides.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 18 | 23 | 26 | 29 | 32 | 35 | 36 | -------------------------------------------------------------------------------- /Documentation/Introduction/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _introduction: 4 | 5 | ============ 6 | Introduction 7 | ============ 8 | 9 | .. tip:: 10 | 11 | New to reStructuredText and PHP-based documentation rendering? 12 | 13 | * Get an introduction in :ref:`Writing documentation ` 14 | * Use this cheat sheet as reference: :ref:`Cheat sheet: reStructuredText ` 15 | * Still using Sphinx? :ref:`Migration: From Sphinx to PHP-based rendering ` 16 | * Get an overview in the :ref:`reStructuredText Reference ` 17 | 18 | .. _what-it-does: 19 | 20 | What does it do? 21 | ================ 22 | 23 | The aim of this chapter is to provide a general overview of your extension. 24 | 25 | * What does it do? 26 | * What problems does it solve? 27 | * Who is the target audience? 28 | 29 | This chapter should provide information that will help inform 30 | potential users and assist them in deciding if they should 31 | install and use this extension. 32 | 33 | .. attention:: 34 | 35 | Do not forget to set extension's version number in :file:`guides.xml` file, 36 | in the :code:`release` property. 37 | It will be automatically picked up on the cover page by the :code:`|release|` substitution. 38 | 39 | .. _screenshots: 40 | 41 | Screenshots 42 | =========== 43 | 44 | This chapter should help people understand how the extension works. 45 | Remove it if it is not relevant. 46 | 47 | .. figure:: /Images/IntroductionPackage.png 48 | :class: with-shadow 49 | :alt: Introduction Package 50 | :width: 300px 51 | 52 | Introduction Package after installation (caption of the image). 53 | 54 | How the Frontend of the Introduction Package looks like after installation (legend of the image). 55 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Introduction/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _introduction: 4 | 5 | ============ 6 | Introduction 7 | ============ 8 | 9 | .. tip:: 10 | 11 | Nouveau à reStructuredText et rendu de la documentation en PHP? 12 | 13 | * Obtenir une introduction dans la :ref:`documentation écrite ` 14 | * Utilisez cet :ref:`aide-mémoire: reStructuredText ` comme référence 15 | * Vous utilisez toujours Sphinx ? :ref:`Migration : De Sphinx à un rendu basé sur PHP ` 16 | * Obtenez une vue d'ensemble dans la :ref:`référence reStructuredText ` 17 | 18 | .. _what-it-does: 19 | 20 | Que fait-il ? 21 | ============= 22 | 23 | L'objectif de ce chapitre est de fournir une vue d'ensemble de votre extension. 24 | 25 | * Qu'est-ce qu'elle fait ? 26 | * Quels problèmes résout-elle ? 27 | * Qui est le public cible ? 28 | 29 | Ce chapitre doit fournir des informations qui aideront à informer les 30 | utilisateurs potentiels et les aider à décider s'ils doivent ou non 31 | installer et utiliser cette extension. 32 | 33 | .. attention:: 34 | 35 | N'oubliez pas d'indiquer le numéro de version de l'extension dans le fichier :file:`guides.xml`, 36 | dans la propriété :code:`release`. 37 | Il sera automatiquement repris sur la page de couverture par la substitution :code:`|release|`. 38 | 39 | .. _screenshots: 40 | 41 | Captures d'écran 42 | ================ 43 | 44 | Ce chapitre doit aider à comprendre le fonctionnement de l'extension. 45 | Supprimez-le s'il n'est pas pertinent. 46 | 47 | .. figure:: /Images/IntroductionPackage.png 48 | :class: with-shadow 49 | :alt: Introduction Package 50 | :width: 300px 51 | 52 | Introduction Paquet après installation (légende de l'image). 53 | 54 | A quoi ressemble le Frontend du Package d'Introduction après l'installation (légende de l'image). 55 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Introduction/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _introduction: 4 | 5 | ========== 6 | Einführung 7 | ========== 8 | 9 | .. tip:: 10 | 11 | Neu in reStructuredText und PHP-basiertem Dokumentationsrendering? 12 | 13 | * Bekommen Sie eine Einführung in die :ref:`Dokumentationserstellung ` 14 | * Verwende Sie dieses Cheat Sheet als Referenz: :ref:`reStructuredText ` 15 | * Immer noch Sphinx? :ref:`Migration: Von Sphinx zu PHP-basiertem Dokumentationsrendering ` 16 | * Bekommen Sie einen Überblick in der :ref:`reStructuredText Referenz ` 17 | 18 | .. _what-it-does: 19 | 20 | Was tut sie? 21 | ============ 22 | 23 | Ziel dieses Kapitels ist es, einen allgemeinen Überblick über Ihre Erweiterung zu geben. 24 | 25 | * Was tut sie? 26 | * Welche Probleme löst sie? 27 | * Wer ist das Zielpublikum? 28 | 29 | Dieses Kapitel sollte Informationen enthalten, die dazu beitragen potentielle 30 | Nutzer zu informieren und ihnen bei der Entscheidung zu helfen, ob sie diese 31 | Erweiterung installieren und benutzen sollen. 32 | 33 | .. attention:: 34 | 35 | Vergessen Sie nicht, die Versionsnummer der Erweiterung in der Datei :file:`guides.xml` anzugeben, 36 | in der Eigenschaft :code:`release`. 37 | Sie wird automatisch auf der Titelseite durch die Ersetzung :code:`|release|` übernommen. 38 | 39 | .. _screenshots: 40 | 41 | Bildschirmfotos 42 | =============== 43 | 44 | Dieses Kapitel soll helfen zu verstehen, wie die Erweiterung funktioniert. 45 | Entfernen Sie es, wenn es nicht relevant ist. 46 | 47 | .. figure:: /Images/IntroductionPackage.png 48 | :class: with-shadow 49 | :alt: Introduction Package 50 | :width: 300px 51 | 52 | Einführungspaket nach der Installation (Bildunterschrift). 53 | 54 | So sieht das Frontend nach der Installation des Einführungspakets aus (Legende des Bildes). 55 | -------------------------------------------------------------------------------- /Documentation/Developer/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: php 3 | 4 | .. _developer: 5 | 6 | ================ 7 | Developer corner 8 | ================ 9 | 10 | Use this section to provide examples of code or detail any information that would be deemed relevant to a developer. 11 | 12 | For example explain how a certain feature was implemented. 13 | 14 | 15 | .. _developer-api: 16 | 17 | API 18 | === 19 | 20 | How to use the API... 21 | 22 | Interfaces 23 | ---------- 24 | 25 | The following list provides information for all necessary interfaces that are 26 | used inside of this documentation. For up to date information, please check 27 | the source code. 28 | 29 | 30 | .. php:namespace:: Vendor\MyExtension\Interfaces 31 | 32 | .. php:interface:: ExampleInterface 33 | 34 | Has to be implemented by all ... 35 | 36 | .. php:method:: methodOne() 37 | 38 | :returntype: string 39 | :returns: Something important 40 | 41 | .. php:interface:: AnotherImportantInterface 42 | 43 | Used for ... 44 | 45 | .. php:interface:: RequireJsModuleInterface 46 | 47 | Widgets implementing this interface will add the provided RequireJS modules. 48 | Those modules will be loaded in dashboard view if the widget is added at least once. 49 | 50 | .. php:method:: getRequireJsModules() 51 | 52 | Returns a list of RequireJS modules that should be loaded, e.g.:: 53 | 54 | return [ 55 | 'TYPO3/CMS/MyExtension/ModuleName', 56 | 'TYPO3/CMS/MyExtension/Module2Name', 57 | ]; 58 | 59 | See also :ref:`t3coreapi:requirejs` for further information regarding RequireJS 60 | in TYPO3 Backend. 61 | 62 | :returntype: array 63 | :returns: List of modules to require. 64 | 65 | .. php:method:: setDate($year, $month, $day) 66 | 67 | Set the date. 68 | 69 | :param int $year: The year. 70 | :param int $month: The month. 71 | :param int $day: The day. 72 | :returns: Either false on failure, or the datetime object for method chaining. 73 | 74 | 75 | Examples 76 | -------- 77 | 78 | A php example:: 79 | 80 | // use \TYPO3\CMS\Core\Utility\GeneralUtility; 81 | $stuff = GeneralUtility::makeInstance( 82 | '\\Foo\\Bar\\Utility\\Stuff' 83 | ); 84 | $stuff->do(); 85 | 86 | Example in another language: 87 | 88 | .. code-block:: javascript 89 | :linenos: 90 | :emphasize-lines: 2-4 91 | 92 | $(document).ready( 93 | function () { 94 | doStuff(); 95 | } 96 | ); 97 | 98 | A YAML example: 99 | 100 | .. code-block:: yaml 101 | 102 | services: 103 | Vendor\Extension\EventListener\YourListener: 104 | tags: 105 | - name: event.listener 106 | identifier: 'your-self-choosen-identifier' 107 | method: 'methodToConnectToEvent' 108 | event: Vendor\MyExtension\Event\MyActionEvent 109 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Developer/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: php 3 | 4 | .. _developer: 5 | 6 | ================ 7 | Developer corner 8 | ================ 9 | 10 | Use this section to provide examples of code or detail any information that would be deemed relevant to a developer. 11 | 12 | For example explain how a certain feature was implemented. 13 | 14 | 15 | .. _developer-api: 16 | 17 | API 18 | === 19 | 20 | How to use the API... 21 | 22 | Interfaces 23 | ---------- 24 | 25 | The following list provides information for all necessary interfaces that are 26 | used inside of this documentation. For up to date information, please check 27 | the source code. 28 | 29 | 30 | .. php:namespace:: Vendor\MyExtension\Interfaces 31 | 32 | .. php:interface:: ExampleInterface 33 | 34 | Has to be implemented by all ... 35 | 36 | .. php:method:: methodOne() 37 | 38 | :returntype: string 39 | :returns: Something important 40 | 41 | .. php:interface:: AnotherImportantInterface 42 | 43 | Used for ... 44 | 45 | .. php:interface:: RequireJsModuleInterface 46 | 47 | Widgets implementing this interface will add the provided RequireJS modules. 48 | Those modules will be loaded in dashboard view if the widget is added at least once. 49 | 50 | .. php:method:: getRequireJsModules() 51 | 52 | Returns a list of RequireJS modules that should be loaded, e.g.:: 53 | 54 | return [ 55 | 'TYPO3/CMS/MyExtension/ModuleName', 56 | 'TYPO3/CMS/MyExtension/Module2Name', 57 | ]; 58 | 59 | See also :ref:`t3coreapi:requirejs` for further information regarding RequireJS 60 | in TYPO3 Backend. 61 | 62 | :returntype: array 63 | :returns: List of modules to require. 64 | 65 | .. php:method:: setDate($year, $month, $day) 66 | 67 | Set the date. 68 | 69 | :param int $year: The year. 70 | :param int $month: The month. 71 | :param int $day: The day. 72 | :returns: Either false on failure, or the datetime object for method chaining. 73 | 74 | 75 | Examples 76 | -------- 77 | 78 | A php example:: 79 | 80 | // use \TYPO3\CMS\Core\Utility\GeneralUtility; 81 | $stuff = GeneralUtility::makeInstance( 82 | '\\Foo\\Bar\\Utility\\Stuff' 83 | ); 84 | $stuff->do(); 85 | 86 | Example in another language: 87 | 88 | .. code-block:: javascript 89 | :linenos: 90 | :emphasize-lines: 2-4 91 | 92 | $(document).ready( 93 | function () { 94 | doStuff(); 95 | } 96 | ); 97 | 98 | A YAML example: 99 | 100 | .. code-block:: yaml 101 | 102 | services: 103 | Vendor\Extension\EventListener\YourListener: 104 | tags: 105 | - name: event.listener 106 | identifier: 'your-self-choosen-identifier' 107 | method: 'methodToConnectToEvent' 108 | event: Vendor\MyExtension\Event\MyActionEvent 109 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Developer/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | .. highlight:: php 3 | 4 | .. _developer: 5 | 6 | ================ 7 | Developer corner 8 | ================ 9 | 10 | Use this section to provide examples of code or detail any information that would be deemed relevant to a developer. 11 | 12 | For example explain how a certain feature was implemented. 13 | 14 | 15 | .. _developer-api: 16 | 17 | API 18 | === 19 | 20 | How to use the API... 21 | 22 | Interfaces 23 | ---------- 24 | 25 | The following list provides information for all necessary interfaces that are 26 | used inside of this documentation. For up to date information, please check 27 | the source code. 28 | 29 | 30 | .. php:namespace:: Vendor\MyExtension\Interfaces 31 | 32 | .. php:interface:: ExampleInterface 33 | 34 | Has to be implemented by all ... 35 | 36 | .. php:method:: methodOne() 37 | 38 | :returntype: string 39 | :returns: Something important 40 | 41 | .. php:interface:: AnotherImportantInterface 42 | 43 | Used for ... 44 | 45 | .. php:interface:: RequireJsModuleInterface 46 | 47 | Widgets implementing this interface will add the provided RequireJS modules. 48 | Those modules will be loaded in dashboard view if the widget is added at least once. 49 | 50 | .. php:method:: getRequireJsModules() 51 | 52 | Returns a list of RequireJS modules that should be loaded, e.g.:: 53 | 54 | return [ 55 | 'TYPO3/CMS/MyExtension/ModuleName', 56 | 'TYPO3/CMS/MyExtension/Module2Name', 57 | ]; 58 | 59 | See also :ref:`t3coreapi:requirejs` for further information regarding RequireJS 60 | in TYPO3 Backend. 61 | 62 | :returntype: array 63 | :returns: List of modules to require. 64 | 65 | .. php:method:: setDate($year, $month, $day) 66 | 67 | Set the date. 68 | 69 | :param int $year: The year. 70 | :param int $month: The month. 71 | :param int $day: The day. 72 | :returns: Either false on failure, or the datetime object for method chaining. 73 | 74 | 75 | Examples 76 | -------- 77 | 78 | A php example:: 79 | 80 | // use \TYPO3\CMS\Core\Utility\GeneralUtility; 81 | $stuff = GeneralUtility::makeInstance( 82 | '\\Foo\\Bar\\Utility\\Stuff' 83 | ); 84 | $stuff->do(); 85 | 86 | Example in another language: 87 | 88 | .. code-block:: javascript 89 | :linenos: 90 | :emphasize-lines: 2-4 91 | 92 | $(document).ready( 93 | function () { 94 | doStuff(); 95 | } 96 | ); 97 | 98 | A YAML example: 99 | 100 | .. code-block:: yaml 101 | 102 | services: 103 | Vendor\Extension\EventListener\YourListener: 104 | tags: 105 | - name: event.listener 106 | identifier: 'your-self-choosen-identifier' 107 | method: 'methodToConnectToEvent' 108 | event: Vendor\MyExtension\Event\MyActionEvent 109 | -------------------------------------------------------------------------------- /Documentation/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _start: 4 | 5 | ========= 6 | 7 | ========= 8 | 9 | Welcome to the example manual of the example extension . 10 | 11 | This guide provides an introduction to an example extension . 12 | It shows the basic setup of a manual describing how to use the extension 13 | . You can use it as a starting point or a building guideline to 14 | create your own documentation for your extension. 15 | 16 | The first overview should give the user a good starting point to quickly find the 17 | information that the user is looking for. 18 | 19 | ---- 20 | 21 | .. card-grid:: 22 | :columns: 1 23 | :columns-md: 2 24 | :gap: 4 25 | :class: pb-4 26 | :card-height: 100 27 | 28 | .. card:: Introduction 29 | 30 | You can add a small introduction to the . If you are new 31 | to writing a documentation in general this section provides a good 32 | starting point to look at. 33 | 34 | .. card-footer:: :ref:`Get an overview ` 35 | :button-style: btn btn-secondary stretched-link 36 | 37 | .. card:: Installation 38 | 39 | Provide which steps should be done to install the 40 | properly. We recommend to give enough hints to kindly guide the user 41 | through this process. 42 | 43 | .. card-footer:: :ref:`View the installation steps ` 44 | :button-style: btn btn-secondary stretched-link 45 | 46 | .. card:: Configuration 47 | 48 | In this section you should cover all the needed configurations to set up 49 | the correctly. Additionally you should present an 50 | overview about all available configurations one can set up in . 51 | 52 | .. card-footer:: :ref:`Learn how to configure the extension ` 53 | :button-style: btn btn-secondary stretched-link 54 | 55 | .. card:: Templates 56 | 57 | In this section you can describe how a user can use its custom 58 | templates. Additionally you can present and describe what your custom 59 | viewhelpers are doing. Last but not least you can provide some example 60 | templates. 61 | 62 | .. card-footer:: :ref:`Inspect the templating ` 63 | :button-style: btn btn-secondary stretched-link 64 | 65 | .. card:: The editor section 66 | 67 | This section is specialised for editors. Editors find everything that is 68 | useful for them using the in this section. 69 | 70 | .. card-footer:: :ref:`Discover editor specific tools ` 71 | :button-style: btn btn-secondary stretched-link 72 | 73 | .. card:: The developers corner 74 | 75 | Use this section to provide examples of code or any information 76 | that would be deemed relevant to a developer. For example explain how 77 | a certain feature was implemented. 78 | 79 | .. card-footer:: :ref:`Get to know the developers corner ` 80 | :button-style: btn btn-secondary stretched-link 81 | 82 | .. card:: Troubleshooting 83 | 84 | Use this section for informing about troubleshooting. If the users of 85 | your extension encountered any problems they should be able to find 86 | information to solve their problems in this section. 87 | 88 | .. card-footer:: :ref:`Learn how to troubleshoot ` 89 | :button-style: btn btn-secondary stretched-link 90 | 91 | .. toctree:: 92 | :hidden: 93 | :titlesonly: 94 | 95 | Introduction/Index 96 | Installation/Index 97 | Configuration/Index 98 | Editor/Index 99 | Templates/Index 100 | Developer/Index 101 | KnownProblems/Index 102 | 103 | .. Meta Menu 104 | 105 | .. toctree:: 106 | :hidden: 107 | 108 | Sitemap 109 | 110 | ---- 111 | 112 | :Extension key: 113 | 114 | 115 | :Package name: 116 | 117 | 118 | :Version: 119 | |release| 120 | 121 | :Language: 122 | en 123 | 124 | :Author: 125 | 126 | 127 | :License: 128 | This document is published under the 129 | `Creative Commons BY 4.0 `__ 130 | license. 131 | 132 | :Rendered: 133 | |today| 134 | 135 | 136 | 137 | 138 | -------------------------------------------------------------------------------- /Documentation/Localization.fr_FR/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _start: 4 | 5 | ============ 6 | 7 | ============ 8 | 9 | Bienvenue dans le manuel de l'exemple d'extension . 10 | 11 | Ce guide présente un exemple d'extension . Il montre la 12 | configuration de base d'un manuel décrivant comment utiliser l'extension 13 | . Vous pouvez l'utiliser comme point de départ ou comme 14 | ligne directrice pour créer votre propre documentation pour votre extension. 15 | 16 | La première vue d'ensemble devrait donner à l'utilisateur un bon point de départ 17 | pour trouver rapidement les informations qu'il recherche. 18 | 19 | ---- 20 | 21 | .. card-grid:: 22 | :columns: 1 23 | :columns-md: 2 24 | :gap: 4 25 | :class: pb-4 26 | :card-height: 100 27 | 28 | .. card:: Introduction 29 | 30 | Vous pouvez ajouter une petite introduction à la . Si 31 | vous n'avez pas l'habitude de rédiger une documentation, cette section 32 | constitue un bon point de départ. 33 | 34 | .. card-footer:: :ref:`Vue d'ensemble ` 35 | :button-style: btn btn-secondary stretched-link 36 | 37 | .. card:: Installation 38 | 39 | Indiquer les étapes à suivre pour installer correctement la 40 | . Nous recommandons de donner suffisamment d'indications 41 | pour guider l'utilisateur tout au long du processus. 42 | 43 | .. card-footer:: :ref:`Voir les étapes de l'installation ` 44 | :button-style: btn btn-secondary stretched-link 45 | 46 | .. card:: Configuration 47 | 48 | Dans cette section, vous devez présenter toutes les configurations 49 | nécessaires pour configurer correctement la . 50 | En outre, vous devez présenter une vue d'ensemble de toutes 51 | les configurations disponibles que l'on peut définir dans . 52 | 53 | .. card-footer:: :ref:`Apprendre à configurer l'extension ` 54 | :button-style: btn btn-secondary stretched-link 55 | 56 | .. card:: Templates 57 | 58 | Dans cette section, vous pouvez décrire comment un utilisateur peut 59 | utiliser ses modèles personnalisés. En outre, vous pouvez présenter 60 | et décrire ce que font vos viewhelpers personnalisés. Enfin, vous 61 | pouvez fournir des exemples de modèles. 62 | 63 | .. card-footer:: :ref:`Inspecter le modèle ` 64 | :button-style: btn btn-secondary stretched-link 65 | 66 | .. card:: The editor section 67 | 68 | Cette section est spécialisée pour les éditeurs. Les éditeurs trouvent 69 | tout ce qui leur est utile en utilisant les de cette 70 | section. 71 | 72 | .. card-footer:: :ref:`Découvrir les outils spécifiques aux éditeurs ` 73 | :button-style: btn btn-secondary stretched-link 74 | 75 | .. card:: The developers corner 76 | 77 | Utilisez cette section pour fournir des exemples de code ou toute 78 | information jugée pertinente pour un développeur. Par exemple, 79 | expliquer comment une certaine fonctionnalité a été mise en œuvre. 80 | 81 | .. card-footer:: :ref:`Faire connaissance avec le coin des développeurs ` 82 | :button-style: btn btn-secondary stretched-link 83 | 84 | .. card:: Troubleshooting 85 | 86 | Utilisez cette section pour informer sur le dépannage. Si les 87 | utilisateurs de votre extension rencontrent des problèmes, ils 88 | devraient pouvoir trouver des informations pour les résoudre dans 89 | cette section. 90 | 91 | .. card-footer:: :ref:`Apprendre à dépanner ` 92 | :button-style: btn btn-secondary stretched-link 93 | 94 | .. toctree:: 95 | :hidden: 96 | :titlesonly: 97 | 98 | Introduction/Index 99 | Installation/Index 100 | Configuration/Index 101 | Editor/Index 102 | Templates/Index 103 | Developer/Index 104 | KnownProblems/Index 105 | 106 | .. Metamenu 107 | 108 | .. toctree:: 109 | :hidden: 110 | 111 | Sitemap 112 | 113 | ---- 114 | 115 | :Clé d'extension: 116 | 117 | 118 | :Nom du package: 119 | 120 | 121 | :Version: 122 | |release| 123 | 124 | :Langue: 125 | fr 126 | 127 | :Auteur: 128 | 129 | 130 | :Licence: 131 | Ce document est publié sous la licence 132 | `Creative Commons BY 4.0 `__. 133 | 134 | :Généré: 135 | |today| 136 | 137 | -------------------------------------------------------------------------------- /Documentation/Localization.de_DE/Index.rst: -------------------------------------------------------------------------------- 1 | .. include:: /Includes.rst.txt 2 | 3 | .. _start: 4 | 5 | ============ 6 | 7 | ============ 8 | 9 | Willkommen zur Beispielanleitung der Beispielerweiterung . 10 | 11 | Diese Anleitung gibt eine Einführung in die Beispielerweiterung . 12 | Sie zeigt den grundlegenden Aufbau einer Anleitung, die die Verwendung der Erweiterung 13 | erklärt. Sie können sie als Ausgangspunkt oder als Leitfaden verwenden, um 14 | Ihre eigene Dokumentation für Ihre Erweiterung zu erstellen. 15 | 16 | Die erste Übersicht sollte dem Benutzer einen guten Ausgangspunkt bieten, um 17 | schnell die Informationen zu finden, nach denen er sucht. 18 | 19 | ---- 20 | 21 | .. card-grid:: 22 | :columns: 1 23 | :columns-md: 2 24 | :gap: 4 25 | :class: pb-4 26 | :card-height: 100 27 | 28 | .. card:: Einführung 29 | 30 | Sie sollten eine kleine Einführung in Ihre Erweiterung geben. 31 | Wenn Sie neu sind im Dokumentationen schreiben, sollte dieser Abschnitt 32 | einen guten Ausgangspunkt für Sie darstellen. 33 | 34 | .. card-footer:: :ref:`Bekommen Sie einen Überblick ` 35 | :button-style: btn btn-secondary stretched-link 36 | 37 | .. card:: Installation 38 | 39 | Beschreiben Sie welche Schritte man folgen muss, um die Erweiterung 40 | erfolgreich zu installieren. Geben Sie genügend Hinweise, um den Nutzer 41 | durch diesen Prozess zu begleiten. 42 | 43 | .. card-footer:: :ref:`Installieren Sie Ihre Erweiterung ` 44 | :button-style: btn btn-secondary stretched-link 45 | 46 | .. card:: Konfiguration 47 | 48 | In diesem Kapitel sollten Sie alle benötigten Konfigurationen erwähnen, 49 | die man braucht, um die Erweiterung zu verwenden. Zudem sollten Sie dem 50 | Nutzer einen Überblick geben über alle möglichen Konfigurationen, die 51 | es in Ihrer Erweiterung gibt. 52 | 53 | .. card-footer:: :ref:`Konfigurieren Sie Ihre Erweiterung ` 54 | :button-style: btn btn-secondary stretched-link 55 | 56 | .. card:: Templates 57 | 58 | Hier sollte beschrieben werden, wie der Nutzer seine eigenen Fluid 59 | Templates nutzen kann. Zudem können Sie hier auch Ihre Viewhelper 60 | erklären und zeigen wie man sie nutzt. Außerdem können Sie Beispieltemplates 61 | zeigen. 62 | 63 | .. card-footer:: :ref:`Templating relevante Informationen ` 64 | :button-style: btn btn-secondary stretched-link 65 | 66 | .. card:: Für Editoren 67 | 68 | Dieses Kapitel enhält alle wichtigen Informationen, die ein Editor 69 | wissen sollte. Und zwar nicht die allgemeinen, sondern die, die für Ihre 70 | Erweiterung relevant sind. 71 | 72 | .. card-footer:: :ref:`Endecken Sie die Editor Werkzeuge ` 73 | :button-style: btn btn-secondary stretched-link 74 | 75 | .. card:: Für Entwickler 76 | 77 | Dieses Kapitel können Sie verwenden, um Beispielcode zu zeigen oder um 78 | Informationen zu geben, die für einen Entwickler relevant sind. Zum 79 | Beispiel können Sie hier erklären, wie Sie ein spezielles Feature erstellt 80 | haben. 81 | 82 | .. card-footer:: :ref:`Entdecken Sie alles Relevante für den Entwickler ` 83 | :button-style: btn btn-secondary stretched-link 84 | 85 | .. card:: Troubleshooting 86 | 87 | Informieren Sie hier über Troubleshooting. Wenn ein Nutzer Probleme 88 | hat sollte er hier sinnvolle Informationen finden, um die Lösung für 89 | sein Problem zu finden. 90 | 91 | .. card-footer:: :ref:`Probleme und ihre Lösungen ` 92 | :button-style: btn btn-secondary stretched-link 93 | 94 | .. toctree:: 95 | :hidden: 96 | :titlesonly: 97 | 98 | Introduction/Index 99 | Installation/Index 100 | Configuration/Index 101 | Editor/Index 102 | Templates/Index 103 | Developer/Index 104 | KnownProblems/Index 105 | 106 | .. Metamenü 107 | 108 | .. toctree:: 109 | :hidden: 110 | 111 | Sitemap 112 | 113 | ---- 114 | 115 | :Extension-Schlüssel: 116 | 117 | 118 | :Paketname: 119 | 120 | 121 | :Version: 122 | |release| 123 | 124 | :Sprache: 125 | de 126 | 127 | :Autor: 128 | 129 | 130 | :Lizenz: 131 | Dieses Dokument wird unter der 132 | `Creative Commons BY 4.0 `__ 133 | Lizenz veröffentlicht. 134 | 135 | :Erstellt: 136 | |today| 137 | --------------------------------------------------------------------------------