Skip to content

[DOCS] Add info about route enhancers to the "Further readings" section #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kanow wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −0
Open

[DOCS] Add info about route enhancers to the "Further readings" section #410

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions Documentation/NextSteps/Index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,27 @@ Videos on YouTube

TYPO3 has an `official YouTube channel <https://www.youtube.com/channel/UCwpl8LY9Tr3PB26Kk2FYW_w>`__.

.. _using-route-enhancers:

Using Route Enhancers
---------------------

TYPO3 offers a simple way to create attractive, readable URLs for pages.
If you want readable URLs for records from extensions, a small extra manual
work is required. Then you need the `Routing Enhancers <https://docs.typo3.org/permalink/t3coreapi:routing-advanced-routing-configuration-enhancers>`_.

Most of the time the thing you need is a `Extbase plugin enhancer <https://docs.typo3.org/permalink/t3coreapi:routing-extbase-plugin-enhancer>`_.
Copy link
Copy Markdown
Member

@linawolf linawolf Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As we are not working with Extbase here why should they need an Extbase plugin enhancer? That would only make sense if they use such extensions

Copy link
Copy Markdown
Contributor Author

@kanow kanow Apr 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@linawolf Yes, you are right. We discussed yesterday only whether it makes sense to add such information and where.
I’m wondering again why it is necessary and useful to describe how to use the Route Enhancer in this tutorial. We don't know

  • Do users following this tutorial to create a site package really need the Route Enhancer guide?
  • Which guide for Route Enhancers they need? Simple? Plugin? Extbase?

If we answering the firs question with yes, then maybe just the first part of the text is sufficient?

If you follow the link, you see an example routing configuration for the
`News <https://docs.typo3.org/permalink/georgringer-news:start>`_ Extension.

.. note::
By default the routing configuration must be set in the Site Config of your
TYPO3 installation. But it's also possible to `use it with imports <https://docs.typo3.org/permalink/t3coreapi:routing-examples-imports>`_
to get the routing configuration directly from your Site Package.
Put your routing configuration into: `my_site_package/Configuration/Routes`
and use the :yaml:`import` command.


.. _next-steps-questions:

Where to ask questions
Expand Down