I dont like to have names of components be shown at the userdocumentation. So I suggest changing the text for ImageLinks from the componentname to the aliasname. E.g. changing line 796/797 in UGUIHelpReader.pas from
This way you can change the way ImageLinks look by writing something like
~guiAlias ButtonXY MyCoolLinkName
~gui MyCoolLinkName MyCoolTopicName
This is a cool help Text.
Greets
Svelix
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
while you are right, that showing internal names to the end users may not be a good idea, I think it might also be confusing hovering above a label and reading something about "EditXYZ".
I guess the best solution would be to show the title of the topic the link points to. But this might cause problems when there are formattings in the title, to filter these out would be much easier to accomplish after the revamp of the generators, again.
Of course you are free to change the lines and compile it yourself, but I probably won't use that change. Until the revamp I will probably not change anything.
Best regards,
Gerold Veith
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hi,
I dont like to have names of components be shown at the userdocumentation. So I suggest changing the text for ImageLinks from the componentname to the aliasname. E.g. changing line 796/797 in UGUIHelpReader.pas from
Generator.AddImageLink(URI, False, False, Data.LoggedComponents[i].Position,
Data.LoggedComponents[i].Name);
to
Generator.AddImageLink(URI, False, False, Data.LoggedComponents[i].Position,
GUIHelpUnalias(Data.LoggedComponents[i].Name, Data));
This way you can change the way ImageLinks look by writing something like
~guiAlias ButtonXY MyCoolLinkName
~gui MyCoolLinkName MyCoolTopicName
This is a cool help Text.
Greets
Svelix
Hello,
while you are right, that showing internal names to the end users may not be a good idea, I think it might also be confusing hovering above a label and reading something about "EditXYZ".
I guess the best solution would be to show the title of the topic the link points to. But this might cause problems when there are formattings in the title, to filter these out would be much easier to accomplish after the revamp of the generators, again.
Of course you are free to change the lines and compile it yourself, but I probably won't use that change. Until the revamp I will probably not change anything.
Best regards,
Gerold Veith