FreeCADView Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0003054 | Sketcher | Feature | public | 2017-05-27 19:53 | 2021-03-27 10:09 |
| Reporter | Kunda1 | Assigned To | |||
| Priority | high | Severity | major | Reproducibility | N/A |
| Status | closed | Resolution | fixed | ||
| Target Version | 0.20 | ||||
| Summary | 0003054: Sketcher - List of important but empty wiki pages that need contents | ||||
| Description | This is just to keep track. Feel free to work on any of these! | ||||
| Additional Information | Forum discussion: https://forum.freecadweb.org/viewtopic.php?f=21&t=31631 http://freecadweb.org/wiki/Sketcher_ConicSections | ||||
| Tags | #lowhangingfruit, documentation, wiki | ||||
| FreeCAD Information | |||||
|
|
This is just a note to notify of any updates - as time allows I will see if I can offer any help here. |
|
|
@bejant do you have any availability to still do this? |
|
|
I expect to be able to start in a few days. Thanks for the reminder! |
|
|
I believe there is a mistake on this issue -- it references Sketcher_Arch3Point. But I believe the correct name for the command is Sketcher_CreateArc3Point. I followed the link given in the issue and ended up creating a page, but found that Sketcher_Arch3Point is not a valid command (at least the GUI template wont work with it). Now I believe that the page I created should be deleted. I don't know how to delete the page. To whom should I report this? |
|
|
@cds4byu link please |
|
|
Removed http://freecadweb.org/wiki/Constraint_PointOnObject since NormandC renamed this to https://freecadweb.org/wiki/Sketcher_ConstrainPointOnObject and the page is complete |
|
|
I had a little look on this and the liked pages. cbs4byu mentioned this one: This site is empty and has a typo https://freecadweb.org/wiki/Sketcher_Arch3Point Arch should be Arc, not to confuse with the workbench. The site https://www.freecadweb.org/wiki/Sketcher_Arc3Point covers the basics. The other linked sites can be differed between emty pages and a basic coverage. Empty: https://freecadweb.org/wiki/Sketcher_ConicSections https://freecadweb.org/wiki/Sketcher_Ellipse_by_3_Points Basic coverage: https://freecadweb.org/wiki/Sketcher_Circle3Point https://freecadweb.org/wiki/Sketcher_MergeSketch https://freecadweb.org/wiki/Sketcher_CloseShape https://freecadweb.org/wiki/Sketcher_ConnectLines https://freecadweb.org/wiki/Sketcher_SelectConstraints https://freecadweb.org/wiki/Sketcher_SelectOrigin https://freecadweb.org/wiki/Sketcher_SelectVerticalAxis https://freecadweb.org/wiki/Sketcher_SelectHorizontalAxis https://freecadweb.org/wiki/Sketcher_SelectRedundantConstraints https://freecadweb.org/wiki/Sketcher_SelectConflictingConstraints https://freecadweb.org/wiki/Sketcher_SelectElementsAssociatedWithConstraints The main missing component is the scripting part. |
|
|
I just now noticed that ticket. What should decide the name of a page is the "What's This?" button in FreeCAD, which is supposed to open the offline Help at the page for the command. https://www.freecadweb.org/wiki/Std_WhatsThis The offline Help file is generated from the wiki. For many commands the help file opens with a "Page not found" error either because the page does not exist, or it is not correctly named in the wiki. In the past few weeks I've been renaming a lot of command pages in the wiki; the plan is for next 0.18 release to eliminate the "page not found" issues with the "What's This?" button. This is a duplicate of Sketcher_Arc3Point, I just deleted it. Sketcher_ConicSections is the wrong name, the real page name is Sketcher_CompCreateConic and is completed. Sketcher_Ellipse_by_3_Points was renamed by me 10 days ago to Sketcher_CreateEllipseBy3Points. A majority of users use the Sketcher as it is mainly meant to be used, from the GUI. It is fine if somebody decides to augment these pages with the scripting part, but they should not be considered incomplete if they don't include it. |
|
|
With fresh git pull from today, i still get a Error loading: qthelp://org.freecad.usermanual/doc/Sketcher_CompCreateConic.html for CompCreateConic, though your link works fine. Maybe the "html", or is the offline Help not generated on my machine? I checked the wiki "Command Reference" and went through the geometry part of the sketcher toolbars. Sketcher Geometrie Toolbar Name should be - current name in the wiki ----------------------------------------------- Sketcher_CreatePoint https://freecadweb.org/wiki/Sketcher_Point Sketcher_CreateLine https://freecadweb.org/wiki/Sketcher_Line Sketcher_CreatePolyline https://freecadweb.org/wiki/Sketcher_Polyline Sketcher_CreateRectangle https://freecadweb.org/wiki/Sketcher_Rectangle Sketcher_CreateSlot https://freecadweb.org/wiki/Sketcher_Slot Sketcher_CreateFillet https://freecadweb.org/wiki/Sketcher_Fillet Comp-Pages to be created and linked with the sub-topics Name should be - current name in the wiki ----------------------------------------------- Sketcher_CompCreateArc no Comp-page, just https://freecadweb.org/wiki/Sketcher_Arc , https://freecadweb.org/wiki/Sketcher_Arc3Point Sketcher_CompCreateCircle no Comp-page, just https://freecadweb.org/wiki/Sketcher_Circle , https://freecadweb.org/wiki/Sketcher_Circle3Point Sketcher_CompCreateRegularPolygon no Comp-page, just https://freecadweb.org/wiki/Sketcher_Triangle , https://freecadweb.org/wiki/Sketcher_Square , https://freecadweb.org/wiki/Sketcher_Pentagon , https://freecadweb.org/wiki/Sketcher_Hexagon , https://freecadweb.org/wiki/Sketcher_Heptagon , https://freecadweb.org/wiki/Sketcher_Octagon , (no regular polygon) Sketcher_CompCreateBSpline no Comp-page, no other pages Sites to create new ----------------------------------------------- Sketcher_Extend Sketcher_CarbonCopy Is this correct? |
|
|
To answer to your first question, as I already wrote, the help file installed with FreeCAD is generated from the wiki, but once it's made it's *static*. Fixing the wiki will not magically fix the help file that is already packaged. It will need to be rebuilt by the FreeCAD developers, and because it is a massive job they only do that once for every new release. So as I wrote, this will not get fixed until the v0.18 release. As for the rest you seem to be correct about page naming. It is even worse: all Sketcher geometries pages should be named "Sketcher_CreateXXX": Sketcher_CreateArc, Sketcher_CreateArc3Point, Sketcher_CreateCircle, etc. We have more pages to rename than I thought. |
|
|
All these comments are buried under a tracker report. I think this discussion needs to be taken out of here and on the wiki where it will have a larger audience and be much easier to follow. https://forum.freecadweb.org/viewtopic.php?f=21&t=31631 |
|
|
Here a patch for this Error: Press "Whats this?" on Radius Constraint tries to open Sketcher_CompCreateCircle. Create refers to a geometry, not a constraint. It should be Sketcher_CompConstrainRadDia. geometry_constraint_typo.patch (710 bytes)
diff --git a/src/Mod/Sketcher/Gui/CommandConstraints.cpp b/src/Mod/Sketcher/Gui/CommandConstraints.cpp
index 5b85d231c..8b137b1ac 100644
--- a/src/Mod/Sketcher/Gui/CommandConstraints.cpp
+++ b/src/Mod/Sketcher/Gui/CommandConstraints.cpp
@@ -5916,7 +5916,7 @@ CmdSketcherCompConstrainRadDia::CmdSketcherCompConstrainRadDia()
sGroup = QT_TR_NOOP("Sketcher");
sMenuText = QT_TR_NOOP("Constrain arc or circle");
sToolTipText = QT_TR_NOOP("Constrain an arc or a circle");
- sWhatsThis = "Sketcher_CompCreateCircle";
+ sWhatsThis = "Sketcher_CompConstrainRadDia";
sStatusTip = sToolTipText;
sAccel = "SHIFT+R";
eType = ForEdit;
|
|
|
Sketcher_MergeSketch should be renamed to Sketcher_MergeSketches. |
|
|
Closing ticket as these pages are either complete or semi-complete (missing images or some sections). Addressing those issues elsewhere. |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2017-05-27 19:53 | Kunda1 | New Issue | |
| 2017-05-27 19:53 | Kunda1 | Issue generated from: 0002017 | |
| 2017-05-27 19:53 | Kunda1 | Relationship added | child of 0002017 |
| 2017-05-27 19:53 | Kunda1 | Tag Attached: documentation | |
| 2017-05-27 19:53 | Kunda1 | Tag Attached: wiki | |
| 2017-05-27 19:53 | Kunda1 | Project | FreeCAD => Sketcher |
| 2017-08-28 20:21 | Kunda1 | Tag Attached: #lowhangingfruit | |
| 2017-08-28 20:21 | Kunda1 | Tag Attached: #post-to-forum | |
| 2017-09-29 03:30 | bejant | Note Added: 0010209 | |
| 2018-01-26 21:33 | Kunda1 | Target Version | => 0.17 |
| 2018-01-26 21:33 | Kunda1 | Note Added: 0010870 | |
| 2018-01-27 14:48 | bejant | Note Added: 0010875 | |
| 2018-03-05 12:18 | cds4byu | Note Added: 0011015 | |
| 2018-06-07 19:17 | Kunda1 | Target Version | 0.17 => 0.18 |
| 2018-06-07 21:00 | Kunda1 | Note Added: 0011364 | |
| 2018-10-10 17:59 | Kunda1 | Relationship added | child of 0003625 |
| 2018-10-10 18:16 | Kunda1 | Relationship replaced | related to 0002017 |
| 2018-10-10 18:21 | Kunda1 | Additional Information Updated | |
| 2018-10-10 18:21 | Kunda1 | Note Added: 0011996 | |
| 2018-10-10 18:22 | Kunda1 | Description Updated | |
| 2018-10-16 11:37 | qurn | Note Added: 0012038 | |
| 2018-10-17 04:30 | normandc | Note Added: 0012044 | |
| 2018-10-17 20:12 | Kunda1 | Relationship added | parent of 0003641 |
| 2018-10-17 20:13 | Kunda1 | Relationship deleted | parent of 0003641 |
| 2018-10-17 20:29 | qurn | Note Added: 0012051 | |
| 2018-10-18 01:38 | normandc | Note Added: 0012061 | |
| 2018-10-18 01:43 | normandc | Note Added: 0012062 | |
| 2018-10-18 01:44 | normandc | Additional Information Updated | |
| 2018-10-24 08:42 | qurn | File Added: geometry_constraint_typo.patch | |
| 2018-10-24 08:42 | qurn | Note Added: 0012087 | |
| 2018-11-01 03:16 | normandc | Note Added: 0012121 | |
| 2020-06-06 14:18 | abdullah | Target Version | 0.18 => 0.19 |
| 2020-11-09 18:09 | abdullah | Target Version | 0.19 => 0.20 |
| 2021-02-06 06:32 | abdullah | Target Version | => 0.20 |
| 2021-03-27 10:00 | Kunda1 | Additional Information Updated | |
| 2021-03-27 10:01 | Kunda1 | Additional Information Updated | |
| 2021-03-27 10:02 | Kunda1 | Additional Information Updated | |
| 2021-03-27 10:03 | Kunda1 | Additional Information Updated | |
| 2021-03-27 10:05 | Kunda1 | Additional Information Updated | |
| 2021-03-27 10:08 | Kunda1 | Status | new => closed |
| 2021-03-27 10:08 | Kunda1 | Resolution | open => fixed |
| 2021-03-27 10:08 | Kunda1 | Note Added: 0015549 | |
| 2021-03-27 10:09 | Kunda1 | Tag Detached: #post-to-forum |
