Bug #100832
closed
Module "Page TSconfig" -> Active page TSconfig -- Shows comments
Added by Christian Hackl over 1 year ago.
Updated over 1 year ago.
Description
I have a sitepackage which includes Page TsConfig via Configuration/TCA/Overrides/page.php
If i have a comment just befor the beginning "TCEFORM..." then this comment shows up at BE module "Page TSconfig" -> Active page TSconfig.
Example:
...some other code
### my comment
TCEFORM { ...
Than "### my comment" shows up. If i put a empty line between my comment and the "TCEFORM..." than the comment dosen't show up.
Example:
... some other code
### my comment
TCEFORM { ...
Files
- Status changed from New to Needs Feedback
Yes.
That's essentially how it works: When a comment is directly before some "code" line, the comment is attached to the code line. When there is a "gap" like an empty line, it is not assigned to the code line.
This limitation is related to the "magic in comment" for the constants editor and the similar ext_conf_template.txt magic. We may be able to get rid of this limitation at some point, but it requires us to get rid of this ugly "define input fields via comments" foo for constants editor and extension configuration editor first.
Is this limitation a huge issue for you? I think that's only view related, it should be ok for integrators to deal with this?
- Related to Bug #100831: Module "Page TSconfig" -> Active page TSconfig -- Shows comments added
Christian Kuhn
Is this limitation a huge issue for you? I think that's only view related, it should be ok for integrators to deal with this?
no just not very nice, because the overview is somewhat lost in this module... :)
- Status changed from Needs Feedback to Rejected
Hey.
I hope it's ok to close here: The v12 comment parser and it's current rendering is the best i could come up with and nobody came up with something better until now, not even an idea on how it could be improved.
The comment display can of course be toggled off when an integrator is annoyed by the noisiness: Both pageTsConfig and TypoScript modules have a toggle for this.
To improve single comments rendering, just place them before a deeper element. When you have something like this:
# ext:foo changes some rowDescription detail
TCEFORM {
pages {
rowDescription {
...
}
}
}
Then change this to:
TCEFORM {
pages {
# ext:foo changes some rowDescription detail
rowDescription {
...
}
}
}
This will locate the comment better when rendering them in the backend modules. We did a similar thing in ext:bootstrap_package already, and this improved things a lot.
Also available in: Atom
PDF