add explanation about Inventory Keys interlink#511
add explanation about Inventory Keys interlink#511franzholz wants to merge 1 commit intoTYPO3-Documentation:mainfrom
Conversation
The Internlink explanations are completely missing here.
| 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>` . |
There was a problem hiding this comment.
Where can I find this target? Ist this a target in current TYPO3 documentation?
There was a problem hiding this comment.
Google brings the answer:
https://docs.typo3.org/other/t3docs/render-guides/0.3/en-us/Developer/InterlinkInventories.html
| 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>` | ||
|
|
There was a problem hiding this comment.
Yes this is another example for a link to another documentation. I'm not sure whether this is necessary for better understanding. We have already an example for the news documentation.
The code example also matches the screenshot. I would say we don't need that second example. But maybe we need a second opinion here?
There was a problem hiding this comment.
I need it. I thought it might be useful to others as well.
| 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 |
There was a problem hiding this comment.
Is this really only visible on link is permalink?
There was a problem hiding this comment.
I have seen a lot of TYPO3 documentation where the chapters did not have the permalink icon.
There was a problem hiding this comment.
It appears in any case weather there is a permalink available or not.
| .. 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>` |
There was a problem hiding this comment.
We do not recommend using references but the links as you can copy them from the popover
There was a problem hiding this comment.
And what will you do if no popover is shown?
|
While I do agree that the chapter needs a make over this change introduces changes that are partly not correct and partly not recommended. |
3 participants
The Internlink explanations are completely missing here.