Bug #100935
open
Have a full description of (typolink) link format
0%
Description
Currently there is no full description of the link format as I am aware. It can only be derived from the source code and there are some discrepancies, e.g. see #100933
While this may be a documentation issue, it would be better if the link format was described somewhere in a formal language (which could also be used by the parser).
Also, I am not sure if this is already documented somewhere. Sometimes there are extensive descriptions in the source code.
TypoScript typolink Resource references contains a good description but appears incomplete (e.g. for page links, the language part is missing. (Also, the question is if the link description should exist somewhat hidden in the TypoScript reference).
Related docs¶
(incomplete) list of currently supported link format¶
Currently the core supports:
- t3://page?uid=\d+ (for page links)
- t3://page?uid=current (for page links)
- with #<someanchor> (for page links), anchor can be numeric which will link to the content element or a string
- with _language=<language uid> for linking to page in different language (formerly L=)
- t3://file?uid=\d+ (for links to files)
- etc.
Possibly outdated ?
- <link
- file:\d+
Updated by Sybille Peters 11 months ago
- Related to Bug #100934: Typolink soft reference parsers does not consider links to currrent page added
Updated by Oliver Hader 11 months ago
- Status changed from New to Needs Feedback
Sybille Peters wrote:
While this may be a documentation issue, it would be better if the link format was described somewhere in a formal language (which could also be used by the parser).
- so, is it about documentation or about changing the current implementation
- which parser are you referring to (and in relation to that, which type of "formal language", there are plenty)
- if it's just about documentation, I could imagine having some aBNF for the
t3://...scheme
Updated by Sybille Peters 11 months ago
If it's just about documentation, I can might be able to contribute.
The other options (e.g. for a schema or formal description) are probably quite a bit more complicated. I mentioned it in case someone sees a solution there or is working on it. I opened it here for visibility and reference as core issue.
I am fine if we convert it into a documentation only issue in which case I would probably close here and work in GitHub TYPO3-Documenation.
so, is it about documentation or about changing the current implementation
I would handle it as documentation issue unless someone jumps in with an alternative solution or is working on one.
which parser are you referring to (and in relation to that, which type of "formal language", there are plenty)
Originally, I opened this issue because I did not find a full definition / description besides the source code.
The implementation in the Typolink*SoftReferenceParsers does not consider page links with t3://page?uid=current. But this is what is written automatically by the RTE post processing if an empty href exists. So this is (as far as I could see) not really documented and inconsistently implemented, see #100934.
if it's just about documentation, I could imagine having some aBNF for the t3://... scheme
I am aware of EBNF, not aBNF. Will look into it. Thanks.