From 474e699e3fa349772ce9d79daf2631a7ebd56c76 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=B6rg=20Rade?= <joerg.rade@kuehne-nagel.com>
Date: Mon, 10 Feb 2020 18:03:53 +0100
Subject: [PATCH] #19 Users Gude started with hint on Branding and Rendering

---
 docs/UsersGuide.md | 67 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 67 insertions(+)
 create mode 100644 docs/UsersGuide.md

diff --git a/docs/UsersGuide.md b/docs/UsersGuide.md
new file mode 100644
index 0000000..78d8356
--- /dev/null
+++ b/docs/UsersGuide.md
@@ -0,0 +1,67 @@
+# Users Guide
+This is about explaining what can be done on the client side in order to customize the viewer.
+
+## Branding
+See kroviz.css
+
+Colours and dimensions can be influenced here, as well as images:
+
+```
+
+.text-danger {
+    color: red !important;
+}
+
+.text-warn {
+    color: orange !important;
+}
+
+.text-ok {
+    color: green !important;
+}
+
+.text-normal {
+    color: black;
+}
+[...]
+@font-face {
+    font-family: Chicago;
+    src: url('/fonts/ChicagoFLF.ttf');
+}
+
+div {
+   /* font-family: Chicago, sans-serif;*/
+}
+
+.logo-button-image:before {
+    content: "";
+    width: 75px;
+    height: 40px;
+    display: inline-block;
+    vertical-align: text-top;
+    background-color: transparent;
+    background-position : center center;
+    background-repeat:no-repeat;
+    background-size: contain, cover;
+    background-image : url("https://svn.apache.org/repos/asf/comdev/project-logos/originals/isis.svg");
+}
+
+```  
+
+## Rendering
+Some data, eg. Dates can be rendered differently depending on context:
+* when editing in a form it can be practical to click on a cell in a 5 by 7 table representing a month, or
+* selecting a point on a x-axis, resembling a timeline.
+
+Objects may even be aggregations of different aspects, eg. may have a Date and a Location so their representation
+depends on the aspect and the perspective most useful to the user working with them.
+
+Which renderers should be provided for what data?
+
+One approach to identifying applicable renderers is duck typing ("if it walkes like a duck and quarks like a duck ...").
+This means resorting to behavior / properties of an object. If eg. an object has two properties of type date, labeled "start" and "end"
+it is reasonable to render it on a timeline. If there is a list of such object they can form a gantt chart. 
+
+The number of renderers included with kroviz is limited and there isn't yet an example of selecting one of possibly many applicale renderers, but there is room for impovement and creativity.   
+
+