WikiPagesDocSchemes

Scheme 1 based on the type of users (for example, to modify)

 * DOC scheme "User type"
 * Introduction and commons for User type "all users" (at this time named at freecadweb.org "the home user/ hobbyist, the experienced CAD user and the programmer")
 * FreeCAD overview (is this headline / level needed?)
 * FreeCAD Commons
 * CAD Commons
 * Commons, Introduction to CAD (link to wikipedia)
 * Commons, Intro 3D - Solid Modeling (wikipedia link)
 * Commons to parametric 3D CAD (link to wikipedia) (beside: the translated wikipedia-pages aren't equal ...)
 * General functions of FreeCAD
 * FreeCAD Workbench principle: FreeCAD uses worbenches (see getting started how to use them) small problem: if someone like "just to start" - the workbench priciple should aligned with the GUI, mouse model etc. All in overview or all in getting started? I prefer in "getting started" - Ralf: in overview a "naming" like "FreeCAD uses worbenches" - linked to "getting started#workbenches"
 * FreeCAD Feature principle: FreeCAD uses features. All things created are representated by features. The most actions depend on features.
 * FreeCAD Feature-Tree principle: FreeCAD uses a feature-tree. All features are structured, organized, handled by a graphical tree
 * FreeCAD Legals
 * FreeCAD licensing: Impact of the licences (short version / explanation of the license (see below))
 * FreeCAD possibilities and limits: what is possible an what not - if this is possible to say "generic"
 * Documentation for User type "new users"
 * FreeCAD - getting started the first time / before you start
 * Description of the GUI (yet difficult: at this point/moment this page don't need to be to exhaustive - but then a second "stage" of the same page would be needed - suggestions? -> as already described: description short an exact, links for everything else, also additional descriptions)
 * link to "mouse model"
 * link to "keyboard shortcuts"
 * may be here: the principle how FreeCAD handles transformation (as properties) of objects and how handles FreeCAD the tree and the dependencies of features according to the tree (too much here: which leads to actual limitations while using some tools, patterns p.e.). Bad, when here: very generic, unusable for one who like to start with something concrete - is abstract - Good: it's the right place to to make the acquaintance of this principles, one time.
 * FreeCAD overall tools / common use guide
 * mouse model
 * keyboard shortcuts
 * modifying objects - property editor
 * Label
 * Placement
 * Geometry
 * displaying objects - property editor
 * Display Mode
 * Selectable
 * Visibility
 * Transparency
 * Shape Color
 * FreeCAD - using / the use of (how to sort? workbenches; workflow; themes (arch, boot etc.); alphabetical...?-> one proposition: new frames "creating something"; "working and change with something existing", "use something existing for futher work" )
 * Operate in 2D - drawing (drafting?): draft workbench
 * drawing objects
 * Creating objects
 * Line
 * Arc
 * Modify objects
 * Move
 * utility tools
 * tool a
 * tool b
 * tool c
 * Operate in 2D - sketch: sketcher workbench
 * New sketch (map to a face, view perpendicular, edit sketch)
 * Plane (choose orientation, offset)
 * Tasks (solver messages, edit controls, constraints)
 * Tools (point line, ...)
 * Constraints
 * Operate in 3D - creating parts: part workbench
 * primitives
 * modifying objects
 * Derive drawings from 3D-parts: drawing workbench
 * Operate in 3D - creating buildings: arch workbench
 * Working with robots: robot workbench
 * Designing ships: ship workbench
 * Documentation for User type "experienced and professional CAD users, "power users""
 * install FreeCAD
 * scripting FreeCAD
 * Pivy (is this also a kind of scripting?)
 * link to license; additional informations about the conditions of use
 * Documentation for User type "developers"
 * compiling FreeCAD
 * modifying FreeCAD
 * Documentation for User type "developers"
 * compiling FreeCAD
 * modifying FreeCAD

Scheme 2 based on the type of documents (for example, to modify)

 * DOC scheme "Document type"
 * Command reference
 * workbench a
 * command a
 * intro
 * image
 * how to use
 * option
 * see also
 * link
 * script
 * macro
 * dev info
 * ____
 * command b
 * intro
 * image
 * how to use
 * option
 * see also
 * link
 * script
 * macro
 * dev info
 * ____
 * workbench b
 * command a
 * intro
 * image
 * how to use
 * option
 * see also
 * link
 * script
 * macro
 * dev info
 * ____
 * command b
 * user manual
 * navigation
 * manipulators
 * preferences
 * placement
 * ______
 * "standard" defined FC-files (the example files)
 * tutorials
 * books
 * FAQ
 * install
 * use
 * script & develop
 * Show your FreeCAD projects here! archives

( Ralf: a lot of my books put the reference at the end) (Renato: ok)

Scheme 3 mixed (for example, to modify)

 * DOC scheme "Work type" - Workflow aligned help
 * Workflow mechanical engineering
 * mesuring, interpolating and understanding an existing construction - workbench Reverse Engineering (in case of reverse engineering)
 * create sketch - workbench Sketcher or PartDesign
 * create parts(s), save CAD- and/or mesh-files of the wanted geometry - workbench PartDesign or Part
 * derive drawing and save drawing if needed - workbench Drawing (partly possible)
 * create assembly - workbench Assembly (not yet possible inside FreeCAD; may be blender is your friend at this time ...)
 * verfify and work with the mesh - workbench Mesh Design
 * do further computations - workbench FEM (not yet possible inside FreeCAD; Salome-Meca can use meshes ...)

Scheme 4. Command Reference
Main template


 * DOC Scheme "Content type" - CommRef
 * Command Reference
 * → Menu
 * Introduction to Command Reference (optional)
 * → File
 * → New
 * → ___
 * → Edit
 * → Undo
 * View
 * Tools
 * Macro
 * Workbench
 * None
 * Windows
 * Help
 * View 3D
 * Utility
 * Snap
 * ContextMenu
 * Appaerance
 * Manipulator
 * Properties

Scheme 4-1 ComRefFile

 * File menu
 * Introduction to File Menu (optional)
 * File → New
 * → Open
 * Close
 * Close All
 * Save
 * Save As
 * Import
 * Export
 * Merge project
 * Project Information
 * Print
 * Print Preview
 * Export PDF
 * Recent Files
 * Exit

Scheme 4-7 ComRefWorkbench

 * Workbench
 * Introduction to Workbench (optional)
 * Workbench → None 	- only shows the main menu -
 * → Arch 	- for working with architectural elements -
 * Assembly - for working with multiple shapes, multiple documents, multiple files, multiple relationships... -
 * Complete - is the default start workbench of FreeCAD (and incorporates all GuiCommands which meet certain Quality requirements ?)-
 * Draft - for doing basic 2D CAD drafting -
 * Drawing - for displaying your 3D work on a 2D sheet respectively a mechanical drawing -
 * Fem - for Pre/Post-processing FEM studies -
 * Image - for working with bitmap images -
 * Info - provides some information about the objects -
 * Inspection - shows RMS value - undocumented -
 * Mesh - for working with triangulated meshes -
 * OpenScad - for interoperability with OpenSCAD and repairing CSG model history -
 * Part - for working with CAD parts -
 * PartDesign - for building Part shapes from sketches -
 * Plot - allows to edit and save output plots created from other modules and tools -
 * Points - for working with point clouds - It is still in development -
 * Raytracing - for working with ray-tracing (rendering) -
 * Robot - for studying robot movements -
 * Ship FreeCAD-Ship - works over Ship entities, that must be created on top of provided geometry -
 * Sketcher - for working with geometry-constrained sketches -
 * Start - opens browser in the main window of FreeCAD -
 * Test - extensive testing framework -
 * Web - opens a website in FreeCAD -

''Ralf: in this way I find the description much more useful, great, thanks! Small addidtion: "still in development" may stay a state for some workbenches some time, may be this hint can be a kind of a "flag"; similar if there are special conditions (as for Complete), moreover there is already an entry for "special conditions" in "FreeCAD commons".'' -

Scheme 4-7-4 ComRefWorkbench-Draft
Page template with some deviations from GuiCommand_model. Editing Template:GuiCommand ?


 * Draft Workbench
 * Introduction to Draft - optional
 * Draft Workbench → Line
 * intro, description
 * image - optional
 * how to use
 * options
 * properties - only a link to a page of the manual or other documentation, which must be written
 * see also - only a link
 * links to forum or other
 * scripting - only a link to a page of a documentation section dedicated to scripts 
 * example - only a link to a page of the manual or to a page of a documentation section dedicated to examples. In this way you can make exhaustive examples, without putting too many things in Command Ref 
 * macro - only a link to a page of a documentation section dedicated to macros 
 * dev info - only a link to a page of a documentation section dedicated to developers 
 * other, version note, alerts, ...
 * Draft Workbench → DWire
 * Draft Workbench →

returns to WikiPages