WikiPagesDocSchemes

Documentation schemes

- DOC Scheme "User type" based on the type of users

  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")
    1. FreeCAD Commons
      1. CAD Commons
        1. Commons, Introduction to CAD (link to wikipedia)
        2. Commons, Intro 3D - Solid Modeling (wikipedia link)
        3. Commons to parametric 3D CAD (link to wikipedia)
      2. General functions of FreeCAD
        1. FreeCAD GUI: FreeCAD is usable and accessible with a graphical user interface and a pointig device (e.g. mouse)
          • FreeCAD offers several pointing-device use-models (e.g. CAD, blender)
          <a name="MMM">"MMM" - "Mind the gap!" - always "mind your choosen mouse model" ! </a>
          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" !
        2. FreeCAD CLI: FreeCAD is usable and accessible with a command-line interface, with or without GUI
          • FreeCAD offers several programming and scripting concepts (macro recording, python, pligins etc.)
        3. FreeCAD Workbench Concept: FreeCAD uses the Workbench Concept
          • 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 "<none>" 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 "<none>" for no workbench functions beeing displayed as buttons and in menus
        4. FreeCAD Feature principle: FreeCAD uses features.
          • All things created are representated by features.
          • The most actions depend on features.
        5. FreeCAD Feature-Properties principle: FreeCAD uses feature specific properties
          • to control physical values of the features
          • to control display parameters of the features
        6. FreeCAD Feature-Tree principle: FreeCAD uses a feature-tree.
          • All features are structured, organized, handled by a graphical tree
        7. FreeCAD works parametric and associative, objects are controlled by their properties
    2. FreeCAD Licensing and Legals
      1. FreeCAD licensing: Impact of the licences (short version / explanation of the license (see below))
    3. FreeCAD versions, features and limits
Version new features limitations in OS distribution particular DOC link
0.9 changelog link http://sourceforge.net/p/free-cad/screenshot/302717.jpg
0.10 changelog link Debian GNU/Linux 6 http://sourceforge.net/p/free-cad/screenshot/270825.jpg
0.11 http://www.freecadweb.org/wiki/index.php?title=Release_notes_011
0.12 http://www.freecadweb.org/wiki/index.php?title=Release_notes_012
0.13 http://www.freecadweb.org/wiki/index.php?title=Release_notes_013

// Mediawiki != TeX :(( - Ralf

    1. FreeCAD help
      1. Workbenches
      2. Tools
      3. Functions
      4. Properties & Property-Editor
      5. Display, Render etc
      6. Files, saving, readung, export, import etc
    2. Command reference
    3. Glossary
  2. Documentation for User type "new users"
    1. FreeCAD - getting started the first time / before you start
      1. Description of the GUI
        1. Main window
          1. Menu bar
          2. Views - additional displaying areas
            1. Tree view
            2. Property view
            3. Selection view
            • combo view - the combination of tree, property and task view
            1. Report view
            2. Python console
          3. Toolbars
            • Workbench dependent toolbars

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

  1. User manual
    1. navigation
    2. manipulators
    3. preferences
    4. placement
  2. Tutorials organized
    1. Mechanical: create a nut, bolt, washer, grower washer, gear, ...
    2. Piping: create a pipe, elbow, tee, cap, ball valve, ...
    3. Electrotechnical, electronic: .....
    4. Arch: window, door, ....
    5. other categories ...
  3. Workflows
    1. Compare different workflows in modeling. Pros/cons. See Washer
      1. Create a shape with a rotation. Part->Revolve or PartDesign->Revolve.
      2. Create a shape with an extrusion. Pad or Extrude.
      3. Create a shape with a boolean operation.
    2. Compare the use of different Workbench in modeling. Pros/cons.
      1. Create edges or faces with Draft.
      2. Create edges or faces with Sketcher.
  4. Standard Parts. They save a lot of work. Recent forum discussions: here.
    1. How to create own Standard Parts Libraries (special parts).
    2. How to create unified library (ISO, sub EN, ...).
    3. How to import libraries (from manufacturers, ... , OpenSCAD, ...).
  5. Books
  6. FAQ
    1. install
    2. use
    3. script & develop
    4. Show your FreeCAD projects here! archives
  7. Command reference; Glossary
    1. workbench a
      1. command a
        1. intro
        2. image
        3. how to use
        4. option
        5. see also
        6. link
        7. script
        8. macro
        9. dev info
        10. ____
      2. command b
        1. intro
        2. ____
    2. workbench b
      1. command a
        1. intro
        2. ____
      2. command b
    3. ______
  8. "standard" defined FC-files (the example files)
  9. 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
    1. mesuring, interpolating and understanding an existing construction - workbench Reverse Engineering (in case of reverse engineering)
    2. create sketch - workbench Sketcher or PartDesign
    3. create part(s), save CAD- and/or mesh-files of the wanted geometry - workbench PartDesign or Part
    4. derive drawing and save drawing if needed - workbench Drawing (partly possible)
    5. create assembly - workbench Assembly (not yet possible inside FreeCAD; may be blender is your friend at this time ...)
    6. verify and work with the mesh - workbench Mesh Design
    7. do further computations - workbench FEM (not yet possible inside FreeCAD; Salome-Meca can use meshes ...)
    8. create a section
    9. displaying dimension
    10. orthographic projections
  2. Workflow building construction

- DOC Scheme "Content type"

Main template

  1. Command Reference
    1. → Menu
      1. Introduction to Command Reference (optional)
      2. → File
      3. → New

Scheme 4-1 ComRefFile

Scheme 4-2 ....

Scheme 4-3 ComRefEdit

Scheme 4-4 ComRefView

Scheme 4-5 ComRefTools

Scheme 4-6 ComRefMacro

Scheme 4-7 ComRefWorkbench

Scheme 4-7-1 ComRefWorkbench-None

Scheme 4-7-2 ComRefWorkbench-Arch

Scheme 4-7-3 ComRefWorkbench-Complete

Scheme 4-7-4 ComRefWorkbench-Draft

Page template with some deviations from GuiCommand_model. Editing Template:GuiCommand ?

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-8 ComRefWindows

Scheme 4-9 ComRefHelp

Scheme 4-10 ComRefView 3D

Scheme 4-11 ComRefUtility

Scheme 4-12 ComRefSnap

Scheme 4-13 ComRefContextMenu

Scheme 4-14 ComRefAppaerance

Scheme 4-15 ComRefManipulator

Scheme 4-16 ComRefProperty

returns to WikiPages

Online version: "http://www.freecadweb.org/wiki/index.php?title=WikiPagesDocSchemes&oldid=87426"

Navigation menu