Difference between revisions of "Help FreeCAD/zh-cn"

From FreeCAD Documentation
Jump to navigation Jump to search
Line 8: Line 8:
* [[:Category:Command_Reference|范畴:命令参考]]页面列出了关于FreeCAD所有[[Command|命令]]的相关文档。他们大多数只含有很少的信息,或者根本还是空白。请您参考[[WikiPages]],那里有一些例子,说明什么样子是比较好的命令文档页面。
* [[:Category:Command_Reference|范畴:命令参考]]页面列出了关于FreeCAD所有[[Command|命令]]的相关文档。他们大多数只含有很少的信息,或者根本还是空白。请您参考[[WikiPages]],那里有一些例子,说明什么样子是比较好的命令文档页面。
* [[Tutorials|教程]]部分也很不够。如果你用FreeCAD做出了挺酷的东西,为什么不为后人记录下来你的做法呢?
* [[Tutorials|教程]]部分也很不够。如果你用FreeCAD做出了挺酷的东西,为什么不为后人记录下来你的做法呢?
* 在FreeCAD的[[bugtracker|抓虫者]]系统, 有一些开口机票(原意是可以不确定时间和地点的返程机票,这里指遗留下来有待填补的工作。-译者注),打有“[https://freecadweb.org/tracker/search.php?tag_string=documentation 文档]”标签,它们需要有爱的你。
* 在FreeCAD的[[bugtracker|抓虫者]]系统, 有一些开口机票,打有“[https://freecadweb.org/tracker/search.php?tag_string=documentation 文档]”标签,它们在等待有爱的你。(Open tickets,原意是可以不确定时间和地点的返程机票,这里指遗留下来有待填补的工作。-译者注)
=== Share your FreeCAD knowledge ===
=== Share your FreeCAD knowledge ===

Revision as of 01:43, 27 August 2018

Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎hrvatski • ‎italiano • ‎polski • ‎português • ‎português do Brasil • ‎română • ‎svenska • ‎čeština • ‎български • ‎русский • ‎українська • ‎中文(中国大陆)‎ • ‎中文(台灣)‎ • ‎日本語 • ‎한국어



帮助我们撰写、更正和丰满这个文档。比如说,改正错误;遇到不清楚的页面,帮我们扩展内容或修改表达方式;给缺失的主题创建新页面,等等。为FreeCAD的文档做贡献很简单,在WikiPages页面,你能找到FreeCADwiki的约束条件,还有帮你起步的内容。要编辑wiki,你可以在论坛索要一个账号, 或者通过irc 频道。但是IRC频道里的反应不一定像论坛里那么快。


  • 范畴:命令参考页面列出了关于FreeCAD所有命令的相关文档。他们大多数只含有很少的信息,或者根本还是空白。请您参考WikiPages,那里有一些例子,说明什么样子是比较好的命令文档页面。
  • 教程部分也很不够。如果你用FreeCAD做出了挺酷的东西,为什么不为后人记录下来你的做法呢?
  • 在FreeCAD的抓虫者系统, 有一些开口机票,打有“文档”标签,它们在等待有爱的你。(Open tickets,原意是可以不确定时间和地点的返程机票,这里指遗留下来有待填补的工作。-译者注)

Share your FreeCAD knowledge

The users community around FreeCAD is still small, but already includes several advanced users who do a very important job in showing to newcomers how to use the software. If you begin to feel comfortable with FreeCAD, your knowledge could be very valuable to others, and you might contribute with important assets, like:

  • Showing the work you do with FreeCAD on the Users Showcase forum. You can post screenshots, and, even better, attach the FreeCAD files so other people can examine it and understand how you did it.
  • Recording videos showing how you did something interesting in FreeCAD. These videos usually do a great job in showing new features.
  • Write tutorials describing or teaching something interesting. You can write tutorials on your own blog, directly on our wiki, or even on the forum.
  • Post on the FreeCAD Google Plus or Facebook community.

Translate FreeCAD

Translate FreeCAD in your own language. All text of the FreeCAD interface can be easily translated in other languages. All we need is someone who know that other language and is willing to help! All the translations are done online on crowdin.

For details on translation, see FreeCAD Wiki Translation Process under Localisation.

Translate the documentation

Translating is easy, the FreeCAD wiki supports a Translation plugin which allows to manage translations between pages.

For details on translation, see FreeCAD Wiki Translation Process under Localisation#Translating_the_wiki.

Please be sure to be familiar with the WikiPages style guide, which includes rules for good translations.

The Help Editing page provides some information on editing.

Help others to know FreeCAD

  • Talk about FreeCAD to other people who might be interested
  • Find interesting uses for FreeCAD, and document it, for example with screenshots. FreeCAD is very young, and not many people see what they can do with it. If you are a FreeCAD fan already, you surely know some cool thing FreeCAD can do. Help us to show that to others!
  • Hang on the forum, and help newcomers to solve basic questions
  • Write tutorials, record videos, etc... showing what you do with FreeCAD
  • Contribute with files, drawings, etc... We still lack good example files of what can be done with FreeCAD
  • Help to promote FreeCAD on GitHub by 'Starring' and 'Watching' the FreeCAD repository github

Report bugs and ask for interesting features


Although the place to report confirmed bugs and suggest new features is eventually the FreeCAD Tracker, please always post bug reports and feature requests to the Help forum first. In order to save developers time (triaging and handling hard to understand bugs can be very time consuming), and avoid frustrations because your issue was not handled the way you would like, please read the following:

  • Bugs and features requests are handled in the same tracker. Just mark your issue as "bug" (something that doesn't work as it should) or "feature" (something that is not there but you think it would be good to have)
  • Although originally you could submit issues anonymously, unfortunately this had to be cancelled due to spam. Now if you would like to create/edit tickets you will have to create an account. You will then by default be notified when someone adds notes to the issue. In many cases, the person who will handle the bug will need more information from you.
  • When reporting a bug, the most important point is to allow developers to reproduce it. Be sure to include the exact steps needed to make the bug happen, so another person can do the same and see the bug happen on his machine too. If the developer cannot see the bug, he cannot solve it either.
  • Also include information that can help developers to situate the problem, like the operating system you are running FreeCAD on, the exact version of FreeCAD and the relevant libraries. Please post all the data by using the "copy to clip board" button in the Help (menu) -> about FreeCAD dialogue, and do this from the Part or PartDesign workbench.
  • No matter how sure you are that you have found a bug, please always discuss bugs first in the Help forum.
  • Before submitting a feature request, always discuss it with other users first on the Open discussion forum, so you might end up with a more solid proposal, with more chances to interest a developer to implement it.
  • Remember that FreeCAD is developed by volunteers who use their free time to work on it. Although everyone tries his best to make the best possible application, your bug report might be treated with low priority, or cancelled if you cannot give sufficient information, and your feature request might be postponed or even refused if no developer has interest in implement it or if that would request unrealistic amount of work.

Design artwork

See the Artwork page for guidelines about designing icons for FreeCAD.


Writing code for FreeCAD is not hard, and you don't need any permission, you can start right now to work on something you want, then submit a patch on the tracker or request a merge from a git branch. But to avoid some headache you should meet the following prerequisites first:

  • FreeCAD goes at its own pace, and has a very small team of developers. We have not as much time as we would like to dedicate to FreeCAD, and things are not planned ahead, they are done when some developer sees it fit and when he finds time to do it. So we don't maintain a list of tasks to be done. It is up to you to find something you would like to do, for example a defect you would like to correct, or a small feature you think is missing. The tracker also contains some items that are not yet assigned to anybody.
  • Before you start to code for FreeCAD, you must know well how FreeCAD works. This seems obvious, but if you don't know how it is supposed to work you won't know what to do internally or how to do it.
  • Almost everything can be done either in python or C++. The internals work almost the same in both languages. We suggest you read through the Power users hub pages, even if you're going to code in C++, since it will give you a good overview of the internals.
  • If you are going to work in C++, make sure you can compile FreeCAD without problems first.
  • Present yourself to other developers. FreeCAD is before anything a social project, we discuss a lot of things on the forum before implementing it, and it's always best to discuss your ideas and tell people what you are planning to do before actually doing it. We also have an IRC channel, but the forum is the one and only place where you can meet all the developers.
  • Since 2016, FreeCAD is also participating to the Google Summer of Code. Be sure to check our ideas there if you are interested in participating in a next edition.