Merge pull request #39 from dirkolbrich/mermaid

remove duplicate include of mermaid.js

Author: chennes

_includes/markdown-enhancements/mermaid.html

@@ -1,8 +1,11 @@
+{% if page.mermaid == true %}
 <script src="https://cdnjs.cloudflare.com/ajax/libs/mermaid/8.0.0/mermaid.min.js"></script>
 <script>
-   mermaid.initialize({
-       startOnLoad:true,
-       theme: 'default'
-   });
-   window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
+var config = {
+    startOnLoad:true,
+    theme: 'default'
+};
+mermaid.initialize(config);
+window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
 </script>
+{% endif %}

_layouts/mermaid.html

@@ -1,3 +1,7 @@
+---
+layout: default
+---
+
 # Checklist for adding a new feature to an existing workbench in C++
 
 This checklist is intended as an aid to contributors.

technical/ChecklistForNewFeatureC++.md

@@ -1,4 +1,10 @@
-# Background
+---
+layout: default
+---
+
+# Create a Python Binding for C++
+
+## Background
 
 It becomes necessary at times to expand the FreeCAD API further by exposing functions that are available in the source code in c++ to the python. This process is generally referred to as creating a binding.
 
@@ -18,7 +24,7 @@ The XML file YourClassPy.xml provides information about the functions and attrib
 
 For this example, we will look at the wrapper for the Base::Axis C++ class. The XML description file begins with:
 
-```XML
+```xml
 <GenerateModel xmlns:xsi##"http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation##"generateMetaModel_Module.xsd">
     <PythonExport
         Father##"PyObjectBase"
@@ -42,7 +48,7 @@ For this example, we will look at the wrapper for the Base::Axis C++ class. The
 
 Following this preamble, a list of methods and attributes is given. The format of a method is:
 
-```XML
+```xml
 <Methode Name##"move">
     <Documentation>
         <UserDocu>
@@ -55,7 +61,7 @@ Following this preamble, a list of methods and attributes is given. The format o
 
 The format of an attribute is:
 
-```XML
+```xml
 <Attribute Name##"Direction" ReadOnly##"false">
     <Documentation>
         <UserDocu>Direction vector of the Axis</UserDocu>
@@ -66,24 +72,25 @@ The format of an attribute is:
 
 For an attribute, if "ReadOnly" is false, you will provide both a getter and a setter function. If it is true, only a getter is allowed. In this case we will be required to provide two functions in the implementation C++ file:
 
-```C++
+```cpp
 Py::Object AxisPy::getDirection(void) const
+````
 
 and:
 
+```cpp
 void AxisPy::setDirection(Py::Object arg)
 ```
 
+## Implementation C++ File
 
-## Implementation Cplusplus File
-
-The implementation C++ file YourClassPyImp.cpp provides the "glue" that connects the C++ and Python structures together, effectively translating from one language to the other. The FreeCAD C++-to-Python system provides a number of C++ classes that map to their corresponding Python type. The most fundamental of these is the incode|Py::Object class -- rarely created directly, this class provides the base of the inheritance tree, and is used as the return type for any function that is returning Python data.
+The implementation C++ file `YourClassPyImp.cpp` provides the "glue" that connects the C++ and Python structures together, effectively translating from one language to the other. The FreeCAD C++-to-Python system provides a number of C++ classes that map to their corresponding Python type. The most fundamental of these is the incode `Py::Object` class - rarely created directly, this class provides the base of the inheritance tree, and is used as the return type for any function that is returning Python data.
 
 ### Include Files
 
 Your C++ implementation file will include the following files:
 
-```C++
+```cpp
  #include "PreCompiled.h"
 
  #include "YourClass.h"
@@ -99,7 +106,7 @@ Of course, you may include whatever other C++ headers your code requires to func
 
 Your C++ implementation must contain the definition of the PyInit function: for example, for the Axis class wrapper, this is
 
-```C++
+```cpp
 int AxisPy::PyInit(PyObject* args, PyObject* /*kwd*/)
 
 //Within this function you will most likely need to parse incoming arguments to the constructor: the most important function for this purpose is the Python-provided incode|PyArg_ParseTuple. It takes in the 
@@ -123,7 +130,6 @@ For a complete list of format specifiers see [https://docs.python.org/3/c-api/ar
 * PyArg_VaParse (PyObject *, const char *, va_list);
 * PyArg_VaParseTupleAndKeywords (PyObject *, PyObject *, const char *, char **, va_list);
 
-
 ## Another Explanation
 
 The basic structure of a program to expose functionality to Python is something like this:
@@ -147,14 +153,10 @@ There is a convention for return values from our C++/Python connections:
 * xxxxxPyImp routines return a PyObject* pointer (see TopoShapePyImp.cpp) 
 * AppmyModulePy.cpp routines return a Py::Object (see https://github.com/FreeCAD/FreeCAD/blob/master/src/Mod/Part/App/AppPartPy.cpp and FreeCAD/src/Mod/Part/AppPartPy.cpp.
 
-
 ## See also
 
 * [https://forum.freecadweb.org/viewtopic.php?p##314796#p314617]
 * [https://forum.freecadweb.org/viewtopic.php?p##560639#p560639] Forum discussion: Adding Commands in Python to C++ Workbench
 * [https://forum.freecadweb.org/viewtopic.php?f##10&t##70750] Another forum thread
 * (./Workbench creation.md)
 * [https://github.com/FreeCAD/FreeCAD/commit/20b86e55b8dd1873f4c19e036d047528c9ff7f4e] Commit 20b86e5, exposing OCC's precision methods to Python
-
-
-

technical/CreatePythonBindingForCpp.md

@@ -2,19 +2,16 @@
 layout: default
 mermaid: true
 ---
-# "Partial View of the FreeCAD Source Tree"
 
-"A picture of the most commonly encountered branches of the tree."
+# Partial View of the FreeCAD Source Tree
 
-{{page.mermaid}}
+A picture of the most commonly encountered branches of the tree.
 
 The full FreeCAD source tree has many other branches, but most Contributors will
 only need to deal with these:
 
-
 ![The FreeCAD Source Tree](./SourceTreeBasics.svg)
 
-
 ```mermaid
 graph LR
     A[src] --- B[App: Documents, DocumentObjects, EventPropagation]
@@ -28,4 +25,3 @@ graph LR
     E --- I["..."]
     end
 ```
-

technical/SourceTreeBasics.md

@@ -1,15 +1,14 @@
 ---
 layout: default
-mermaid: true
 ---
 
-# "The Application Module"
+# The Application Module
 
-"An overview of application module structure."
+An overview of application module structure.
 
-The functionality of FreeCAD is separated into Modules.  Some Modules are built into FreeCAD and some are Extension Modules (a form of plug-in).  Once installed, Extension Modules behave exactly as built-in Modules.
+The functionality of FreeCAD is separated into Modules. Some Modules are built into FreeCAD and some are Extension Modules (a form of plug-in). Once installed, Extension Modules behave exactly as built-in Modules.
 
-Application Modules provide specialized functions and may store specialized data.   Examples of Application Modules are Arch (for buildings) and Sketcher (for drawing Sketches).
+Application Modules provide specialized functions and may store specialized data. Examples of Application Modules are Arch (for buildings) and Sketcher (for drawing Sketches).
 
 Application Modules are almost always divided into two parts: App which manages the relevant document objects and operations on them, and Gui which handles the display.
 

technical/TheApplicationModule.md

@@ -1,12 +1,12 @@
 ---
 layout: default
 ---
-# "Developer's Glossary"
 
-"Some terms that a developer may run across."
+# Developer's Glossary
 
-Note that there may be subtle differences in how some terms are used by developers vs how they are used by users.
+Some terms that a developer may run across.
 
+Note that there may be subtle differences in how some terms are used by developers vs how they are used by users.
 
 * Binding: the mechanism for linking C++ functionality to and from Python.
 * CI (Continuous Integration): the mechanism by which Pull Requests are automatically built and unit tested.
@@ -17,9 +17,6 @@ Note that there may be subtle differences in how some terms are used by develope
 * Pull Request: how a contributor indicates that they have a change to be merged
 * ViewProvider: an object that provides painting services for a Feature.  The ViewProvider is notified of changes in a Features properties and, if the change affects the visual representation of the Feature, updates the display.  Note that in some modules (ex TechDraw with the Qt GraphicsFramework) there is another layer of functionality that manages the painting.
 
-
-
-
 ## See Also
 
 * [FreeCAD glossary wiki entry](https://wiki.freecad.org/Glossary)

technical/developerglossary.md

@@ -1,12 +1,13 @@
 ---
 layout: default
 ---
+
 # Technical
 
 Technical information of interest to Contributors.
 
-
 ## The Basics
+
 - [Developer's Glossary](./developerglossary.md)
 - [Source Tree Basics](./SourceTreeBasics.md)
 - [The Application Module](./TheApplicationModule.md)
@@ -19,8 +20,8 @@ Technical information of interest to Contributors.
     - [Coin3d](https://www.coin3d.org/): a [scenegraph](https://wiki.freecad.org/Scenegraph) manager based on OpenInventor that handles drawing in the 3d window.
     - [Pivy](https://wiki.freecad.org/Pivy): a Python binding for Coin3d
 
-
 ## Modifying FreeCAD
+
 - Contributing to FreeCAD
     - The process for submitting changes to FreeCAD is described in the [CONTRIBUTING.md](https://github.com/FreeCAD/FreeCAD/blob/master/CONTRIBUTING.md)
     file in the root of the source tree.
@@ -30,11 +31,8 @@ Technical information of interest to Contributors.
 - [Create a Python Binding for C++ Class](./CreatePythonBindingForCpp.md)
 - [Checklist for Adding a Feature to a Workbench in C++](./ChecklistForNewFeatureC++.md)
 
+## See Also
 
-
-
-
-### See Also
 - [Wiki Developer Hub](https://wiki.freecad.org/Developer_hub)
 - [Compiling](https://wiki.freecad.org/Developer_hub#Compiling_FreeCAD)
 - [Useful Python Modules](https://wiki.freecad.org/Extra_python_modules)

technical/index.md

@@ -1,11 +1,12 @@
 ---
 layout: default
 ---
+
 #  Handling Preferences
 
-How to retrieve and update user preferences
+How to retrieve and update user preferences.
 
-The user.cfg Xml file contains a hierarchical list of all the preferences used by FreeCAD.
+The `user.cfg` XML file contains a hierarchical list of all the preferences used by FreeCAD.
 
 Each module has its own branch of the hierarchy starting under Preferences/Mod.
 
@@ -24,4 +25,5 @@ Good examples of retrieving parameters can be found in:
 * C++: [various methods](https://github.com/FreeCAD/FreeCAD/blob/master/src/Mod/TechDraw/App/Preferences.cpp) in /Mod/TechDraw/App/Preferences.cpp
 
 ## See also
+
 * [Preference Editor wiki entry](https://wiki.freecad.org/Preferences_Editor)