From d14863232343c64736f19a42fb487b8ef031b934 Mon Sep 17 00:00:00 2001
From: engisalor <50170623+engisalor@users.noreply.github.com>
Date: Thu, 19 Oct 2023 18:56:55 +0200
Subject: [PATCH] docs: update guide, env example

---
 .env-example         |  3 +++
 config/user_guide.md | 23 +++++++++++++++++++++++
 2 files changed, 26 insertions(+)

diff --git a/.env-example b/.env-example
index 8324625..39f37aa 100644
--- a/.env-example
+++ b/.env-example
@@ -27,6 +27,9 @@ SGEX_SERVER=ske
 # custom call throttling times (see sgex package docs)
 # SGEX_WAIT_DICT="<{JSON_DICT}>"
 
+# URL for generating external links
+# SERVER_URL=https://app.sketchengine.eu
+
 # docker
 IMAGE="quartz:latest"
 CONTAINER="quartz"
diff --git a/config/user_guide.md b/config/user_guide.md
index 1daeeb0..0442ae6 100644
--- a/config/user_guide.md
+++ b/config/user_guide.md
@@ -83,6 +83,29 @@ Graphs are made with [plotly](https://plotly.com/) and have interactive features
 - Select/deselect corpora in the legend
 - Other features are shown on the top right of a graph when hovering over it
 
+#### Summary table
+
+The summary table can be shown/hidden with the spreadsheet icon next to the `settings` button.
+
+| Column | Description |
+|-|-|
+| query | Query as written in the `search` bar |
+| cql | CQL representation of the query |
+| corpus | Current corpus |
+| attribute | Current attribute |
+| n attr. | Number of text types collected: if many exist, only the top `N` are shown to prevent the app from freezing |
+| frq corp. | Occurrences in the whole corpus: the absolute number of times a query appears|
+| frq attr. | Sum of occurrences in each attribute: when an attribute is single-value, the sum of all occurrences across text types generally equals `frq. corp.`; when an attribute is multivalue, this can exceed `freq. corp.` (because an occurrence can be shared by multiple text types) |
+| fpm corp. | Frequency per million tokens in the whole corpus |
+| M rel % | Mean relative density in text types |
+| M reltt | Mean relative density per million in text types |
+| M fpm | Mean frequency per million in text types |
+| M frq | Mean occurrences in text types |
+
+#### Data point URL generation
+
+If activated, this feature generates a URL to the Sketch Engine GUI when a specific data point is clicked. Once the point is selected, click the link icon on the top right of the graph to open a new tab.
+
 #### Advanced queries
 
 *For custom search behaviors*