Converted section title to separate page

for setting up osi

Signed-off-by: Philip Windecker <philip.windecker@avenyr.de>

Author: philipwindecker

README.md

@@ -22,9 +22,9 @@ For usage examples, please refer to the official documentation:
 ## Installation
 
 For detailed installation instructions, please refer to the official documentation:
-- [Setting up OSI](https://opensimulationinterface.github.io/osi-documentation/#_setting_up_osi)
-  - [Installing _protobuf_ for static / dynamic linking](https://opensimulationinterface.github.io/osi-documentation/#_installing_prerequisites)
-  - [Installing OSI for C++ on Linux](https://opensimulationinterface.github.io/osi-documentation/#_installing_osi_for_c_on_linux)
-  - [Installing OSI for Python on Linux](https://opensimulationinterface.github.io/osi-documentation/#_installing_osi_for_python_on_linux)
-  - [Installing OSI for C++ on Windows](https://opensimulationinterface.github.io/osi-documentation/#_installing_osi_for_c_on_windows)
-  - [Installing OSI for Python on Windows](https://opensimulationinterface.github.io/osi-documentation/#_installing_osi_for_python_on_windows)
+- [Setting up OSI](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/setup/setting_up_osi.html)
+  - [Installing _protobuf_ for static / dynamic linking](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/setup/installing_prerequisites.html)
+  - [Installing OSI for C++ on Linux](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/setup/installing_linux_cpp.html)
+  - [Installing OSI for Python on Linux](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/setup/installing_linux_python.html)
+  - [Installing OSI for C++ on Windows](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/setup/installing_windows_cpp.html)
+  - [Installing OSI for Python on Windows](https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/interface/setup/installing_windows_python.html)

doc/open-simulation-interface_user_guide.adoc

@@ -71,7 +71,9 @@ include::./architecture/trace_file_example.adoc[leveloffset=+3]
 
 include::./architecture/formatting_scripts.adoc[leveloffset=+3]
 
-== Setting up OSI
+
+// Setting up OSI
+include::./setup/setting_up_osi.adoc[leveloffset=+1]
 
 include::./setup/installing_prerequisites.adoc[leveloffset=+2]
 

doc/setup/installing_linux_cpp.adoc

@@ -6,7 +6,7 @@ endif::[]
 
 **Prerequisites**
 
-* You have installed everything described in <<Installing _protobuf_ for static / dynamic linking depending on the use case>>.
+* You have installed everything described in <<top-installing-osi-prerequisits>>.
 
 **Steps**
 

doc/setup/installing_linux_python.adoc

@@ -6,7 +6,7 @@ endif::[]
 
 **Prerequisites**
 
-* You have installed everything described in <<Installing _protobuf_ for static / dynamic linking depending on the use case>>.
+* You have installed everything described in <<top-installing-osi-prerequisits>>.
 * You have installed _pip3_.
 * You have installed _python-setuptools_.
 * For a local installation, you have installed _virtualenv_.

doc/setup/installing_prerequisites.adoc

@@ -2,32 +2,32 @@ ifndef::include-only-once[]
 :root-path: ../
 include::{root-path}_config.adoc[]
 endif::[]
-
-= Installing _protobuf_ for static / dynamic linking
+[#top-installing-osi-prerequisits]
+= Installing protobuf for static / dynamic linking
 
 == Prerequisites
 
-* You have installed _cmake_ (version 3.10.2 or higher).
-* You must have super user privileges.
+* You have installed _cmake_ (version 3.10.2 or higher)
+* You must have superuser privileges
 
-Static linking is the recommended way to package OSI FMUs for sharing with others to be integrated in a co-simulation: They should have minimal external dependencies, in order to ensure maximum portability.
-Fo other use cases like first trials to get started with OSI, dynamic linking could be an option, as well.
+Static linking is the recommended way to package OSI FMUs for sharing with others to be integrated in a co-simulation: They should have minimal external dependencies in order to ensure maximum portability.
+For other use cases like first trials to get started with OSI, dynamic linking could be an option as well.
 
 == Windows
 
 **Dynamic Linking (NOT RECOMMENDED)**
 
-Since on windows symbols are not exported per default it can be kind of annoying to deal with this during _protobuf_ header generation (see for example  https://groups.google.com/g/protobuf/c/PDR1bqRazts).
-So basically thats one more reason to use static linking.
+Since on Windows symbols are not exported per default, it can be kind of annoying to deal with this during _protobuf_ header generation (see for example https://groups.google.com/g/protobuf/c/PDR1bqRazts).
+That is an important reason to use static linking.
 
 **Static Linking**
 
 Static linking might require to manually build _protobuf_. 
-Its important to notice that on windows you can also specify how to link against the C runtime.
-Basically this can be set in CMake e.g. https://cmake.org/cmake/help/latest/prop_tgt/MSVC_RUNTIME_LIBRARY.html
+It is important to notice that on Windows you can also specify how to link against the C runtime.
+Basically, this can be set in CMake, e.g. https://cmake.org/cmake/help/latest/prop_tgt/MSVC_RUNTIME_LIBRARY.html
 
-Therefore, it could make sense to still dynamically link against the C Runtime  when statically linking _protobuf_ / OSI.
-(This is important e.g. when building shared libraries, since a static C runtime will create an isolated heap for your  dll, which can lead to segfaults depending on what you expose on your public interfaces.)
+Therefore, it could make sense to still dynamically link against the C Runtime when statically linking _protobuf_ / OSI.
+(This is important e.g. when building shared libraries, since a static C runtime will create an isolated heap for your dll, which can lead to segfaults depending on what you expose on your public interfaces.)
 
 The easiest way to achieve static linking on Windows without setting all the stuff manually in Cmake and building _protobuf_ is to actually use vcpkg:
 
@@ -39,7 +39,7 @@ vcpkg install --triplet=x64-windows-static-md protobuf
 
 **Build:**
 
-For the cmake configuration we can directly specify our vcpkg installation:
+For the cmake configuration, we can directly specify our vcpkg installation:
 ----
 cmake .. -DVCPKG_TARGET_TRIPLET=x64-windows-static-md -DCMAKE_TOOLCHAIN_FILE=C:/path/to/vcpkg/scripts/buildsystems/vcpkg.cmake -A x64
 cmake --build . --config Release
@@ -49,18 +49,19 @@ cmake --build . --config Release
 
 **Dynamic linking (NOT RECOMMENDED)**
 
-As already mentioned, shared linking is possible on linux, but NOT RECOMMENDED.
-However, for dynamic linking, install _protobuf_ (version 3.0.0 or higher) with apt: 
+As already mentioned, shared linking is possible on Linux, but NOT RECOMMENDED.
+However, for dynamic linking install _protobuf_ (version 3.0.0 or higher) with apt: 
 ----
 sudo apt-get install libprotobuf-dev protobuf-compiler
 ----
-and in the CMakeLists of the OSI project, `LINK_WITH_SHARED_OSI` has to be enabled.
+In the CMakeLists of the OSI project, `LINK_WITH_SHARED_OSI` has to be enabled.
 
 **Static linking**
 
 A common error here is to just install _protobuf_ with apt and link against it. 
 This means that your OSI is build statically but still linking dynamically against _protobuf_.
-Here, again either _protobuf_ has to build statically from source or some solution e.g. vcpkg needs to be utilized. We recommend the following (as in the README of the OSI project):
+Here, again either _protobuf_ has to build statically from source or some solution e.g. vcpkg needs to be utilized.
+We recommend the following (as in the README of the OSI project):
 
 Install _protobuf_ (version 3.0.0 or higher) from source with `CXXFLAGS="-fPIC"` to allow static linking of your OSI FMUs (replace <version> with preferred release):
 ----

doc/setup/installing_windows_cpp.adoc

@@ -6,7 +6,7 @@ endif::[]
 
 **Prerequisites**
 
-* You have installed everything described in <<Installing _protobuf_ for static / dynamic linking depending on the use case>>.
+* You have installed everything described in <<top-installing-osi-prerequisits>>.
 
 **Steps**
 

doc/setup/installing_windows_python.adoc

@@ -6,7 +6,7 @@ endif::[]
 
 **Prerequisites**
 
-* You have installed everything described in <<Installing _protobuf_ for static / dynamic linking depending on the use case>>.
+* You have installed everything described in <<top-installing-osi-prerequisits>>.
 * You have installed _Python_ with administrator rights.
 * Make sure _Python_ is added to `PATH`.
 

doc/setup/setting_up_osi.adoc

@@ -0,0 +1,6 @@
+ifndef::include-only-once[]
+:root-path: ../
+include::{root-path}_config.adoc[]
+endif::[]
+[#top-setting-up-osi]
+= Setting up OSI