Making the Help system work for TechDraw command groups

Discussions about the wiki documentation of FreeCAD and its translation.
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Post Reply
User avatar
Roy_043
Veteran
Posts: 8450
Joined: Thu Dec 27, 2018 12:28 pm

Making the Help system work for TechDraw command groups

Post by Roy_043 »

The TechDraw Workbench has 16 command groups. They occur as dropdowns (or 'flyouts') in the toolbars. For the Help system (Std_WhatsThis) to work properly a Wiki page must exist for each group. To avoid having to create (and maintain and translate) these 16 pages, which would just contain a copied portion of the main TechDraw_Workbench page anyway, I have created them as 'redirects' instead. Each of the 16 redirect pages redirects to a span element on the TechDraw_Workbench page.

To test how this works:
  1. Make sure the Help addon is installed.
  2. If you are using Windows and FreeCAD V0.21 read this: https://forum.freecadweb.org/viewtopic.php?f=3&t=72381
  3. In the preferences (Preferences_Editor#Help) specify the https://wiki.freecad.org/ URL and leave the Language suffix blank.
  4. Call Std_WhatsThis.
  5. Click on a toolbar flyout.
  6. The Help should redirect you to the correct span element on the TechDraw_Workbench page.
As already explained, I think this is a solution that is more efficient. But if anyone has serious objections I can roll it back of course. If there are no objections I will create redirects for the other languages as well.
Attachments
TD_command_groups_redirects.png
TD_command_groups_redirects.png (47.29 KiB) Viewed 1498 times
User avatar
FBXL5
Posts: 980
Joined: Sat Aug 03, 2019 8:45 pm

Re: Making the Help system work for TechDraw command groups

Post by FBXL5 »

Seeing redirects and span elements in action I would say that I like it.

Go for it! 8-)

Edit: All icons I have tried redirected to the right section of the page.
david69
Veteran
Posts: 1774
Joined: Wed Jan 01, 2014 7:48 pm

Re: Making the Help system work for TechDraw command groups

Post by david69 »

it works too for me.

Code: Select all

OS: Ubuntu 22.04.1 LTS (LXQt/Lubuntu)
Word size of FreeCAD: 64-bit
Version: 0.21.30492 (Git) AppImage
Build type: Release
Branch: master
Hash: b4578fb3eae842eb510a1bc055d07d369a67ce94
Python 3.10.6, Qt 5.15.4, Coin 4.0.0, Vtk 9.1.0, OCC 7.6.3
Locale: French/France (fr_FR)
Installed mods: 
  * Help.backup1662889774.5125165 1.0.3
  * Help 1.0.3
david69
Veteran
Posts: 1774
Joined: Wed Jan 01, 2014 7:48 pm

Re: Making the Help system work for TechDraw command groups

Post by david69 »

just update the French wiki pages and in parallel I was looking for the translations on Crowdin to synchronize both translation. I can not find the new entrances like "Adjust stacking order of views". I think they are missing but they also can be stucked. @wandererfan do you have an idea?
User avatar
wandererfan
Veteran
Posts: 6268
Joined: Tue Nov 06, 2012 5:42 pm
Contact:

Re: Making the Help system work for TechDraw command groups

Post by wandererfan »

david69 wrote: Fri Oct 14, 2022 8:14 am @wandererfan do you have an idea?
I would guess that the translations for new functions have not be been extracted from the source code yet. I think @yorik runs the extract and load to Crowdin on request.
User avatar
yorik
Founder
Posts: 13640
Joined: Tue Feb 17, 2009 9:16 pm
Location: Brussels
Contact:

Re: Making the Help system work for TechDraw command groups

Post by yorik »

Doing it right now ;)
Post Reply