Jump to content
Toggle sidebar
FreeCAD Documentation
Search
English
Log in
Personal tools
Log in
Index
Overview
Features
Screenshots
Download
FAQ
Forum
Tracker
General usage
User Hub
Manual
Tutorials
Installing
Getting started
Navigation styles
Customizing FreeCAD
Commands list
Workbenches
Workbenches list
Arch
Assembly
CAM/Path
Draft
FEM
Mesh
OpenSCAD
Part
PartDesign
Points
Robot
Sketcher
Spreadsheet
Surface
TechDraw
External workbenches
Python scripting
Powerusers hub
Discovering Python
Python in FreeCAD
Macros
Mesh scripting
Part scripting
Pivy
PySide
Parametric objects
Code examples
Python API
Development
Developers hub
How to contribute
Git repository
Compiling
License details
Organization chart
Startup options
Branding
Translating
Help & Feedback
Forum
Bugs tracker
IRC channel
Facebook
Twitter
Mastodon
Meta
Recent changes
Random page
Links
Tools
Special pages
Printable version
Export translations
Translate
English
Language statistics
Message group statistics
Export
More
Language statistics
Message group statistics
Export
Settings
Group
3D input devices
3D view
3Dconnexion input devices
A2plus Workbench
About FreeCAD
Add Button to FEM Toolbar Tutorial
Add FEM Constraint Tutorial
Add FEM Equation Tutorial
Add Workbench to Addon Manager
Addon
Advanced Attachment OYX
Advanced TechDraw Tutorial
Aeroplane
Analysis of reinforced concrete with FEM
Animation Workbench
ANSI templates
App DocumentObject
App DocumentObjectGroup
App FeaturePython
App GeoFeature
App Link
App OriginGroupExtension
App Part
AppImage
Arch 3DS
Arch 3Views
Arch Add
Arch API
Arch Axis
Arch AxisSystem
Arch Building
Arch BuildingPart
Arch Check
Arch CloneComponent
Arch CloseHoles
Arch CompAxis
Arch Component
Arch CompPanel
Arch CompPipe
Arch CompRebarStraight
Arch CompSetMaterial
Arch CurtainWall
Arch CutLine
Arch CutPlane
Arch DAE
Arch Door
Arch Equipment
Arch Fence
Arch Floor
Arch Frame
Arch Grid
Arch IFC
Arch IfcExplorer
Arch IfcSpreadsheet
Arch JSON
Arch MergeWalls
Arch MeshToShape
Arch MultiMaterial
Arch Nest
Arch OBJ
Arch Panel
Arch Panel Cut
Arch Panel Sheet
Arch panel tutorial
Arch Pipe
Arch PipeConnector
Arch Preferences
Arch Profile
Arch Project
Arch Rebar
Arch Reference
Arch Remove
Arch RemoveShape
Arch Roof
Arch Schedule
Arch SectionPlane
Arch SelectNonSolidMeshes
Arch SetMaterial
Arch SHP
Arch Site
Arch Space
Arch SplitMesh
Arch Stairs
Arch Structure
Arch Survey
Arch templates
Arch ToggleIfcBrepFlag
Arch ToggleSubs
Arch Truss
Arch tutorial
Arch Wall
Arch Window
Arch Workbench
Artwork
Artwork Arch
Artwork Assembly
Artwork Assembly3
Artwork CAM
Artwork Draft
Artwork Fem
Artwork Gui
Artwork Guidelines
Artwork Inspection
Artwork Material
Artwork Mesh
Artwork MeshPart
Artwork OpenSCAD
Artwork Part
Artwork PartDesign
Artwork Plot
Artwork Points
Artwork Reinforcement
Artwork Render
Artwork ReverseEngineering
Artwork Robot
Artwork Ship
Artwork Sketcher
Artwork Splash screen
Artwork Spreadsheet
Artwork Start
Artwork Surface
Artwork TechDraw
Artwork Test
Artwork Tux
Artwork Web
Assembly
Assembly Workbench
Assembly2 Workbench
Assembly3 AddOrigin
Assembly3 AddPlacement
Assembly3 AddWorkplane
Assembly3 AddXZWorkplane
Assembly3 AddZYWorkplane
Assembly3 AutoElementVisibility
Assembly3 AutoFixElement
Assembly3 AutoRecompute
Assembly3 AxialMove
Assembly3 ConstraintAlignment
Assembly3 ConstraintAngle
Assembly3 ConstraintArcLineTangent
Assembly3 ConstraintAttachment
Assembly3 ConstraintAttachmentOffset
Assembly3 ConstraintAxial
Assembly3 ConstraintCoincidence
Assembly3 ConstraintColinear
Assembly3 ConstraintDiameter
Assembly3 ConstraintEqualAngle
Assembly3 ConstraintEqualLength
Assembly3 ConstraintEqualLineArcLength
Assembly3 ConstraintEqualPointLineDistance
Assembly3 ConstraintEqualRadius
Assembly3 ConstraintLengthDifference
Assembly3 ConstraintLengthEqualPointLineDistance
Assembly3 ConstraintLengthRatio
Assembly3 ConstraintLineHorizontal
Assembly3 ConstraintLineLength
Assembly3 ConstraintLineVertical
Assembly3 ConstraintLock
Assembly3 ConstraintMidPoint
Assembly3 ConstraintMore
Assembly3 ConstraintMultiParallel
Assembly3 ConstraintPerpendicular
Assembly3 ConstraintPointDistance
Assembly3 ConstraintPointInPlane
Assembly3 ConstraintPointLineDistance
Assembly3 ConstraintPointOnCircle
Assembly3 ConstraintPointOnLine
Assembly3 ConstraintPointPlaneDistance
Assembly3 ConstraintPointsCoincident
Assembly3 ConstraintPointsDistance
Assembly3 ConstraintPointsHorizontal
Assembly3 ConstraintPointsProjectDistance
Assembly3 ConstraintPointsSymmetric
Assembly3 ConstraintPointsVertical
Assembly3 ConstraintSameOrientation
Assembly3 ConstraintSketchPlane
Assembly3 ConstraintSymmetric
Assembly3 ConstraintSymmetricHorizontal
Assembly3 ConstraintSymmetricLine
Assembly3 ConstraintSymmetricVertical
Assembly3 CreateAssembly
Assembly3 CreateElement
Assembly3 GoToRelation
Assembly3 GroupObjects
Assembly3 ImportFromSTEP
Assembly3 ImportMultiDocument
Assembly3 LockMover
Assembly3 MeasureAngle
Assembly3 MeasurePointLine
Assembly3 MeasurePointPlane
Assembly3 MeasurePoints
Assembly3 MoveItemDown
Assembly3 MoveItemUp
Assembly3 MovePart
Assembly3 MultiplyConstraint
Assembly3 QuickMove
Assembly3 QuickSolve
Assembly3 ResolveConstraints
Assembly3 ShowElementCS
Assembly3 SmartRecompute
Assembly3 TogglePartVisibility
Assembly3 TracePartMove
Assembly3 Workbench
Assembly4 Workbench
Asymptote
B-Splines
Base API
Basic Attachment Tutorial
Basic modeling tutorial
Basic Part Design Tutorial
Basic Part Design Tutorial 019
Basic Sketcher Tutorial
Basic TechDraw Tutorial
BIM application compatibility table
BIM Box
BIM Classification
BIM Clone
BIM Copy
BIM IfcElements
BIM IfcProperties
BIM IfcQuantities
BIM ingame tutorial
BIM Layers
BIM Library
BIM Preflight
BIM Project
BIM Setup
BIM Views
BIM Windows
BIM Workbench
Bitmap
Body
BOLTSFC Workbench
Books
Branding
Builtin modules
CadQuery Workbench
CAM Adaptive
CAM Area
CAM Area Workplane
CAM Array
CAM Comment
CAM Copy
CAM Custom
CAM Deburr
CAM DressupAxisMap
CAM DressupDogbone
CAM DressupDragKnife
CAM DressupLeadInOut
CAM DressupPathBoundary
CAM DressupRampEntry
CAM DressupTag
CAM DressupZCorrect
CAM Drilling
CAM Engrave
CAM experimental
CAM ExportTemplate
CAM FAQ
CAM Fixture
CAM fourth axis
CAM Helix
CAM Inspect
CAM Job
CAM MillFace
CAM OpActiveToggle
CAM Pocket 3D
CAM Pocket Shape
CAM Post
CAM Postprocessor Customization
CAM Preferences
CAM Probe
CAM Profile
CAM Sanity
CAM scripting
CAM SelectLoop
CAM SetupSheet
CAM Shape
CAM SimpleCopy
CAM Simulator
CAM Slot
CAM Stop
CAM Surface
CAM ThreadMilling
CAM ToolBit
CAM ToolBit Library
CAM ToolBitDock
CAM ToolBitLibraryOpen
CAM ToolController
CAM Tools
CAM ToolShape
CAM Vcarve
CAM Walkthrough for the Impatient
CAM Waterline
CAM Workbench
Cfd Workbench
Changelog
Civil Engineering Workbench
Code snippets
Coin3d snippets
Combo view
Command
Common Airfoil Data Import
Compile on Docker
Compile on Linux
Compile on MacOS
Compile on MinGW
Compile on Windows
CompileOnWindows - Reducing Disk Footprint
Compiling
Compiling (Speeding up)
Conda
Console API
Constructive solid geometry
Continuous Integration
Contributors
Copying Objects
Create a FeaturePython object part I
Create a FeaturePython object part II
Creating a simple part with Draft and Part WB
Creating a simple part with Part WB
Creating a simple part with PartDesign
Crowdin Administration
Crowdin Scripts
CurvedShapes CurvedArray
CurvedShapes Workbench
Curves CompressionSpring
Curves Discretize
Curves EditableSpline
Curves ExtendCurve
Curves GordonSurface
Curves Interpolate
Curves IsoCurve
Curves JoinCurve
Curves Line
Curves MultiLoft
Curves ParametricComb
Curves ParametricSolid
Curves PasteSVG
Curves Pipeshell
Curves PipeshellProfile
Curves ProfileSupport
Curves ReflectLines
Curves SegmentSurface
Curves SketchOnSurface
Curves SplitCurve
Curves ToConsole
Curves Workbench
Curves ZebraTool
Custom icon in tree view
Customize Toolbars
DAG view
Datum
Debian development
Debian Unstable
Debugging
Defeaturing
Defeaturing Workbench
Developer hub
Developing FreeCAD with GitKraken
Developing FreeCAD with KDevelop
Development roadmap
Dialog creation
Dialog creation image and animated GIF
Dialog creation reading and writing files
Dialog creation setting colors
Dialog creation with various widgets
Document structure
Donate
Download
Doxygen
Draft AddConstruction
Draft AddNamedGroup
Draft AddToGroup
Draft annotation scale widget
Draft AnnotationStyleEditor
Draft API
Draft ApplyStyle
Draft Arc
Draft Arc 3Points
Draft Array
Draft AutoGroup
Draft BezCurve
Draft BSpline
Draft Circle
Draft CircularArray
Draft Clone
Draft Constrain
Draft CubicBezCurve
Draft DAT
Draft Dimension
Draft Downgrade
Draft Draft2Sketch
Draft Drawing
Draft DXF
Draft Edit
Draft Ellipse
Draft Facebinder
Draft Fillet
Draft FlipDimension
Draft Hatch
Draft Heal
Draft Join
Draft Label
Draft Layer
Draft LayerManager
Draft Line
Draft Mirror
Draft Move
Draft OCA
Draft Offset
Draft OrthoArray
Draft PathArray
Draft PathLinkArray
Draft Pattern
Draft Point
Draft PointArray
Draft PointLinkArray
Draft PolarArray
Draft Polygon
Draft Preferences
Draft Rectangle
Draft Rotate
Draft Scale
Draft SelectGroup
Draft SelectPlane
Draft SetStyle
Draft Shape2DView
Draft ShapeString
Draft ShapeString tutorial
Draft ShowSnapBar
Draft Slope
Draft Snap
Draft Snap Angle
Draft Snap Center
Draft Snap Dimensions
Draft Snap Endpoint
Draft Snap Extension
Draft Snap Grid
Draft Snap Intersection
Draft Snap Lock
Draft Snap Midpoint
Draft Snap Near
Draft Snap Ortho
Draft Snap Parallel
Draft Snap Perpendicular
Draft Snap Special
Draft snap widget
Draft Snap WorkingPlane
Draft Split
Draft Stretch
Draft SubelementHighlight
Draft SVG
Draft Text
Draft ToggleConstructionMode
Draft ToggleContinueMode
Draft ToggleDisplayMode
Draft ToggleGrid
Draft Tray
Draft Trimex
Draft tutorial
Draft Upgrade
Draft Wire
Draft WireToBSpline
Draft Workbench
Draft WorkingPlaneProxy
Drawing
Drawing Annotation
Drawing API example
Drawing Clip
Drawing Dimensioning Addon
Drawing Documentation
Drawing Landscape A3
Drawing Open SVG
Drawing Openbrowser
Drawing Orthoviews
Drawing ProjectShape
Drawing Save
Drawing SpreadsheetView
Drawing Symbol
Drawing Template HowTo
Drawing templates
Drawing tutorial
Drawing View
Drawing Workbench
DXF
DynamicData Workbench
EM FHEquiv
EM FHInputFile
EM FHNode
EM FHPath
EM FHPlane
EM FHPlaneAddRemoveNodeHole
EM FHPlaneHole
EM FHPort
EM FHSegment
EM FHSolver
EM Workbench
Embedding FreeCAD
Embedding FreeCADGui
Engine Block Tutorial
Example Combined Footing
Example Slab Having LShape Rebars Reinforcement Mesh
Example Slab Having Mesh Of Straight Rebars
Example Slab Having UShape Rebars Reinforcement Mesh
Example Slab Spanning in One Direction
Example Slab Spanning in Two Directions
ExplodedAssembly Workbench
Export to STL or OBJ
Expressions
Extend FEM Module
External workbenches
Extra python modules
Fasteners BOM
Fasteners ChamferHole
Fasteners ChangeParameters
Fasteners Flip
Fasteners MatchTypeInner
Fasteners MatchTypeOuter
Fasteners Move
Fasteners ScrewCalculator
Fasteners Simplify
Fasteners Workbench
FCGear BevelGear
FCGear CrownGear
FCGear CycloidGear
FCGear CycloidRack
FCGear GearConnector
FCGear HypoCycloidGear
FCGear InternalInvoluteGear
FCGear InvoluteGear
FCGear InvoluteRack
FCGear LanternGear
FCGear TimingGear
FCGear Workbench
FCGear WormGear
Fcmcua Workbench
Feature
Feature editing
Feature list
FeaturePython Custom Properties
FeaturePython methods
FEM Analysis
FEM CalculiX
FEM CalculiX Cantilever 3D
FEM ClippingPlaneAdd
FEM ClippingPlaneRemoveAll
FEM Concrete
FEM ConstantVacuumPermittivity
FEM ConstraintBearing
FEM ConstraintBodyHeatSource
FEM ConstraintCentrif
FEM ConstraintContact
FEM ConstraintCurrentDensity
FEM ConstraintDisplacement
FEM ConstraintElectrostaticPotential
FEM ConstraintFixed
FEM ConstraintFlowVelocity
FEM ConstraintFluidBoundary
FEM ConstraintForce
FEM ConstraintGear
FEM ConstraintHeatflux
FEM ConstraintInitialFlowVelocity
FEM ConstraintInitialPressure
FEM ConstraintInitialTemperature
FEM ConstraintMagnetization
FEM ConstraintPlaneRotation
FEM ConstraintPressure
FEM ConstraintPulley
FEM ConstraintSectionPrint
FEM ConstraintSelfWeight
FEM ConstraintSpring
FEM ConstraintTemperature
FEM ConstraintTie
FEM ConstraintTransform
FEM CreateNodesSet
FEM Element Types
FEM ElementFluid1D
FEM ElementGeometry1D
FEM ElementGeometry2D
FEM ElementRotation1D
FEM EquationDeformation
FEM EquationElasticity
FEM EquationElectricforce
FEM EquationElectrostatic
FEM EquationFlow
FEM EquationFlux
FEM EquationHeat
FEM EquationMagnetodynamic
FEM EquationMagnetodynamic2D
FEM Example Capacitance Two Balls
FEM Examples
FEM FemMesh2Mesh
FEM FrontISTR Workbench
FEM Geometry Preparation and Meshing
FEM Install
FEM MaterialEditor
FEM MaterialFluid
FEM MaterialMechanicalNonlinear
FEM MaterialReinforced
FEM MaterialSolid
FEM Mesh
FEM Mesh CalculiX
FEM MeshBoundaryLayer
FEM MeshClear
FEM MeshDisplayInfo
FEM MeshGmshFromShape
FEM MeshGroup
FEM MeshNetgenFromShape
FEM MeshRegion
FEM PostApplyChanges
FEM PostCreateFunctionBox
FEM PostCreateFunctionCylinder
FEM PostCreateFunctionPlane
FEM PostCreateFunctionSphere
FEM PostFilterClipRegion
FEM PostFilterClipScalar
FEM PostFilterContours
FEM PostFilterCutFunction
FEM PostFilterDataAlongLine
FEM PostFilterDataAtPoint
FEM PostFilterLinearizedStresses
FEM PostFilterWarp
FEM PostPipelineFromResult
FEM Preferences
FEM ResultShow
FEM ResultsPurge
FEM Shear of a Composite Block
FEM Solver
FEM SolverCalculiX
FEM SolverCalculixCxxtools
FEM SolverControl
FEM SolverElmer
FEM SolverElmer SolverSettings
FEM SolverMystran
FEM SolverRun
FEM SolverZ88
FEM tutorial
FEM Tutorial Python
FEM Workbench
FEMbyGEN Workbench
File Format FCStd
Fine-tuning
Flamingo Workbench
Flatpak
FreeCAD and DWG Import
FreeCAD and DXF Import
FreeCAD and Mesh Import
FreeCAD API
FreeCAD Build Tool
FreeCAD Community Portal
FreeCAD Docker CLI mode
FreeCAD Managing Expectations
FreeCAD Scripting Basics
FreeCAD used in production
FreeCAD vector math library
FreeCAD-SH3D
FreeCAD-Ship s60 tutorial
FreeCAD-Ship s60 tutorial (II)
FreeCADGui API
Frequently asked questions
Getting started
Git buildpackage
Glossary
GlTF
Gui Command
GuiCommand model
Headless FreeCAD
Help
Help FreeCAD
History
How to install additional workbenches
How to install macros
IfcOpenShell
IfcPlusPlus
Image CreateImagePlane
Image Open
Image Scaling
Image Workbench
ImageConv
Import Export
Import Export Preferences
Import from STL or OBJ
Import OpenSCAD code
Import text and geometry from Inkscape
Import/Export IFC - compiling IfcOpenShell
Important information
Importing From Sketchup
InputField
Inspection Workbench
Installing additional components
Installing Helpfile
Installing more workbenches
Installing on Linux
Installing on Mac
Installing on Windows
Interface
Interface creation
Interface Customization
Introduction to Python
Key ASCII
KicadStepUp Workbench
Lattice2 AttachablePlacement
Lattice2 Workbench
LGTM
License
Line drawing function
LinkSub
LinkSubList
Linux packaging
Localisation
Localisation Sidebar
Localization Older Methods
LuxCoreRender
LuxRender
MacOS packaging
Macro 3D Parametric Curve
Macro 3d Printer Slicer
Macro 3d Printer Slicer Individual Parts
Macro 3D Printer Workflow
Macro 3DXML import
Macro AeroFoil
Macro Airfoil Import & Scale
Macro Alias For Table For Object
Macro Alias Manager
Macro Align Camera to Working Plane
Macro Align Face Object to View
Macro Align Object to View
Macro Align View to Face
Macro Align Working Plane to Camera
Macro Animated Constrain
Macro Animator
Macro Apothem Based Prism GUI
Macro Arch Axis System Repartition
Macro ArrayCopy
Macro Assemblage Imprimante 3D
Macro Assembly
Macro at Startup
Macro Automatic drawing
Macro Bevel
Macro BOLTS
Macro BoundingBox Tracing
Macro BSurf from grid
Macro Build Utility
Macro Cabinets32
Macro CartoucheFC
Macro CartoucheFC 2
Macro CartoucheFC Full
Macro Center Align Objects with Faces or Edges
Macro CenterFace
Macro CenterOfMass
Macro Circle
Macro CirclePlus
Macro clone explicit
Macro CloneConvert
Macro Colorize
Macro Compound Plus
Macro Connect And Sweep
Macro Constraint Draft
Macro ConstraintToAlias
Macro Convert 021
Macro Copy3DViewToClipboard
Macro Corner shapes wizard
Macro Corner shapes wizard/update
Macro crank simul
Macro Creating faces from a DXF file
Macro cross section
Macro Cut Circle
Macro Cut Line
Macro DeepCopy
Macro Delta xyz
Macro documentation
Macro Draft Circle 3 Points
Macro Draft Circle 3 Points 3D
Macro Draft Circle Tangent
Macro Draw 2D Function
Macro Draw Parametric 2D Function
Macro Dump Objects
Macro Duplicate Selection
Macro DXF to Face and Sketch
Macro Easy cutouts for Enclosure Design
Macro EasyAlias
Macro EasyReflector
Macro EdgesToArc
Macro Editor Assistant
Macro Ellipse-Center+2Points
Macro ExpandTreeItem
Macro export transient FEM results
Macro Extract Wires from Mesh
Macro FaceToSketch
Macro FC Convert Lines
Macro FC element selector
Macro FCBmpImport
Macro FCCamera
Macro FCCamGroover
Macro FCCircularText
Macro FCGear
Macro FCHoneycombMaker
Macro FCInfo
Macro FCInfo Alternate Linux
Macro FCInfo ToolBar
Macro FCInfoGlass
Macro FCInfoToMouse
Macro FCSpreadSheet Extract
Macro FCSpring Helix Variable
Macro FCSpring On Surface
Macro FCTreeView
Macro FCWire To Volume
Macro FindAliasReferences
Macro findConfigFiles
Macro FlattenWire
Macro FlattenWire3Points
Macro Fonts Win10 PYMP
Macro ForceRecompute
Macro FreeCAD to Kerkythea
Macro GenerateDrawing
Macro GenerateViews
Macro Geneva Wheel
Macro Geneva Wheel GUI
Macro Geodesic Dome
Macro Global Variable Watcher
Macro GMSH
Macro GuiResetToolbars
Macro Guitar fretboard
Macro Guitar Nut
Macro Half turn stairs
Macro Half-Hull Model
Macro HealArcs
Macro HiddenAlls
Macro HighlightCommon
Macro HighlightDifference
Macro HilbertCurve
Macro hinge
Macro Honeycomb
Macro If Selected Stay If Not Then Delete
Macro Iges PyImporter
Macro Image Scaling
Macro ImperialScales
Macro ImportAirfoil
Macro Intersection
Macro Joint
Macro JointWire
Macro Kerkythea
Macro Line Length
Macro Loft
Macro MacroMenu
Macro MacroToolbarManager
Macro Make Arc 3 Points
Macro Make Circle 3 Points
Macro Make Cube
Macro MatrixTransform
Macro MeasureCircle
Macro Megaminx
Macro merge duplicate materials
Macro MeshToPart
Macro MessageBox
Macro Mouse Cross
Macro Mouse over cb
Macro MoveToOrigin
Macro MultiCopy
Macro MultiCuts
Macro Normal Vector
Macro ObjectInfo
Macro Overlap
Macro Parametric Curve FP
Macro Parametric Defeaturing
Macro PartsLibrary
Macro PartToVRML
Macro PCBWay
Macro PDWrapper
Macro Perpendicular To Wire
Macro Pinger
Macro Place Image
Macro PlacementAbsolufy
Macro Polyhedrons
Macro Print SceneGraph
Macro PropertyMemo
Macro Pyramid
Macro Python Assistant Window
Macro Recompute Profiler
Macro Rectellipse
Macro Remove parametric history
Macro Replace Part in Assembly
Macro Repro Wire
Macro Rotate To Point
Macro Rotate View
Macro Rotate View Free
Macro Rotate ViewAxonometric
Macro Rubik Cube
Macro Screen Wiki
Macro screw maker1 2
Macro Section
Macro Select Hovering
Macro SelectVisible
Macro Shake Sketch
Macro Sheet Metal Unfolder
Macro SimpleProperties
Macro Site From Contours
Macro Sketch Constraint From Spreadsheet
Macro SketchUnmap
Macro Snip
Macro Solid Sweep
Macro SplitPropEditor
Macro Spreadsheet2html
Macro SpreadsheetTools
Macro Spring
Macro Stairs
Macro StraightenObject
Macro SuperWire
Macro TemplateHelper
Macro Texture
Macro Texture Objects
Macro TimingGear
Macro TNP Solution
Macro Toggle Drawstyle
Macro Toggle Drawstyle Optimized
Macro Toggle Panels Visibility
Macro Toggle Visibility
Macro Toggle Visibility2 1-2
Macro Toggle Visibility2 2-2
Macro TreeToAscii
Macro Triangle AH
Macro Unbind Numpad Shortcuts
Macro Unfold Box
Macro Unroll Ruled Surface
Macro View Rotation
Macro Visibility Manager
Macro VisibleAlls
Macro Wiki Object Properties List Generator
Macro Wiki Object Properties List Generator Basic Version
Macro WireFilter
Macro WireXYZ
Macro Wiring And Hoses
Macro WorkFeatures
Macro Z Height Map
Macro Zoom1 1
Macros
Macros recipes
Main Page
Main view area
Manipulator Workbench
Manual:A gentle introduction
Manual:All workbenches at a glance
Manual:BIM modeling
Manual:Creating and manipulating geometry
Manual:Creating FEM analyses
Manual:Creating interface tools
Manual:Creating parametric objects
Manual:Creating renderings
Manual:Generating 2D drawings
Manual:Import and export to other filetypes
Manual:Installing
Manual:Introduction
Manual:Modeling for product design
Manual:Navigating in the 3D view
Manual:Parametric objects
Manual:Preparing models for 3D printing
Manual:Summary
Manual:The Community
Manual:The FreeCAD document
Manual:The FreeCAD Interface
Manual:Traditional 2D drafting
Manual:Traditional modeling, the CSG way
Manual:Using spreadsheets
Manual:What is FreeCAD
Matrix API
Measurement Of Angles On Holes
Mesh
Mesh AddFacet
Mesh API
Mesh BoundingBox
Mesh BuildRegularSolid
Mesh CrossSections
Mesh CurvatureInfo
Mesh Decimating
Mesh Difference
Mesh EvaluateFacet
Mesh EvaluateSolid
Mesh Evaluation
Mesh Export
Mesh Feature
Mesh FillInteractiveHole
Mesh FillupHoles
Mesh FlipNormals
Mesh FromPartShape
Mesh HarmonizeNormals
Mesh Import
Mesh Intersection
Mesh Merge
Mesh MeshObject
Mesh PolyCut
Mesh PolyTrim
Mesh RemeshGmsh
Mesh RemoveCompByHand
Mesh RemoveComponents
Mesh Scale
Mesh Scripting
Mesh SectionByPlane
Mesh Segmentation
Mesh SegmentationBestFit
Mesh Smoothing
Mesh SplitComponents
Mesh to Part
Mesh TrimByPlane
Mesh Union
Mesh VertexCurvature
Mesh Workbench
MeshPart CreateFlatFace
MeshPart CreateFlatMesh
MeshRemodel Workbench
MIBA
Migrating to FreeCAD from Fusion360
Migrating to FreeCAD from OnShape
Migrating to FreeCAD from Revit
Migrating to FreeCAD from SolidWorks
Misc templates
Misc templates Full
Model
ModernUI Workbench
MOOC Workbench
Mouse navigation
Multithreading
Navigation Cube
NumPy
O-X-Y Type Attachment Modes
Object API
Object name
Onboarding FEM Devs
Online Help Startpage
Online Help Toc
OpenCamLib
OpenCASCADE
OpenSCAD AddOpenSCADElement
OpenSCAD ColorCodeShape
OpenSCAD CSG
OpenSCAD Edgestofaces
OpenSCAD ExpandPlacements
OpenSCAD ExplodeGroup
OpenSCAD Hull
OpenSCAD IncreaseToleranceFeature
OpenSCAD MeshBoolean
OpenSCAD Minkowski
OpenSCAD MirrorMeshFeature
OpenSCAD Preferences
OpenSCAD RefineShapeFeature
OpenSCAD RemoveSubtree
OpenSCAD ReplaceObject
OpenSCAD ResizeMeshFeature
OpenSCAD ScaleMeshFeature
OpenSCAD Workbench
Organization chart
OSE 3D Printer Workbench
OSE Piping Workbench
Package Metadata
Packaging
Part
Part and PartDesign
Part API
Part Boolean
Part BooleanFragments
Part Box
Part BoxSelection
Part Builder
Part Chamfer
Part CheckGeometry
Part Circle
Part ColorPerFace
Part Common
Part CompCompoundTools
Part CompJoinFeatures
Part CompOffsetTools
Part Compound
Part CompoundFilter
Part CompSplittingTools
Part Cone
Part CrossSections
Part Cut
Part Cylinder
Part Defeaturing
Part EditAttachment
Part ElementCopy
Part Ellipse
Part Ellipsoid
Part ExplodeCompound
Part Export
Part Extrude
Part Feature
Part Fillet
Part Fuse
Part Helix
Part Import
Part JoinConnect
Part JoinCutout
Part JoinEmbed
Part Line
Part Loft
Part Loft Technical Details
Part MakeFace
Part MakeSolid
Part Measure Angular
Part Measure Clear All
Part Measure Linear
Part Measure Refresh
Part Measure Toggle 3D
Part Measure Toggle All
Part Measure Toggle Delta
Part Mirror
Part Module
Part Offset
Part Offset2D
Part Part2DObject
Part Plane
Part Point
Part PointsFromMesh
Part Primitives
Part Prism
Part ProjectionOnSurface
Part RefineShape
Part RegularPolygon
Part ReverseShape
Part Revolve
Part RuledSurface
Part Scale
Part scripting
Part Section
Part SectionCut
Part ShapeFromMesh
Part SimpleCopy
Part Slice
Part SliceApart
Part Sphere
Part Spiral
Part Sweep
Part Thickness
Part TopoShape
Part Torus
Part TransformedCopy
Part Tube
Part Wedge
Part XOR
PartDesign AdditiveBox
PartDesign AdditiveCone
PartDesign AdditiveCylinder
PartDesign AdditiveEllipsoid
PartDesign AdditiveHelix
PartDesign AdditiveLoft
PartDesign AdditivePipe
PartDesign AdditivePrism
PartDesign AdditiveSphere
PartDesign AdditiveTorus
PartDesign AdditiveWedge
PartDesign Bearingholder Tutorial I
PartDesign Bearingholder Tutorial II
PartDesign Body
PartDesign Boolean
PartDesign Chamfer
PartDesign Clone
PartDesign CompPrimitiveAdditive
PartDesign CompPrimitiveSubtractive
PartDesign CoordinateSystem
PartDesign Draft
PartDesign Examples
PartDesign Feature
PartDesign Fillet
PartDesign Groove
PartDesign Hole
PartDesign InvoluteGear
PartDesign Line
PartDesign LinearPattern
PartDesign Migrate
PartDesign Mirrored
PartDesign MoveFeature
PartDesign MoveFeatureInTree
PartDesign MoveTip
PartDesign MultiTransform
PartDesign NewSketch
PartDesign Pad
PartDesign Plane
PartDesign Pocket
PartDesign Point
PartDesign PolarPattern
PartDesign Preferences
PartDesign Revolution
PartDesign Scaled
PartDesign ShapeBinder
PartDesign Sprocket
PartDesign SubShapeBinder
PartDesign SubtractiveBox
PartDesign SubtractiveCone
PartDesign SubtractiveCylinder
PartDesign SubtractiveEllipsoid
PartDesign SubtractiveHelix
PartDesign SubtractiveLoft
PartDesign SubtractivePipe
PartDesign SubtractivePrism
PartDesign SubtractiveSphere
PartDesign SubtractiveTorus
PartDesign SubtractiveWedge
PartDesign Thickness
PartDesign tutorial
PartDesign WizardShaft
PartDesign Workbench
Parts Library Workbench
PCB Workbench
PDF
Pivy
Placement
Placement API
Plot Axes
Plot Basic tutorial
Plot Grid
Plot Labels
Plot Legend
Plot MultiAxes tutorial
Plot Positions
Plot Save
Plot Series
Plot Workbench
Points Convert
Points Export
Points Import
Points Merge
Points PolyCut
Points Structure
Points Workbench
Post-Processing of FEM Results with Paraview
POV-Ray
POV-Ray-Rendering Workbench
Power users hub
Preference Packs
Preferences Editor
Private Preference Packs
Profiling
Property
Property editor
PropertyLink: InList and OutList
Pyramids and polyhedrons Workbench
Pyrate Workbench
PySide
PySide Advanced Examples
PySide Beginner Examples
PySide Intermediate Examples
PySide usage snippets
Python
Python console
Python Development Environment
Python scripting tutorial
PythonOCC
Qt Example
Quantity
Raytracing API example
Raytracing ExportProject
Raytracing InsertPart
Raytracing Lux
Raytracing New
Raytracing Preferences
Raytracing Render
Raytracing ResetCamera
Raytracing templates
Raytracing tutorial
Raytracing Workbench
Raytracing WriteCamera
Raytracing WritePart
Raytracing WriteView
Reinforcement API
Reinforcement BarBendingSchedule
Reinforcement BarShapeCutList
Reinforcement BeamRebars
Reinforcement BentShapeRebar
Reinforcement BillOfMaterial
Reinforcement ColumnRebars
Reinforcement ColumnRebars Circular
Reinforcement ColumnRebars TwoTiesSixRebars
Reinforcement Custom Spacing
Reinforcement DrawingDimensioning
Reinforcement FootingRebars
Reinforcement HelicalRebar
Reinforcement LShapeRebar
Reinforcement SlabRebars
Reinforcement StirrupRebar
Reinforcement StraightRebar
Reinforcement UShapeRebar
Reinforcement Workbench
Release notes 0.13
Release notes 0.14
Release notes 0.15
Release notes 0.16
Release notes 0.17
Release notes 0.18
Release notes 0.19
Release notes 0.20
Release notes 0.21
Release notes 1.0
Render Workbench
Report view
Reverse Engineering Workbench
Robot 6-Axis
Robot API example
Robot CreateRobot
Robot CreateTrajectory
Robot Edge2Trac
Robot Export
Robot InsertWaypoint
Robot InsertWaypointPre
Robot RestoreHomePos
Robot SetDefaultOrientation
Robot SetDefaultValues
Robot SetHomePos
Robot Simulate
Robot TrajectoryCompound
Robot TrajectoryDressUp
Robot tutorial
Robot Workbench
Rocket BodyTube
Rocket Bulkhead
Rocket CenteringRing
Rocket CompLaunchGuide
Rocket Ejection Charge Calculator
Rocket Fin
Rocket FinCan
Rocket LaunchLug
Rocket NoseCone
Rocket Parachute Size Calculator
Rocket RailButton
Rocket RailGuide
Rocket Thrust To Weight Calculator
Rocket Transition
Rocket Vent Hole Size Calculator
Rocket Workbench
Scenegraph
Scientific literature
Screenshots
Scripted objects
Scripted objects migration
Scripted objects saving attributes
Scripted objects with attachment
Scripted Parts: Ball Bearing - Part 1
Scripted Parts: Ball Bearing - Part 2
Scripting and macros
Scripts
SearchBar Mod
Selection API
Selection methods
Selection view
Shape
SheetMetal AddBase
SheetMetal AddBend
SheetMetal AddCornerRelief
SheetMetal AddFoldWall
SheetMetal AddJunction
SheetMetal AddRelief
SheetMetal AddWall
SheetMetal BaseShape
SheetMetal Examples
SheetMetal Extrude
SheetMetal Forming
SheetMetal SketchOnSheet
SheetMetal UnattendedUnfold
SheetMetal Unfold
SheetMetal Workbench
Ship AreasCurve
Ship Capacity
Ship CreateShip
Ship GZ
Ship Hydrostatics
Ship LoadCondition
Ship LoadExample
Ship Tank
Ship Weight
Ship Workbench
Silk Workbench
Sketch
Sketcher ArcOverlay
Sketcher BSplineComb
Sketcher BSplineConvertToNURBS
Sketcher BSplineDecreaseDegree
Sketcher BSplineDecreaseKnotMultiplicity
Sketcher BSplineDegree
Sketcher BSplineIncreaseDegree
Sketcher BSplineIncreaseKnotMultiplicity
Sketcher BSplineInsertKnot
Sketcher BSplineKnotMultiplicity
Sketcher BSplinePoleWeight
Sketcher BSplinePolygon
Sketcher CarbonCopy
Sketcher Clone
Sketcher CloseShape
Sketcher ConnectLines
Sketcher ConstrainAngle
Sketcher ConstrainBlock
Sketcher ConstrainCoincident
Sketcher ConstrainCoincidentUnified
Sketcher ConstrainDiameter
Sketcher ConstrainDistance
Sketcher ConstrainDistanceX
Sketcher ConstrainDistanceY
Sketcher ConstrainEqual
Sketcher ConstrainHorizontal
Sketcher ConstrainHorVer
Sketcher ConstrainLock
Sketcher ConstrainParallel
Sketcher ConstrainPerpendicular
Sketcher ConstrainPointOnObject
Sketcher ConstrainRadiam
Sketcher ConstrainRadius
Sketcher ConstrainSnellsLaw
Sketcher ConstrainSymmetric
Sketcher ConstrainTangent
Sketcher ConstrainVertical
Sketcher Copy
Sketcher Create3PointArc
Sketcher Create3PointCircle
Sketcher CreateArc
Sketcher CreateArcOfEllipse
Sketcher CreateArcOfHyperbola
Sketcher CreateArcOfParabola
Sketcher CreateArcSlot
Sketcher CreateBSpline
Sketcher CreateBSplineByInterpolation
Sketcher CreateChamfer
Sketcher CreateCircle
Sketcher CreateEllipseBy3Points
Sketcher CreateEllipseByCenter
Sketcher CreateFillet
Sketcher CreateHeptagon
Sketcher CreateHexagon
Sketcher CreateLine
Sketcher CreateOblong
Sketcher CreateOctagon
Sketcher CreatePentagon
Sketcher CreatePeriodicBSpline
Sketcher CreatePeriodicBSplineByInterpolation
Sketcher CreatePoint
Sketcher CreatePointFillet
Sketcher CreatePolyline
Sketcher CreateRectangle
Sketcher CreateRectangle Center
Sketcher CreateRegularPolygon
Sketcher CreateSlot
Sketcher CreateSquare
Sketcher CreateTriangle
Sketcher DeleteAllConstraints
Sketcher DeleteAllGeometry
Sketcher Dialog
Sketcher Dimension
Sketcher EditSketch
Sketcher Examples
Sketcher Extend
Sketcher External
Sketcher Grid
Sketcher helper constraint
Sketcher JoinCurves
Sketcher LeaveSketch
Sketcher MapSketch
Sketcher MergeSketches
Sketcher Micro Tutorial - Constraint Practices
Sketcher MirrorSketch
Sketcher Move
Sketcher NewSketch
Sketcher Offset
Sketcher Preferences
Sketcher RectangularArray
Sketcher reference
Sketcher RemoveAxesAlignment
Sketcher RenderingOrder
Sketcher ReorientSketch
Sketcher requirement for a sketch
Sketcher RestoreInternalAlignmentGeometry
Sketcher Rotate
Sketcher Scale
Sketcher scripting
Sketcher SelectConflictingConstraints
Sketcher SelectConstraints
Sketcher SelectElementsAssociatedWithConstraints
Sketcher SelectElementsWithDoFs
Sketcher SelectHorizontalAxis
Sketcher SelectOrigin
Sketcher SelectRedundantConstraints
Sketcher SelectVerticalAxis
Sketcher SketchObject
Sketcher Snap
Sketcher Split
Sketcher StopOperation
Sketcher SwitchVirtualSpace
Sketcher Symmetry
Sketcher ToggleActiveConstraint
Sketcher ToggleConstruction
Sketcher ToggleDrivingConstraint
Sketcher Translate
Sketcher Trimming
Sketcher Tutorial
Sketcher ValidateSketch
Sketcher ViewSection
Sketcher ViewSketch
Sketcher Workbench
Source code management
Source documentation
Sphinx
Splash screen
Spreadsheet
Spreadsheet AlignBottom
Spreadsheet AlignCenter
Spreadsheet AlignLeft
Spreadsheet AlignRight
Spreadsheet AlignTop
Spreadsheet AlignVCenter
Spreadsheet CreateSheet
Spreadsheet CSV
Spreadsheet Export
Spreadsheet Import
Spreadsheet MergeCells
Spreadsheet Preferences
Spreadsheet SetAlias
Spreadsheet SplitCell
Spreadsheet StyleBold
Spreadsheet StyleItalic
Spreadsheet StyleUnderline
Spreadsheet Workbench
Standard Menu
Start Preferences
Start up and Configuration
Start Workbench
Status bar
Std About
Std ActivateNextWindow
Std ActivatePrevWindow
Std AddonMgr
Std Alignment
Std AxisCross
Std Base
Std BoxElementSelection
Std BoxSelection
Std CascadeWindows
Std CloseActiveWindow
Std CloseAllWindows
Std Copy
Std Cut
Std Delete
Std DemoMode
Std DependencyGraph
Std DlgCustomize
Std DlgMacroExecute
Std DlgMacroExecuteDirect
Std DlgMacroRecord
Std DlgParameter
Std DlgPreferences
Std DrawStyle
Std DuplicateSelection
Std Edit
Std Edit Menu
Std Export
Std File Menu
Std FreeCADDonation
Std FreeCADFAQ
Std FreeCADForum
Std FreeCADPowerUserHub
Std FreeCADUserHub
Std FreeCADWebsite
Std FreezeViews
Std Group
Std Help Menu
Std HideObjects
Std HideSelection
Std Import
Std LinkImport
Std LinkImportAll
Std LinkMake
Std LinkMakeRelative
Std LinkReplace
Std LinkSelectAllLinks
Std LinkSelectLinked
Std LinkSelectLinkedFinal
Std LinkUnlink
Std Macro Menu
Std MacroAttachDebugger
Std MacroStartDebug
Std MacroStepInto
Std MacroStepOver
Std MacroStopDebug
Std MacroStopRecord
Std MainFullscreen
Std MeasureDistance
Std MergeProjects
Std New
Std OnlineHelp
Std Open
Std OrthographicCamera
Std Part
Std Paste
Std PerspectiveCamera
Std Placement
Std Print
Std PrintPdf
Std PrintPreview
Std ProjectInfo
Std ProjectUtil
Std PythonHelp
Std Quit
Std RandomColor
Std RecallWorkingView
Std RecentFiles
Std Redo
Std Refresh
Std ReportBug
Std Revert
Std Save
Std SaveAll
Std SaveAs
Std SaveCopy
Std SceneInspector
Std SelBack
Std SelBoundingBox
Std SelectAll
Std SelectVisibleObjects
Std SelForward
Std SendToPythonConsole
Std SetAppearance
Std ShowObjects
Std ShowSelection
Std StoreWorkingView
Std TextDocument
Std TextureMapping
Std TileWindows
Std ToggleBreakpoint
Std ToggleClipPlane
Std ToggleNavigation
Std ToggleObjects
Std ToggleSelectability
Std ToggleVisibility
Std Tools Menu
Std TransformManip
Std TreeCollapseDocument
Std TreeDrag
Std TreeMultiDocument
Std TreePreSelection
Std TreeRecordSelection
Std TreeSelection
Std TreeSingleDocument
Std TreeSyncPlacement
Std TreeSyncSelection
Std TreeSyncView
Std Undo
Std UnitsCalculator
Std UserEditMode
Std View Menu
Std ViewBottom
Std ViewBoxZoom
Std ViewCreate
Std ViewDimetric
Std ViewDockUndockFullscreen
Std ViewFitAll
Std ViewFitSelection
Std ViewFront
Std ViewFullscreen
Std ViewHome
Std ViewIsometric
Std ViewIvIssueCamPos
Std ViewIvStereoInterleavedColumns
Std ViewIvStereoInterleavedRows
Std ViewIvStereoOff
Std ViewIvStereoQuadBuff
Std ViewIvStereoRedGreen
Std ViewLeft
Std ViewLoadImage
Std ViewRear
Std ViewRight
Std ViewRotateLeft
Std ViewRotateRight
Std ViewScreenShot
Std ViewStatusBar
Std ViewTop
Std ViewTrimetric
Std ViewZoomIn
Std ViewZoomOut
Std WhatsThis
Std Windows
Std Windows Menu
Std Workbench
Stemfie Workbench
Surface BlendCurve
Surface CurveOnMesh
Surface ExtendFace
Surface Filling
Surface GeomFillSurface
Surface Sections
Surface Workbench
SVG
Svg Namespace
Swag
SweetHome3D
Symbols Library Workbench
Task panel
Tasks Placement
TechDraw 2LineCenterLine
TechDraw 2PointCenterLine
TechDraw 2PointCosmeticLine
TechDraw 3PtAngleDimension
TechDraw ActiveView
TechDraw AngleDimension
TechDraw Annotation
TechDraw API
TechDraw ArchView
TechDraw AxoLengthDimension
TechDraw Balloon
TechDraw BrokenView
TechDraw ClipGroup
TechDraw ClipGroupAdd
TechDraw ClipGroupRemove
TechDraw CommandAddOffsetVertex
TechDraw ComplexSection
TechDraw CosmeticCircle
TechDraw CosmeticEraser
TechDraw CosmeticVertex
TechDraw DecorateLine
TechDraw DetailView
TechDraw DiameterDimension
TechDraw DimensionRepair
TechDraw DraftView
TechDraw ExportPageDXF
TechDraw ExportPageSVG
TechDraw ExtensionArcLengthAnnotation
TechDraw ExtensionAreaAnnotation
TechDraw ExtensionCascadeHorizDimension
TechDraw ExtensionCascadeObliqueDimension
TechDraw ExtensionCascadeVertDimension
TechDraw ExtensionChangeLineAttributes
TechDraw ExtensionCircleCenterLines
TechDraw ExtensionCreateHorizChainDimension
TechDraw ExtensionCreateHorizChamferDimension
TechDraw ExtensionCreateHorizCoordDimension
TechDraw ExtensionCreateLengthArc
TechDraw ExtensionCreateObliqueChainDimension
TechDraw ExtensionCreateObliqueCoordDimension
TechDraw ExtensionCreateVertChainDimension
TechDraw ExtensionCreateVertChamferDimension
TechDraw ExtensionCreateVertCoordDimension
TechDraw ExtensionCustomizeFormat
TechDraw ExtensionDecreaseDecimal
TechDraw ExtensionDrawCosmArc
TechDraw ExtensionDrawCosmCircle
TechDraw ExtensionDrawCosmCircle3Points
TechDraw ExtensionExtendLine
TechDraw ExtensionHoleCircle
TechDraw ExtensionIncreaseDecimal
TechDraw ExtensionInsertDiameter
TechDraw ExtensionInsertSquare
TechDraw ExtensionLineParallel
TechDraw ExtensionLinePerpendicular
TechDraw ExtensionLockUnlockView
TechDraw ExtensionPosHorizChainDimension
TechDraw ExtensionPositionSectionView
TechDraw ExtensionPosObliqueChainDimension
TechDraw ExtensionPosVertChainDimension
TechDraw ExtensionRemovePrefixChar
TechDraw ExtensionSelectLineAttributes
TechDraw ExtensionShortenLine
TechDraw ExtensionThreadBoltBottom
TechDraw ExtensionThreadBoltSide
TechDraw ExtensionThreadHoleBottom
TechDraw ExtensionThreadHoleSide
TechDraw ExtensionVertexAtIntersection
TechDraw FaceCenterLine
TechDraw General Examples
TechDraw Geometric dimensioning and tolerancing
TechDraw GeometricHatch
TechDraw Hatch
TechDraw Hatching
TechDraw HoleShaftFit
TechDraw HorizontalDimension
TechDraw HorizontalExtentDimension
TechDraw HowTo Page
TechDraw Image
TechDraw LandmarkDimension
TechDraw LeaderLine
TechDraw LengthDimension
TechDraw LineGroup
TechDraw LinkDimension
TechDraw Midpoints
TechDraw MoveView
TechDraw PageDefault
TechDraw PageTemplate
TechDraw Pitch Circle Tutorial
TechDraw Preferences
TechDraw PrintAll
TechDraw ProjectionGroup
TechDraw ProjectShape
TechDraw Quadrants
TechDraw RadiusDimension
TechDraw RedrawPage
TechDraw RichTextAnnotation
TechDraw Section Examples
TechDraw SectionView
TechDraw ShareView
TechDraw ShowAll
TechDraw SpreadsheetView
TechDraw StackBottom
TechDraw StackDown
TechDraw StackTop
TechDraw StackUp
TechDraw SurfaceFinishSymbol
TechDraw Symbol
TechDraw TemplateGenerator
TechDraw TemplateHowTo
TechDraw Templates
TechDraw ToggleFrame
TechDraw VerticalDimension
TechDraw VerticalExtentDimension
TechDraw View
TechDraw WeldSymbol
TechDraw Workbench
TechDrawGui API
Testing
The FreeCAD source code
Third Party Libraries
Third Party Tools
Thread for Screw Tutorial
ThreadProfile Workbench
Timber Workbench
Toothbrush Head Stand
Topological data scripting
Topological naming problem
TopoShape API
Tracker
Transient FEM analysis
Translating an external workbench
Transportation Workbench
Tree view
Tutorial custom placing of windows and doors
Tutorial for open windows
Tutorial FreeCAD POV ray
Tutorial KinematicAssembly
Tutorial KinematicController
Tutorial KinematicSkeleton
Tutorial Render with Blender
Tutorials
Ubuntu Snap
Units
User hub
Vector API
Video tutorials
Video tutorials for architectural design
Video tutorials for product design
View Measure Clear All
View Measure Toggle All
ViewObject API
Viewprovider
VRML Preparation for Robot Simulation
Web BrowserBack
Web BrowserNext
Web BrowserRefresh
Web BrowserSetURL
Web BrowserStop
Web BrowserZoomIn
Web BrowserZoomOut
Web OpenWebsite
Web Workbench
WebTools BimServer
WebTools Git
WebTools Sketchfab
WebTools Workbench
Which workbench should I choose
Whiffle Ball tutorial
Wikihouse porting tutorial
WikiPages
WikiRobots
Windows packaging
Wood Frame Workbench
Workarounds
Workbench creation
Workbenches
Workfeature Workbench
Wrapping a Cplusplus class in Python
Language
aa - Qafár af
ab - аԥсшәа
abs - bahasa ambon
ace - Acèh
ady - адыгабзэ
ady-cyrl - адыгабзэ
aeb - تونسي / Tûnsî
aeb-arab - تونسي
aeb-latn - Tûnsî
af - Afrikaans
ak - Akan
aln - Gegë
alt - алтай тил
am - አማርኛ
ami - Pangcah
an - aragonés
ang - Ænglisc
ann - Obolo
anp - अंगिका
ar - العربية
arc - ܐܪܡܝܐ
arn - mapudungun
arq - جازايرية
ary - الدارجة
arz - مصرى
as - অসমীয়া
ase - American sign language
ast - asturianu
atj - Atikamekw
av - авар
avk - Kotava
awa - अवधी
ay - Aymar aru
az - azərbaycanca
azb - تۆرکجه
ba - башҡортса
ban - Basa Bali
ban-bali - ᬩᬲᬩᬮᬶ
bar - Boarisch
bbc - Batak Toba
bbc-latn - Batak Toba
bcc - جهلسری بلوچی
bci - wawle
bcl - Bikol Central
be - беларуская
be-tarask - беларуская (тарашкевіца)
bg - български
bgn - روچ کپتین بلوچی
bh - भोजपुरी
bho - भोजपुरी
bi - Bislama
bjn - Banjar
blk - ပအိုဝ်ႏဘာႏသာႏ
bm - bamanankan
bn - বাংলা
bo - བོད་ཡིག
bpy - বিষ্ণুপ্রিয়া মণিপুরী
bqi - بختیاری
br - brezhoneg
brh - Bráhuí
bs - bosanski
btm - Batak Mandailing
bto - Iriga Bicolano
bug - ᨅᨔ ᨕᨘᨁᨗ
bxr - буряад
ca - català
cbk-zam - Chavacano de Zamboanga
cdo - 閩東語 / Mìng-dĕ̤ng-ngṳ̄
ce - нохчийн
ceb - Cebuano
ch - Chamoru
cho - Chahta Anumpa
chr - ᏣᎳᎩ
chy - Tsetsêhestâhese
ckb - کوردی
co - corsu
cps - Capiceño
cr - Nēhiyawēwin / ᓀᐦᐃᔭᐍᐏᐣ
crh - qırımtatarca
crh-cyrl - къырымтатарджа (Кирилл)
crh-latn - qırımtatarca (Latin)
cs - čeština
csb - kaszëbsczi
cu - словѣньскъ / ⰔⰎⰑⰂⰡⰐⰠⰔⰍⰟ
cv - чӑвашла
cy - Cymraeg
da - dansk
dag - dagbanli
de - Deutsch
de-at - Österreichisches Deutsch
de-ch - Schweizer Hochdeutsch
de-formal - Deutsch (Sie-Form)
dga - Dagaare
din - Thuɔŋjäŋ
diq - Zazaki
dsb - dolnoserbski
dtp - Dusun Bundu-liwan
dty - डोटेली
dv - ދިވެހިބަސް
dz - ཇོང་ཁ
ee - eʋegbe
egl - Emiliàn
el - Ελληνικά
eml - emiliàn e rumagnòl
en - English
en-ca - Canadian English
en-gb - British English
eo - Esperanto
es - español
es-419 - español de América Latina
es-formal - español (formal)
et - eesti
eu - euskara
ext - estremeñu
fa - فارسی
fat - mfantse
ff - Fulfulde
fi - suomi
fit - meänkieli
fj - Na Vosa Vakaviti
fo - føroyskt
fon - fɔ̀ngbè
fr - français
frc - français cadien
frp - arpetan
frr - Nordfriisk
fur - furlan
fy - Frysk
ga - Gaeilge
gaa - Ga
gag - Gagauz
gan - 贛語
gan-hans - 赣语(简体)
gan-hant - 贛語(繁體)
gcr - kriyòl gwiyannen
gd - Gàidhlig
gl - galego
gld - на̄ни
glk - گیلکی
gn - Avañe'ẽ
gom - गोंयची कोंकणी / Gõychi Konknni
gom-deva - गोंयची कोंकणी
gom-latn - Gõychi Konknni
gor - Bahasa Hulontalo
got - 𐌲𐌿𐍄𐌹𐍃𐌺
gpe - Ghanaian Pidgin
grc - Ἀρχαία ἑλληνικὴ
gsw - Alemannisch
gu - ગુજરાતી
guc - wayuunaiki
gur - farefare
guw - gungbe
gv - Gaelg
ha - Hausa
hak - 客家語/Hak-kâ-ngî
haw - Hawaiʻi
he - עברית
hi - हिन्दी
hif - Fiji Hindi
hif-latn - Fiji Hindi
hil - Ilonggo
ho - Hiri Motu
hr - hrvatski
hrx - Hunsrik
hsb - hornjoserbsce
hsn - 湘语
ht - Kreyòl ayisyen
hu - magyar
hu-formal - magyar (formal)
hy - հայերեն
hyw - Արեւմտահայերէն
hz - Otsiherero
ia - interlingua
id - Bahasa Indonesia
ie - Interlingue
ig - Igbo
igl - Igala
ii - ꆇꉙ
ik - Iñupiatun
ike-cans - ᐃᓄᒃᑎᑐᑦ
ike-latn - inuktitut
ilo - Ilokano
inh - гӀалгӀай
io - Ido
is - íslenska
it - italiano
iu - ᐃᓄᒃᑎᑐᑦ / inuktitut
ja - 日本語
jam - Patois
jbo - la .lojban.
jut - jysk
jv - Jawa
ka - ქართული
kaa - Qaraqalpaqsha
kab - Taqbaylit
kbd - адыгэбзэ
kbd-cyrl - адыгэбзэ
kbp - Kabɩyɛ
kcg - Tyap
kea - kabuverdianu
kg - Kongo
khw - کھوار
ki - Gĩkũyũ
kiu - Kırmancki
kj - Kwanyama
kjh - хакас
kjp - ဖၠုံလိက်
kk - қазақша
kk-arab - قازاقشا (تٴوتە)
kk-cn - قازاقشا (جۇنگو)
kk-cyrl - қазақша (кирил)
kk-kz - қазақша (Қазақстан)
kk-latn - qazaqşa (latın)
kk-tr - qazaqşa (Türkïya)
kl - kalaallisut
km - ភាសាខ្មែរ
kn - ಕನ್ನಡ
ko - 한국어
ko-kp - 조선말
koi - перем коми
kr - kanuri
krc - къарачай-малкъар
kri - Krio
krj - Kinaray-a
krl - karjal
ks - कॉशुर / کٲشُر
ks-arab - کٲشُر
ks-deva - कॉशुर
ksh - Ripoarisch
ksw - စှီၤ
ku - kurdî
ku-arab - كوردي (عەرەبی)
ku-latn - kurdî (latînî)
kum - къумукъ
kus - Kʋsaal
kv - коми
kw - kernowek
ky - кыргызча
la - Latina
lad - Ladino
lb - Lëtzebuergesch
lbe - лакку
lez - лезги
lfn - Lingua Franca Nova
lg - Luganda
li - Limburgs
lij - Ligure
liv - Līvõ kēļ
lki - لەکی
lld - Ladin
lmo - lombard
ln - lingála
lo - ລາວ
loz - Silozi
lrc - لۊری شومالی
lt - lietuvių
ltg - latgaļu
lus - Mizo ţawng
luz - لئری دوٙمینی
lv - latviešu
lzh - 文言
lzz - Lazuri
mad - Madhurâ
mag - मगही
mai - मैथिली
map-bms - Basa Banyumasan
mdf - мокшень
mg - Malagasy
mh - Ebon
mhr - олык марий
mi - Māori
min - Minangkabau
mk - македонски
ml - മലയാളം
mn - монгол
mni - ꯃꯤꯇꯩ ꯂꯣꯟ
mnw - ဘာသာ မန်
mo - молдовеняскэ
mos - moore
mr - मराठी
mrh - Mara
mrj - кырык мары
ms - Bahasa Melayu
ms-arab - بهاس ملايو
mt - Malti
mus - Mvskoke
mwl - Mirandés
my - မြန်မာဘာသာ
myv - эрзянь
mzn - مازِرونی
na - Dorerin Naoero
nah - Nāhuatl
nan - Bân-lâm-gú
nap - Napulitano
nb - norsk bokmål
nds - Plattdüütsch
nds-nl - Nedersaksies
ne - नेपाली
new - नेपाल भाषा
ng - Oshiwambo
nia - Li Niha
niu - Niuē
nl - Nederlands
nl-informal - Nederlands (informeel)
nmz - nawdm
nn - norsk nynorsk
no - norsk
nod - ᨣᩤᩴᨾᩮᩬᩥᨦ
nog - ногайша
nov - Novial
nqo - ߒߞߏ
nrm - Nouormand
nso - Sesotho sa Leboa
nv - Diné bizaad
ny - Chi-Chewa
nyn - runyankore
nys - Nyunga
oc - occitan
ojb - Ojibwemowin
olo - livvinkarjala
om - Oromoo
or - ଓଡ଼ିଆ
os - ирон
pa - ਪੰਜਾਬੀ
pag - Pangasinan
pam - Kapampangan
pap - Papiamentu
pcd - Picard
pcm - Naijá
pdc - Deitsch
pdt - Plautdietsch
pfl - Pälzisch
pi - पालि
pih - Norfuk / Pitkern
pl - polski
pms - Piemontèis
pnb - پنجابی
pnt - Ποντιακά
prg - prūsiskan
ps - پښتو
pt - português
pt-br - português do Brasil
pwn - pinayuanan
qqq - Message documentation
qu - Runa Simi
qug - Runa shimi
rgn - Rumagnôl
rif - Tarifit
rki - ရခိုင်
rm - rumantsch
rmc - romaňi čhib
rmy - romani čhib
rn - ikirundi
ro - română
roa-tara - tarandíne
rsk - руски
ru - русский
rue - русиньскый
rup - armãneashti
ruq - Vlăheşte
ruq-cyrl - Влахесте
ruq-latn - Vlăheşte
rw - Ikinyarwanda
ryu - うちなーぐち
sa - संस्कृतम्
sah - саха тыла
sat - ᱥᱟᱱᱛᱟᱲᱤ
sc - sardu
scn - sicilianu
sco - Scots
sd - سنڌي
sdc - Sassaresu
sdh - کوردی خوارگ
se - davvisámegiella
se-fi - davvisámegiella (Suoma bealde)
se-no - davvisámegiella (Norgga bealde)
se-se - davvisámegiella (Ruoŧa bealde)
sei - Cmique Itom
ses - Koyraboro Senni
sg - Sängö
sgs - žemaitėška
sh - srpskohrvatski / српскохрватски
sh-cyrl - српскохрватски (ћирилица)
sh-latn - srpskohrvatski (latinica)
shi - Taclḥit
shi-latn - Taclḥit
shi-tfng - ⵜⴰⵛⵍⵃⵉⵜ
shn - ၽႃႇသႃႇတႆး
shy - tacawit
shy-latn - tacawit
si - සිංහල
simple - Simple English
sjd - кӣллт са̄мь кӣлл
sje - bidumsámegiella
sk - slovenčina
skr - سرائیکی
skr-arab - سرائیکی
sl - slovenščina
sli - Schläsch
sm - Gagana Samoa
sma - åarjelsaemien
smn - anarâškielâ
sms - nuõrttsääʹmǩiõll
sn - chiShona
so - Soomaaliga
sq - shqip
sr - српски / srpski
sr-ec - српски (ћирилица)
sr-el - srpski (latinica)
srn - Sranantongo
sro - sardu campidanesu
ss - SiSwati
st - Sesotho
stq - Seeltersk
sty - себертатар
su - Sunda
sv - svenska
sw - Kiswahili
syl - ꠍꠤꠟꠐꠤ
szl - ślůnski
szy - Sakizaya
ta - தமிழ்
tay - Tayal
tcy - ತುಳು
tdd - ᥖᥭᥰᥖᥬᥳᥑᥨᥒᥰ
te - తెలుగు
tet - tetun
tg - тоҷикӣ
tg-cyrl - тоҷикӣ
tg-latn - tojikī
th - ไทย
ti - ትግርኛ
tk - Türkmençe
tl - Tagalog
tly - tolışi
tly-cyrl - толыши
tn - Setswana
to - lea faka-Tonga
tok - toki pona
tpi - Tok Pisin
tr - Türkçe
tru - Ṫuroyo
trv - Seediq
ts - Xitsonga
tt - татарча / tatarça
tt-cyrl - татарча
tt-latn - tatarça
tum - chiTumbuka
tw - Twi
ty - reo tahiti
tyv - тыва дыл
tzm - ⵜⴰⵎⴰⵣⵉⵖⵜ
udm - удмурт
ug - ئۇيغۇرچە / Uyghurche
ug-arab - ئۇيغۇرچە
ug-latn - Uyghurche
uk - українська
ur - اردو
uz - oʻzbekcha / ўзбекча
uz-cyrl - ўзбекча
uz-latn - oʻzbekcha
ve - Tshivenda
vec - vèneto
vep - vepsän kel’
vi - Tiếng Việt
vls - West-Vlams
vmf - Mainfränkisch
vmw - emakhuwa
vo - Volapük
vot - Vaďďa
vro - võro
wa - walon
wal - wolaytta
war - Winaray
wls - Fakaʻuvea
wo - Wolof
wuu - 吴语
xal - хальмг
xh - isiXhosa
xmf - მარგალური
xsy - saisiyat
yi - ייִדיש
yo - Yorùbá
yrl - Nhẽẽgatú
yue - 粵語
za - Vahcuengh
zea - Zeêuws
zgh - ⵜⴰⵎⴰⵣⵉⵖⵜ ⵜⴰⵏⴰⵡⴰⵢⵜ
zh - 中文
zh-cn - 中文(中国大陆)
zh-hans - 中文(简体)
zh-hant - 中文(繁體)
zh-hk - 中文(香港)
zh-mo - 中文(澳門)
zh-my - 中文(马来西亚)
zh-sg - 中文(新加坡)
zh-tw - 中文(臺灣)
zu - isiZulu
Format
Export for off-line translation
Export in native format
Export in CSV format
Fetch
{{DISPLAYTITLE:Doxygen}}<languages/> <span id="About"></span> == Über == {{TOCright}} Doxygen ist ein beliebtes Werkzeug zur Generierung von Dokumentation aus kommentierten C++ Quellen; es unterstützt auch andere gängige Programmiersprachen wie C#, PHP, Java und Python. Besuche die [http://www.doxygen.nl/ Doxygen Website], um mehr über das System zu erfahren, und konsultiere das [http://www.doxygen.nl/manual/index.html Doxygen Handbuch] für die vollständigen Informationen. <span id="Doxygen_and_FreeCAD"></span> == Doxygen und FreeCAD == Dieses Dokument gibt eine kurze Einführung in Doxygen, insbesondere wie es in FreeCAD zur Dokumentation seiner Quellen verwendet wird. Auf der Seite [[source documentation/de|Quelldokumentation]] findest Du Anweisungen zum Erstellen der FreeCAD Dokumentation, die ebenfalls online auf der [https://www.freecadweb.org/api/ FreeCAD API Website] bereitgestellt wird. [[File:FreeCAD_doxygen_workflow.svg|800px]] {{Caption|Allgemeiner Arbeitsablauf zur Erstellung von Quellcode Dokumentation mit Doxygen.}} <span id="Doxygen_with_C++_code"></span> == Doxygen mit C++ Code == Der Abschnitt [http://www.doxygen.nl/manual/starting.html Getting started (Step 3)] im Doxygen Handbuch erwähnt die grundlegenden Möglichkeiten der Dokumentation der Quellen. Für Mitglieder, Klassen und Namensräume gibt es grundsätzlich zwei Möglichkeiten: # Platziere einen speziellen "Dokumentationsblock" (einen kommentierten Absatz) vor der Deklaration oder Definition der Funktion, des Elements, der Klasse oder des Namensraums. Bei Datei-, Klassen- und Namensraumelementen (Variablen) ist es auch erlaubt, die Dokumentation direkt nach dem Element zu platzieren. Siehe Abschnitt [http://www.doxygen.nl/manual/docblocks.html#specialblock Spezielle Kommentarblöcke] im Handbuch, um mehr über diese Blöcke zu erfahren. # Platziere einen speziellen Dokumentationsblock an einer anderen Stelle (eine andere Datei oder einen anderen Ort in der gleichen Datei) und füge einen "Strukturbefehl" in den Dokumentationsblock ein. Ein Strukturbefehl verknüpft einen Dokumentationsblock mit einer bestimmten zu dokumentierenden Einheit (Funktion, Element, Variable, Klasse, Namensraum oder Datei). Siehe Abschnitt [http://www.doxygen.nl/manual/docblocks.html#structuralcommands Dokumentation an anderer Stelle] im Handbuch, um mehr über Strukturbefehle zu erfahren. Hinweis: *Der Vorteil der ersten Option ist, dass du den Namen der Einheit (Funktion, Element, Variable, Klasse oder Namensraum) nicht wiederholen musst, da Doxygen den Code analysiert und die relevanten Informationen extrahiert. *Dateien können nur mit der zweiten Option dokumentiert werden, da es keine Möglichkeit gibt, einen Dokumentationsblock vor eine Datei zu stellen. Natürlich benötigen Dateimitglieder (Funktionen, Variablen, Typedefinitionen, Definitionen) keinen expliziten Strukturbefehl; einfach einen Dokumentationsblock vor oder nach ihnen zu setzen, wird gut funktionieren. <span id="First_style:_documentation_block_before_the_code"></span> === Erster Stil: Dokumentationsblock vor dem Kode === Normalerweise möchtest du den Code in der Kopfzeilendatei dokumentieren, kurz vor der Klassendeklaration oder dem Funktionsprototyp. Dadurch bleiben Deklaration und Dokumentation dicht beieinander, so dass es einfach ist, letztere zu aktualisieren, wenn sich die erste ändert. Der spezielle Dokumentationsblock beginnt wie ein Kommentar im C-Stil {{incode|/*}}, hat aber ein zusätzliches Sternchen, also {{incode|/**}}; der Block endet mit einem passenden {{incode|*/}}. Eine Alternative ist die Verwendung von Kommentaren im C++-Stil {{incode|//}} mit einem zusätzlichen Schrägstrich, also {{incode|////}}. {{Code|code= /** * Returns the name of the workbench object. */ std::string name() const; /** * Set the name to the workbench object. */ void setName(const std::string&); /// remove the added TaskWatcher void removeTaskWatcher(void); }} <span id="Second_style:_documentation_block_elsewhere"></span> === Zweiter Stil: Dokumentationsblock an anderer Stelle === Alternativ kann die Dokumentation auch in einer anderen Datei (oder in derselben Datei oben, unten oder wo auch immer) abgelegt werden, weg von der Klassendeklaration oder dem Funktionsprototyp. In diesem Fall hast du duplizierte Informationen, einmal in der eigentlichen Quelldatei und einmal in der Dokumentationsdatei. Erste Datei, {{incode|source.h}}: {{Code|code= std::string name() const; void setName(const std::string&); }} Zweite Datei, {{incode|source.h.dox}}: {{Code|code= /** \file source.h * \brief The documentation of source.h * * The details of this file go here. */ /** \fn std::string name() const; * \brief Returns the name of the workbench object. */ /** \fn void setName(const std::string&); * \brief Set the name to the workbench object. */ }} In diesem Fall wird der Strukturbefehl {{incode|\file}} verwendet, um anzugeben, welche Quelldatei dokumentiert wird; ein Strukturbefehl {{incode|\fn}} zeigt an, dass der folgende Code eine Funktion ist, und der Befehl {{incode|\brief}} wird verwendet, um eine kleine Beschreibung dieser Funktion zu geben. Diese Art der Dokumentation einer Quelldatei ist nützlich, wenn du nur Dokumentation zu deinem Projekt hinzufügen möchtest, ohne echten Code hinzuzufügen. Wenn du einen Kommentar-Block in eine Datei mit einer der folgenden Erweiterungen {{incode|.dox}}, {{incode|.txt}}, {{incode|.txt}} oder {{incode|.doc}} platzierst, dann wird Doxygen die Kommentare analysieren und die entsprechende Dokumentation erstellen, aber es wird diese Hilfsdatei aus der Dateiliste ausblenden. Das FreeCAD Projekt fügt in vielen Verzeichnissen mehrere Dateien mit der Endung {{incode|.dox}} hinzu, um eine Beschreibung oder Beispiele für den dortigen Code zu liefern. Es ist wichtig, dass solche Dateien korrekt in einer Gruppe oder einem Namensraum kategorisiert werden, für die Doxygen einige Hilfsbefehle wie {{incode|\defgroup}}, {{incode|\ingroup}}, {{incode|\ingroup}}, und {{incode|\namespace}} bereitstellt. <div class="mw-collapsible mw-collapsed toccolours"> Beispiel {{incode|src/Base/core-base.dox}}; diese Datei im FreeCAD Quellbaum gibt eine kurze Erklärung des Namensraums {{incode|Base}}. <div class="mw-collapsible-content"> {{Code|code= /** \defgroup BASE Base * \ingroup CORE \brief Basic structures used by other FreeCAD components The Base module includes most of the basic functions of FreeCAD, such as: - Console services: printing different kinds of messages to the FreeCAD report view or the terminal - Python interpreter: handles the execution of Python code in FreeCAD - Parameter handling: Management, saving and restoring of user preferences settings - Units: Management and conversion of different units */ /*! \namespace Base \ingroup BASE \brief Basic structures used by other FreeCAD components The Base module includes most of the basic functions of FreeCAD, such as: - Console services: printing different kinds of messages to the FreeCAD report view or the terminal - Python interpreter: handles the execution of Python code in FreeCAD - Parameter handling: Management, saving and restoring of user preferences settings - Units: Management and conversion of different units */ }} </div> </div> Ein weiteres Beispiel ist die Datei {{incode|src/Gui/Command.cpp}}. Vor den Implementierungsdetails der Methoden {{incode|Gui::Command}} gibt es einen Dokumentationsblock, der einige Details des Befehlsrahmens von FreeCAD erklärt. Es verfügt über verschiedene {{incode|\section}} Befehle, um die Dokumentation zu strukturieren. Es beinhaltet sogar Beispielcode, der in einem Paar von {{incode|\code}} und {{incode|\endcode}} Schlüsselwörtern eingeschlossen ist; wenn die Datei von Doxygen verarbeitet wird, wird dieses Code-Beispiel speziell formatiert, um sich abzuheben. Das Schlüsselwort {{incode|\ref}} wird an mehreren Stellen verwendet, um Links zu benannten Abschnitten, Unterabschnitten, Seiten oder Ankern an anderer Stelle in der Dokumentation zu erstellen. Ebenso drucken die Befehle {{incode|\see}} oder {{incode|\sa}} "Siehe auch" und stellen einen Link zu anderen Klassen, Funktionen, Methoden, Variablen, Dateien oder URLs dar. <div class="mw-kollabierbare mw-kollabierte toccolours"> Beispiel {{incode|src/Gui/Command.cpp}} <div class="mw-collapsible-content"> {{Code|code= /** \defgroup commands Command Framework \ingroup GUI \brief Structure for registering commands to the FreeCAD system * \section Overview * In GUI applications many commands can be invoked via a menu item, a toolbar button or an accelerator key. The answer of Qt to master this * challenge is the class \a QAction. A QAction object can be added to a popup menu or a toolbar and keep the state of the menu item and * the toolbar button synchronized. * * For example, if the user clicks the menu item of a toggle action then the toolbar button gets also pressed * and vice versa. For more details refer to your Qt documentation. * * \section Drawbacks * Since QAction inherits QObject and emits the \a triggered() signal or \a toggled() signal for toggle actions it is very convenient to connect * these signals e.g. with slots of your MainWindow class. But this means that for every action an appropriate slot of MainWindow is necessary * and leads to an inflated MainWindow class. Furthermore, it's simply impossible to provide plugins that may also need special slots -- without * changing the MainWindow class. * * \section wayout Way out * To solve these problems we have introduced the command framework to decouple QAction and MainWindow. The base classes of the framework are * \a Gui::CommandBase and \a Gui::Action that represent the link between Qt's QAction world and the FreeCAD's command world. * * The Action class holds a pointer to QAction and CommandBase and acts as a mediator and -- to save memory -- that gets created * (@ref Gui::CommandBase::createAction()) not before it is added (@ref Gui::Command::addTo()) to a menu or toolbar. * * Now, the implementation of the slots of MainWindow can be done in the method \a activated() of subclasses of Command instead. * * For example, the implementation of the "Open file" command can be done as follows. * \code * class OpenCommand : public Command * { * public: * OpenCommand() : Command("Std_Open") * { * // set up menu text, status tip, ... * sMenuText = "&Open"; * sToolTipText = "Open a file"; * sWhatsThis = "Open a file"; * sStatusTip = "Open a file"; * sPixmap = "Open"; // name of a registered pixmap * sAccel = "Shift+P"; // or "P" or "P, L" or "Ctrl+X, Ctrl+C" for a sequence * } * protected: * void activated(int) * { * QString filter ... // make a filter of all supported file formats * QStringList FileList = QFileDialog::getOpenFileNames( filter,QString::null, getMainWindow() ); * for ( QStringList::Iterator it = FileList.begin(); it != FileList.end(); ++it ) { * getGuiApplication()->open((*it).latin1()); * } * } * }; * \endcode * An instance of \a OpenCommand must be created and added to the \ref Gui::CommandManager to make the class known to FreeCAD. * To see how menus and toolbars can be built go to the @ref workbench. * * @see Gui::Command, Gui::CommandManager */ }} </div> </div> <span id="Example_from_the_VTK_project"></span> === Beispiel aus dem VTK Projekt === Dies ist ein Beispiel aus [https://vtk.org/ VTK], einer 3D Visualisierungsbibliothek, die zur Darstellung wissenschaftlicher Daten wie Finite Elemente Ergebnisse und Punktwolkeninformationen verwendet wird. Eine Klasse zum Speichern einer Sammlung von Koordinaten wird in einer C++ Kopfzeilendatei definiert. Der obere Teil der Datei wird kommentiert, und es werden einige Schlüsselwörter verwendet, wie {{incode|@class}}, {{incode|@brief}}, und {{incode|@sa}}, um wichtige Teile zu kennzeichnen. Innerhalb der Klasse, vor den Prototypen der Klassenmethode, erklärt ein Block aus kommentiertem Text, was die Funktion tut und welche Argumente sie hat. * Quellcode von [https://github.com/Kitware/VTK/blob/master/Common/Core/vtkArrayCoordinates.h vtkArrayCoordinates.h]. * Doxygen hat die Dokumentation für die [http://www.vtk.org/doc/nightly/html/classvtkArrayCoordinates.html vtkArrayCoordinates class] erstellt. <span id="Compiling_the_documentation"></span> === Zusammenstellung der Dokumentation === [[File:FreeCAD_doxygen_workflow.svg|800px]] {{Caption|Allgemeiner Arbeitsablauf zur Erstellung von Quellcode Dokumentation mit Doxygen.}} Um die Quellcode Dokumentation zu erstellen, gibt es zwei grundlegende Schritte: # Erstelle eine Konfigurationsdatei, um zu steuern, wie Doxygen die Quelldateien verarbeiten soll. # Führe {{incode|doxygen}} in dieser Konfiguration aus. <div class="mw-collapsible mw-collapsed toccolours"> Der Prozess wird im Folgenden beschrieben. <div class="mw-collapsible-content"> * Stelle sicher, dass die Programme {{incode|doxygen}} und {{incode|doxywizard}} in Deinem System vorhanden sind. Es wird auch empfohlen, das Programm {{incode|dot}} von [https://www.graphviz.org/ Graphviz] zu verwenden, um Diagramme mit den Beziehungen zwischen Klassen und Namensräumen zu erzeugen. Auf Linux Systemen können diese Programme über Ihren Paketmanager installiert werden. {{Code|code= sudo apt install doxygen doxygen-gui graphviz }} * Stelle sicher, dass Du Dich im gleichen Ordner wie Deine Quelldateien befindest, oder im Toplevel Verzeichnis Deines Quellbaums, wenn Du viele Quelldateien in verschiedenen Unterverzeichnissen hast. {{Code|code= cd toplevel-source }} * Führe {{incode|doxygen -g DoxyDoc.cfg}} aus, um eine Konfigurationsdatei namens {{incode|DoxyDoc.cfg}} zu erstellen. Wenn Du diesen Namen weglässt, wird er standardmäßig auf {{incode|Doxyfile}} ohne Erweiterung gesetzt. * Dies ist eine große, einfache Textdatei, die viele Variablen mit ihren Werten enthält. Im Doxygen Handbuch werden diese Variablen als "Tags" bezeichnet. Die Konfigurationsdatei und alle Tags sind im Abschnitt [http://www.doxygen.nl/manual/config.html Konfiguration] des Handbuchs ausführlich beschrieben. Du kannst die Datei mit einem beliebigen Texteditor öffnen und den Wert jedes Tags nach Bedarf bearbeiten. In der gleichen Datei kannst du Kommentare lesen, die jedes der Tags und seine Standardwerte erklären. {{Code|code= DOXYFILE_ENCODING = UTF-8 PROJECT_NAME = "My Project" PROJECT_NUMBER = PROJECT_BRIEF = PROJECT_LOGO = OUTPUT_DIRECTORY = CREATE_SUBDIRS = NO ALLOW_UNICODE_NAMES = NO BRIEF_MEMBER_DESC = YES REPEAT_BRIEF = YES ... }} * Anstatt einen Texteditor zu verwenden, kannst du {{incode|doxywizard}} starten, um viele Tags gleichzeitig zu bearbeiten. Mit dieser Schnittstelle kannst du viele Eigenschaften definieren, wie z.B. Projektinformationen, Art der Ausgabe (HTML und LaTeX), Verwendung von Graphviz zur Erstellung von Diagrammen, Warnmeldungen zur Anzeige, Dateimuster (Erweiterungen) zum Dokumentieren oder Ausschließen, Eingabefilter, optionale Kopf- und Fußzeilen für die von HTML generierten Seiten, Optionen für LaTeX-, RTF-, XML- oder Docbook-Ausgaben und viele andere Optionen. {{Code|code= doxywizard DoxyDoc.cfg }} * Eine weitere Möglichkeit besteht darin, die Konfigurationsdatei von Grund auf neu zu erstellen und nur die Tags hinzuzufügen, die du mit einem Texteditor willst. * Nachdem die Konfiguration gespeichert wurde, kannst du Doxygen auf dieser Konfigurationsdatei ausführen. {{Code|code= doxygen DoxyDoc.cfg }} * Die erzeugte Dokumentation wird in einem Ordner namens {{incode|toplevel-source/html}} erstellt. Es wird aus vielen HTML Seiten, PNG Bildern für Grafiken, Cascading Style Sheets ({{incode|.css}}), Javascript Dateien ({{incode|.js}}) und möglicherweise vielen Unterverzeichnissen mit mehr Dateien je nach Größe Ihres Codes bestehen. Der Einstiegspunkt in die Dokumentation ist {{incode|index.html}}, den du mit einem Webbrowser öffnen kannst. {{Code|code= xdg-open toplevel-source/html/index.html }} </div> </div> Wenn du neue Klassen, Funktionen oder eine ganze neue Arbeitsbereiche schreibst, wird empfohlen, {{incode|doxygen}} regelmäßig auszuführen, um sicherzustellen, dass die Dokumentationsblöcke [[#Markdown support|Markdown]] und [[#Doxygen markup/de|Spezielle Befehle]] korrekt gelesen werden und dass alle öffentlichen Funktionen vollständig dokumentiert sind. Bitte lies auch die [https://github.com/FreeCAD/FreeCAD/blob/master/src/Doc/doctips.dox Dokumentationshinweise] im Quellcode. Bei der Generierung der kompletten FreeCAD Dokumentation führe {{incode|doxygen}} nicht direkt aus. Stattdessen verwende das Projekt {{incode|cmake}}, um die Build Umgebung zu konfigurieren, und löst dann {{incode|make}} die Kompilierung der FreeCAD Quellen und der Doxygen Dokumentation aus; dies wird auf der Seite [[source documentation/de|Quell Dokumentation]] erläutert. <span id="Doxygen_markup"></span> == Doxygen Auszeichnung == Alle Doxygen [http://www.doxygen.nl/manual/commands.html Befehlsdokumentation] beginnt mit einem Backslash {{incode|\\}} oder einem at Symbol {{incode|@}}, je nach Wunsch. Normalerweise wird der Backslash {{incode|\\}} verwendet, aber gelegentlich wird der {{incode|@}} verwendet, um die Lesbarkeit zu verbessern. Die Befehle können ein oder mehrere Argumente haben. Im Doxygen Handbuch werden die Argumente wie folgt beschrieben. * Wenn {{incode|<sharp>}} Klammern verwendet werden, ist das Argument ein einzelnes Wort. * Wenn {{incode|(round)}} Klammern verwendet werden, erstreckt sich das Argument bis zum Ende der Zeile, in der der Befehl gefunden wurde. * Wenn <code>{curly}</code> Klammern verwendet werden, verlängert sich das Argument bis zum nächsten Absatz. Absätze werden durch eine Leerzeile oder durch ein Abschnittskennzeichen begrenzt. * Wenn {{incode|[square]}} Klammern verwendet werden, ist das Argument optional. <div class="mw-collapsible mw-collapsed toccolours"> Einige der häufigsten Schlüsselwörter, die in der FreeCAD Dokumentation verwendet werden, sind hier aufgeführt. <div class="mw-collapsible-content"> * <code>\defgroup <name> (Gruppentitel) </code>, siehe [http://www.doxygen.nl/manual/commands.html#cmddefgroup \defgroup], und[http://www.doxygen.nl/manual/grouping.html Gruppierung]. * <code>\ingroup (<groupname> [<groupname> <groupname> <groupname>])</code>, siehe[http://www.doxygen.nl/manual/commands.html#cmdingroup \ingroup], und[http://www.doxygen.nl/manual/grouping.html Gruppierung]. <code>\addtogroup <name> <name> [(title)]</code>, siehe [http://www.doxygen.nl/manual/commands.html#cmdaddtogroup \addtogroup], und[http://www.doxygen.nl/manual/grouping.html Gruppierung]. * <code>\author { list of authors }</code>, siehe [http://www.doxygen.nl/manual/commands.html#cmdauthor \author]; gibt den Autor dieses Stückes Code an. * <code>\brief {kurze Beschreibung }</code>, siehe [http://www.doxygen.nl/manual/commands.html#cmdbrief \brief]; beschreibt kurz die Funktion. * <code>\file [<name>]</code>, siehe [http://www.doxygen.nl/manual/commands.html#cmdfile \file]; dokumentiert eine Quell- oder Header-Datei. * <code>\page <name> (title)</code>, siehe [http://www.doxygen.nl/manual/commands.html#cmdpage \page]; stellt die Informationen auf eine separate Seite, nicht direkt in Bezug stehend mit einer bestimmten Klasse, Datei oder einem Mitglied. * <code>\package <name></code>, siehe[http://www.doxygen.nl/manual/commands.html#cmdpackage \package]; zeigt die Dokumentation für ein Java Paket an (wird aber auch mit Python verwendet). * <code>\fn (Funktionsdeklaration)</code>, siehe [http://www.doxygen.nl/manual/commands.html#cmdfn \fn]; dokumentiert eine Funktion. * <code>\var (Variablendeklaration)</code>, siehe [http://www.doxygen.nl/manual/commands.html#cmdvar \var]; dokumentiert eine Variable; sie entspricht {{incode|\fn}}, {{incode|\property}}, und {{incode|\typedef}}. * <code>\section <section-name> (section title)</code>, siehe[http://www.doxygen.nl/manual/commands.html#cmdsection \section]; startet einen Abschnitt. <code>\subsection <subsection-name> (subection title)</code>, siehe[http://www.doxygen.nl/manual/commands.html#cmdsubsection \subsection]; startet einen Unterabschnitt. * <code>\namespace <name></code>, siehe[http://www.doxygen.nl/manual/commands.html#cmdnamespace \namespace]; zeigt Informationen für einen Namensraum an. * <code>\cond [(section-label)]</code>, und <code>\endcond</code>, siehe[http://www.doxygen.nl/manual/commands.html#cmdcond \cond]; definiert einen Block, der bedingt dokumentiert oder weggelassen werden soll. * <code>\a <word></code>, siehe[http://www.doxygen.nl/manual/commands.html#cmda \a]; zeigt das Argument kursiv zur Hervorhebung an. * <code>\param [(dir)] <parameter-name> { parameter description }</code>, siehe[http://www.doxygen.nl/manual/commands.html#cmdparam \param]; gibt den Parameter einer Funktion an. <code>\return { Beschreibung des Rückgabewertes }</code>, siehe[http://www.doxygen.nl/manual/commands.html#cmdreturn \return]; gibt den Rückgabewert an. * <code>\sa { Referenzen }</code>, siehe [http://www.doxygen.nl/manual/commands.html#cmdsa \sa]; druckt "Siehe auch". * <code>\note { text }</code>, siehe[http://www.doxygen.nl/manual/commands.html#cmdnote \note]; fügt einen Absatz hinzu, der als Notiz verwendet werden soll. </div> </div> <span id="Markdown_support"></span> == Markdown Unterstützung == Seit Doxygen 1.8 wird die Markdown Syntax in Dokumentationsblöcken erkannt. Markdown ist eine minimalistische Formatierungssprache, die von einfachen Text Emails inspiriert ist, die, ähnlich wie die Wiki Syntax, einfach und lesbar sein soll, ohne komplizierten Code wie den in HTML, LaTeX oder Doxygens eigenen Befehlen zu benötigen. Markdown hat bei freier Software an Popularität gewonnen, insbesondere in Online Plattformen wie Github, da es die Erstellung von Dokumentation ohne komplizierten Code ermöglicht. Weitere Informationen finden sich im Abschnitt [http://www.doxygen.nl/manual/markdown.html Markdown Support] im Doxygen Handbuch. Besuche die [https://daringfireball.net/projects/markdown/ Markdown Webseite], um mehr über den Ursprung und die Philosophie von Markdown zu erfahren. Doxygen unterstützt einen Standardsatz von Markdown Anweisungen sowie einige Erweiterungen wie z.B. [https://github.github.com/github-flavored-markdown/ Github Markdown]. <div class="mw-collapsible mw-collapsed toccolours"> Im Folgenden werden einige Beispiele für die Formatierung von Markdown vorgestellt. <div class="mw-collapsible-content"> Das Folgende ist Standard Markdown. {{Code|code= Hier ist der Text für einen Absatz. Wir machen mit mehr Text in einem anderen Absatz weiter. Dies ist eine Level 1 Kopfzeile ======================== Dies ist eine Level 2 Kopfzeile. ------------------------ # Dies ist ein Level 1 Kopfteil ### Dies ist ein Level 3 Kopfteil ####### > Dies ist ein Blockzitat > über mehrere Linien hinweg - Punkt 1 Mehr Text für dieses Element. - Punkt 2 * Verschachtelte Listenelemente. * ein weiteres verschachteltes Element. - Punkt 3 1. Erstes Element. 2. Zweites Element. *einzelne Sternchen: Hervorhebung* _single underscores_ **double asterisks: strong emphasis** __double underscores__ Dies ist ein normaler Abschnitt Dies ist ein Codeblock Wir fahren mit einem normalen Absatz fort. Use the `printf()` function. Inline `code`. [The link text](http://example.net/) ![Caption text](/path/to/img.jpg) <http://www.example.com> }} Die folgenden sind Markdown Erweiterungen. <pre> [TOC] Erste Kopfzeile | Zweite Kopfzeile ------------- | ------------- Zellinhalt | Zellinhalt Zellinhalt | Zellinhalt <nowiki>~~~~~~~~~~~~~</nowiki>{.py} # Eine Klasse class Dummy: pass <nowiki>~~~~~~~~~~~~~</nowiki> <nowiki>~~~~~~~~~~~~~</nowiki>{.c} int func(int a, int b) { return a*b; } <nowiki>~~~~~~~~~~~~~</nowiki> ``` int func(int a, int b) { return a*b; } ``` </pre> </div> </div> <span id="Parsing_of_documentation_blocks"></span> == Zerteilen von Dokumentationsblöcken == Der Text in einem speziellen Dokumentationsblock wird analysiert, bevor er in die HTML- und LaTeX Ausgabedateien geschrieben wird. Beim Zertilen (engl.: Parsen) finden die folgenden Schritte statt: * Die Markdown Formatierung wird durch entsprechendes HTML oder spezielle Befehle ersetzt. * Die speziellen Befehle innerhalb der Dokumentation werden ausgeführt. Siehe Abschnitt [http://www.doxygen.nl/manual/commands.html Spezielle Befehle] im Handbuch für eine Erklärung der einzelnen Befehle. * Wenn eine Zeile mit einem Leerzeichen beginnt, gefolgt von einem oder mehreren Sternchen ({{incode|*}}) und dann optional mehr Leerzeichen, dann werden alle Leerzeichen und Sternchen entfernt. * Alle resultierenden Leerzeilen werden als Absatztrennzeichen behandelt. * Links werden automatisch für Wörter erstellt, die den dokumentierten Klassen oder Funktionen entsprechen. Wenn dem Wort ein Prozentsymbol {{incode|%}} vorangestellt ist, wird dieses Symbol entfernt und es wird keine Verknüpfung für das Wort erstellt. * Links werden erstellt, wenn bestimmte Muster im Text gefunden werden. Weitere Informationen finden Sie im Abschnitt [http://www.doxygen.nl/manual/autolink.html Automatische Linkerzeugung] im Handbuch. * HTML-Tags, die sich in der Dokumentation befinden, werden interpretiert und für die LaTeX Ausgabe in LaTeX Äquivalente umgewandelt. Siehe den Abschnitt [http://www.doxygen.nl/manual/htmlcmds.html HTML-Befehle] im Handbuch für eine Erklärung der einzelnen unterstützten HTML-Tags. <span id="Doxygen_with_Python_code"></span> == Doxygen mit Python Code == Doxygen funktioniert am besten für statisch typisierte Sprachen wie C++. Es kann aber auch eine [http://www.doxygen.nl/manual/docblocks.html#pythonblocks Dokumentation für Python-Dateien] erstellen. Es gibt zwei Möglichkeiten, Dokumentationsblöcke für Python zu schreiben: # Der pythonische Weg, mit "docstrings", d.h. ein Textblock, der von <code><nowiki>'''triple quotes'''</nowiki></code> unmittelbar nach der Klassen- oder Funktionsdefinition umgeben ist. # Der Doxygen Weg, bei dem Kommentare vor die Klassen- oder Funktionsdefinition gestellt werden; in diesem Fall werden doppelte Hash-Zeichen {{incode|###}} verwendet, um den Dokumentationsblock zu starten, und dann kann ein einzelnes Hash Zeichen in nachfolgenden Zeilen verwendet werden. Hinweis: * Die erste Option wird bevorzugt, um [https://www.python.org/dev/peps/pep-0008/#documentation-strings PEP8], [https://www.python.org/dev/peps/pep-0257/ PEP257] und die meisten Stilrichtlinien für das Schreiben von Python zu erfüllen (siehe [https://realpython.com/python-pep8/ 1], [https://realpython.com/documenting-python-code/ 2]). Es wird empfohlen, diesen Stil zu verwenden, wenn du beabsichtigst, dokumentierte Quellen mit [https://www.sphinx-doc.org/en/master/ Sphinx] zu erzeugen, einem sehr gebräuchlichen Werkzeug zur Dokumentation von Python Code. Wenn Du diesen Stil verwendest, kann Doxygen die Kommentare wörtlich extrahieren, aber spezielle Doxygen Befehle, die mit {{incode|\\}} oder {{incode|@}} beginnen, funktionieren nicht. * Die zweite Option ist nicht der traditionelle Python Stil, aber sie erlaubt es Dir, die speziellen Befehle von Doxygen wie {{incode|\param}} und {{incode|\var}} zu verwenden. <span id="First_style:_Pythonic_documentation"></span> === Erster Stil: Pythonische Dokumentation === Im folgenden Beispiel steht am Anfang eine docstring, um den allgemeinen Inhalt dieses Moduls (Datei) zu erklären. Dann erscheinen docstrings innerhalb der Funktions-, Klassen- und Klassenmethodendefinitionen. Auf diese Weise extrahiert Doxygen die Kommentare und präsentiert sie so, wie sie sind, ohne Änderungen. {{Code|code= '''@package pyexample_a DoKumentation für dieses Modul. Mehr Details. ''' def func(): '''DoKumentation für eine Funktion. Mehr Details. ''' pass class PyClass: '''DoKumentation für eine Klasse. Mehr Details.. ''' def __init__(self): '''Der Konstrukteur.''' self._memVar = 0 def PyMethod(self): '''DoKumentation für eine Methode.''' pass }} <span id="Second_style:_documentation_block_before_the_code"></span> === Zweiter Stil: Dokumentationsblock vor dem Code === Im folgenden Beispiel beginnen die Dokumentationsblöcke mit doppelten Hashzeichen {{incode|###}}. Am Anfang erscheint eine, um den allgemeinen Inhalt dieses Moduls (Datei) zu erklären. Dann gibt es Blöcke vor den Definitionen von Funktions-, Klassen- und Klassenmethoden, und es gibt einen Block nach einer Klassenvariablen. Auf diese Weise extrahiert Doxygen die Dokumentation, erkennt die speziellen Befehle {{incode|@package}}, {{incode|@param}}, und {{incode|@var}} und formatiert den Text entsprechend. {{Code|code= ## @package pyexample_b # Documentation for this module. # # More details. ## Documentation for a function. # # More details. def func(): pass ## Documentation for a class. # # More details. class PyClass: ## The constructor. def __init__(self): self._memVar = 0 ## Documentation for a method. # @param self The object pointer. def PyMethod(self): pass ## A class variable. classVar = 0 ## @var _memVar # a member variable }} <span id="Compiling_the_documentation"></span> === Zusammenstellung der Dokumentation === Die Kompilierung der Dokumentation erfolgt wie bei [[#Compilierung der Dokumentation/de|für C++ Quellen]]. Wenn sich beide Python Dateien, {{incode|pyexample_a.py}} und {{incode|pyexample_b.py}}, mit eigenem Kommentarstil im gleichen Verzeichnis befinden, werden beide verarbeitet. {{Code|code= cd toplevel-source/ doxygen -g doxygen Doxyfile xdg-open ./html/index.html }} Die Dokumentation sollte ähnliche Informationen wie die folgenden enthalten und entsprechende Verknüpfungen zu den einzelnen Modulen und Klassen herstellen. {{Code|code= Class List Here are the classes, structs, unions and interfaces with brief descriptions: N pyexample_a C PyClass N pyexample_b Documentation for this module C PyClass Documentation for a class }} <span id="Converting_the_Pythonic_style_to_Doxygen_style"></span> === Umwandlung des pythonischen Stils in den Doxygen Stil === Im vorherigen Beispiel zeigt die Python Datei, die in einem [[#Second style: documentation block before the code/de|Doxygen Stil]] kommentiert wird, detailliertere Informationen und Formatierungen für ihre Klassen, Funktionen und Variablen. Der Grund dafür ist, dass dieser Stil es Doxygen erlaubt, die speziellen Befehle zu extrahieren, die mit {{incode|\\}} oder {{incode|@}} beginnen, während der [[#First style: Pythonic documentation/de|Pythonischer Stil]] dies nicht tut. Daher wäre es wünschenswert, den pythonischen Stil in den Doxygen Stil zu konvertieren, bevor die Dokumentation erstellt wird. Dies ist mit einem zusätzlichen Python-Programm namens [https://github.com/Feneric/doxypypy doxypypy] möglich. Dieses Programm ist inspiriert von einem älteren Programm namens [https://github.com/Feneric/doxypy doxypy], das den Python <code><nowiki>'''docstrings''''</nowiki></code> nehmen und in die Doxygen Kommentarblöcke konvertieren würde, die mit einem Doppelhash {{incode|###}} beginnen. Doxypypy geht noch weiter, da es die docstrings analysiert und interessante Elemente wie Variablen und Argumente extrahiert und sogar Doktests (Beispielcode in den docstrings). Doxypypy kann mit {{incode|pip}}, dem Installationsprogramm für Python Pakete, installiert werden. {{Code|code= pip3 install --user doxypypy }} Wenn der Befehl {{incode|pip}} ohne die Option {{incode|--user}} verwendet wird, benötigt er Superuser (root) Rechte, um das Paket zu installieren, aber das ist in den meisten Fällen nicht erforderlich; verwende root Rechte nur, wenn Du sicher bist, dass das Paket nicht mit den von der Distribution bereitgestellten Paketen kollidiert. Wenn das Paket als Benutzer installiert wurde, kann es sich in Deinem Heimatverzeichnis befinden, z.B. in {{incode|$HOME/.local/bin}}. Wenn sich dieses Verzeichnis nicht im {{incode|PATH}} deines Systems befindet, wird das Programm nicht gefunden. Füge daher das Verzeichnis der Variablen {{incode|PATH}} hinzu, entweder in deiner {{incode|$HOME/.bashrc}} Datei oder in deiner {{incode|$HOME/.profile}} Datei. {{Code|code= export PATH="$HOME/.local/bin:$PATH" }} Alternativ kannst du auch einen symbolischen Link zum {{incode|doxypy}} Programm erstellen und den Link in ein Verzeichnis legen, das bereits im {{incode|PATH}} enthalten ist. {{Code|code= mkdir -p $HOME/bin ln -s $HOME/.local/bin/doxypypy $HOME/bin/doxypypy }} Sobald das Programm {{incode|doxypypy}} installiert und vom Terminal aus zugänglich ist, kann eine Python Datei mit pythonischen docstrings mit den folgenden Anweisungen in den Doxygen Stil umformatiert werden. Das Programm gibt den formatierten Code als Standardausgabe aus, also leite diese Ausgabe in eine neue Datei um. {{Code|code= doxypypy -a -c pyexample_pythonic.py > pyexample_doxygen.py }} <div class="mw-collapsible mw-collapsed toccolours"> {{incode|pyexample_pythonic.py}} <div class="mw-collapsible-content"> {{Code|code= '''@package pyexample_pythonic Documentation for this module. More details go here. ''' def myfunction(arg1, arg2, kwarg='whatever.'): ''' Does nothing more than demonstrate syntax. This is an example of how a Pythonic human-readable docstring can get parsed by doxypypy and marked up with Doxygen commands as a regular input filter to Doxygen. Args: arg1: A positional argument. arg2: Another positional argument. Kwargs: kwarg: A keyword argument. Returns: A string holding the result. Raises: ZeroDivisionError, AssertionError, & ValueError. Examples: >>> myfunction(2, 3) '5 - 0, whatever.' >>> myfunction(5, 0, 'oops.') Traceback (most recent call last): ... ZeroDivisionError: integer division or modulo by zero >>> myfunction(4, 1, 'got it.') '5 - 4, got it.' >>> myfunction(23.5, 23, 'oh well.') Traceback (most recent call last): ... AssertionError >>> myfunction(5, 50, 'too big.') Traceback (most recent call last): ... ValueError ''' assert isinstance(arg1, int) if arg2 > 23: raise ValueError return '{0} - {1}, {2}'.format(arg1 + arg2, arg1 / arg2, kwarg) }} </div> </div> <div class="mw-collapsible mw-collapsed toccolours"> {{incode|pyexample_doxygen.py}} <div class="mw-collapsible-content"> {{Code|code= ##@package pyexample_pythonic #Documentation for this module. #More details go here. # ## @brief Does nothing more than demonstrate syntax. # # This is an example of how a Pythonic human-readable docstring can # get parsed by doxypypy and marked up with Doxygen commands as a # regular input filter to Doxygen. # # # @param arg1 A positional argument. # @param arg2 Another positional argument. # # # @param kwarg A keyword argument. # # @return # A string holding the result. # # # @exception ZeroDivisionError # @exception AssertionError # @exception ValueError. # # @b Examples # @code # >>> myfunction(2, 3) # '5 - 0, whatever.' # >>> myfunction(5, 0, 'oops.') # Traceback (most recent call last): # ... # ZeroDivisionError: integer division or modulo by zero # >>> myfunction(4, 1, 'got it.') # '5 - 4, got it.' # >>> myfunction(23.5, 23, 'oh well.') # Traceback (most recent call last): # ... # AssertionError # >>> myfunction(5, 50, 'too big.') # Traceback (most recent call last): # ... # ValueError # @endcode # def myfunction(arg1, arg2, kwarg='whatever.'): assert isinstance(arg1, int) if arg2 > 23: raise ValueError return '{0} - {1}, {2}'.format(arg1 + arg2, arg1 / arg2, kwarg) }} </div> </div> Die Originaldatei hat oben einen Kommentar <code><nowiki>''''@package pyexample_pythonic</nowiki></code>, der das Modul oder den Namensraum angibt, der durch die Datei beschrieben wird. Dieses Schlüsselwort {{incode|@package}} wird nicht interpretiert, wenn dreifache Anführungszeichen im Kommentarblock verwendet werden. In der neuen Datei wird der Kommentarstil so geändert, dass die Zeile {{incode|###@package pyexample_pythonic}} wird, die nun von Doxygen interpretiert wird. Um jedoch korrekt interpretiert zu werden, muss das Argument manuell bearbeitet werden, um dem neuen Modul (Datei-) Namen zu entsprechen; danach sollte die Zeile {{incode|###@package pyexample_doxygen}} sein. <div class="mw-collapsible mw-collapsed toccolours"> {{incode|pyexample_doxygen.py}} (das Obere wird manuell bearbeitet, der Rest bleibt gleich) <div class="mw-collapsible-content"> {{Code|code= ##@package pyexample_doxygen #Documentation for this module. #More details go here. # }} </div> </div> Um zu kompilieren, erstelle die Konfiguration und führe {{incode|doxygen}} im Toplevel Verzeichnis aus, das die Dateien enthält. {{Code|code= cd toplevel-source/ doxygen -g doxygen Doxyfile xdg-open ./html/index.html }} Die Dokumentation sollte ähnliche Informationen wie die folgenden enthalten und entsprechende Verknüpfungen zu den einzelnen Modulen herstellen. {{Code|code= Namespace List Here is a list of all documented namespaces with brief descriptions: N pyexample_doxygen Documentation for this module N pyexample_pythonic }} <span id="Converting_the_comment_style_on_the_fly"></span> === Fliegendes konvertieren des Kommentarstils === Im vorherigen Beispiel wurde die Konvertierung der Dokumentationsblöcke manuell mit nur einer Quelldatei durchgeführt. Im Idealfall soll diese Konvertierung automatisch, fliegend, mit einer beliebigen Anzahl von Python Dateien erfolgen. Dazu muss die Doxygen Konfiguration entsprechend angepasst werden. Verwende zunächst nicht direkt das Programm {{incode|doxypy}}, sondern erstelle die Konfigurationsdatei mit {{incode|doxygen -g}}, bearbeite dann die erstellte {{incode|Doxyfile}} und ändere das folgende Tag. {{Code|code= FILTER_PATTERNS = *.py=doxypypy_filter }} Was dies bewirkt, ist, dass Dateien, die dem Muster entsprechen, alle Dateien mit einer Erweiterung, die auf {{incode|.py}} endet, das Programm {{incode|doxypypy_filter}} durchlaufen. Jedes Mal, wenn Doxygen auf eine solche Datei im Quellbaum trifft, wird der Dateiname als erstes Argument an dieses Programm übergeben. {{Code|code= doxypypy_filter example.py }} Das Programm {{incode|doxypy_filter}} ist standardmäßig nicht vorhanden; es sollte als Shell Skript erstellt werden, um {{incode|doxypypy}} mit den entsprechenden Optionen auszuführen und eine Datei als erstes Argument zu verwenden. {{Code|code= #!/bin/sh doxypypy -a -c "$1" }} Nachdem du dieses Shell Skript gespeichert hast, stelle sicher, dass es über Ausführungsrechte verfügt und sich in einem Verzeichnis befindet, das sich im {{incode|PATH}} deines Systems befindet. {{Code|code= chmod a+x doxypypy_filter mv doxypypy_filter $HOME/bin }} Auf Windows Systemen kann eine Batch Datei auf ähnliche Weise verwendet werden. {{Code|code= doxypypy -a -c %1 }} Wenn diese Konfiguration abgeschlossen ist, kann der Befehl {{incode|doxygen Doxyfile}} ausgeführt werden, um die Dokumentation wie gewohnt zu generieren. Jede Python Datei, die Pythonic <code><nowiki>''''triple quotes''''</nowiki></code> verwendet, wird spontan neu formatiert, um Kommentare im Stil von {{incode|###Doxygen}} zu verwenden, und dann von Doxygen verarbeitet, das nun in der Lage ist, das [[#Doxygen markup/de|special commands]] und [[#Markdown support/de|Mardown syntax]] zu interpretieren. Der ursprüngliche Quellcode wird nicht geändert, und es muss keine temporäre Datei mit einem anderen Namen erstellt werden, wie in [[#Converting the Pythonic style to Doxygen style|der vorherige Abschnitt]]; wenn also eine Anweisung {{incode|@package example}} gefunden wird, muss sie nicht manuell geändert werden. Beachte , dass bestehende Python Dateien, die bereits den Stil {{incode|###double hash}} für ihre Kommentarblöcke verwenden, vom Filter {{incode|doxypypy}} nicht beeinflusst werden und von Doxygen normal verarbeitet werden. [[File:FreeCAD_doxygen_doxypypy_workflow.svg|800px]] {{Caption|Allgemeiner Arbeitsablauf zur Erstellung von Quellcodedokumentation mit Doxygen, wenn die Python Dateien gefiltert werden, um die Kommentarblöcke zu transformieren.}} <span id="Python_code_quality_check"></span> === Python Code Qualitätsprüfung === Um die automatische Konvertierung von Dokumentationsblöcken nutzen zu können, ist es wichtig, dass die originalen Python Quellen korrekt geschrieben sind und den pythonischen Richtlinien in [https://www.python.org/dev/peps/pep-0008/#documentation-strings PEP8] und [https://www.python.org/dev/peps/pep-0257/ PEP257] entsprechen. Schlampig geschriebener Code führt dazu, dass {{incode|doxypypy}} bei der Verarbeitung der Datei fehlschlägt, so dass Doxygen die Dokumentation nicht korrekt formatieren kann. <div class="mw-collapsible mw-collapsed toccolours"> Die folgenden Kommentarstile erlauben kein Zerlegen der docstrings durch {{incode|doxypypypy}}, daher sollten sie vermieden werden. <div class="mw-collapsible-content"> {{Code|code= '''@package Bad ''' def first_f(one, two): "Bad comment 1" result = one + two result_m = one * two return result, result_m def second_f(one, two): "Bad comment 2" result = one + two result_m = one * two return result, result_m def third_f(one, two): 'Bad comment 3' result = one + two result_m = one * two return result, result_m def fourth_f(one, two): #Bad comment 4 result = one + two result_m = one * two return result, result_m }} </div> </div> Verwende immer dreifache Anführungszeichen für die docstrings und stelle sicher, dass sie unmittelbar der Klassen- oder Funktionsdeklaration folgen. Es ist auch eine gute Idee, die Qualität Ihres Python Codes mit einem Werkzeug wie[http://flake8.pycqa.org/en/latest/ flake8] ([https://gitlab.com/pycqa/flake8 Gitlab]) zu überprüfen. Flake8 kombiniert im Wesentlichen drei Werkzeuge, [https://github.com/PyCQA/pyflakes Pyflakes], [https://github.com/PyCQA/pycodestyle Pycodestyle] (früher pep8) und den [https://github.com/PyCQA/mccabe McCabe complexity checker], um den richtigen pythonischen Stil durchzusetzen. {{Code|code= pip install --user flake8 flake8 example.py }} Um alle Dateien innerhalb eines Quellbaums zu überprüfen, verwende {{incode|find}}. {{Code|code= find toplevel-source/ -name '*.py' -exec flake8 {} '+' }} Wenn das Projekt es verlangt, können einige zu strenge Code Überprüfungen ignoriert werden. Die Fehlercodes können in der [https://pycodestyle.readthedocs.io/en/latest/intro.html#error-codes Pycodestyle Dokumentation] eingesehen werden. {{Code|code= find toplevel-source/ -name '*.py' -exec flake8 --ignore=E266,E402,E722,W503 --max-line-length=100 {} '+' }} In ähnlicher Weise ist ein Programm, das in erster Linie prüft, ob Kommentare mit [https://www.python.org/dev/peps/pep-0257/ PEP257] übereinstimmen, [https://github.com/PyCQA/pydocstyle Pydocstyle]. Die Fehlercodes können in der [http://www.pydocstyle.org/en/4.0.0/error_codes.html Pydocstyle Dokumentation] eingesehen werden. {{Code|code= pip install --user pydocstyle pydocstyle example.py }} Verwende es auch mit {{incode|find}}, um docstring Überprüfungen für alle Quelldateien durchzuführen. {{Code|code= find toplevel-source/ -name '*.py' -exec pydocstyle {} '+' }} <span id="Source_documentation_with_Sphinx"></span> == Quelldokumentation mit Sphinx == [https://www.sphinx-doc.org/en/master/ Sphinx] ist das beliebteste System zur Dokumentation von Python Quellcode. Da die Kernfunktionen und Arbeitsbereiche von FreeCAD jedoch in C++ geschrieben sind, wurde davon ausgegangen, dass Doxygen ein besseres Dokumentationswerkzeug für dieses Projekt ist. Während Sphinx Python docstrings nativ analysieren kann, erfordert es etwas mehr Arbeit, C++ Quelltexte zu analysieren. Das Projekt [https://breathe.readthedocs.io/en/latest/ Breathe] ([https://github.com/michaeljones/breathe Github]) ist ein Versuch, die Lücke zwischen Sphinx und Doxygen zu schließen, um sowohl Python- als auch C++ Quellcode Dokumentation in das gleiche System zu integrieren. Zuerst muss Doxygen konfiguriert werden, um eine XML Datei auszugeben; die XML Ausgabe wird dann von Breathe gelesen und in einen geeigneten Input für Sphinx umgewandelt. Weitere Informationen zu diesem Prozess findest du in der Dokumentation von Breathe unter [https://breathe.readthedocs.io/en/latest/quickstart.html Quick start guide]. Siehe diese Antwort in [https://stackoverflow.com/a/35377654 Stackoverflow] für andere Alternativen zur Dokumentation von C++ und Python Code zusammen im selben Projekt. <span id="Related"></span> == Verwandt == * [[Source_documentation/de|Quelldokumentation]] * [https://www.freecadweb.org/api/de/ FreeCAD API Internetseite] [[Category:Developer_Documentation{{#translation:}}]] [[Category:Developer{{#translation:}}]] [[Category:3rd Party{{#translation:}}]]