--- /dev/null
+
+.. _buildPlugin:
+
+Build plug-in
+=============
+
+.. toctree::
+ :maxdepth: 1
+
+ compoundFeature.rst
+ compsolidFeature.rst
+ edgeFeature.rst
+ faceFeature.rst
+ fillingFeature.rst
+ interpolationFeature.rst
+ polylineFeature.rst
+ shellFeature.rst
+ solidFeature.rst
+ subShapesFeature.rst
+ vertexFeature.rst
+ wireFeature.rst
--- /dev/null
+
+Compound
+========
--- /dev/null
+
+CompSolid
+=========
--- /dev/null
+
+Edge
+====
--- /dev/null
+
+Face
+====
--- /dev/null
+
+ Filling
+ =======
--- /dev/null
+
+Interpolation
+=============
--- /dev/null
+
+Polyline
+========
--- /dev/null
+
+Shell
+=====
--- /dev/null
+
+Solid
+=====
--- /dev/null
+
+Sub-shapes
+==========
--- /dev/null
+
+Vertex
+======
--- /dev/null
+
+Wire
+====
ELSE(${HAVE_SALOME})
INSTALL(CODE "
EXECUTE_PROCESS(
-COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_PREFIX}/doc', True);shutil.copytree('${CMAKE_CURRENT_BINARY_DIR}/html', '${CMAKE_INSTALL_PREFIX}/doc')\"
+COMMAND ${PYTHON_EXECUTABLE} -c \"import shutil;shutil.rmtree('${CMAKE_INSTALL_PREFIX}/doc/gui', True);shutil.copytree('${CMAKE_CURRENT_BINARY_DIR}/html', '${CMAKE_INSTALL_PREFIX}/doc/gui')\"
)
")
ENDIF(${HAVE_SALOME})
--- /dev/null
+
+.. _collectionPlugin:
+
+
+Collection plug-in
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ fieldFeature.rst
+ groupFeature.rst
--- /dev/null
+
+Field
+=====
--- /dev/null
+
+Group
+=====
--- /dev/null
+
+Axis
+====
--- /dev/null
+
+.. _constructionPlugin:
+
+Construction plug-in
+====================
+
+.. toctree::
+ :maxdepth: 1
+
+ axisFeature.rst
+ planeFeature.rst
+ pointFeature.rst
--- /dev/null
+
+Plane
+=====
--- /dev/null
+
+Point
+=====
--- /dev/null
+
+Dump
+====
--- /dev/null
+
+.. _exchangePlugin:
+
+Exchange plug-in
+================
+
+.. toctree::
+ :maxdepth: 1
+
+ dumpFeature.rst
+ exportFeature.rst
+ importFeature.rst
--- /dev/null
+
+Export
+======
--- /dev/null
+
+Import
+======
--- /dev/null
+
+.. _gdmlPlugin:
+
+GDML plug-in
+=============
+
+.. toctree::
+ :maxdepth: 1
+
+ coneFeature.rst
+ ellipsoidFeature.rst
--- /dev/null
+
+Cone
+====
--- /dev/null
+
+Ellipsoid
+=========
--- /dev/null
+
+Parameters manager
+==================
--- /dev/null
+
+Create parameter
+================
--- /dev/null
+
+.. _parametersPlugin:
+
+Parameters plug-in
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ managerFeature.rst
+ parameterFeature.rst
--- /dev/null
+
+.. _partPlugin:
+
+Part plug-in
+=============
--- /dev/null
+
+Box
+===
--- /dev/null
+
+Cone
+====
--- /dev/null
+
+Cylinder
+========
--- /dev/null
+
+.. _primitivesPlugin:
+
+Primitives plug-in
+==================
+
+.. toctree::
+ :maxdepth: 1
+
+ boxFeature.rst
+ coneFeature.rst
+ cylinderFeature.rst
+ sphereFeature.rst
+ torusFeature.rst
--- /dev/null
+
+Sphere
+======
--- /dev/null
+
+Torus
+=====
--- /dev/null
+
+Rectangle
+=========
+
+
+.. image:: images/Rectangle.png
+ :align: center
+
+.. centered::
+ Create a rectangle
FeaturesPlugin/featuresPlugin.rst
SketchPlugin/sketchPlugin.rst
+ BuildPlugin/buildPlugin.rst
+ CollectionPlugin/collectionPlugin.rst
+ ConstructionPlugin/constructionPlugin.rst
+ ExchangePlugin/exchangePlugin.rst
+ GDMLPlugin/GDMLPlugin.rst
+ ParametersPlugin/parametersPlugin.rst
+ PartPlugin/partPlugin.rst
+ PrimitivesPlugin/primitivesPlugin.rst
Indices and tables
==================
<plugin>
<workbench id="Build" document="Part">
<group id="Generate">
- <feature id="Vertex" title="Vertex" tooltip ="Create a vertex from sketch vertex and vertex objects" icon="icons/Build/feature_vertex.png">
+ <feature id="Vertex" title="Vertex" tooltip ="Create a vertex from sketch vertex and vertex objects" icon="icons/Build/feature_vertex.png"
+ helpfile="BuildPlugin/vertexFeature.html">
<source path="vertex_widget.xml"/>
</feature>
- <feature id="Edge" title="Edge" tooltip ="Create an edge from sketch edges and edge objects" icon="icons/Build/feature_edge.png">
+ <feature id="Edge" title="Edge" tooltip ="Create an edge from sketch edges and edge objects" icon="icons/Build/feature_edge.png"
+ helpfile="BuildPlugin/edgeFeature.html">
<source path="edge_widget.xml"/>
</feature>
- <feature id="Interpolation" title="Interpolation" tooltip ="Create an interpolation curve from points" icon="icons/Build/feature_interpolation.png">
+ <feature id="Interpolation" title="Interpolation" tooltip ="Create an interpolation curve from points" icon="icons/Build/feature_interpolation.png"
+ helpfile="BuildPlugin/interpolationFeature.html">
<source path="interpolation_widget.xml"/>
</feature>
- <feature id="Wire" title="Wire" tooltip ="Create a wire from sketch edges, edges and wires objects" icon="icons/Build/feature_wire.png">
+ <feature id="Wire" title="Wire" tooltip ="Create a wire from sketch edges, edges and wires objects" icon="icons/Build/feature_wire.png"
+ helpfile="BuildPlugin/wireFeature.html">
<source path="wire_widget.xml"/>
</feature>
- <feature id="Polyline" title="Polyline" tooltip ="Create a polyline from points" icon="icons/Build/feature_polyline.png">
+ <feature id="Polyline" title="Polyline" tooltip ="Create a polyline from points" icon="icons/Build/feature_polyline.png"
+ helpfile="BuildPlugin/polylineFeature.html">
<source path="polyline_widget.xml"/>
</feature>
- <feature id="Face" title="Face" tooltip ="Create a face from sketch edges, edges and wires objects" icon="icons/Build/feature_face.png">
+ <feature id="Face" title="Face" tooltip ="Create a face from sketch edges, edges and wires objects" icon="icons/Build/feature_face.png"
+ helpfile="BuildPlugin/faceFeature.html">
<source path="face_widget.xml"/>
</feature>
- <feature id="Shell" title="Shell" tooltip ="Create a shell from faces or shells objects" icon="icons/Build/feature_shell.png">
+ <feature id="Shell" title="Shell" tooltip ="Create a shell from faces or shells objects" icon="icons/Build/feature_shell.png"
+ helpfile="BuildPlugin/shellFeature.html">
<source path="shell_widget.xml"/>
</feature>
- <feature id="Solid" title="Solid" tooltip ="Create a solid from faces or shells" icon="icons/Build/feature_solid.png">
+ <feature id="Solid" title="Solid" tooltip ="Create a solid from faces or shells" icon="icons/Build/feature_solid.png"
+ helpfile="BuildPlugin/solidFeature.html">
<source path="solid_widget.xml"/>
</feature>
- <feature id="CompSolid" title="CompSolid" tooltip ="Create a compsolid from solids or another compsolids" icon="icons/Build/feature_compsolid.png">
+ <feature id="CompSolid" title="CompSolid" tooltip ="Create a compsolid from solids or another compsolids" icon="icons/Build/feature_compsolid.png"
+ helpfile="BuildPlugin/compsolidFeature.html">
<source path="compsolid_widget.xml"/>
</feature>
- <feature id="Compound" title="Compound" tooltip ="Create a compound of objects" icon="icons/Build/feature_compound.png">
+ <feature id="Compound" title="Compound" tooltip ="Create a compound of objects" icon="icons/Build/feature_compound.png"
+ helpfile="BuildPlugin/compoundFeature.html">
<source path="compound_widget.xml"/>
</feature>
</group>
<group id="Modify">
- <feature id="SubShapes" title="Sub-Shapes" tooltip ="Allows to add or to remove sub-shapes of the selected shape" icon="icons/Build/feature_subshapes.png">
+ <feature id="SubShapes" title="Sub-Shapes" tooltip ="Allows to add or to remove sub-shapes of the selected shape" icon="icons/Build/feature_subshapes.png"
+ helpfile="BuildPlugin/subShapesFeature.html">
<source path="subshapes_widget.xml"/>
</feature>
</group>
<group id="Advanced">
- <feature id="Filling" title="Filling" tooltip="Create face from list of edges" icon="icons/Build/feature_filling.png">
+ <feature id="Filling" title="Filling" tooltip="Create face from list of edges" icon="icons/Build/feature_filling.png"
+ helpfile="BuildPlugin/fillingFeature.html">
<source path="filling_widget.xml"/>
</feature>
</group>
title="Group"
tooltip="Create named collection of geometry entities"
icon="icons/Collection/shape_group.png"
- apply_continue="true">
+ apply_continue="true"
+ helpfile="CollectionPlugin/groupFeature.html">
<source path="group_widget.xml"/>
</feature>
<feature id="Field"
title="Field"
tooltip="Create fields for selected shapes"
- icon="icons/Collection/field.png">
+ icon="icons/Collection/field.png"
+ helpfile="CollectionPlugin/fieldFeature.html">
<field-panel id="selected"
filter_points="false" >
<validator id="GeomValidators_BodyShapes"/>
id="Point"
title="Point"
tooltip="Create point"
- icon="icons/Construction/point.png">
+ icon="icons/Construction/point.png"
+ helpfile="ConstructionPlugin/pointFeature.html">
<source path="point_widget.xml" />
</feature>
<feature
id="Axis"
title="Axis"
tooltip="Create axis"
- icon="icons/Construction/axis.png">
+ icon="icons/Construction/axis.png"
+ helpfile="ConstructionPlugin/axisFeature.html">
<source path="axis_widget.xml" />
</feature>
<feature
id="Plane"
title="Plane"
tooltip="Create plane"
- icon="icons/Construction/plane.png">
+ icon="icons/Construction/plane.png"
+ helpfile="ConstructionPlugin/planeFeature.html">
<source path="plane_widget.xml" />
</feature>
</group>
<plugin>
<workbench id="Part">
<group id="Exchange">
- <feature id="Import" title="Import" tooltip="Import a file" icon="icons/Exchange/import.png" document="Part">
+ <feature id="Import" title="Import" tooltip="Import a file" icon="icons/Exchange/import.png" document="Part"
+ helpfile="ExchangePlugin/importFeature.html">
<file_selector id="file_path" title="Import file" path="">
<validator id="ExchangePlugin_ImportFormat" parameters="BREP|BRP:BREP,STEP|STP:STEP,IGES|IGS:IGES,XAO:XAO" />
</file_selector>
</feature>
- <feature id="Export" title="Export" tooltip="Export to file" icon="icons/Exchange/export.png">
+ <feature id="Export" title="Export" tooltip="Export to file" icon="icons/Exchange/export.png"
+ helpfile="ExchangePlugin/exportFeature.html">
<source path="export_widget.xml" />
</feature>
- <feature id="Dump" title="Dump" tooltip="Dump python script" icon="icons/Exchange/dump.png">
+ <feature id="Dump" title="Dump" tooltip="Dump python script" icon="icons/Exchange/dump.png"
+ helpfile="ExchangePlugin/dumpFeature.html">
<export_file_selector id="file_path"
type="save"
title="Dump to file"
<plugin>
<workbench id="GDML" document="Part">
<group id="GDML">
- <feature id="ConeSegment" title="Cone segment" tooltip="Create a GDML Cone Segment" icon="icons/GDML/cone_segment.png">
+ <feature id="ConeSegment" title="Cone segment" tooltip="Create a GDML Cone Segment" icon="icons/GDML/cone_segment.png"
+ helpfile="GDMLPlugin/coneFeature.html">
<source path="conesegment_widget.xml"/>
</feature>
- <feature id="Ellipsoid" title="Ellipsoid" tooltip="Create a GDML Ellipsoid" icon="icons/GDML/ellipsoid.png">
+ <feature id="Ellipsoid" title="Ellipsoid" tooltip="Create a GDML Ellipsoid" icon="icons/GDML/ellipsoid.png"
+ helpfile="GDMLPlugin/ellipsoidFeature.html">
<source path="ellipsoid_widget.xml"/>
</feature>
</group>
<plugin>
<workbench id="Part">
<group id="Parameters">
- <feature id="Parameter" title="Parameter" tooltip="Create a parameter" icon=":icons/expression.png">
+ <feature id="Parameter" title="Parameter" tooltip="Create a parameter" icon=":icons/expression.png"
+ helpfile="ParametersPlugin/parameterFeature.html">
<stringvalue id="variable" label="Name" icon=":icons/expression.png" placeholder="Please input the parameter name">
<validator id="Parameters_VariableValidator"/>
</stringvalue>
<stringvalue id="comment" label="Comment"/>
</feature>
- <feature id="ParametersMgr" title="Parameters" tooltip="Manage parameters" icon=":icons/paper_roll.png" modal="true">
+ <feature id="ParametersMgr" title="Parameters" tooltip="Manage parameters" icon=":icons/paper_roll.png" modal="true"
+ helpfile="ParametersPlugin/managerFeature.html">
<parameters-manager/>
</feature>
</group>
<plugin>
<workbench id="Primitives" document="Part">
<group id="Primitives">
- <feature id="Box" title="Box" tooltip="Create a box" icon="icons/Primitives/box.png">
+ <feature id="Box" title="Box" tooltip="Create a box" icon="icons/Primitives/box.png"
+ helpfile="PrimitivesPlugin/boxFeature.html">
<source path="box_widget.xml"/>
</feature>
</group>
<group id="Primitives">
- <feature id="Cylinder" title="Cylinder" tooltip="Create a cylinder" icon="icons/Primitives/cylinder.png">
+ <feature id="Cylinder" title="Cylinder" tooltip="Create a cylinder" icon="icons/Primitives/cylinder.png"
+ helpfile="PrimitivesPlugin/cylinderFeature.html">
<source path="cylinder_widget.xml"/>
</feature>
</group>
<group id="Primitives">
- <feature id="Sphere" title="Sphere" tooltip="Create a sphere" icon="icons/Primitives/sphere.png">
+ <feature id="Sphere" title="Sphere" tooltip="Create a sphere" icon="icons/Primitives/sphere.png"
+ helpfile="PrimitivesPlugin/sphereFeature.html">
<source path="sphere_widget.xml"/>
</feature>
</group>
<group id="Primitives">
- <feature id="Torus" title="Torus" tooltip="Create a Torus" icon="icons/Primitives/torus.png">
+ <feature id="Torus" title="Torus" tooltip="Create a Torus" icon="icons/Primitives/torus.png"
+ helpfile="PrimitivesPlugin/torusFeature.html">
<source path="torus_widget.xml"/>
</feature>
</group>
<group id="Primitives">
- <feature id="Cone" title="Cone" tooltip="Create a Cone" icon="icons/Primitives/cone.png">
+ <feature id="Cone" title="Cone" tooltip="Create a Cone" icon="icons/Primitives/cone.png"
+ helpfile="PrimitivesPlugin/coneFeature.html">
<source path="cone_widget.xml"/>
</feature>
</group>
id="SketchRectangle"
title="Rectangle"
tooltip="Create rectangle"
- icon="icons/Addons/rectangle.png">
+ icon="icons/Addons/rectangle.png"
+ helpfile="SketchPlugin/rectangleFeature.html">
<sketch-2dpoint_selector id="RectStartPoint" accept_expressions="0" title="Start point" tooltip="Start point coordinates"
enable_value="enable_by_preferences"/>
<sketch-2dpoint_selector id="RectEndPoint" accept_expressions="0" title="End point" tooltip="End point coordinates"
}
#else
QString aDir(getenv("OPENPARTS_ROOT_DIR"));
- aDocDir = aDir + aSep + "doc";
+ aDocDir = aDir + aSep + "doc" + aSep + "gui";
#endif
QStringList aParams;
aParams << aDocDir + aSep + aHelpPage;