docs(advanced search): update naming to advanced search (DSP-1651) #295

tobiasschweizer · 2021-05-20T11:32:51Z

This PR introduces a new user guideline for the advanced search: https://github.com/dasch-swiss/dsp-ui-lib/blob/fd0ef9cb9fa3ba867cbf4d9cc5a346a0f6e5ae83/docs/how-to-use/search/advanced-search-user-docs.md

mdelez

some minor grammar/spelling corrections

mdelez · 2021-05-25T07:38:30Z

docs/how-to-use/search/advanced-search-user-docs.md

+- selection of a resource class belonging to the selected ontology (optional)
+- specification of properties, comparison operators, and values (optional).
+
+Although selection of a resource or a property ore both are optional, either a resource class has to be selected or at least one property has to be specified,


ore -> or (unless we're mining now 😜)

fixed in 8d3c3f2

mdelez · 2021-05-25T07:38:30Z

docs/how-to-use/search/advanced-search-user-docs.md

+Depending on the value type of the chosen property,
+one or more of the following comparison operators can be selected:
+
+- `is equal to`: value equality: same number, exact same string, overlap of date periods, same target resource.


"matching date periods" is probably more clear here (same for the instances below), unless you truly do mean an overlap

The thing is that each date is represented as a period in DSP-API. All kinds of overlap count as a match, e.g., a search for a date with day precision will match a value with year precision.

That's fair. It's fine the way it is then :)

I understand why you asked though.

Maybe it could be covered in more detail in the DSP-API docs and could be linked to from here?

https://docs-api.dasch.swiss/03-apis/api-v2/query-language/#date-comparisons

However, I am not sure how many technical details a user of the GUI should know

mdelez · 2021-05-25T07:38:30Z

docs/how-to-use/search/advanced-search-user-docs.md

+- `is equal to`: value equality: same number, exact same string, overlap of date periods, same target resource.
+- `is not equal to`: value inequality: not same number, not exact same string, no overlap of date periods, not same target resource.
+- `is greater than`: value comparison: number is greater than search value, date period begins after search value.
+- `is greater than or equal to` value equality / value comparison: number is equal or greater than search value, overlap of date periods or date period begins after search value.


fixed in 8d3c3f2

mdelez · 2021-05-25T07:38:30Z

docs/how-to-use/search/advanced-search-user-docs.md

+- `is greater than`: value comparison: number is greater than search value, date period begins after search value.
+- `is greater than or equal to` value equality / value comparison: number is equal or greater than search value, overlap of date periods or date period begins after search value.
+- `is less than`: value comparison: number is less than search value, date period ends before search value.
+- `is less than or equal to`: value equality / value comparison: number is equal or less than search value, overlap of date periods or date period ends before search value.


fixed in 8d3c3f2

mdelez · 2021-05-25T07:38:30Z

docs/how-to-use/search/advanced-search-user-docs.md

+- `is less than`: value comparison: number is less than search value, date period ends before search value.
+- `is less than or equal to`: value equality / value comparison: number is equal or less than search value, overlap of date periods or date period ends before search value.
+- `exists`: a value for the given property exists.
+- `is like`: search value is contained in a text using the SPARQL [REGEX](https://www.w3.org/TR/sparql11-query/#func-regex) function (support of regular expressions).


support of -> supports

fixed in 8d3c3f2

mdelez · 2021-05-25T07:38:30Z

docs/how-to-use/search/advanced-search-user-docs.md

+
+### Regular Expressions (is like)
+
+The `is like` operator lets the user search for texts that are *like* the search value, supporting regular expressions.


the search value, supporting regular expressions. -> the search value via the support of regular expressions.

fixed in 8d3c3f2

mdelez · 2021-05-25T07:38:30Z

docs/how-to-use/search/advanced-search.md


-The extended search allows you to filter by project, by source type (resource class), or by the metadata (properties) of source types. Each filter can be standalone or combined. The metadata field can be precisely filtered with criteria such as "contains", "like", "equals to", "exists" or in case of a date value with "before" or "after". In addition, for a metadata field that is connected to another source type, it's possible to filter by this second source type. If you are looking for the source type "Photograph" with the metadata field "Photographer", which is connected to source type "Person", you can search for photograph(s) taken by person(s) who is born before February 1970. The result of this request will be an intersection of the two source types.
+The advanced search allows you to filter by project, by source type (resource class), or by the metadata (properties) of source types. Each filter can be standalone or combined. The metadata field can be precisely filtered with criteria such as "contains", "like", "equals to", "exists" or in case of a date value with "before" or "after". In addition, for a metadata field that is connected to another source type, it's possible to filter by this second source type. If you are looking for the source type "Photograph" with the metadata field "Photographer", which is connected to source type "Person", you can search for photograph(s) taken by person(s) who is born before February 1970. The result of this request will be an intersection of the two source types.


Each filter can be standalone or combined. -> Each filter can be used individually or combined.

fixed in 8d3c3f2

mdelez · 2021-05-25T07:38:30Z

docs/how-to-use/search/index.md

@@ -14,7 +14,7 @@ DspSearchModule is part of @dasch-swiss/dsp-ui, follow [the installation guide](

 ## Components

-This module contains various components to search. The main component is the dsp-search-panel, which contains the dsp-fulltext-search, dsp-extended-search and dsp-expert-search. All of them can be used standalone or in combination in dsp-search-panel.
+This module contains various components to search. The main component is the dsp-search-panel, which contains the dsp-fulltext-search, dsp-advanced-search and dsp-expert-search. All of them can be used standalone or in combination in dsp-search-panel.


standalone -> individually (standalone is correct and understandable, I would just personally use individually)

flavens

It looks good, some typo to fix though.

flavens · 2021-05-25T07:43:39Z

docs/how-to-use/search/advanced-search-user-docs.md

+## Introduction
+
+The `AdvancedSearchComponent` allows for the creation of complex queries using a graphical widget.
+The widget's contents are then turned into a string representing a Gravsearch (SPAQRL) query to be sent to DSP-API.


typo: SPARQL

fixed in 8d3c3f2

flavens · 2021-05-25T07:43:39Z

docs/how-to-use/search/advanced-search-user-docs.md

+- selection of a resource class belonging to the selected ontology (optional)
+- specification of properties, comparison operators, and values (optional).
+
+Although selection of a resource or a property ore both are optional, either a resource class has to be selected or at least one property has to be specified,


typo: ore > or

already caught be @mdelez :-)

flavens · 2021-05-25T07:43:39Z

docs/how-to-use/search/advanced-search-user-docs.md

+- `is greater than or equal to` value equality / value comparison: number is equal or greater than search value, overlap of date periods or date period begins after search value.
+- `is less than`: value comparison: number is less than search value, date period ends before search value.
+- `is less than or equal to`: value equality / value comparison: number is equal or less than search value, overlap of date periods or date period ends before search value.
+- `exists`: a value for the given property exists.


sometimes you start with a "A" value, sometimes not > make it consistent

fixed in 8d3c3f2

flavens · 2021-05-25T07:43:39Z

mkdocs.yml

@@ -18,7 +18,7 @@ nav:
        - Introduction Search: how-to-use/search/index.md
        - Search-panel: how-to-use/search/search-panel.md
        - Fulltext search: how-to-use/search/fulltext-search.md
-        - Extended search: how-to-use/search/extended-search.md
+        - advanced search: how-to-use/search/advanced-search.md


to be picky: Advanced

fixed in 8d3c3f2

mrivoal

Looks fine, thanks for requesting the review @tobiasschweizer :-)

docs(advanced search): update naming to advanced search

95af3ad

tobiasschweizer self-assigned this May 20, 2021

tobiasschweizer added documentation Improvements or additions to documentation user requirement labels May 20, 2021

Tobias Schweizer and others added 8 commits May 21, 2021 08:43

docs(advanced search): update naming to advanced search

b516f46

docs(advanced search): explain comparison operators

a103925

docs(advanced search): explain is like / regex

2af9fc0

Merge branch 'main' into wip/dsp-1651-search-docs

2778e26

docs(advanced search): explain is like / regex

0e3ca22

docs(advanced search): explain mactches

d80ab9a

docs(advanced search): explain matches for linking props

a5b3b94

docs(advanced search): explain matches

fd0ef9c

tobiasschweizer requested review from flavens, kilchenmann, mdelez and gautschr May 25, 2021 05:45

Update advanced-search-user-docs.md

d4bb3ad

gautschr approved these changes May 25, 2021

View changes

mdelez requested changes May 25, 2021

View changes

flavens reviewed May 25, 2021

View changes

tobiasschweizer requested review from loicjaouen and mrivoal May 25, 2021 07:43

Tobias Schweizer added 2 commits May 25, 2021 10:33

docs(advanced search): fix typos

8d3c3f2

docs(advanced search): fix typos

43d25bc

tobiasschweizer requested a review from mdelez May 25, 2021 08:44

mdelez approved these changes May 25, 2021

View changes

Merge branch 'main' into wip/dsp-1651-search-docs

0dcd07e

mrivoal approved these changes May 25, 2021

View changes

tobiasschweizer merged commit 7f8c7e6 into main May 25, 2021
8 checks passed

tobiasschweizer deleted the wip/dsp-1651-search-docs branch May 25, 2021 09:09

docs(advanced search): update naming to advanced search (DSP-1651) #295

docs(advanced search): update naming to advanced search (DSP-1651) #295

tobiasschweizer commented May 20, 2021 •

edited

mdelez left a comment

mdelez May 25, 2021

tobiasschweizer May 25, 2021

mdelez May 25, 2021

tobiasschweizer May 25, 2021

mdelez May 25, 2021

tobiasschweizer May 25, 2021

tobiasschweizer May 25, 2021

tobiasschweizer May 25, 2021

mdelez May 25, 2021

tobiasschweizer May 25, 2021

mdelez May 25, 2021

tobiasschweizer May 25, 2021

mdelez May 25, 2021

tobiasschweizer May 25, 2021

mdelez May 25, 2021

tobiasschweizer May 25, 2021

mdelez May 25, 2021

tobiasschweizer May 25, 2021

mdelez May 25, 2021

flavens left a comment

flavens May 25, 2021

tobiasschweizer May 25, 2021

flavens May 25, 2021

tobiasschweizer May 25, 2021

flavens May 25, 2021

tobiasschweizer May 25, 2021

flavens May 25, 2021

tobiasschweizer May 25, 2021

mrivoal left a comment


		### Regular Expressions (is like)

		The `is like` operator lets the user search for texts that are like the search value, supporting regular expressions.


		The extended search allows you to filter by project, by source type (resource class), or by the metadata (properties) of source types. Each filter can be standalone or combined. The metadata field can be precisely filtered with criteria such as "contains", "like", "equals to", "exists" or in case of a date value with "before" or "after". In addition, for a metadata field that is connected to another source type, it's possible to filter by this second source type. If you are looking for the source type "Photograph" with the metadata field "Photographer", which is connected to source type "Person", you can search for photograph(s) taken by person(s) who is born before February 1970. The result of this request will be an intersection of the two source types.
		The advanced search allows you to filter by project, by source type (resource class), or by the metadata (properties) of source types. Each filter can be standalone or combined. The metadata field can be precisely filtered with criteria such as "contains", "like", "equals to", "exists" or in case of a date value with "before" or "after". In addition, for a metadata field that is connected to another source type, it's possible to filter by this second source type. If you are looking for the source type "Photograph" with the metadata field "Photographer", which is connected to source type "Person", you can search for photograph(s) taken by person(s) who is born before February 1970. The result of this request will be an intersection of the two source types.

docs(advanced search): update naming to advanced search (DSP-1651) #295

docs(advanced search): update naming to advanced search (DSP-1651) #295

Conversation

tobiasschweizer commented May 20, 2021 • edited

mdelez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

flavens left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mrivoal left a comment

Choose a reason for hiding this comment

tobiasschweizer commented May 20, 2021 •

edited