diff --git a/entity/UserhelpResources/documentation.adoc b/entity/UserhelpResources/documentation.adoc new file mode 100644 index 0000000000000000000000000000000000000000..afa7247cdf3374e56a18a96c4f1088d88dc38176 --- /dev/null +++ b/entity/UserhelpResources/documentation.adoc @@ -0,0 +1,19 @@ += Userhelp_entity + +== Overview + +=== Definition +The Userhelp_entity functions as an image store for the sites userhelp. + +=== Purpose +All images displayed in a userhelp document should be located here. +Once an image is uploaded, it can be referenced by it's id in a userhelp document inside the Designer. + +== FAQ + +[qanda] +How do I reference my uploaded image in the designer?:: + Under the project's preferences->userhelp the two fields have to be configured. + + ressourceDomain -> defines the name of the Domain the image should be loaded from, e.g. "https://myAditoCrm.de". + + relativePathToRessources -> contains a part of the path, the given default should be sufficient ("/client"). + + Inside the userhelp document, the imagepath looks like this: /binary?id=[images id assigned from this entity].