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

Discussions about the wiki documentation of FreeCAD and its translation.
User avatar
fosselius
Posts: 321
Joined: Sat Apr 23, 2016 10:03 am

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

Postby fosselius » Thu Nov 01, 2018 9:08 am

chrisb wrote:
Thu Nov 01, 2018 8:28 am
We have discussed that before and voted against it.
ok. is there a thread i can read? searching the forum for "wiki gif" was not productive ;)

Update:
Aha, from: https://www.freecadweb.org/wiki/WikiPages
"Avoid animated pictures (GIF) in the general Gui Command help pages. Animations and videos should be reserved for tutorials not intended to be used as offline PDF documentation."
and:
"Avoid larger resolutions, as they won't be very portable to other kinds of display or in the printed PDF documentation."

this looks strange to me: "Animations and videos should be reserved for tutorials not intended to be used as offline PDF documentation." Is the wiki intended to be used offline as a PDF document?

But how often is the wiki used in PDF or printed format? I would say that using a downloaded .html copy of the wiki is more useful.
To me, this feels like a big constrant/drawback for the majority/normal use case to please a special case/minority.

Also it should be possible to specify two media types, one that is shown when viewing the page, another when exporting/printing.
According to: https://en.wikipedia.org/wiki/Help:Printing there are a "noprint" class you can use to remove content from the printed format.
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 » Sat Nov 03, 2018 12:19 pm

Quick recap of this ticket (for full list see page 1)
  • Pages need to be moved by a person with the rights to do so.
  • Empty pages:
    B-spline Toolbar - This is still under heavy development.
    IMHO documentation (+translation) can wait until it gets more sophisticated. Though i wont stop anyone from doing it,
    Virtual Toolbar - I can't figure out what it does.
  • Other related work
    Some cleaning work, can only be done by a person with deleting rights.
  • (Ongoing?) Discussion about the name of Sketcher_CompConstrainRadDia:
    -A name has to be decided (IMHO: Sketcher_CompConstrainRadDia)
    -A patch has to be applied (patch for the name Sketcher_CompConstrainRadDia is available)
As I see it, here is nothing left for me to do.
renatorivo
Posts: 2074
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

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

Postby renatorivo » Sat Nov 03, 2018 2:00 pm

Before making movements, please check if these are correct, or if I have made some mistakes. Do we need other movements? Thanks.

- -from https://www.freecadweb.org/wiki/Sketcher_Point -to https://www.freecadweb.org/wiki/Sketcher_CreatePoint
- -from https://www.freecadweb.org/wiki/Sketcher_Line -to https://www.freecadweb.org/wiki/Sketcher_CreateLine
- -from https://www.freecadweb.org/wiki/Sketcher_Polyline -to https://www.freecadweb.org/wiki/Sketcher_CreatePolyline
- -from https://www.freecadweb.org/wiki/Sketcher_Rectangle -to https://www.freecadweb.org/wiki/Sketche ... eRectangle
- -from https://www.freecadweb.org/wiki/Sketcher_Slot -to https://www.freecadweb.org/wiki/Sketcher_CreateSlot
- -from https://www.freecadweb.org/wiki/Sketcher_Fillet -to https://www.freecadweb.org/wiki/Sketcher_CreateFillet
- -from https://www.freecadweb.org/wiki/Sketcher_Arc -to https://www.freecadweb.org/wiki/Sketcher_CreateArc
- -from https://www.freecadweb.org/wiki/Sketcher_Arc3Point -to https://www.freecadweb.org/wiki/Sketche ... e3PointArc
- -from https://www.freecadweb.org/wiki/Sketcher_Circle -to https://www.freecadweb.org/wiki/Sketcher_CreateCircle
- -from https://www.freecadweb.org/wiki/Sketcher_Circle3Point -to https://www.freecadweb.org/wiki/Sketche ... ointCircle
- -from https://www.freecadweb.org/wiki/Sketcher_Triangle -to https://www.freecadweb.org/wiki/Sketcher_CreateTriangle
- -from https://www.freecadweb.org/wiki/Sketcher_Square -to https://www.freecadweb.org/wiki/Sketcher_CreateSquare
- -from https://www.freecadweb.org/wiki/Sketcher_Pentagon -to https://www.freecadweb.org/wiki/Sketcher_CreatePentagon
- -from https://www.freecadweb.org/wiki/Sketcher_Hexagon -to https://www.freecadweb.org/wiki/Sketcher_CreateHexagon
- -from https://www.freecadweb.org/wiki/Sketcher_Heptagon -to https://www.freecadweb.org/wiki/Sketcher_CreateHeptagon
- -from https://www.freecadweb.org/wiki/Sketcher_Octagon -to https://www.freecadweb.org/wiki/Sketcher_CreateOctagon
chrisb
Posts: 15211
Joined: Tue Mar 17, 2015 9:14 am

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

Postby chrisb » Sat Nov 03, 2018 4:39 pm

Seems correct!
renatorivo
Posts: 2074
Joined: Tue Feb 21, 2012 8:07 pm
Location: Torino - Italy

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

Postby renatorivo » Sat Nov 03, 2018 5:25 pm

Thank you crisb. In order not to break all links, I will gradually update these pages.
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 » Sat Nov 03, 2018 8:50 pm

cool, since the moving is done now, that only leaves:
[*]B-spline Toolbar
[*]Virtual Toolbar
[*]Other related work

IMHO this state of the wiki is sufficient for 0.18 and i propose to close the ticket. I can sum up the work left to do for a new ticket with a lower priority and Target Version 0.19.
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 » Sat Nov 03, 2018 9:06 pm

fosselius wrote:
Thu Nov 01, 2018 9:08 am
chrisb wrote:
Thu Nov 01, 2018 8:28 am
We have discussed that before and voted against it.
ok. is there a thread i can read? searching the forum for "wiki gif" was not productive ;)
The key word is animated. Then it's very easy to find a recent topic with "animated gif", from the search bar besides the "New topic" button on top of the Wiki forum index. https://forum.freecadweb.org/viewforum.php?f=21

This search has this topic listed near the top of results: https://forum.freecadweb.org/viewtopic.php?f=21&t=22781
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 » Sat Nov 03, 2018 9:13 pm

qurn wrote:
Sat Nov 03, 2018 8:50 pm
cool, since the moving is done now, that only leaves:
[*]B-spline Toolbar
[*]Virtual Toolbar

IMHO this state of the wiki is sufficient for 0.18 and i propose to close the ticket.
The B-spline tools and virtual space tool were added during the v0.17 development cycle, v0.17 was released 7 months ago, and the documentation has still not been filled since. Now, we are nearing the end of the v0.18 development cycle. I would prefer that we leave the ticket open for a while, until such a time that we know for sure that they won't be done before the v0.18 release.

I will try to put these pages on my todo list. Even pages with minimal content would be preferable to no pages.
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 » Mon Nov 05, 2018 4:34 am

renatorivo wrote:
Sat Nov 03, 2018 2:00 pm
Before making movements, please check if these are correct, or if I have made some mistakes. Do we need other movements? Thanks.
Renato, why did you duplicate all these pages, rather than rename/move them?

We now have 2 separate pages for each of those tools... Or were you planning to delete the old ones?
Last edited by NormandC on Mon Nov 05, 2018 4:49 am, edited 1 time in total.