0003054: Sketcher - List of important but empty wiki pages that need contents

Discussions about the wiki documentation of FreeCAD and its translation.
User avatar
NormandC
Posts: 18534
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

0003054: Sketcher - List of important but empty wiki pages that need contents

Postby NormandC » Thu Oct 18, 2018 1:42 am

Coordination topic for issue #3054 because I think a tracker is a bad place to try to coordinate and communicate.

When working on this ticket and another one, I realized that many wiki pages currently don't have the proper name.
NormandC on the tracker wrote: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.

Std_WhatsThis on the wiki

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.

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.
qurn wrote: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
NormandC wrote:(...) 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.
qurn
Posts: 20
Joined: Wed Oct 10, 2018 4:49 pm

Re: 0003054: Sketcher - List of important but empty wiki pages that need contents

Postby qurn » Thu Oct 18, 2018 9:06 am

This would be the whole list of work to do for this ticket:

Geometrie Toolbar:
This sites have to be simply renamed:
(Replace Sketcher_ to Sketcher_Create)
Sketcher_Point
Sketcher_Line
Sketcher_Polyline
Sketcher_Rectangle
Sketcher_Slot
Sketcher_Fillet

Here is a Comp-Site to be created. The sub-sites just have to be renamed:
(Replace Sketcher_ to Sketcher_Create)

Sketcher_CompCreateArc
Sketcher_Arc
Sketcher_Arc3Point

Sketcher_CompCreateCircle
Sketcher_Circle
Sketcher_Circle3Point

Sketcher_CompCreateRegularPolygon
Sketcher_Triangle
Sketcher_Square
Sketcher_Pentagon
Sketcher_Hexagon
Sketcher_Heptagon
Sketcher_Octagon
Sketcher_CreateRegularPolygon [needs to be created]

Constraints Toolbar:
One missing Site and an Error in FreeCAD-code:
Press "Whats this?" on Radius Constraint tries to open Sketcher_CompCreateCircle.
Create refers to a geometry, not a constraint. It should be Sketcher_CompConstraintCircle (or ...Arc) Sketcher_CompConstrainRadDia and the site doesn't exist.
Patch is available on the tracker.

The comp-page is created:
Sketcher_CompConstrainRadDia
The site for Sketcher_ConstrainDiameter and a picture for ConstrainDiameter is missing on the wiki.
added picture and site for the diameter constraint.


Virtual Toolbar:
Sketcher_SwitchVirtualSpace to be created
SwitchVirtualSpace is now created.

Tools Toolbar:
Create a Comp site:
Sketcher_CompCopy is now created.

B-Spline Toolbar:
Sketcher_BSplineIncreaseDegree
Sketcher_ConvertToNURB

Sketcher_CompBSplineShowHideGeometryInformation
Sketcher_CompModifyKnotMultiplicity

Btw. what does Comp stand for?

Other related wiki-work:
(not needed to make the "Whats this?" button work)

see Command_Reference section C
There are a lot of pages stating with Constraint
These pages are empty and curently not used in FC
They should be moved to SketcherConstrain_
(replace "Constraint " with "Sketcher_Constrain")

Exeption:
Constraint_Tangent

This site is already at the right place: Sketcher_ConstrainTangent
The link Constraint_Tangent links to Sketcher_ConstrainTangent.

And the site has been copied to one wrong place: Sketcher_ConstraintTangent. This site should be deleted.
Last edited by qurn on Mon Feb 25, 2019 9:44 pm, edited 14 times in total.
qurn
Posts: 20
Joined: Wed Oct 10, 2018 4:49 pm

Re: 0003054: Sketcher - List of important but empty wiki pages that need contents

Postby qurn » Thu Oct 18, 2018 9:51 am

Here are 16 sites to be moved. This can only be done by wiki-administrators.
Maybe the moving job can be done with pywikibot.

https://www.freecadweb.org/wiki/WikiRobots
https://www.mediawiki.org/wiki/Special: ... vepages.py

Is there someone with expirience with Pywikibot?
I'd try something like:

Code: Select all

python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Point        -to https://www.freecadweb.org/wiki/Sketcher_CreatePoint
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Line         -to https://www.freecadweb.org/wiki/Sketcher_CreateLine
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Polyline     -to https://www.freecadweb.org/wiki/Sketcher_CreatePolyline
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Rectangle    -to https://www.freecadweb.org/wiki/Sketcher_CreateRectangle
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Slot         -to https://www.freecadweb.org/wiki/Sketcher_CreateSlot
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Fillet       -to https://www.freecadweb.org/wiki/Sketcher_CreateFillet 
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Arc          -to https://www.freecadweb.org/wiki/Sketcher_CreateArc
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Arc3Point    -to https://www.freecadweb.org/wiki/Sketcher_CreateArc3Point
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Circle       -to https://www.freecadweb.org/wiki/Sketcher_CreateCircle
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Circle3Point -to https://www.freecadweb.org/wiki/Sketcher_CreateCircle3Point  
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Triangle     -to https://www.freecadweb.org/wiki/Sketcher_CreateTriangle
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Square       -to https://www.freecadweb.org/wiki/Sketcher_CreateSquare
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Pentagon     -to https://www.freecadweb.org/wiki/Sketcher_CreatePentagon
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Hexagon      -to https://www.freecadweb.org/wiki/Sketcher_CreateHexagon
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Heptagon     -to https://www.freecadweb.org/wiki/Sketcher_CreateHeptagon
python movepages.py -from https://www.freecadweb.org/wiki/Sketcher_Octagon      -to https://www.freecadweb.org/wiki/Sketcher_CreateOctagon
User avatar
HarryGeier
Posts: 1079
Joined: Mon Jul 10, 2017 12:36 pm
Location: Hof Germany

Re: 0003054: Sketcher - List of important but empty wiki pages that need contents

Postby HarryGeier » Thu Oct 18, 2018 11:19 am

I am busy these days..but i will continue to help writing pages for sketcher..
Kaum macht man´s richtig , gehts´s
My Video Tutorials on Youtube: https://www.youtube.com/channel/UCoe3B ... p8Q/videos
My FreeCAD Stuff on Hidrive: https://my.hidrive.com/share/qr3l1yddy6#$/
User avatar
Kunda1
Posts: 4090
Joined: Thu Jan 05, 2017 9:03 pm

Re: 0003054: Sketcher - List of important but empty wiki pages that need contents

Postby Kunda1 » Thu Oct 18, 2018 12:30 pm

@qurn nice work
Good question, it would be nice to have a way to automate the wiki. I've asked for another extension to be added called MassEditRegex to make sweeping changes to pages. I think the devs are overwhelmed. We may need to do these things manually. But first folks like @NormandC or @chrisb should review your above post and give the green light and then maybe at some point we can give you higher wiki privileges?.
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
User avatar
DeepSOIC
Posts: 6523
Joined: Fri Aug 29, 2014 12:45 am
Location: Saint-Petersburg, Russia

Re: 0003054: Sketcher - List of important but empty wiki pages that need contents

Postby DeepSOIC » Thu Oct 18, 2018 1:09 pm

qurn wrote:
Thu Oct 18, 2018 9:06 am
Btw. what does Comp stand for?
Command names that end in "Comp" are drop-down commands (i.e. they don't do anything by themselves, they only provide the dropdown menu and remember last-used command as default).
qurn
Posts: 20
Joined: Wed Oct 10, 2018 4:49 pm

Re: 0003054: Sketcher - List of important but empty wiki pages that need contents

Postby qurn » Thu Oct 18, 2018 7:12 pm

I created Sketcher_CompCreateArc and updated my previous post.
Lets see if the links in it will work after we move the linked pages.
My question was what does Comp literally stand for?

Another little inconsistency i noticed:
CreateEllipseBy3Points has plural points, but Sketcher_Arc3Point and Sketcher_Circle3Point uses singular... doesn't bother me, just saying.
User avatar
NormandC
Posts: 18534
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: 0003054: Sketcher - List of important but empty wiki pages that need contents

Postby NormandC » Fri Oct 19, 2018 4:17 am

qurn wrote:
Thu Oct 18, 2018 7:12 pm
Another little inconsistency i noticed:
CreateEllipseBy3Points has plural points, but Sketcher_Arc3Point and Sketcher_Circle3Point uses singular... doesn't bother me, just saying.
That's in the source code, it's the name of the command, so I don't think it's going to be changed.

BTW the inconsistency deepens. Sketcher_Circle3Point should actually be named Sketcher_Create3PointCircle, not Sketcher_CreateCircle3Point, because that's the internal name of the command (and that of the WhatsThis call).
https://github.com/FreeCAD/FreeCAD/blob ... .cpp#L5275

As for Sketcher_Arc3Point, it should be named Sketcher_Create3PointArc, not Sketcher_CreateArc3Point.
https://github.com/FreeCAD/FreeCAD/blob ... .cpp#L1984

Will try to check the other page renames this weekend.
User avatar
NormandC
Posts: 18534
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: 0003054: Sketcher - List of important but empty wiki pages that need contents

Postby NormandC » Fri Oct 19, 2018 4:24 am

Kunda1 wrote:
Thu Oct 18, 2018 12:30 pm
I think the devs are overwhelmed.
It's simple, only two people have full administrator rights to install extensions on the wiki: yorik and kkremitzki. They seem to be overloaded with responsibilities...
User avatar
NormandC
Posts: 18534
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: 0003054: Sketcher - List of important but empty wiki pages that need contents

Postby NormandC » Fri Oct 19, 2018 4:26 am

qurn wrote:
Thu Oct 18, 2018 7:12 pm
My question was what does Comp literally stand for?
I have no clue either.

About this, I really wish that the "What's This?" button could work directly on the individual command icons under the drop-down, rather than open this "Comp" thing. I wonder if it's a Qt limitation. Sub-menus work, why not drop-down toolbar icons?
cron