From cf4d78ede359738109e52510f704ab63883e8be5 Mon Sep 17 00:00:00 2001 From: Ubbo Veentjer Date: Fri, 15 Nov 2019 14:17:41 +0100 Subject: [PATCH 1/4] start userdoc how to use faceted search --- docs/faceted-search-userdoc.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 docs/faceted-search-userdoc.md diff --git a/docs/faceted-search-userdoc.md b/docs/faceted-search-userdoc.md new file mode 100644 index 0000000..94c1eab --- /dev/null +++ b/docs/faceted-search-userdoc.md @@ -0,0 +1,13 @@ +# How to search + +After entering a search term a list of matching documents shown. + +## Facets + +On the left side a list of terms is presented which allow to further filter the result set. A facet could be presented like: + + Place of Publication + - Munich (14) + - Berlin (8) + +This tells that out of the documents found 14 state to be published in Munich and 8 believe they where published in Berlin. Clicking on the label, e.g. "Munich" will just show you the 14 documents published in Munich. You could now apply further filters, like on the "Publication Year". The filter could be removed with clickling the small "-" in front of the selected term. If you do not click on the term "Munich" but on the "-" all documents **not** published in Munich are shown. Afterwards there is a small "+" in front of the filter wichh allows you to undo this filter again. -- GitLab From 40ae5c716070e673c8895b8b8374f4b32f20c73c Mon Sep 17 00:00:00 2001 From: Ubbo Veentjer Date: Fri, 22 Nov 2019 13:16:53 +0100 Subject: [PATCH 2/4] corrections and format (80 chars/line) --- docs/faceted-search-userdoc.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/faceted-search-userdoc.md b/docs/faceted-search-userdoc.md index 94c1eab..e66a3fd 100644 --- a/docs/faceted-search-userdoc.md +++ b/docs/faceted-search-userdoc.md @@ -1,13 +1,21 @@ # How to search -After entering a search term a list of matching documents shown. +After entering a search term a list of matching documents is presented. ## Facets -On the left side a list of terms is presented which allow to further filter the result set. A facet could be presented like: +On the left side a list of terms is presented which allow to further filter the +result set. A facet could be presented like: Place of Publication - Munich (14) - Berlin (8) -This tells that out of the documents found 14 state to be published in Munich and 8 believe they where published in Berlin. Clicking on the label, e.g. "Munich" will just show you the 14 documents published in Munich. You could now apply further filters, like on the "Publication Year". The filter could be removed with clickling the small "-" in front of the selected term. If you do not click on the term "Munich" but on the "-" all documents **not** published in Munich are shown. Afterwards there is a small "+" in front of the filter wichh allows you to undo this filter again. +This tells that out of the documents found 14 state to be published in Munich +and 8 believe they where published in Berlin. Clicking on the label, e.g. +"Munich" will just show you the 14 documents published in Munich. You could now +apply further filters, like on the "Publication Year". The filter could be +removed with clicking the small "-" in front of the selected term. If you do +not click on the term "Munich" but on the "-" all documents **not** published +in Munich are shown. Afterwards there is a small "+" in front of the filter +which allows you to undo this filter again. -- GitLab From de556f997b95969385e8fd0761df082fe50b0494 Mon Sep 17 00:00:00 2001 From: Ubbo Veentjer Date: Fri, 22 Nov 2019 17:19:19 +0100 Subject: [PATCH 3/4] corrections from Johannes --- docs/faceted-search-userdoc.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/faceted-search-userdoc.md b/docs/faceted-search-userdoc.md index e66a3fd..e413f8e 100644 --- a/docs/faceted-search-userdoc.md +++ b/docs/faceted-search-userdoc.md @@ -11,11 +11,11 @@ result set. A facet could be presented like: - Munich (14) - Berlin (8) -This tells that out of the documents found 14 state to be published in Munich -and 8 believe they where published in Berlin. Clicking on the label, e.g. -"Munich" will just show you the 14 documents published in Munich. You could now -apply further filters, like on the "Publication Year". The filter could be -removed with clicking the small "-" in front of the selected term. If you do -not click on the term "Munich" but on the "-" all documents **not** published -in Munich are shown. Afterwards there is a small "+" in front of the filter -which allows you to undo this filter again. +This tells that 14 documents have been published in Munich and 8 have been +published in Berlin. Clicking on the label name, e.g. "Munich" will just show +you the 14 documents which have been published in Munich. You could now apply +further filters, like on the "Publication Year". The filter can be removed with +clicking the small minus sign "-" in front of the selected term. If you do not +click on the term "Munich", but on the minus sign "-", all documents **not** +published in Munich are shown. After applying the filter, a small plus sign "+" +appears in front of the filter. This allows you to undo this filter again. -- GitLab From bc2237d781431720c03b2bbec4e7e5de02c4cb99 Mon Sep 17 00:00:00 2001 From: Ubbo Veentjer Date: Fri, 29 Nov 2019 13:15:57 +0100 Subject: [PATCH 4/4] changelog entry --- repo.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/repo.xml b/repo.xml index 0e0aef4..2851d16 100644 --- a/repo.xml +++ b/repo.xml @@ -18,7 +18,7 @@
  • Features
      -
    • +
    • Add document how to use faceted search
  • Bugfixes -- GitLab