diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..fe14340 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,23 @@ +# EditorConfig is awesome: http://EditorConfig.org +# +# Use as master: https://github.com/TYPO3-Documentation/T3DocTeam/blob/master/.editorconfig + +# top-most EditorConfig file +root = false + +[{*.rst,*.rst.txt}] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space +indent_size = 3 + +# MD-Files +[*.md] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true +indent_style = space +indent_size = 4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b9cd1fe --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*GENERATED* diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b1521c8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contribute to TYPO3 Documentation + +## Create Issues + +* If you find something missing or something is wrong in this manual, you are welcome to write an issue describing the problem. +* If you can, please try to fix the problem yourself. +* For minor changes, it is not necessary to create an issue first. + +## Make changes (create pull requests) + +* In order to make changes on a [rendered page](https://docs.typo3.org/), just click on "Edit me on GitHub". +* For a step-by-step walkthrough for making a change, see [Contribute to docs.typo3.org](https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/Index.html) +* For a step-by-step walkthrough of alternative workflow, see [Local Editing and Rendering with Docker](https://docs.typo3.org/typo3cms/HowToDocument/WritingDocsOfficial/LocalEditing.html) + +## Get help + +* If you need help with contributing to the docs, see [How to get Help](https://docs.typo3.org/typo3cms/HowToDocument/HowToGetHelp.html) + +# Contribute to TYPO3 Core + +* See [TYPO3 Contribution Guide - Core Development](https://docs.typo3.org/typo3cms/ContributionWorkflowGuide/) + +# General TYPO3 Support + +If you have some general TYPO3 support questions or need help with TYPO3, please see https://typo3.org/help. diff --git a/Documentation/AboutContributing.rst b/Documentation/AboutContributing.rst new file mode 100644 index 0000000..8263c2a --- /dev/null +++ b/Documentation/AboutContributing.rst @@ -0,0 +1,25 @@ +.. include:: Includes.txt + +.. _contribute: + +================== +About Contributing +================== + + +**Do you have a cheat sheet yourself?** + +Do you want **your** cheat sheets to be featured on docs.typo3.org as well? + +Then don't hesitate to add your cheat sheet :ref:`with a pull request `. + +Or `contact the Documentation Team `__. + +Every contribution is welcome! + +**Have you found an error on one of the cheat sheets or want to make +a suggestion?** + +Again, make the change yourself :ref:`with a pull request `, +report an issue or `contact the Documentation Team `__. + diff --git a/Documentation/CheatSheets.rst b/Documentation/CheatSheets.rst new file mode 100644 index 0000000..1537fd6 --- /dev/null +++ b/Documentation/CheatSheets.rst @@ -0,0 +1,143 @@ +.. include:: Includes.txt + +.. _cheat-sheets: + +====================== +TYPO3 CMS Cheat Sheets +====================== + +.. important:: + + The cheat sheets on this page refer to version |release| of TYPO3 + CMS. Use the version selector on this page to select the + version of TYPO3 you are currently using. + See `Usage tips: version selector `__. + + +TypoScript +========== + +stdWrap overview for cObjects +----------------------------- + +*by Xavier Perseguers* + + +This overview presents the different stdWrap properties of a cObject. +It uses the cObject "TEXT" as example to demonstrate where they are applied. + + +* `Download `__ +* `Edit `__ + +stdWrap overview for menu objects +--------------------------------- + +*by Xavier Perseguers* + +This overview presents the different stdWrap properties of a menu. It uses the menu type +"HMENU" as an example to demonstrate where they are applied. + +* `Download `__ +* `Edit `__ + + +New Website Cheat Sheet +----------------------- + +*by Leon D.* + +Overview of common TypoScript settings for a new TYPO3 website. + +* `Download `__ + + +TYPO3 Page Includes +------------------- + +*by Steffen Kamper* + +An illustration of the different includes, which are supported by the Page renderer since TYPO3 4.3. + +* `Download `__ +* `Edit `__ + + +Extbase / Fluid +=============== + +2 Extbase Cheat Sheets and 2 Fluid Cheat Sheets +----------------------------------------------- + +*by Patrick Lobacher* + +Everything around Extbase and Fluid: Extension directory structure, TypoScript settings, API for ActionController, +View and Request. And for Fluid: Fluidtemplate and usage of ViewHelpers. + +* `Download `__ + + + +TCA +=== + +Compact overview of TCA settings and values +------------------------------------------- + +*by Stefan Frömken* + + + +* `Download `__ + + +Testing +======= + +Creating and using mocks with Prophecy in PHPUnit +------------------------------------------------- + +*by Oliver Klee* + + +* `Download `__ +* `Repository `__ + +Creating and using mocks in PHPUnit +----------------------------------- + +*by Oliver Klee* + +* `Download `__ +* `Repository `__ + + +Test Driven Development with TYPO3 CMS +-------------------------------------- + +*by Oliver Klee* + +* `Download `__ +* `Repository `__ + + + +Core Development +================ + +Git +--- + +Basic commands for using Git to create and modify core patches + +* :ref:`t3contribute:cheat-sheet-git` + + +Writing TYPO3 Documentation +=========================== + + +reST & Sphinx Cheat Sheet +------------------------- + +* :ref:`h2document:rest-cheat-sheet` diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt new file mode 100644 index 0000000..0648a88 --- /dev/null +++ b/Documentation/Includes.txt @@ -0,0 +1,27 @@ +.. This is 'Includes.txt'. It is included at the very top of each and + every ReST source file in THIS documentation project (= manual). + +.. role:: aspect (emphasis) + +.. role:: html(code) + :language: html + +.. role:: js(code) + :language: javascript + +.. role:: jts(code) + :class: typescript + :language: typescript + +.. role:: php(code) + :language: php + +.. role:: typoscript(code) + :language: typoscript + +.. role:: ts(typoscript) + :class: typoscript + :language: typoscript + +.. default-role:: code +.. highlight:: php diff --git a/Documentation/Index.rst b/Documentation/Index.rst new file mode 100644 index 0000000..2769e2c --- /dev/null +++ b/Documentation/Index.rst @@ -0,0 +1,69 @@ +.. include:: Includes.txt + +.. _start: + +============ +Cheat Sheets +============ + +:Version: + |release| + +:Language: + en + +:Description: + Cheat Sheets provided by the community + +:Audience: + Developers, Integrators + +:License: + Licenses and copyright as specified in the cheat sheet + +:Shortcut: + `t3cheatsheets` is the usual alias for + :ref:`cross-referencing `. + + +.. rst-class:: horizbuttons-primary-xxl + +* `Jump to the cheat sheets `__ + + +The content of this document is related to TYPO3 CMS, a GNU/GPL CMS/Framework +available from https://typo3.org/. + +**About this manual** + +This section holds files, which are related to the TYPO3 CMS Core +documentation, but which do not really fit into any specific manual. + +They contain concise information about one topic, usually on one or +only a few pages. + +**Community Documentation** + +The cheat sheets are provided by the TYPO3 community. + +**Contribute** + +.. note:: + + **Do you have a cheat sheet yourself or have you found an error + or want to make a suggestion?** + + Then don't hesitate to :ref:`contribute` + +**Credits** + +The Documentation Team kindly thanks all authors for their work! + +TYPO3 - inspiring people to share. + +**Table of Contents** + +.. toctree:: + CheatSheets + AboutContributing + Sitemap \ No newline at end of file diff --git a/Documentation/Resources/Public/CheatSheets/T3_pageinclude_sheet v1.odp b/Documentation/Resources/Public/CheatSheets/T3_pageinclude_sheet v1.odp new file mode 100644 index 0000000..7996230 Binary files /dev/null and b/Documentation/Resources/Public/CheatSheets/T3_pageinclude_sheet v1.odp differ diff --git a/Documentation/Resources/Public/CheatSheets/T3_pageinclude_sheet v1.pdf b/Documentation/Resources/Public/CheatSheets/T3_pageinclude_sheet v1.pdf new file mode 100644 index 0000000..04ae68a Binary files /dev/null and b/Documentation/Resources/Public/CheatSheets/T3_pageinclude_sheet v1.pdf differ diff --git a/Documentation/Resources/Public/CheatSheets/TYPO3 CMS Coding Guidelines on one page v1.odt b/Documentation/Resources/Public/CheatSheets/TYPO3 CMS Coding Guidelines on one page v1.odt new file mode 100644 index 0000000..33467f2 Binary files /dev/null and b/Documentation/Resources/Public/CheatSheets/TYPO3 CMS Coding Guidelines on one page v1.odt differ diff --git a/Documentation/Resources/Public/CheatSheets/TYPO3 CMS Coding Guidelines on one page v1.pdf b/Documentation/Resources/Public/CheatSheets/TYPO3 CMS Coding Guidelines on one page v1.pdf new file mode 100644 index 0000000..ea0b2e2 Binary files /dev/null and b/Documentation/Resources/Public/CheatSheets/TYPO3 CMS Coding Guidelines on one page v1.pdf differ diff --git a/Documentation/Resources/Public/CheatSheets/stdwrap-menu.png b/Documentation/Resources/Public/CheatSheets/stdwrap-menu.png new file mode 100644 index 0000000..2de3c60 Binary files /dev/null and b/Documentation/Resources/Public/CheatSheets/stdwrap-menu.png differ diff --git a/Documentation/Resources/Public/CheatSheets/stdwrap.png b/Documentation/Resources/Public/CheatSheets/stdwrap.png new file mode 100644 index 0000000..59608ac Binary files /dev/null and b/Documentation/Resources/Public/CheatSheets/stdwrap.png differ diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg new file mode 100644 index 0000000..e837459 --- /dev/null +++ b/Documentation/Settings.cfg @@ -0,0 +1,58 @@ +# coding: utf-8 + +[general] + +project = Cheat Sheets +release = master (10-dev) +t3author = TYPO3 Documentation Team +copyright = since ever by the TYPO3 Documentation Team + +description = Cheat Sheets for TYPO3 CMS + + +[html_theme_options] + +# "Edit me on GitHub" button +github_branch = master +github_repository = TYPO3-Documentation/TYPO3CMS-Cheat-Sheets + +# Releated Links +project_contact = https://typo3.org/community/teams/documentation/#c9886 +project_discussions = +project_home = https://typo3.org/community/teams/documentation/ +project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Cheat-Sheets/issues +project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Cheat-Sheets + + +[intersphinx_mapping] + +h2document = https://docs.typo3.org/typo3cms/HowToDocument/ +#t3api = https://typo3.org/api/typo3cms/ +#t3cgl = https://docs.typo3.org/typo3cms/CodingGuidelinesReference/ +t3contribute = https://docs.typo3.org/typo3cms/ContributionWorkflowGuide/ +#t3coreapi = https://docs.typo3.org/typo3cms/CoreApiReference/ +#t3editors = https://docs.typo3.org/typo3cms/EditorsTutorial/ +#t3extbase = https://docs.typo3.org/typo3cms/ExtbaseGuide/ +#t3extbasebook = https://docs.typo3.org/typo3cms/ExtbaseFluidBook/ +#t3fal = https://docs.typo3.org/typo3cms/FileAbstractionLayerReference/ +#t3inside = https://docs.typo3.org/typo3cms/InsideTypo3Reference/ +#t3install = https://docs.typo3.org/typo3cms/InstallationGuide/ +#t3l10n = https://docs.typo3.org/typo3cms/FrontendLocalizationGuide/ +#t3security = https://docs.typo3.org/typo3cms/SecurityGuide/ +#t3services = https://docs.typo3.org/typo3cms/Typo3ServicesReference/ +#t3sitepackage = https://docs.typo3.org/typo3cms/SitePackageTutorial/ +#t3skinning = https://docs.typo3.org/typo3cms/SkinningReference/ +#t3start = https://docs.typo3.org/typo3cms/GettingStartedTutorial/ +#t3tca = https://docs.typo3.org/typo3cms/TCAReference/ +#t3templating = https://docs.typo3.org/typo3cms/TemplatingTutorial/ +#t3ts45 = https://docs.typo3.org/typo3cms/TyposcriptIn45MinutesTutorial/ +#t3tsconfig = https://docs.typo3.org/typo3cms/TSconfigReference/ +#t3tsref = https://docs.typo3.org/typo3cms/TyposcriptReference/ +#t3tssyntax = https://docs.typo3.org/typo3cms/TyposcriptSyntaxReference/ +#t3viewhelper = https://docs.typo3.org/typo3cms/ViewHelperReference/ + + +[extensions] + +any_name_youtube = sphinxcontrib.youtube + diff --git a/Documentation/Sitemap.rst b/Documentation/Sitemap.rst new file mode 100644 index 0000000..915f565 --- /dev/null +++ b/Documentation/Sitemap.rst @@ -0,0 +1,11 @@ +:template: sitemap.html + +.. _Sitemap: + +======= +Sitemap +======= + +.. template 'sitemap.html' will insert the toctree as a sitemap here below +normal contents + diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..beeb1fe --- /dev/null +++ b/README.rst @@ -0,0 +1,19 @@ +============================================================ +Contents of the docs.typo3.org homepage and the "glue"-pages +============================================================ + +:Repository: https://github.com/TYPO3-Documentation/DocsTypo3Org-Homepage + +:Published: https://docs.typo3.org/ + +:Authors: TYPO3 Documentation Team + +:Rendered: (automatically) `drafts/github/TYPO3-Documentation/DocsTypo3Org-Homepage + `__ + +:How to: `How to publish + `__ + +:Rendered: (manually) `drafts/github/TYPO3-Documentation/DocsTypo3Org-Homepage/0.0/ + `__ + diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..58929e9 --- /dev/null +++ b/composer.json @@ -0,0 +1,9 @@ +{ + "name": "typo3/docs-homepage", + "type": "typo3-cms-documentation", + "description": "Cheat Sheets", + "license": "", + "require": { + "typo3/cms-core": "^10" + } +}