Skip to content
This repository has been archived by the owner on Feb 25, 2023. It is now read-only.

Commit

Permalink
Merge pull request #13 from TYPO3-Documentation/task-update-docs-v7
Browse files Browse the repository at this point in the history
[TASK] Align with new TYPO3 documentation standards
  • Loading branch information
linawolf committed Mar 22, 2022
2 parents 004c43c + 221114d commit 5d3540d
Show file tree
Hide file tree
Showing 9 changed files with 126 additions and 152 deletions.
25 changes: 0 additions & 25 deletions Documentation/AboutContributing.rst

This file was deleted.

15 changes: 4 additions & 11 deletions Documentation/CheatSheets.rst
@@ -1,17 +1,10 @@
.. include:: Includes.txt
.. include:: /Includes.rst.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 <https://docs.typo3.org/Home/About/UsingThisSite/Index.html#version-selector>`__.
============
Cheat Sheets
============


TypoScript
Expand Down
34 changes: 34 additions & 0 deletions Documentation/Includes.rst.txt
@@ -0,0 +1,34 @@
.. More information about this file:
https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt
.. ----------
.. text roles
.. ----------
.. role:: aspect(emphasis)
.. role:: bash(code)
.. role:: html(code)
.. role:: js(code)
.. role:: php(code)
.. role:: rst(code)
.. role:: sep(strong)
.. role:: sql(code)

.. role:: tsconfig(code)
:class: typoscript

.. role:: typoscript(code)
.. role:: xml(code)
:class: html

.. role:: yaml(code)

.. default-role:: code

.. ---------
.. highlight
.. ---------
.. By default, code blocks use PHP syntax highlighting
.. highlight:: php
27 changes: 0 additions & 27 deletions Documentation/Includes.txt

This file was deleted.

72 changes: 24 additions & 48 deletions Documentation/Index.rst
@@ -1,69 +1,45 @@
.. include:: Includes.txt
.. include:: /Includes.rst.txt

.. _start:

============
Cheat Sheets
============
==================
TYPO3 Cheat Sheets
==================

:Version:
|release|
|release|

:Language:
en
en

:Description:
Cheat Sheets provided by the community

:Audience:
Developers, Integrators
:Author:
TYPO3 contributors

:License:
Licenses and copyright as specified in the cheat sheet

:Shortcut:
`t3cheatsheets` is the usual alias for
:ref:`cross-referencing <linktargets-explanation>`.


.. rst-class:: horizbuttons-primary-xxl

* :ref:`Jump to the cheat sheets <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 document is published under the
`Creative Commons BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`__
license.

This section holds files, which are related to the TYPO3 CMS Core
documentation, but which do not really fit into any specific manual.
:Rendered:
|today|

They contain concise information about one topic, usually on one or
only a few pages.
----

**Community Documentation**
This is a collection of TYPO3 cheat sheets provided by the TYPO3 community.

The cheat sheets are provided by the TYPO3 community.
----

**Contribute**
**Table of Contents:**

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

**Credits**

The Documentation Team kindly thanks all authors for their work!
.. toctree::
:maxdepth: 2

TYPO3 - inspiring people to share.
CheatSheets

**Table of Contents**
.. Meta Menu
.. toctree::
CheatSheets
AboutContributing
:hidden:

Sitemap
genindex
69 changes: 49 additions & 20 deletions Documentation/Settings.cfg
@@ -1,33 +1,62 @@
# 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 = Cheat Sheets
project = TYPO3 Cheat Sheets
version = 7.6
release = 7.6
t3author = TYPO3 Documentation Team
copyright = since ever by the TYPO3 Documentation Team

description = Cheat Sheets for TYPO3 CMS

copyright = since 2019 by the TYPO3 contributors

[html_theme_options]

# "Edit me on GitHub" button
github_branch = 7.6
# "Edit on GitHub" button
github_repository = TYPO3-Documentation/TYPO3CMS-CheatSheets
github_branch = 7.6

# 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-CheatSheets/issues
# Footer links
project_home = https://docs.typo3.org/m/typo3/docs-cheatsheets/7.6/en-us/
project_contact = https://typo3.slack.com/archives/C028JEPJL
project_repository = https://github.com/TYPO3-Documentation/TYPO3CMS-CheatSheets
project_issues = https://github.com/TYPO3-Documentation/TYPO3CMS-CheatSheets/issues
project_discussions =

use_opensearch =

[intersphinx_mapping]

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/

[extensions]

any_name_youtube = sphinxcontrib.youtube

# 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/
6 changes: 2 additions & 4 deletions Documentation/Sitemap.rst
@@ -1,11 +1,9 @@
:template: sitemap.html

.. _Sitemap:
.. include:: /Includes.rst.txt

=======
Sitemap
=======

.. template 'sitemap.html' will insert the toctree as a sitemap here below
normal contents

.. The sitemap.html template will insert here the page tree automatically.
7 changes: 7 additions & 0 deletions Documentation/genindex.rst
@@ -0,0 +1,7 @@
.. include:: /Includes.rst.txt

=====
Index
=====

.. Sphinx will insert here the general index automatically.
23 changes: 6 additions & 17 deletions README.rst
@@ -1,19 +1,8 @@
============================================================
Contents of the docs.typo3.org homepage and the "glue"-pages
============================================================
==================
TYPO3 Cheat Sheets
==================

: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
<https://docs.typo3.org/typo3cms/drafts/github/TYPO3-Documentation/DocsTypo3Org-Homepage/>`__

:How to: `How to publish
<https://docs.typo3.org/typo3cms/RenderTYPO3DocumentationGuide/AtTheDocsServer/Administration/AboutTheHomepage/Index.html#manual-intervention-needed>`__

:Rendered: (manually) `drafts/github/TYPO3-Documentation/DocsTypo3Org-Homepage/0.0/
<https://docs.typo3.org/typo3cms/drafts/github/TYPO3-Documentation/DocsTypo3Org-Homepage/0.0/>`__
This is a collection of TYPO3 cheat sheets provided by the TYPO3 community.

:Repository: https://github.com/TYPO3-Documentation/TYPO3CMS-CheatSheets
:Read online: https://docs.typo3.org/m/typo3/docs-cheatsheets/7.6/en-us/

0 comments on commit 5d3540d

Please sign in to comment.