From c3ee8c5b3344bf42d4931432ab249dea76a0eae2 Mon Sep 17 00:00:00 2001
From: Lars Bilke <lars.bilke@ufz.de>
Date: Thu, 17 Feb 2022 11:49:49 +0100
Subject: [PATCH] [web] Added note on file encodings in prj include files.

---
 web/content/docs/userguide/basics/project-file.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/web/content/docs/userguide/basics/project-file.md b/web/content/docs/userguide/basics/project-file.md
index 454cd32cf9f..4dfab2a7932 100644
--- a/web/content/docs/userguide/basics/project-file.md
+++ b/web/content/docs/userguide/basics/project-file.md
@@ -44,6 +44,14 @@ The `<include file="other_file.xml" />`-tag allows to include the content of ano
 </process>
 ```
 
+<div class='note'>
+
+### <i class="far fa-exclamation-triangle"></i>  Note on file encoding
+
+Please do not use `UTF-8 with BOM`-encoding! The BOM-marker from the included file will be included somewhere in the middle of the final prj-file and this will cause OGS' ConfigTree to crash. In a text editor you typically can convert a file to other encodings. Please also check your text editor for default encodings on creating new files. In general `UTF-8` or `ISO 8859-1` should be fine.
+
+</div>
+
 ## Option 2: Apply patch files to the project file
 
 Patch files contain `<replace>`, `<add>` and `<remove>`-elements with [XPath](https://en.wikipedia.org/wiki/XPath)-selectors to modify a specific part of the project file (in-memory during run-time):
-- 
GitLab