TYPO3-Documentation / T3DocTeam

This repository is for the Documentation Team. To contribute, please see CONTRIBUTING.md For help and support on TYPO3, please see: https://typo3.org/help/
3 stars 1 forks source link

TYPO3: Unify Index.rst of TYPO3 Core documentation #168

Closed alexander-nitsche closed 2 years ago

alexander-nitsche commented 2 years ago

Having a look at the Index.rst of the TYPO3 system extensions there are some variants out there and i would like to find the one Index.rst which should be used and apply that to all extensions.

Let's take the rather new typo3/sysext/adminpanel/Documentation/Index.rst as starting point:

.. every .rst file should include Includes.txt
.. use correct path!

.. include:: Includes.txt

.. Every manual should have a start label for cross-referencing to
.. start page. Do not remove this!

.. _start:

===========
Admin Panel
===========

:Extension key:
   adminpanel

:Version:
   |release|

:Language:
   en

:Description:
   Manual for the TYPO3 Admin Panel.

:Keywords:
   admin panel, frontend, debug

:Copyright:
   2021

:Authors:
   Felicity Brand

:License:
   This extension documentation is published under the `CC BY-NC-SA 4.0 <https://creativecommons.org/licenses/by-nc-sa/4.0/>`__ (Creative Commons) license.

:Rendered:
   |today|

**TYPO3**

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

**For Contributors**

You are welcome to help improve this guide.
Just click on "Edit me on GitHub" on the top right to submit your change
request.

.. toctree::
   :maxdepth: 3

   Introduction/Index
   Installation/Index
   Configuration/Index
   Inspecting/Index
   Settings/Index
   Extending/Index
   Changelog/Index
   Sitemap

Regarding the Index.rst i have some questions:

(1) the :Author: is named "TYPO3 CMS Core Development Team" instead of "TYPO3 Core Team": should it be named the same? (2) can :Description: , :Copyright: , :Author: be handed over from the Settings.cfg? I tried with |description| , |copyright| , |t3author| and |author| but nothing worked (3) in https://github.com/TYPO3-Documentation/TYPO3CMS-Example-ExtensionManual/blob/master/Documentation/Index.rst the description is placed below the parameters, whereas in the TYPO3 Core it is placed in the parameters as :Description:

alexander-nitsche commented 2 years ago

@susannemoog :

(1) I would go for TYPO3 Core Team and TYPO3 Documentation Team as you proposed earlier. (2) I don't know, I guess @marble should know (3) that results in different looks for that page I guess. As the description is the first real part of the content (and the most important one on that page) I'd argue that it should not be part of the parameters/list but added separately.

alexander-nitsche commented 2 years ago

@susannemoog : On the Index.rst: I would probably remove the "default" texts altogether, as they don't add much value (or move them to an "About this manual" page) and hinder fast information retrieval for readers.

alexander-nitsche commented 2 years ago

This issue is done with the publication of the new page File structure that contains the new standard regarding the Index.rst for official TYPO3 manuals and TYPO3 extension documentation.