Help for first steps within the wiki

Discussions about the wiki documentation of FreeCAD and its translation.
User avatar
r-frank
Posts: 2181
Joined: Thu Jan 24, 2013 6:26 pm
Location: Möckmühl, Germany
Contact:

Help for first steps within the wiki

Postby r-frank » Tue Apr 19, 2016 1:27 pm

Thanks for joining the wiki-editing-team.
Any and all help to improve the existing wiki of FreeCAD is greatly appreciated.

For first steps on editing the wiki you may:
  • read the WikiPages before starting to edit
  • browse this forum for help
  • post questions about the wiki here in this sub-Forum
cds4byu
Posts: 10
Joined: Fri Feb 23, 2018 8:40 pm

Re: Help for first steps within the wiki

Postby cds4byu » Sun Feb 25, 2018 10:38 am

I'm wanting to edit some structures on Wiki pages.

There is one command in the source that I don't understand:

<!--T:8-->

Is this syntax explained anywhere? I've searched the wiki and the forums, and I can't see it explained.

Thanks,

Carl
cds4byu
Posts: 10
Joined: Fri Feb 23, 2018 8:40 pm

Re: Help for first steps within the wiki

Postby cds4byu » Sun Feb 25, 2018 2:51 pm

I have now found that this is translation infrastructure that is automatically added. I should not modify these when I am updating the page. For more information, see https://www.mediawiki.org/wiki/Help:Ext ... on_example
qurn
Posts: 22
Joined: Wed Oct 10, 2018 4:49 pm

Re: Help for first steps within the wiki

Postby qurn » Tue Oct 16, 2018 1:08 pm

Hello, i want to make some changes for the wiki and start with the sketcher part.

Deletion:
- The Note Available since FreeCAD v0.15. i don't see any benefit for the user to know this information.

Inconsistency:
- The section Usage is sometimes named "Usage", "Use" or "How to use". The "Template" https://www.freecadweb.org/wiki/Draft_Line says How to use.

- Section hierarchy: Compare the sections of this two sites:
https://www.freecadweb.org/wiki/Draft_Line
https://freecadweb.org/wiki/Sketcher_Line
Which is preferred? The one used in Sketcher Line makes more sense to me.
If you look at the sections of draft line, section 1 is Draft Line, section 2 is Description. The topic "Draft line" doesn't ends at the beginning of section 2.
GeneFC
Posts: 1025
Joined: Sat Mar 19, 2016 3:36 pm
Location: Punta Gorda, FL

Re: Help for first steps within the wiki

Postby GeneFC » Tue Oct 16, 2018 2:28 pm

qurn wrote:
Tue Oct 16, 2018 1:08 pm
Deletion:
- The Note Available since FreeCAD v0.15. i don't see any benefit for the user to know this information.
This is quite valuable for those who spend a lot of time on the forum helping others. There are many, many cases where people using version 0.16, for example, try to apply functions or options that did not exist until later versions.
qurn wrote:
Tue Oct 16, 2018 1:08 pm
- Section hierarchy: Compare the sections of this two sites:
https://www.freecadweb.org/wiki/Draft_Line
https://freecadweb.org/wiki/Sketcher_Line
Which is preferred? The one used in Sketcher Line makes more sense to me.
If you look at the sections of draft line, section 1 is Draft Line, section 2 is Description. The topic "Draft line" doesn't ends at the beginning of section 2.
Sorry, this comment makes little sense. Both forms are perfectly readable.

Gene
User avatar
Kunda1
Posts: 5505
Joined: Thu Jan 05, 2017 9:03 pm

Re: Help for first steps within the wiki

Postby Kunda1 » Tue Oct 16, 2018 4:37 pm

qurn wrote:
Tue Oct 16, 2018 1:08 pm
Hello, i want to make some changes for the wiki and start with the sketcher part.
Hey @qurn
Thanks for your enthusiasm and willingness to help with the wiki!
I saw you post on issue #3054
It's great you're asking about these specific things and asking for orientation and permission. Any changes to the wiki need to be thought out really well due to the obvious fact that we want said changes to be:
1. accurate
2. reflect the consensus of the community
3. mindful because many pages on the wiki are translated and so any change we make, we need to think about the translators and the work we create for them. (This is a point that I've been learning about since sometimes admittedly get hasty and ahead of myself)
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
NormandC
Posts: 18534
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: Help for first steps within the wiki

Postby NormandC » Wed Oct 17, 2018 4:52 am

Hello qurn, welcome and thanks for your interest.

I replied to your PM and gave you wiki access.

qurn wrote:
Tue Oct 16, 2018 1:08 pm
Deletion:
- The Note Available since FreeCAD v0.15. i don't see any benefit for the user to know this information.
Please look at my topic Adding version to GuiCommand template?

qurn wrote:
Tue Oct 16, 2018 1:08 pm
Inconsistency:
- The section Usage is sometimes named "Usage", "Use" or "How to use". The "Template" https://www.freecadweb.org/wiki/Draft_Line says How to use.
I agree it should be "How to use". Unfortunately this change on a massive scale would invalidate a lot of translations on translated pages that have nonetheless a consistent naming scheme in their language. When I happen upon such pages I do change "Usage" or "Use" for "How to use", but I also immediately confirm the corresponding translations afterwards. This is very tedious, and requires admin rights.

qurn wrote:
Tue Oct 16, 2018 1:08 pm
- Section hierarchy: Compare the sections of this two sites:
https://www.freecadweb.org/wiki/Draft_Line
https://freecadweb.org/wiki/Sketcher_Line
Which is preferred? The one used in Sketcher Line makes more sense to me.
The TOC tree notwithstanding, I disagree. We should use H2 headers like in Sketcher_Line. Draft_Line has only H4 (level 4) headers. H1 is for the page title, after that it should be H2, then H3, etc. IMO clearly defined headers is better for the page layout than the minor inconvenience of seeing the page name on the same level as the sections in the infobox table of contents. I wrote so in a comment on a ticket not long ago, but couldn't find it back.

The real problem is that the page title should really not appear in the TOC... But I think we cannot avoid it, as the infobox is a template (an external page). Unless a MediaWiki wizard finds a way to hide it.
User avatar
NormandC
Posts: 18534
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: Help for first steps within the wiki

Postby NormandC » Wed Oct 17, 2018 4:56 am

GeneFC wrote:
Tue Oct 16, 2018 2:28 pm
Sorry, this comment makes little sense. Both forms are perfectly readable.
qurn talks about the table of contents (TOC) found in the infobox to the top right of the page, which is a template called "GuiCommand". The Draft_Line page shows it as flat with the page title on the same level as the sections, while Sketcher_Line shows the page title with the sections nested under it, which is indeed more logical.
GeneFC
Posts: 1025
Joined: Sat Mar 19, 2016 3:36 pm
Location: Punta Gorda, FL

Re: Help for first steps within the wiki

Postby GeneFC » Wed Oct 17, 2018 2:24 pm

OK, it was not clear to me that he was talking only about the TOC. :oops:

Gene
User avatar
NormandC
Posts: 18534
Joined: Sat Feb 06, 2010 9:52 pm
Location: Québec, Canada

Re: Help for first steps within the wiki

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

Well, I have a more complete knowledge about our wiki's peculiarities. Plus it was fresh on my mind as I had already mentioned in in a comment on the tracker, which I was finally able to hunt down.

https://www.freecadweb.org/tracker/view ... 625#c12009