Skip to content

Commit

Permalink
[DOCS] Switch fluid_styled_content documentation to PHP-based rendering
Browse files Browse the repository at this point in the history
* Introduce a guides.xml, the presence of this file
  triggers the new rendering.
* Remove superfluous genindex, it is not supported anymore
* Remove old Settings.cfg, was only used for Sphinx
* Fix references
* Remove screenshots.json as the screenshot tool
  is not maintained anymore

Attention: Backports need manual changes to the guides.xml.

Resolves: #103301
Releases: main, 12.4, 11.5
Change-Id: I6d912175b59b3bbfc833931a8cbf41dc19fceecf
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83282
Reviewed-by: Lina Wolf <112@linawolf.de>
Tested-by: Lina Wolf <112@linawolf.de>
  • Loading branch information
linawolf committed Mar 7, 2024
1 parent 89ceafd commit af8a48c
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 507 deletions.
35 changes: 1 addition & 34 deletions typo3/sysext/fluid_styled_content/Documentation/Includes.rst.txt
@@ -1,34 +1 @@
.. 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
.. You can put central messages to display on all pages here
3 changes: 2 additions & 1 deletion typo3/sysext/fluid_styled_content/Documentation/Index.rst
@@ -1,5 +1,7 @@
.. include:: /Includes.rst.txt

.. _start:

=====================================
TYPO3 Content Elements based on Fluid
=====================================
Expand Down Expand Up @@ -51,4 +53,3 @@ This extension provides Fluid templating for TYPO3 content elements.
:hidden:

Sitemap
genindex
Expand Up @@ -71,7 +71,7 @@ Upgrade

If you upgrade your TYPO3 CMS installation from one major version to another
(for example 10.4 to 11.5), it is advised to run the
:ref:`Upgrade Wizard <t3upgrade:postupgradetasks>`.
:ref:`Upgrade Wizard <t3install:postupgradetasks>`.
It guides you through the necessary steps to upgrade your database records.

Open the tool at :guilabel:`Admin Tools > Upgrade > Upgrade Wizard` and run all
Expand Down
66 changes: 0 additions & 66 deletions typo3/sysext/fluid_styled_content/Documentation/Settings.cfg

This file was deleted.

7 changes: 0 additions & 7 deletions typo3/sysext/fluid_styled_content/Documentation/genindex.rst

This file was deleted.

20 changes: 20 additions & 0 deletions typo3/sysext/fluid_styled_content/Documentation/guides.xml
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<guides xmlns="https://www.phpdoc.org/guides" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="https://www.phpdoc.org/guides ../vendor/phpdocumentor/guides-cli/resources/schema/guides.xsd"
links-are-relative="true">
<extension class="\T3Docs\Typo3DocsTheme\DependencyInjection\Typo3DocsThemeExtension"
project-home="https://extensions.typo3.org/extension/fluid_styled_content/"
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"
edit-on-github-branch="12.4"
edit-on-github="typo3/typo3"
typo3-core-preferred="12.4"
interlink-shortcode="typo3/cms-fluid-styled-content"
/>
<project title="Fluid Styled Content"
release="12.4"
version="12.4"
copyright="since 2015 by the TYPO3 contributors"
/>
</guides>

0 comments on commit af8a48c

Please sign in to comment.