[DOC] formatting / fix links

doc/CFDEMcoupling_about.txt

@@ -34,7 +34,7 @@ The file structure:
 {tutorials} directory including basic tutorial cases showing the functionality  :l
 :ule
 
-Details on installation are given on the "CFDEMproject WWW Site"_lig .
+Details on installation are given on the "CFDEMproject Website"_lig .
 The functionality of this CFD-DEM framework is described via "tutorial
 cases"_CFDEMcoupling_tutorials.html showing how to use different solvers and
 models.

doc/CFDEMcoupling_dicts.txt

@@ -7,11 +7,11 @@
 
 4. Dictionaries :link(1_4),h3
 
-4.1 "couplingProperties" dictionary :link(couplingProperties),h4
+4.1 couplingProperties dictionary :link(couplingProperties),h4
 
 [General:]
 
-In the "couplingProperties" dictionary the setup of the coupling routines of the
+In the {couplingProperties} dictionary the setup of the coupling routines of the
 CFD-DEM simulation are defined.
 
 [Location:] $caseDir/CFD/constant
@@ -42,7 +42,7 @@ specific parameters.
 
 [Settings:]
 
-Reasonable example settings for the "couplingProperties" dictionary are given in
+Reasonable example settings for the {couplingProperties} dictionary are given in
 the tutorial cases.
 
 modelType :pre
@@ -69,29 +69,31 @@ Choose the CFD timestep in the controlDict. It must be equal to or smaller than
 the coupling time, otherwise you will get the error: "Error - TS bigger than
 coupling interval!". :l,ole
 
-Example: DEMts=0.00001s, couplingInterval=10 exchange data (=couple) will happen
+[Example:]
-every 0.0001s.
+
+Choosing DEMts=0.00001s and couplingInterval=10 means that an exchange of data
+(=coupling) will happen every 0.0001s.
 
 :line
 
-4.2 "liggghtsCommands" dictionary :link(liggghtsCommands),h4
+4.2 liggghtsCommands dictionary :link(liggghtsCommands),h4
 
 [General:]
 
-In the "liggghtsCommands" dictionary liggghts commands being executed during a
+In the {liggghtsCommands} dictionary LIGGGHTS commands which are to be executed
-coupled CFD-DEM simulation are specified.
+during a coupled CFD-DEM simulation are specified.
 
 [Location:] $caseDir/CFD/constant
 
 [Structure:]
 
 The dictionary is divided into two parts, first a list of
-"liggghtsCommandModels" is defined, then the settings for each model must be
+"liggghtsCommandModels"_CFDEMcoupling_models.html#lcm is defined, then the
-specified.
+settings for each model must be specified.
 
 [Settings:]
 
-Reasonable example settings for the "liggghtsCommands" dictionary are given in
+Reasonable example settings for the {liggghtsCommands} dictionary are given in
 the tutorial cases.
 
 

doc/CFDEMcoupling_tutorials.txt

@@ -9,15 +9,15 @@
 
 [General:]
 
-Each solver of the CFDEMcoupling comes with at least one tutorial example,
+Each solver of CFDEMcoupling comes with at least one tutorial example, showing
-showing its functionality and correct usage. Provided that the installation is
+its functionality and correct usage. Provided that the installation is correct,
-correct, the tutorials can be run via "Allrun.sh" shell scripts. These scripts
+the tutorials can be run via "Allrun.sh" shell scripts. These scripts perform
-perform all necessary steps (preprocessing, run, postprocessing, visualization).
+all necessary steps (preprocessing, run, postprocessing, visualization).
 
 [Location:]
 
-The tutorials can be found in the directory $CFDEM_PROJECT_DIR/tutorials, which
+The tutorials can be found in the directory $CFDEM_PROJECT_DIR/tutorials,
-can be reached by typing "cfdemTut"
+which can be reached by typing {cfdemTut} in a CLI terminal.
 
 [Structure:]
 
@@ -46,9 +46,10 @@ fvSchemes, controlDict). You can find more information on that in
 "OpenFOAM(R)(*)"_of documentations.
 
 Settings of the coupling routines are defined in
-$caseDir/CFD/constant/"couplingProperies"_#1_3 (e.g. force models, data exchange
+$caseDir/CFD/constant/"couplingProperies"_CFDEMcoupling_dicts.html#couplingProperties
-model, etc.) and $caseDir/CFD/constant/"liggghtsCommands"_#1_3 (allows to
+(e.g. force models, data exchange model, etc.) and
-execute a LIGGGHTS command during a coupled simulation).
+$caseDir/CFD/constant/"liggghtsCommands"_CFDEMcoupling_dicts.html#liggghtsCommands
+(allows to execute a LIGGGHTS command during a coupled simulation).
 
 NOTE:
 (*) This offering is not approved or endorsed by OpenCFD Limited, producer and

doc/IOModel.txt

@@ -25,7 +25,7 @@ in this documentation.
 
 [Description:]
 
-The IO-model is the base class to write data (e.g. particle properties) to files.
+{IOModel} is the base class to write data (e.g. particle properties) to files.
 
 [Restrictions:]
 

doc/chemistryModel_diffusionCoefficients.txt

@@ -52,7 +52,7 @@ Fuller-Schettler-Giddings correlation.
 
 [Restrictions:]
 
-Species model needs to be active.
+The "species"_chemistryModel_species.html model needs to be active.
 
 [Related commands:]
 

doc/locateModel_engineSearchMany2Many.txt

@@ -40,7 +40,8 @@ engineSearchMany2ManyProps
 The locateModel "engine" locates the CFD cell and cellID corresponding to a
 given position.
 
-The engineSearchMany2Many locateModel can be used with different settings to use different algorithms:
+The {engineSearchMany2Many} locateModel can be used with different settings to
+use different algorithms:
 
 treeSearch false;  will execute some geometric (linear) search using the last
 known cellID (recommended) :ulb,l

doc/meshMotionModel_noMeshMotion.txt

@@ -20,7 +20,7 @@ meshMotionModel noMeshMotion; :pre
 
 [Description:]
 
-The noMeshMotion-model is a dummy meshMotion model.
+The {noMeshMotion} model is a dummy meshMotion model.
 
 [Restrictions:]
 

doc/regionModel_allRegion.txt

@@ -22,7 +22,7 @@ regionModel allRegion; :pre
 
 [Description:]
 
-The allRegion-model is a region model including the whole CFD region for the coupling.
+The {allRegion} model is a region model including the whole CFD region for the coupling.
 
 [Restrictions:]