01553: Reference to PmWiki variables.
Description:
When a PmWiki variable, e.g. $EnableGUIButtonsPmWiki/EditVariables#EnableGUIButtons.
I suggest that it instead is linked to the PmWiki version of the documentation https://www.pmwiki.org/wiki/PmWiki/EditVariables#EnableGUIButtons or PmWiki:EditVariables#EnableGUIButtons
rather than the local version of the documentation (if it exists).
See this page for example.
The latest version of the documentation may be different from the locally installed version, and there may be differences in the functionality and configuration. --Petko
True, but rarely. To me it's unexpected, e.g. Cookbook and Extension references take me to PmWiki. Also search engines may pick up a user site, rather than PmWiki as the reference site.
How is the Variables documentation different from the rest of the documentation? Do you also advocate for removing all documentation from the distribution and telling people to just use PmWiki.org?
What if PmWiki.org is down or unreachable, it already happened, and also I know of people using PmWiki on Antarctica.
To me a big problem would be someone reading the documentation and trying to enable features that do not exist in their installation.
There are already links at the bottom of the pages in the PmWiki group to here, so people who want to visit it can do it easily.
We could add a configuration option to enable the online links, but I fear we will have to support people who are lost. --Petko
I think the idea of adding an option so that optionally references to all variables, e.g. $HTMLStylesFmt
I try to hide (e.g. exclude from search), rather than delete (probably because I am too lazy to remove then from every update), the groups PmWiki and Mainso that users do not get confused as to why the website (say about tramping) has all this other stuff in it (do other CMS deploy with all their documentation?).