Technical/Help-System.md

+# Anatomy of the included help system
+
+GitSearch supports a minimalistic version of a help system.
+
+It uses the capabilities of the Git Wiki-Pages of the Git-Project `infrastructure/GitSearchEditorialPages` and renders them as internal help pages. Thus we do not need an extra editing and storage facilities to maintain extra content.
+
+To support English and German Wiki-Pages two hierarchies of wiki pages must be maintained:
+
+![image](uploads/1d5c4ed3629c69282c6b96efae268f49/image.png)
+
+The start page is [de,en]/helpStart .
+
+![image](uploads/dcd202afa8cbbdb3451de947a7d909d5/image.png)
+
+From there the other pages can be linked into.
+If necessary, further help pages can be hard coded into the navigation menu.
+
+To reuse the wiki system of gitlab has various drawbacks, mainly because the used mark-down rendering engine [ngx-markdown](https://www.npmjs.com/package/ngx-markdown#road-map) has some reduced functionalities:
+
+1. Links to other pages must not contain spaces :-(
+2. Special commands as e.g. `[[TOC]]` are not supported
+3. Syntax highlighting is not yet implemented (but is already supported)
\ No newline at end of file