The names of top level workbench pages must have this format: XYZ Workbench, where XYZ is the name of the workbench, for example PartDesign Workbench. 'of', 'on', 'in', 'a', 'an', 'and').īad page name Construction of AeroCompany airplanes Good page name Construction of AeroCompany Airplanes Page names should be short and they should use title case: every word should begin with a capital letter, unless they are articles, prepositions, conjunctions, or other grammatical particles (f.e. See #Templates for a list of all templates. The Template:Docnav is used to sequentially link pages, following the structure of the Table of Contents. This is used as the main reference for automatically building the offline help you can reach from FreeCAD, as well as the offline PDF documentation. The User hub provides a Table of Contents. To quickly get familiar with the structure and style of the FreeCAD wiki look at the model page: GuiCommand model. Once the work is done, please don't forget to remove the flags! To flag a page add either indicates that you will do the work yourself and others should give you some time. This assures that wiki admins don't mark your page as ready for translation while you are still changing it. If you are working on a large page it is advisable to mark the page either as a work in progress or as unfinished. Please get familiar with the #Templates section before writing help pages. There is a template for menu commands, File → Save, a template to style keys to be pressed, Shift, to show a Boolean value, true, etc. They give the documentation a consistent look and feel. Templates are used to style the help pages. Use only the templates described below in #Templates. Insert the information in a new page, and link to this page from other pages that require this information.ĭo not use transclusion of pages ( Help:Editing#Templates and transcluding pages), as this makes the wiki difficult to translate. Centralized informationĪvoid duplicating the same information in different places. Good description PartDesign Workbench: aims to provide tools for modelling complex solid parts. Use 'some' when dealing with an indeterminate number, or specify the correct quantity.īad description PartDesign Workbench: the PartDesign Workbench is a workbench for part design that aims to provide tools for modelling complex solid parts. Also avoid colloquial expressions such as 'a couple'. Describe what FreeCAD does, not what FreeCAD does not do. When describing FreeCAD try to be concise and to the point and avoid repetition. For more information see Localisation and the original Mediawiki:Extension:Translate page. Do not worry when adding new material because the system will add new tags automatically after your edits. Please be aware that changes to existing headings and paragraphs affect the current translations. If you remove a heading or a paragraph you should also remove the tag belonging to it. It is however fine to move paragraphs or change wording as long as the tags stay with them. You should not change them as that would destroy those links. They link the headings and paragraphs to their translated versions. The latter mark so-called translation units and are created by the translation system, you should never create them manually. For every page multiple language versions can exist. The FreeCAD wiki uses automated translation support to provide pages in many languages. This is done by adding ] at the bottom of the wiki code. Sandbox pages must be placed in the Sandbox category. Use a sandbox to test your code, for example, FreeCADDocu:Sandbox or a particular page with your name Sandbox:Yourname.We like to keep the documentation easy to read, so avoid using complex features.Not all features of MediaWiki are available in this FreeCAD wiki, but many are. For advanced use of the wiki software, see MediaWiki Help:Contents.If you have never used wiki software before, please read Help:Editing to become familiar with the markup that is used.You must request an account on the forum. Contrary to Wikipedia, the FreeCAD wiki is write-protected to avoid spam.If you have contributed to Wikipedia, editing FreeCAD wiki pages should be easy. This wiki documentation is based on MediaWiki, the same software that powers Wikipedia.It summarizes several discussions and brainstorming sessions This page is an extension of the Help:Editing page and gives common guidelines for writing and updating the FreeCAD wiki documentation.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |