uwestoehr wrote: ↑
Sat Nov 02, 2019 1:46 pm
Therefore I volunteer to update the Wiki pages but I don't know if and how pages should be renamed. I mean, from the user's perspective the Wiki should use the menu names, not internal programming code names.
The wiki pages should be named as the code shows in the sWhatsThis
https://github.com/FreeCAD/FreeCAD/blob ... d.cpp#L160
Code: Select all
sAppModule = "TechDraw";
sGroup = QT_TR_NOOP("TechDraw");
sMenuText = QT_TR_NOOP("Insert new Page using Template");
sToolTipText = QT_TR_NOOP("Insert new Page using Template");
sWhatsThis = "TechDraw_New_Pick";
sStatusTip = sToolTipText;
sPixmap = "actions/techdraw-new-pick";
Why? Because the Std_WhatsThis
tool uses this name to display the proper help page.
That is, click on the Std_WhatsThis
button, then click on a TechDraw Workbench
button. If the offline help files are installed, the documentation should open exactly in that page. The offline help files are generated from the wiki pages, so the names must match.
So, in my opinion, if you want to improve the names of the pages, you should propose a change in TechDraw's source code.
Being completely honest, I don't like the way wandererfan has named many of the tools in TechDraw. In my opinion, they should follow this convention, [Workbench]_[Tool], where [Tool] is a substantive that can be used as part of a sentence. This is done in the Draft Workbench
, for example: Draft_Line, Draft_Polygon, Draft_Rectangle, Draft_Array, etc. Then in a regular sentence you can say, "please create a Draft Rectangle", and it is evident which workbench and object is meant.
In TechDraw, the names are more about actions, so they cannot be used in a sentence very well: TechDraw_New_Pick, TechDraw_NewView, TechDraw_NewActiveView, TechDraw_NewSection, etc.
I think these would be better as TechDraw_Pick, TechDraw_View, TechDraw_ActiveView, TechDraw_Section, etc.
About redirections, yes, you can use redirections of pages, however, this only really works well for English language pages. You need to consider translated pages.
For example, the page [TechDraw_Insert_New_Page_Using_Template] could be redirected to [TechDraw_New_Pick]. However, once the translation of that page is produced, you would have [TechDraw_Insert_New_Page_Using_Template/de] redirected to [TechDraw_New_Pick/de], however, the first redirection is not done automatically. This causes a problem with existing page names and existing translations.
So, in general, redirections should be kept to a minimum, in general, only when there are old pages that have been migrated to a new page. Why should a redirection be kept? Even if that link name is no longer used in the wiki, there may be links to the old name in the forum, so somebody who reads old threads in the forum may still want to follow those links.
In the past, NormandC was the one who monitored the wiki closely. If you edited something that he didn't like, he would call you an idiot and would publicly rant about how dumb you were for not discussing your changes before in the forum. He was particularly aggressive if you dared affect the translations. Angry little Quebecois he was; do not mess with the French, man. Since NormandC decided to step away, the situation is less tense now. You can do more changes to the wiki, and not expect a bunch of insults.
Personally, I would like to see all wiki pages edited in the style of the Draft Workbench
. About a year ago, I basically re-wrote all pages from that workbench to more or less follow a standardized style. My intention was to continue with Arch and then TechDraw, since I was using those workbenches the most, and I felt the documentation was not very good. But due to time constraints, my constant clashes with Normand, and giving priority to other pages, I never quite followed through with my plan. I still would like to continue improving the pages, but now I'm also busy organizing the Draft code itself, so I haven't prioritized the documentation.