diff --git a/Documentation/Basics/GeneralConventions/CodingGuidelines.rst b/Documentation/Advanced/CodingGuidelines.rst similarity index 99% rename from Documentation/Basics/GeneralConventions/CodingGuidelines.rst rename to Documentation/Advanced/CodingGuidelines.rst index 9277f7c6..076d4003 100644 --- a/Documentation/Basics/GeneralConventions/CodingGuidelines.rst +++ b/Documentation/Advanced/CodingGuidelines.rst @@ -194,7 +194,6 @@ file: reST directives; deprecated reST directives; versionadded reST directives; versionchanged -.. _version-hints: How to add version hints ======================== diff --git a/Documentation/Basics/GeneralConventions/ContentStyleGuide.rst b/Documentation/Advanced/ContentStyleGuide.rst similarity index 94% rename from Documentation/Basics/GeneralConventions/ContentStyleGuide.rst rename to Documentation/Advanced/ContentStyleGuide.rst index d1f44d45..940f67fd 100644 --- a/Documentation/Basics/GeneralConventions/ContentStyleGuide.rst +++ b/Documentation/Advanced/ContentStyleGuide.rst @@ -7,6 +7,26 @@ Spelling ======== +.. contents:: + +Title capitalization +==================== + +Use :ref:`sentence case ` - this means the title and +headers will be capitalized like normal sentences. The first word +is always capitalized and the rest is spelled as they would in +"normal text". + +This is different from "TYPO3 content style guide" which capitalizes +more words in the title. Capitalization in the documentation is still +inconsistent currently, so you cannot rely on existing pages to show +the correct convention. + +Spelling +======== + +Use common spelling for American English. Some specific TYPO3 terms +have a special spelling. See :ref:`spelling-ref` General information =================== diff --git a/Documentation/Basics/GeneralConventions/Format.rst b/Documentation/Advanced/Format.rst similarity index 100% rename from Documentation/Basics/GeneralConventions/Format.rst rename to Documentation/Advanced/Format.rst diff --git a/Documentation/Basics/GeneralConventions/Glossary.rst b/Documentation/Advanced/Glossary.rst similarity index 100% rename from Documentation/Basics/GeneralConventions/Glossary.rst rename to Documentation/Advanced/Glossary.rst diff --git a/Documentation/Basics/GeneralConventions/GuidelinesForImages.rst b/Documentation/Advanced/GuidelinesForImages.rst similarity index 100% rename from Documentation/Basics/GeneralConventions/GuidelinesForImages.rst rename to Documentation/Advanced/GuidelinesForImages.rst diff --git a/Documentation/Advanced/HowToAddTranslation/Index.rst b/Documentation/Advanced/HowToAddTranslation.rst similarity index 100% rename from Documentation/Advanced/HowToAddTranslation/Index.rst rename to Documentation/Advanced/HowToAddTranslation.rst diff --git a/Documentation/Advanced/Index.rst b/Documentation/Advanced/Index.rst new file mode 100644 index 00000000..90426293 --- /dev/null +++ b/Documentation/Advanced/Index.rst @@ -0,0 +1,13 @@ +:navigation-title: Advanced +.. include:: /Includes.rst.txt +.. _advanced: + +============================= +Advanced documentation topics +============================= + +.. toctree:: + :glob: + :titlesonly: + + * diff --git a/Documentation/Basics/GeneralConventions/Licenses.rst b/Documentation/Advanced/Licenses.rst similarity index 100% rename from Documentation/Basics/GeneralConventions/Licenses.rst rename to Documentation/Advanced/Licenses.rst diff --git a/Documentation/Basics/GeneralConventions/ReadmeFile.rst b/Documentation/Advanced/ReadmeFile.rst similarity index 100% rename from Documentation/Basics/GeneralConventions/ReadmeFile.rst rename to Documentation/Advanced/ReadmeFile.rst diff --git a/Documentation/Advanced/ReviewInformation.rst b/Documentation/Advanced/ReviewInformation.rst deleted file mode 100644 index a88f5636..00000000 --- a/Documentation/Advanced/ReviewInformation.rst +++ /dev/null @@ -1,159 +0,0 @@ -.. include:: /Includes.rst.txt -.. index:: ! Reviewing manuals -.. _guidelines-for-reviewing: - -================================ -Guidelines for reviewing manuals -================================ - -Reviewing manuals and finding a workflow for this is still a work in progress. - -See the :ref:`Related Issues `. - - -.. index:: Reviewing manuals; Guidelines - -Guidelines for reviewing -======================== - -#. Preferably, an entire branch should be systematically reviewed. - In that case, just :ref:`add a status to the start page ` - with information when it was last - reviewed and for which version. -#. When you come across a single page that is outdated, preferably fix it right away. - If you can't, :ref:`add a warning `, but also make - sure to write an issue. -#. For branches that have not been entirely reviewed yet and that are too comprehensive - to do this in one sitting, a procedure should be selected to systematically review. - This can be decided on a case by case basis for each manual / branch. - - -What to watch out for while reviewing: - -* **Duplicate content:** Check for similar content in other manuals. - Merge duplicate content: Decide where the content should live, remove it in the - other places and add links. -* **Remove redundant content:** Keep content short and to the point. - For things that are not TYPO3-specific: Link elsewhere if good - documentation is already available elsewhere. -* **Technical correctness:** Is information correct and up-to-date (for version of - branch)? Does it propagate good best practices (instead of deprecated ones)? -* **Didactic:** Is the text easy to understand and follow? For lengthy texts: Is there - a quick start or a summary at the beginning (Example: :ref:`Logging Quick Start `)? -* **Language correctness:** Spelling, grammar, style. - -Not everyone is a native English speaker and not everyone knows TYPO3 inside-out. It -is entirely fine to only focus on one aspect at a time (for example language) while reviewing. - - -Examples for review information -=============================== - -Until we can be sure, that the published documentation is generally correct and up-to-date, -you can add review information. - -There are 3 goals here: - -#. Warn readers about outdated information (must be visible on the rendered page). -#. Help reviewers to quickly see which state a page is in without having to read the entire - page. -#. Help reviewers to keep track of reviewed / unreviewed pages. It should be possible to - mark pages that have been already checked as ok or not ok and find all unchecked pages - or find all pages with problems. - - -.. index:: - Reviewing manuals; Review information - Reviewing manuals; Outdated content -.. _add-review-info-to-startpage: - -Add review information to the start page ----------------------------------------- - -Once the entire branch has been reviewed and updated, you can add this -information to the start page: - -:Status: - Tested and reviewed for TYPO3 9.5.5 on April 11, 2019 - -.. code-block:: rst - - :Status: - Tested and reviewed for TYPO3 9.5.5 on April 11, 2019 - -*If* pages become outdated and are not fixed immediately, you can modify -the review information on the start page, for example - - -:Status: - Last tested and reviewed for TYPO3 9.5.5 on April 11, 2019, some pages outdated - -.. code-block:: rst - - :Status: - Last tested and reviewed for TYPO3 9.5.5 on April 11, 2019, some pages outdated - - - -Examples: - -* :ref:`t3start:start`. - - -.. index:: - Reviewing manuals; Outdated content - reST directives; warning -.. _reviewInfoWarning: - -Add warning for outdated content ---------------------------------- - -If the information is clearly outdated (or incorrect), you should add -a **visible** warning to warn readers. - -Better would be to update the page. So, this should only be done in the rare -cases where updating is not possible immediately. - -.. warning:: - - The information on this page is outdated! - -.. code-block:: rst - - .. warning:: - - The information on this page is outdated! - - -.. index:: - Reviewing manuals; Todo - reST directives; todo - -Todo directive --------------- - -The "todo" directive will not get rendered by default. - -Examples of review information with todo: - -.. code-block:: rst - - .. todo:: Needs review: Outdated (2019/5/15 TYPO3 9.5.5) - - .. todo:: Needs review: Improved language (2019/5/15 TYPO3 9.5.5) - -In order to render this, add this to :file:`Settings.cfg`: - -.. code-block:: none - - [extensions] - todo_include_todos=True - - -.. _review-workflow-related-issues: - -Related issues -============== - -* `Find a workflow for reviewing / updating / refining manuals `__ -* `Update the docs before we release the new version. `__ diff --git a/Documentation/Basics/GeneralConventions/ReviewPolicy.rst b/Documentation/Advanced/ReviewPolicy.rst similarity index 100% rename from Documentation/Basics/GeneralConventions/ReviewPolicy.rst rename to Documentation/Advanced/ReviewPolicy.rst diff --git a/Documentation/Basics/GeneralConventions/images/backend-raw.png b/Documentation/Advanced/images/backend-raw.png similarity index 100% rename from Documentation/Basics/GeneralConventions/images/backend-raw.png rename to Documentation/Advanced/images/backend-raw.png diff --git a/Documentation/Basics/GeneralConventions/images/backend-with-boxes-2.svg b/Documentation/Advanced/images/backend-with-boxes-2.svg similarity index 100% rename from Documentation/Basics/GeneralConventions/images/backend-with-boxes-2.svg rename to Documentation/Advanced/images/backend-with-boxes-2.svg diff --git a/Documentation/Basics/GeneralConventions/images/backend-with-boxes.png b/Documentation/Advanced/images/backend-with-boxes.png similarity index 100% rename from Documentation/Basics/GeneralConventions/images/backend-with-boxes.png rename to Documentation/Advanced/images/backend-with-boxes.png diff --git a/Documentation/Basics/GeneralConventions/images/github-getting-started-raw.png b/Documentation/Advanced/images/github-getting-started-raw.png similarity index 100% rename from Documentation/Basics/GeneralConventions/images/github-getting-started-raw.png rename to Documentation/Advanced/images/github-getting-started-raw.png diff --git a/Documentation/Basics/BasicPrinciples.rst b/Documentation/Basics/BasicPrinciples.rst index dc1a23ff..348b0208 100644 --- a/Documentation/Basics/BasicPrinciples.rst +++ b/Documentation/Basics/BasicPrinciples.rst @@ -55,8 +55,8 @@ All of these examples have a few things in common: * The source of the documentation is written (mostly) in reStructuredText (**reST**) * All documentation is rendered using the **same rendering toolchain**. All documentation can be rendered locally, with the officially supported Docker image. -* The documentation source files adhere to :ref:`general-conventions` and - share a **common structure** (for example all documentation files in a +* The documentation source files adhere to :ref:`file-structure` + (for example all documentation files in a :file:`Documentation` subdirectory). * Due to the conventions, the rendering of documentation can be automated and every documentation project only requires a minimum of setup. diff --git a/Documentation/Basics/GeneralConventions/Index.rst b/Documentation/Basics/GeneralConventions/Index.rst deleted file mode 100644 index 02327bd2..00000000 --- a/Documentation/Basics/GeneralConventions/Index.rst +++ /dev/null @@ -1,110 +0,0 @@ -.. include:: /Includes.rst.txt -.. index:: Documentation; Content style guide -.. _general-conventions: -.. _conventions: - -================================= -Documentation content style guide -================================= - -This contains conventions, coding guidelines and best practices for TYPO3 -documentation. In general, the documentation follows the conventions as -described in the following sections. - -Finding common conventions is an ongoing task. Some of the decisions are -still pending. For a list of open topics, see the "Documentation" category -on `decisions.typo3.org `__ - -The most important conventions are summarized on this page, the rest can -be found in the subchapters. - -.. rst-class:: bignums-xxl - -#. Title capitalization - - Use :ref:`sentence case ` - this means the title and - headers will be capitalized like normal sentences. The first word - is always capitalized and the rest is spelled as they would in - "normal text". - - This is different from "TYPO3 content style guide" which capitalizes - more words in the title. Capitalization in the documentation is still - inconsistent currently, so you cannot rely on existing pages to show - the correct convention. - -#. Spelling - - Use common spelling for American English. Some specific TYPO3 terms - have a special spelling. See :ref:`spelling-ref` - -#. Version hints - - :ref:`version-hints` describes how to add version hints for new sections - or chapters: - - .. code-block:: rst - - .. deprecated:: 10.2 - The hook shown here is deprecated since TYPO3 10.2 - use a custom - :ref:`PSR-15 middleware` instead. - - .. versionadded:: 10.2 - Starting with TYPO3 10.2 hooks and signals have been replaced by a PSR-14 based - event dispatching system. - - .. versionchanged:: 2.3.1 - This feature was changed ... - -#. Link to the changelog - - :ref:`link-to-changelog` describes how to link to the changelog: - - .. code-block:: rst - - :ref:`ext_core:feature-101544-1691063522` - - -#. Coding guidelines for headers - - Headline underline should follow :ref:`rest-cgl-headline-underlines` - - .. code-block:: rst - - ===== - Title - ===== - - First header level - ================== - - Second header level - ------------------- - - Third header level - ~~~~~~~~~~~~~~~~~~ - - .. seealso:: - - * :ref:`format-rest-cgl` - -#. Refer to elements in the GUI with :rst:`:guilabel:` - - Example: - - .. code-block:: rst - - :guilabel:`Admin Tools > Extensions` - - This will look like this: :guilabel:`Admin Tools > Extensions` - -.. toctree:: - :caption: Table of contents - :maxdepth: 1 - - ReviewPolicy - ContentStyleGuide - Glossary - Format - CodingGuidelines - GuidelinesForImages - Licenses diff --git a/Documentation/Howto/Contribute/HowYouCanHelp.rst b/Documentation/Howto/Contribute/HowYouCanHelp.rst index c34d999d..c5d055d5 100644 --- a/Documentation/Howto/Contribute/HowYouCanHelp.rst +++ b/Documentation/Howto/Contribute/HowYouCanHelp.rst @@ -146,9 +146,6 @@ Here are some examples: Replace outdated images and screenshots ======================================= -Replace outdated images, for example, in the :ref:`t3tsconfig:start` -reference. - Look at :ref:`how-to-document-images` for information about how to embed images with reST. @@ -170,8 +167,6 @@ Pick a manual and start reviewing it. If you find something that needs fixing or something is missing, either fix it or write an issue for it, if you cannot make the changes yourself. -More information: :ref:`guidelines-for-reviewing` - .. tip:: Usually, there is one branch for each major TYPO3 version in a manual. Please focus your efforts mostly on the "main" branch, to get diff --git a/Documentation/Howto/Contribute/Index.rst b/Documentation/Howto/Contribute/Index.rst index d0dce3c9..d6cc6d4d 100644 --- a/Documentation/Howto/Contribute/Index.rst +++ b/Documentation/Howto/Contribute/Index.rst @@ -13,7 +13,7 @@ Contribute to the TYPO3 documentation .. sidebar:: Quicklinks * :ref:`reStructuredText cheatsheet ` - * :ref:`Conventions ` + * :ref:`File structure ` * :ref:`Render with Docker ` * :ref:`Typical tasks ` * `Open issues `__ (a GitHub account is required) diff --git a/Documentation/Howto/WritingDocForExtension/Index.rst b/Documentation/Howto/WritingDocForExtension/Index.rst index a091147a..91e96fc8 100644 --- a/Documentation/Howto/WritingDocForExtension/Index.rst +++ b/Documentation/Howto/WritingDocForExtension/Index.rst @@ -14,8 +14,7 @@ How to document an extension This chapter explains how to write documentation for a new extension. This guide uses the `example extension manual `__ -as a template for starting out. It contains a working navigation panel, a range of example content and adheres to the guidelines -laid out in the :ref:`general-conventions` chapter. +as a template for starting out. Rendering the documentation locally ----------------------------------- diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 9dd88310..38124b81 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -94,7 +94,6 @@ reStructuredText (reST). Basics/About Basics/HowToGetHelp Basics/BasicPrinciples - Basics/GeneralConventions/Index Basics/RstCheatSheet @@ -117,8 +116,7 @@ reStructuredText (reST). :hidden: :caption: ADVANCED - Advanced/HowToAddTranslation/Index - Advanced/ReviewInformation + Advanced/Index .. toctree:: :hidden: diff --git a/Documentation/Reference/ReStructuredText/Content/Versions.rst b/Documentation/Reference/ReStructuredText/Content/Versions.rst index 5fa2d875..4c5143fb 100644 --- a/Documentation/Reference/ReStructuredText/Content/Versions.rst +++ b/Documentation/Reference/ReStructuredText/Content/Versions.rst @@ -1,6 +1,7 @@ .. include:: /Includes.rst.txt .. index:: reST; Versions .. _rest-versions: +.. _version-hints: ======== Versions @@ -11,12 +12,6 @@ We have 3 directives to mark versions in the manuals. The incentive is that information which is important for migration can be marked and semi-automatically be removed after one or two versions. -.. seealso:: - - * :ref:`update-docs` - * :ref:`version-hints` - * `The version directives in the Sphinx Docu `__ - Versionadded ============ diff --git a/Documentation/_CodeSnippets/FileStructure/Dashboard/SettingsCfg.rst.txt b/Documentation/_CodeSnippets/FileStructure/Dashboard/SettingsCfg.rst.txt deleted file mode 100644 index 6043d130..00000000 --- a/Documentation/_CodeSnippets/FileStructure/Dashboard/SettingsCfg.rst.txt +++ /dev/null @@ -1,70 +0,0 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3/sysext/dashboard/Documentation/Settings.cfg - -.. code-block:: none - :caption: Documentation/Settings.cfg of the Dashboard manual - - # More information about this file: - # https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg - - [general] - - project = Dashboard - version = main (development) - release = main (development) - copyright = since 2020 by the TYPO3 contributors - - [html_theme_options] - - # "Edit on GitHub" button - github_repository = typo3/typo3 - github_branch = main - path_to_documentation_dir = typo3/sysext/dashboard/Documentation - - # Footer links - project_home = https://extensions.typo3.org/extension/dashboard/ - project_contact = https://typo3.slack.com/archives/C025BQLFA - project_repository = https://github.com/typo3/typo3 - project_issues = https://forge.typo3.org/projects/typo3cms-core/issues - project_discussions = - - use_opensearch = - - [intersphinx_mapping] - - # Official TYPO3 manuals - # h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ - # t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/main/en-us/ - # t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/ - t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ - # t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/ - # t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/ - # t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/ - # t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/ - # t3home = https://docs.typo3.org/ - # t3install = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ - # t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ - # t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/ - # t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/ - # t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ - # t3templating = https://docs.typo3.org/m/typo3/tutorial-templating/main/en-us/ - # t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ - t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/ - # t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/ - # t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/ - # t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/ - # t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ - - # TYPO3 system extensions - # ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/ - ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/ - # ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/ - # ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/ - # ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/ - # ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/ - # ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/ - # ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/ - # ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/ - # ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/ - # ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/ - \ No newline at end of file diff --git a/Documentation/_CodeSnippets/FileStructure/Examples/SettingsCfg.rst.txt b/Documentation/_CodeSnippets/FileStructure/Examples/SettingsCfg.rst.txt deleted file mode 100644 index c54bba0c..00000000 --- a/Documentation/_CodeSnippets/FileStructure/Examples/SettingsCfg.rst.txt +++ /dev/null @@ -1,60 +0,0 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from typo3conf/ext/examples/Documentation/Settings.cfg - -.. code-block:: none - :caption: Documentation/Settings.cfg of the Examples extension manual - - [general] - project = Core documentation code examples - version = master (development) - release = master (development) - copyright = since 1999 by the TYPO3 Documentation Team - t3author = TYPO3 Documentation Team - copyright = since 2000 by the TYPO3 Documentation Team - description = … - - - [html_theme_options] - - github_branch = master - github_repository = TYPO3-Documentation/t3docs-examples - - project_contact = - project_discussions = - project_home = https://github.com/TYPO3-Documentation/t3docs-examples - project_issues = https://github.com/TYPO3-Documentation/t3docs-examples/issues - project_repository = https://github.com/TYPO3-Documentation/t3docs-examples - - - [extlinks] - - issue = https://github.com/TYPO3-Documentation/t3docs-examples/issues/%s | Issue # - - - [intersphinx_mapping] - - t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ - t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/master/en-us/ - t3tca = https://docs.typo3.org/m/typo3/reference-tca/master/en-us/ - t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/master/en-us/ - - # # TYPO3 official docs - # h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/ - # t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/master/en-us/ - # t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/master/en-us/ - # t3install = https://docs.typo3.org/m/typo3/guide-installation/master/en-us/ - # t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/master/en-us/ - # t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/master/en-us/ - # t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/master/en-us/ - # t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/master/en-us/ - # t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/master/en-us/ - # - # # TYPO3 system extensions - # ckedit = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/master/en-us/ - # form = https://docs.typo3.org/c/typo3/cms-form/master/en-us/ - # fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/master/en-us/ - # sched = https://docs.typo3.org/c/typo3/cms-scheduler/master/en-us/ - # t3core = https://docs.typo3.org/c/typo3/cms-core/master/en-us/ - # t3dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/master/en-us/ - # workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/master/en-us/ - \ No newline at end of file diff --git a/Documentation/_CodeSnippets/FileStructure/GettingStarted/SettingsCfg.rst.txt b/Documentation/_CodeSnippets/FileStructure/GettingStarted/SettingsCfg.rst.txt deleted file mode 100644 index 0a6cb106..00000000 --- a/Documentation/_CodeSnippets/FileStructure/GettingStarted/SettingsCfg.rst.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. Generated by https://github.com/TYPO3-Documentation/t3docs-codesnippets -.. Extracted from fileadmin/TYPO3CMS-Tutorial-GettingStarted/Documentation/Settings.cfg - -.. code-block:: none - :caption: Documentation/Settings.cfg of the Getting Started tutorial - - # More information about this file: - # https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg - - [general] - - project = Getting Started - version = main (development) - release = main (development) - copyright = since 2012 by the TYPO3 contributors - - [html_theme_options] - - # "Edit on GitHub" button - github_repository = TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted - github_branch = main - - # Footer links - project_home = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/ - project_contact = https://typo3.slack.com/archives/C028JEPJL - project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted - project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-GettingStarted/issues - project_discussions = - - use_opensearch = - - [intersphinx_mapping] - - # Official TYPO3 manuals - # h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ - # t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/main/en-us/ - # t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/ - t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ - # t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/ - t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/ - # t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/ - # t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/ - # t3home = https://docs.typo3.org/ - # t3install = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ - # t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ - t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/ - # t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/ - # t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ - # t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ - # t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/ - # t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/ - # t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/ - # t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/ - # t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ - - # TYPO3 system extensions - # ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/ - # ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/ - # ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/ - # ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/ - # ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/ - # ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/ - # ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/ - # ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/ - # ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/ - # ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/ - ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/ - ext_surf = https://docs.typo3.org/other/typo3/surf/main/en-us/ - \ No newline at end of file diff --git a/Documentation/_CodeSnippets/FileStructure/SettingsCfg.rst.txt b/Documentation/_CodeSnippets/FileStructure/SettingsCfg.rst.txt deleted file mode 100644 index 48e67675..00000000 --- a/Documentation/_CodeSnippets/FileStructure/SettingsCfg.rst.txt +++ /dev/null @@ -1,69 +0,0 @@ -.. code-block:: none - :caption: Documentation/Settings.cfg - - # More information about this file: - # https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#settings-cfg - - [general] - - project = - version = - release = - copyright = - - [html_theme_options] - - # "Edit on GitHub" button - github_repository = - github_branch = - - # Footer links - project_home = - project_contact = - project_repository = - project_issues = - project_discussions = - - use_opensearch = - - [intersphinx_mapping] - - # Official TYPO3 manuals - # h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/ - # t3cheatsheets = https://docs.typo3.org/m/typo3/docs-cheatsheets/main/en-us/ - # t3contribute = https://docs.typo3.org/m/typo3/guide-contributionworkflow/main/en-us/ - # t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/main/en-us/ - # t3docteam = https://docs.typo3.org/m/typo3/team-t3docteam/main/en-us/ - # t3editors = https://docs.typo3.org/m/typo3/tutorial-editors/main/en-us/ - # t3extbasebook = https://docs.typo3.org/m/typo3/book-extbasefluid/main/en-us/ - # t3extexample = https://docs.typo3.org/m/typo3/guide-example-extension-manual/main/en-us/ - # t3home = https://docs.typo3.org/ - # t3install = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ - # t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ - # t3sitepackage = https://docs.typo3.org/m/typo3/tutorial-sitepackage/main/en-us/ - # t3start = https://docs.typo3.org/m/typo3/tutorial-getting-started/main/en-us/ - # t3tca = https://docs.typo3.org/m/typo3/reference-tca/main/en-us/ - # t3translate = https://docs.typo3.org/m/typo3/guide-frontendlocalization/main/en-us/ - # t3tsconfig = https://docs.typo3.org/m/typo3/reference-tsconfig/main/en-us/ - # t3tsref = https://docs.typo3.org/m/typo3/reference-typoscript/main/en-us/ - # t3ts45 = https://docs.typo3.org/m/typo3/tutorial-typoscript-in-45-minutes/main/en-us/ - # t3viewhelper = https://docs.typo3.org/other/typo3/view-helper-reference/main/en-us/ - # t3upgrade = https://docs.typo3.org/m/typo3/guide-installation/main/en-us/ - - # TYPO3 system extensions - # ext_adminpanel = https://docs.typo3.org/c/typo3/cms-adminpanel/main/en-us/ - # ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/ - # ext_dashboard = https://docs.typo3.org/c/typo3/cms-dashboard/main/en-us/ - # ext_felogin = https://docs.typo3.org/c/typo3/cms-felogin/main/en-us/ - # ext_form = https://docs.typo3.org/c/typo3/cms-form/main/en-us/ - # ext_fsc = https://docs.typo3.org/c/typo3/cms-fluid-styled-content/main/en-us/ - # ext_impexp = https://docs.typo3.org/c/typo3/cms-impexp/main/en-us/ - # ext_indexed_search = https://docs.typo3.org/c/typo3/cms-indexed-search/main/en-us/ - # ext_linkvalidator = https://docs.typo3.org/c/typo3/cms-linkvalidator/main/en-us/ - # ext_lowlevel = https://docs.typo3.org/c/typo3/cms-lowlevel/main/en-us/ - # ext_recycler = https://docs.typo3.org/c/typo3/cms-recycler/main/en-us/ - # ext_redirects = https://docs.typo3.org/c/typo3/cms-redirects/main/en-us/ - # ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/ - # ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/ - # ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/ - # ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/