Skip to content

add explanation about Inventory Keys interlink #511

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
franzholz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add explanation about Inventory Keys interlink #511

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
13 changes: 12 additions & 1 deletion Documentation/Reference/ReStructuredText/Links/Documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You can link the following elements in any TYPO3 manual: Headlines,
:ref:`confvals <rest-confval>` and :ref:`phpdomain definitions <rest-phpdomain>`.
It is also possible to put an anchor almost anywhere and then link it.

When an element in a manual can be linked a link symbol will appear when you
When an element in a manual can be linked as permalink a link symbol will appear when you
hover it:

.. figure:: /_Images/link-headlines.png
Expand All @@ -26,6 +26,17 @@ appears:

Copy the reST reference

When a link to an element in a manual is required outside of permalinks, then an inventory key needs to be used.
See :ref:`Inventory Keys <t3renderguides:InterlinkRepositories>` .

reST code with interlink to a TYPO3 official manual:

.. code-block:: rst
:caption: Reference to the TYPO3 Explained manual's chapter "Settings and Configuration"

:ref:`Settings and Configuration of TYPO3 websites <t3coreapi/configuration-glossary>`


The reST code of the reference looks like this:

.. code-block:: rst
Expand Down