Skip to content

Commit

Permalink
[FEATURE] Improvements to start page (#330)
Browse files Browse the repository at this point in the history 
* [FEATURE] Improvements to start page

- Add link targets to start page and remove from main menu (as decided
  on Slack)
- remove "Previous key" (as decided on Slack)
- Remove some information from start page that is already displayed via
  the theme, e.g. in the footer, specifically: version, copyright, email
  etc.
- Add a link to the sitemap
- Update the texts (e.g. upon finding the bug, the preferred behaviour is
  NOT to send an email).

* Remove Link targets from menu

* Update Documentation/Index.rst

Co-authored-by: Mathias Brodala <mbrodala@pagemachine.de>

* Improve text style

Co-authored-by: Mathias Brodala <mbrodala@pagemachine.de>

* [BUGFIX] Use Edit on GitHub

* Use :guilabel: for Edit on GitHub

* Use "standard" Targets.rst

* Create genindex.rst

* Add 'genindex.rst' to menu

* Some text updates

* Reformat lines only, no content change

* Make sidebar more concise

Co-authored-by: Mathias Brodala <mbrodala@pagemachine.de>
Co-authored-by: Martin Bless <martin.bless@mbless.de>
  • Loading branch information
@sypets @mbrodala @marble
3 people committed Dec 23, 2020
1 parent 4336d69 commit 2475d36
Show file tree
Hide file tree
Showing 3 changed files with 47 additions and 66 deletions.
101 changes: 40 additions & 61 deletions Documentation/Index.rst
View file
@@ -1,102 +1,81 @@
.. include:: Includes.txt


.. _start:

=============
TCA Reference
=============

:Previous Key:
doc_core_tca

:Version:
|release|
A complete reference to the Table Configuration Array :php:`$GLOBALS['TCA']`.

:Language:
en

:Description:
Complete reference to the Table Configuration Array :php:`$GLOBALS['TCA']`.

:Keywords:
forAdmins, forDevelopers, forIntermediates

:Copyright:
2000-2017

:Author:
Documentation Team

:Email:
documentation@typo3.org
TYPO3 community (see :ref:`credits`)

:License:
Open Publication License available from `www.opencontent.org/openpub/
<http://www.opencontent.org/openpub/>`_
Open Publication License available from
http://www.opencontent.org/openpub/


.. sidebar:: Contributors:

:Rendered:
|today|
* :ref:`How to contribute to documentation <h2document:contribute>`
* :ref:`Link targets <Link-targets>`
* `t3tca` is usually used in cross-referencing.

The content of this document is related to TYPO3, a GNU/GPL CMS/Framework
available from `www.typo3.org <https://typo3.org/>`_
available from https://typo3.org/.


**Official documentation**

This document is included as part of the official TYPO3 documentation.
It has been approved by the TYPO3 Documentation Team following a peer-
review process. The reader should expect the information in this
document to be accurate - please report discrepancies to the
Documentation Team (documentation@typo3.org). Official documents are
kept up-to-date to the best of the Documentation Team's abilities.


**Core Manual**

This document is a Core Manual. Core Manuals address the built in
functionality of TYPO3 and are designed to provide the reader with in-
depth information. Each Core Manual addresses a particular process or
function and how it is implemented within the TYPO3 source code. These
may include information on available APIs, specific configuration
options, etc.
This document is a Core Manual. Core Manuals address the built in functionality
of TYPO3 and are designed to provide the reader with in- depth information.
Each Core Manual addresses a particular process or function and how it is
implemented within the TYPO3 source code. These may include information on
available APIs, specific configuration options, etc.

Core Manuals are written as reference manuals. The reader should rely
on the Table of Contents to identify what particular section will best
address the task at hand.
Core Manuals are written as reference manuals. The reader should rely on the
:ref:`sitemap` to identify what particular section will best address the task
at hand.


**Versions**

TCA properties change between major versions, this main array had significant refactorings
especially between core versions 6.2 to 7 LTS, and again between 7 LTS and 8 LTS. Use the version
selector of this documentation to select the documentation variant that fits.
TCA properties change between major versions, this main array had significant
refactorings especially between core versions 6.2 to 7 LTS, and again between 7
LTS and 8 LTS. Use the version selector of this documentation to select the
documentation variant that fits.


.. _credits:

**Credits**

The original reference to the TCA was written by Kasper Skårhøj. This
version has been updated by François Suter. Lots of core team members and
other contributors maintain this document over time, see
`github <https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-CoreApi>`__ for
an overview of recent contributors. A big "Thank You!" goes to every single one of them.
The original reference to the TCA was written by Kasper Skårhøj. Subsequent
versions have been updated by François Suter. Several Core Team members and
other contributors maintained this document over time, see the list of
`contributors on GitHub
<https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-TCA/graphs/contributors>`__.

A big "Thank You!" goes to every single one of them.

**Feedback**

For general questions about the documentation get in touch by writing
to `documentation@typo3.org <mailto:documentation@typo3.org>`_ .
**Contribution**

If you find a bug in this manual, please be so kind as to check the
`online version <https://docs.typo3.org/typo3cms/TCAReference/>`__.
Use the "Edit me on GitHub" button in the top right corner
and submit a pull request via GitHub. Alternatively you can just file an issue
using the `bug tracker <https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-TCA/issues>`__.
For general questions about the documentation get in touch with the
`Documentation Team <https://typo3.org/community/teams/documentation>`__.

Maintaining high quality documentation requires time and effort
and the TYPO3 Documentation Team always appreciates support.
If you want to support us, please join the `#typo3-documentation` channel
on `typo3.slack.com <https://typo3.slack.com/>`__ to get in contact. If you're not
using slack yet, trigger a `slack invite <https://forger.typo3.org/slack>`__.
If you find a bug in this manual, please do not be afraid to suggest a fix,
e.g. by using the :guilabel:`"Edit on GitHub"` button in the top right corner.
Alternatively you can `file an issue
<https://github.com/TYPO3-Documentation/TYPO3CMS-Reference-TCA/issues>`__.


.. toctree::
Expand All @@ -110,4 +89,4 @@ using slack yet, trigger a `slack invite <https://forger.typo3.org/slack>`__.
Palettes/Index
Types/Index
Sitemap
Targets

1 change: 1 addition & 0 deletions Documentation/Settings.cfg
View file
Expand Up @@ -53,6 +53,7 @@ use_opensearch = https://docs.typo3.org/m/typo3/reference-tca/master/en-us

; in this manual we actually use:

h2document = https://docs.typo3.org/m/typo3/docs-how-to-document/master/en-us/
t3core = https://docs.typo3.org/c/typo3/cms-core/master/en-us/
t3coreapi = https://docs.typo3.org/m/typo3/reference-coreapi/9.5/en-us/
t3l10n = https://docs.typo3.org/m/typo3/guide-frontendlocalization/9.5/en-us/
Expand Down
11 changes: 6 additions & 5 deletions Documentation/Targets.rst
View file
@@ -1,11 +1,12 @@
.. include:: Includes.txt
:orphan:

.. _targets-for-crossreferencing:
.. _labels-for-crossreferencing:
.. _Linktargets:
.. include:: /Includes.txt
.. index::
Link targets
see: Targets; Link targets
.. _Link-Targets:

Link Targets
============

.. ref-targets-list::

0 comments on commit 2475d36

Please sign in to comment.