WikiPagesDocSchemes

Documentation schemes

- DOC Scheme "User type" based on the type of users
// Mediawiki != TeX :(( - Ralf
 * 1) 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")
 * 2) FreeCAD Commons
 * 3) CAD Commons
 * 4) Commons, Introduction to CAD (link to wikipedia)
 * 5) Commons, Intro 3D - Solid Modeling (wikipedia link)
 * 6) Commons to parametric 3D CAD (link to wikipedia)
 * 7) General functions of FreeCAD
 * 8) FreeCAD GUI: FreeCAD is usable and accessible with a graphical user interface and a pointig device (e.g. mouse)
 * 9) * FreeCAD offers several pointing-device use-models (e.g. CAD, blender)
 * "MMM" - "Mind the gap!" - always "mind your choosen mouse model" ! 
 * If you're not very familar with FreeCADs possibility to change the mouse model while working you may think sometimes that especially selection but also other functions are not working properly while you've just choosen a mouse model which works different as you've expected it. Therefore: always "MMM" !
 * 1) FreeCAD CLI: FreeCAD is usable and accessible with a command-line interface, with or without GUI
 * 2) * FreeCAD offers several programming and scripting concepts (macro recording, python, pligins etc.)
 * 3) FreeCAD Workbench Concept: FreeCAD uses the Workbench Concept
 * 4) * see getting started/workbenches how to use them. Improve the description of workbenches. Workbenches are a key aspect of FreeCAD. When you start it is hard to understand quickly how they work. Need some simple examples.
 * there are already two: Workbench Concept and Workbenches. From the Workbench Concept could be the workbenches left out, to the Workbenches page the " " and "Complete" Workbench could be added. Alternative try:
 * 1st: FreeCAD has a lot of functions and respective buttons
 * 2nd: for the most task some only some of the funcions are needed, the other functions not or seldom
 * 3rd: therefore the functions are grouped together in "workbenches" accordung to specific tasks
 * 4th: if you've a specific task try to choose the correspondig workbench for beginning your work
 * 5th: if you want to do anything else there are the possibility "all" - all functions instead of one group or
 * 6th: the possibility to choose " " for no workbench functions beeing displayed as buttons and in menus
 * 1) FreeCAD Feature principle: FreeCAD uses features.
 * 2) * All things created are representated by features.
 * 3) * The most actions depend on features.
 * 4) FreeCAD Feature-Properties principle: FreeCAD uses feature specific properties
 * 5) * to control physical values of the features
 * 6) * to control display parameters of the features
 * 7) FreeCAD Feature-Tree principle: FreeCAD uses a feature-tree.
 * 8) * All features are structured, organized, handled by a graphical tree
 * 9) FreeCAD works parametric and associative, objects are controlled by their properties
 * 10) FreeCAD Licensing and Legals
 * 11) FreeCAD licensing: Impact of the licences (short version / explanation of the license (see below))
 * 12) FreeCAD versions, features and limits
 * 1) FreeCAD help
 * 2) Workbenches
 * 3) Tools
 * 4) Functions
 * 5) Properties & Property-Editor
 * 6) Display, Render etc
 * 7) Files, saving, readung, export, import etc
 * 8) Command reference
 * 9) Glossary
 * 10) Documentation for User type "new users"
 * 11) FreeCAD - getting started the first time / before you start
 * 12) Description of the GUI
 * 13) Main window
 * 14) Menu bar
 * 15) Views - additional displaying areas
 * 16) Tree view
 * 17) Property view
 * 18) Selection view
 * 19) * combo view - the combination of tree, property and task view
 * 20) Report view
 * 21) Python console
 * 22) Toolbars
 * 23) * Workbench dependent toolbars

- DOC Scheme "Document type" based on the type of documents

 * 1) User manual
 * 2) navigation
 * 3) manipulators
 * 4) preferences
 * 5) placement
 * 6) Tutorials organized
 * 7) Mechanical: create a nut, bolt, washer, grower washer, gear, ...
 * 8) Piping: create a pipe, elbow, tee, cap, ball valve, ...
 * 9) Electrotechnical, electronic: .....
 * 10) Arch: window, door, ....
 * 11) other categories ...
 * 12) Workflows
 * 13) Compare different workflows in modeling. Pros/cons. See Washer
 * 14) Create a shape with a rotation. Part->Revolve or PartDesign->Revolve.
 * 15) Create a shape with an extrusion. Pad or Extrude.
 * 16) Create a shape with a boolean operation.
 * 17) Compare the use of different Workbench in modeling. Pros/cons.
 * 18) Create edges or faces with Draft.
 * 19) Create edges or faces with Sketcher.
 * 20) Standard Parts. They save a lot of work. Recent forum discussions: here.
 * 21) How to create own Standard Parts Libraries (special parts).
 * 22) How to create unified library (ISO, sub EN, ...).
 * 23) How to import libraries (from manufacturers, ..., OpenSCAD, ...).
 * 24) Books
 * 25) FAQ
 * 26) install
 * 27) use
 * 28) script & develop
 * 29) Show your FreeCAD projects here! archives
 * 30) Command reference; Glossary
 * 31) workbench a
 * 32) command a
 * 33) intro
 * 34) image
 * 35) how to use
 * 36) option
 * 37) see also
 * 38) link
 * 39) script
 * 40) macro
 * 41) dev info
 * 42) ____
 * 43) command b
 * 44) intro
 * 45) ____
 * 46) workbench b
 * 47) command a
 * 48) intro
 * 49) ____
 * 50) command b
 * 51) ______
 * 52) "standard" defined FC-files (the example files)
 * 53) DOC as "all-in-one-files" html / pdf, e.g. for offline use

- DOC Scheme "Work type" - Workflow aligned help

 * 1) Workflow mechanical parts and assembly construction
 * 2) mesuring, interpolating and understanding an existing construction - workbench Reverse Engineering (in case of reverse engineering)
 * 3) create sketch - workbench Sketcher or PartDesign
 * 4) create part(s), save CAD- and/or mesh-files of the wanted geometry - workbench PartDesign or Part
 * 5) derive drawing and save drawing if needed - workbench Drawing (partly possible)
 * 6) create assembly - workbench Assembly (not yet possible inside FreeCAD; may be blender is your friend at this time ...)
 * 7) verify and work with the mesh - workbench Mesh Design
 * 8) do further computations - workbench FEM (not yet possible inside FreeCAD; Salome-Meca can use meshes ...)
 * 9) create a section
 * 10) dimension
 * 11) Workflow building construction

- DOC Scheme "Content type"
Main template
 * CommRef
 * 1) Command Reference
 * 2) → Menu
 * 3) Introduction to Command Reference (optional)
 * 4) → File
 * 5) → 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 -

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 →
 * Glossary

''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-5 ...
-

Scheme 4-16 ComRefProperty
returns to WikiPages