Merge pull request #10 from internet4refugees/docs

Docs

docs/user-guide/user-guide-de.md

@@ -0,0 +1,60 @@
+# Beherbergung Software
+
+**Contact:** <internet-for-refugees@lists.c3d2.de>
+
+## Login und Authentifizierung
+
+Die Authentifizierung/Login ist zweistufig, als Erstes wirst du nach deinem Organisations-Login gefragt.
+
+![](../graphics/org_password.png)
+
+Danach siehst du einen minimalen Dialog, welcher dich nach deinen Benutzer-spezifischen Login-Credentials fragt.
+
+![](../graphics/user_password.png)
+
+## Nach Einträgen Suchen
+
+- Prinzipiell ist der Kopf jeder Spalte interaktiv. Durch schreiben in den Spalten Kopf können Suchkriterien zusammen gestellt werden.
+Die Suchergebnisse werden dann direkt in der Tabelle darunter dargestellt.
+
+### Navigation der UI
+
+- **Struktur:** Auf der unteren Hälfte der Oberfläche ist eine Karte, wo die verschiedenen Wohnungen eingetragen sind. 
+
+- **Tabelle zu groß:**Ich möchte noch auf den Slider an der Kante zwischen Map und Tabelle aufmerksam machen um auch den rechten Rand der Tabelle betrachten zu
+können. Nach klicken in die Tabelle kann diese auch durch die Cursor-Tasten verschoben werden.
+
+
+<!---->
+Es wird, dass die Wohnung in dem jeweiligen grauen Kreis ist. Bei genauen Ortsangaben ist das Zentrum des Kreises der Ort.
+-->
+
+
+### Suchen und Sortieren
+
+![](../graphics/table.png)
+
+- **Suche:** Die Tabelle kann nach den meisten Spalten gefiltert werden. Dafür einfach in der Zeile zwischen dem Tabellenkopf und der ersten Zeile mit Angeboten eingeben. Mit dem Filtersymbol das in dieser Zeile in
+jeder Spalte ist, können weitere Optionen fürs Filtern ausgewählt werden. z.B. „enthält den eingegebenen Text“ oder „Spalten die angezeigt werden sollen, müssen einen Wert haben der mindestens so groß wie der eingegebene Wert ist“. Bei den meisten Spalten haben wir bereits eine sinnvolle Vorauswahl.
+
+- **Spalten Typen:** Der Tabellenkopf enthält Eingabe-Felder, womit sich suchen lässt. Das Format des Spaltenkopfs ist dabei abhängig von der jeweiligen Spalte mögliche Formate sind z.B Zeichenketten, Ganzzahlen, Checkboxes oder Datumsangaben. Wenn eine Spalte einen inkorrekten Typ hat sagt uns gerne bescheid.
+
+![](../graphics/city_column.png)
+
+- **Filter anpassen:** Die Filtermethode für einen Spaltenkopf ist in den meisten Fällen die Gleichheit oder Beinhaltet. Diese kann aber auch verändert werden durch die Trichter-Symbol (siehe Bild).
+
+- **Filter/Suche Zurücksetzen:** F5 lädt die Seite neu und setzt somit alle Filter zurück.
+
+- **Tabelle Sortieren** Die Tabelle kann nach beliebigen Spalten sortiert werden. Dafür einfach auf die Überschrift der Spalte klicken z. B. „Beds“ oder „km“. Nochmal darauf klicken dreht die Sortierreihenfolge um. Beim dritten Klick wird die Sortierung aufgehoben.
+
+### Nutzung der Karte
+
+- In der Tabelle gibt es die Spalte Distanz, diese Distanz wird von aktuellen Karten Mittelpunkt zu der jeweiligen Wohnung berechnet.
+
+- Wenn du z.B nach Orten im Dresdner Zentrum sucht richtest du deine Karte so aus das diese auf das Zentrum zeigt und sortierst dann die Einträge in der Tabelle nach der Distanz absteigend.
+
+
+### Fehler / Bugs gefunden.
+
+- Bitte schreibe uns eine Mail mit einer kurzen Beschreibung wie es zu diesem Fehler kam. Mit einer Anleitung wie man diesen Fehler reproduzieren kann. Screenshots sind meistens auch sehr hilfreich zudem potenziell deine Browser + Version.
+

docs/user-guide/user-guide-en.md

@@ -0,0 +1,62 @@
+# Accommodation Software
+
+**Contact:** <internet-for-refugees@lists.c3d2.de>
+
+## Login and authentication
+
+The authentication/login is two-step process, first you will be asked for your organisation login.
+
+![](file:///home/revol-xut/workspace/hostel/docs/graphics/org_password.png)
+
+After that you will see a minimal dialogue asking you for your user-specific login credentials.
+
+![](file:///home/revol-xut/workspace/host/docs/graphics/user_password.png)
+
+## Search for entries
+
+- In principle, the header of each column is interactive. Search criteria can be compiled by writing in the columns header.
+  The search results are then displayed directly in the table below.
+
+### Navigation of the UI
+
+- **Structure:** On the lower half of the interface is a map where the different flats are entered.
+  
+- **Table too large:** I would like to draw your attention to the slider at the edge between the map and the table so that you can also view the right edge of the table.
+  edge of the table. After clicking into the table, it can also be moved by using the cursor keys.
+  
+
+<!--
+
+It becomes that the flat is in the respective grey circle. For exact locations, the centre of the circle is the location.
+-->
+
+### Search and sort
+
+![](file:///home/revol-xut/workspace/housing/docs/graphics/table.png)
+
+- **Search:** The table can be filtered by most columns. To do this, simply type in the line between the table header and the first line with offers. With the filter symbol that is in this line in
+  for example "contains the entered text" or "columns that should be displayed must have a value that is at least as large as the entered value". For most columns we already have a reasonable preselection.
+  
+- **Column types:** The table header contains input fields that can be used to search. The format of the column header depends on the column. Possible formats are e.g. strings, integers, checkboxes or dates. If a column has an incorrect type, please let us know.
+  
+
+![](file:///home/revol-xut/workspace/housing/docs/graphics/city_column.png)
+
+- **Customise filter:** The filter method for a column header is in most cases equality or contains. However, this can also be changed by using the funnel icon (see image).
+  
+- **Reset filter/search:** F5 reloads the page and resets all filters.
+  
+- **Sort table** The table can be sorted by any column. Simply click on the column heading, e.g. "Beds" or "km". Clicking on it again reverses the sorting order. The third click cancels the sorting.
+  
+
+### Using the map
+
+- In the table there is the column Distance, this distance is calculated from the current map centre to the respective flat.
+  
+- If you are looking for places in the centre of Dresden, for example, you align your map so that it points to the centre and then sort the entries in the table according to distance in descending order.
+  
+
+### Error / Bugs found.
+
+- Please send us an email with a short description of how this error occurred. With instructions on how to reproduce this error. Screenshots are usually also very helpful, as well as potentially your browser + version.
+