Help for first steps within the wiki

Discussions about the wiki documentation of FreeCAD and its translation.
catman
Posts: 300
Joined: Fri Jan 11, 2019 10:42 pm

Re: Help for first steps within the wiki

Post by catman »

cds4byu wrote: Sun Feb 25, 2018 10:38 am 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.

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
I had the same problem, but I was not aware other have it as well. I think that information should go to the wiki. The best place I figured was the
WikiPages:Before Starting


I added a section on what I understood. Please review the text (https://www.freecadweb.org/wiki/WikiPag ... e_Starting) and tell me what is wrong, so I can correct it.

I find the page title unfortunate, because "WikiPages" does not tell what the page is about, it too general. Better would be "Editing Guidlines" or ""Wiki Editing". However, since the page is hard to find anyway I would suggest to put a link with that name to that page into the sidebar just below "Tutorials". I believe one needs admin rights to do that.
gianfrancodp
Posts: 1
Joined: Tue Mar 24, 2020 6:05 am

Re: Help for first steps within the wiki

Post by gianfrancodp »

I'm wanting to fix some errors in this page:
https://wiki.freecadweb.org/Import/Expo ... cOpenShell

For example at step 4 the correct command is

Code: Select all

import sys
print (sys.paht)
I'm a new user, I can suggest to someone else these editing?
Thank you.
User avatar
PrzemoF
Veteran
Posts: 3389
Joined: Fri Jul 25, 2014 4:52 pm
Contact:

Re: Help for first steps within the wiki

Post by PrzemoF »

gianfrancodp wrote: Tue Mar 24, 2020 6:16 am I'm wanting to fix some errors in this page:
https://wiki.freecadweb.org/Import/Expo ... cOpenShell

For example at step 4 the correct command is

Code: Select all

import sys
print (sys.paht)
I'm a new user, I can suggest to someone else these editing?
Thank you.
Welcome to the forum! Take a look here: https://forum.freecadweb.org/viewtopic.php?f=21&t=6830
User avatar
Baritone
Posts: 32
Joined: Fri Jul 29, 2016 4:06 pm
Location: Москва

Re: Help for first steps within the wiki

Post by Baritone »

NormandC wrote: Wed Oct 17, 2018 4:52 am
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.
I am a translator. Please, do not change "Usage" or "Use" for "How to use". "Usage" is becoming a new standard in fact on all updated pages. Let everything remain as it is.
User avatar
Cekuhnen
Posts: 443
Joined: Sat Jul 10, 2021 11:37 pm

Re: Help for first steps within the wiki

Post by Cekuhnen »

hi all

sorry for asking - new to the wiki here

I would like to enhance few pages to make the workflow and limitations more clear to new users

example:

https://wiki.freecadweb.org/PartDesign_Fillet
add
limitations:
cannot do full round
show photos of errors
show photos of what works
show image of possible work around
there is some language present but it is so convoluted i even as a pro overlooked it

https://wiki.freecadweb.org/PartDesign_Plane
add
how to add datum tools to part design via adding macros to toolbar like for part design wb
this will be super useful and it is not clear to new users


https://wiki.freecadweb.org/Sketcher_Workbench
add
how to add sketch tools to part design via adding macros to toolbar like for part design wb
this will be super useful and it is not clear to new users



shall i just start the edit and submit or better have a discussion before?
Last edited by Cekuhnen on Mon Jul 26, 2021 3:55 pm, edited 1 time in total.
MacOS Big Sur / Win 10

Designer | Faculty
Wayne State University
Interior - Industrial Design
User avatar
Kunda1
Veteran
Posts: 12694
Joined: Thu Jan 05, 2017 9:03 pm

Re: Help for first steps within the wiki

Post by Kunda1 »

Cekuhnen wrote: Mon Jul 26, 2021 2:20 pm shall i just start the edit and submit or better have a discussion before?
go for it!
Alone you go faster. Together we go farther
Please mark thread [Solved]
Want to contribute back to FC? Checkout:
#lowhangingfruit | Use the Source, Luke. | How to Help FreeCAD | How to report FC bugs and features
chrisb
Veteran
Posts: 43495
Joined: Tue Mar 17, 2015 9:14 am

Re: Help for first steps within the wiki

Post by chrisb »

Cekuhnen wrote: Mon Jul 26, 2021 2:20 pm https://wiki.freecadweb.org/PartDesign_Fillet
https://wiki.freecadweb.org/PartDesign_Plane
https://wiki.freecadweb.org/Sketcher_Workbench
add
how to add datum tools to part design via adding macros to toolbar like for part design wb
The first two: yes, go for it. The third: rather no, Then it should be added to all other workbenches such as Part, Draft too, but that seems far too special to me. The documentation is not a tutorial, where a certain concrete problem is handled.
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
User avatar
Cekuhnen
Posts: 443
Joined: Sat Jul 10, 2021 11:37 pm

Re: Help for first steps within the wiki

Post by Cekuhnen »

chrisb i have to stop mult tasking i make currently to many mistakes

i was referring to adding a sketch to the part wb - it is already part of part design wb


the main idea here is to make it clear how the env can be customised to a more unified work flow for new users
MacOS Big Sur / Win 10

Designer | Faculty
Wayne State University
Interior - Industrial Design
User avatar
kaktus
Posts: 719
Joined: Sun Aug 11, 2019 11:59 am
Location: opolskie
Contact:

Re: Help for first steps within the wiki

Post by kaktus »

how about making a new valuable tutorial
:?:
wierny padawan mistrza arturromarr
Twórca polskiej wersji Wiki dla FreeCAD, współwórca polskiej wersji GUI.
"Cierpliwym być musisz, by wiedzę zgłębiać tajemną, gdyż ciemna strona mocy niszczącą i silną jest".
chrisb
Veteran
Posts: 43495
Joined: Tue Mar 17, 2015 9:14 am

Re: Help for first steps within the wiki

Post by chrisb »

Cekuhnen wrote: Mon Jul 26, 2021 3:56 pm chrisb i have to stop mult tasking i make currently to many mistakes
Good idea, do one step after the other.
i was referring to adding a sketch to the part wb - it is already part of part design wb

the main idea here is to make it clear how the env can be customised to a more unified work flow for new users
You have to consider two things: abstract from your own models and targets, and you have to be very precise in your wording. There is no such thing as adding a sketch to Part workbench. Sketches can be added to models, tools or functions can be added to workbenches.
A Sketcher Lecture with in-depth information is available in English, auf Deutsch, en français, en español.
Post Reply