diff --git a/invenio_app_rdm/theme/templates/semantic-ui/invenio_app_rdm/help/search.en.html b/invenio_app_rdm/theme/templates/semantic-ui/invenio_app_rdm/help/search.en.html index 301d82729..621e91135 100644 --- a/invenio_app_rdm/theme/templates/semantic-ui/invenio_app_rdm/help/search.en.html +++ b/invenio_app_rdm/theme/templates/semantic-ui/invenio_app_rdm/help/search.en.html @@ -1,6 +1,7 @@ {# Copyright (C) 2021 CERN. Copyright (C) 2021 Northwestern University. + Copyright (C) 2024 KTH Royal Institute of Technology. Invenio App RDM is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details. @@ -10,253 +11,250 @@ {%- block page_body %}
-

Search guide

+

{{ _("Search guide") }}

- This guide explains how to write advanced search queries using easy - to understand examples. + {{ _("This guide explains how to write advanced search queries using easy to understand examples.") }}

-

Simple search (one or multiple terms)

+

{{ _("Simple search (one or multiple terms)")}}

- Example: + {{ _("Example:") }} open science{{ _("open science") }}

- Results will match records with the terms open - or science in any field. Note that stemming - is applied so e.g. science will also match - sciences. Search results are ranked according to an algorithm - that takes your query terms into account. + {{ _("Results will match records with the ")}}{{_("terms")}} {{ _("open") }} + {{ _("or") }} {{ _("science") }} {{ _("in") }} {{ _("any field") }}. {{ _("Note that stemming is applied so e.g.") }} {{ _("science") }} {{ _("will also match") }} + {{ _("sciences") }}. {{ _("Search results are ranked according to an algorithm that takes your query terms into account.") }}

- You can require presence of both terms using either the - + or AND operator: + {{ _("You can require") }} {{ _("presence") }} {{ _("of both terms using either the") }} + {{ _("+") }} {{ _("or") }} {{ _("AND") }} {{ _("operator:") }}

- Examples: + {{ _("Examples:") }} +open +science{{ _("+open +science") }} - or + {{ _("or") }} open AND science{{ _("open AND science") }}

- You can require absence of one or more terms using either the - - or NOT operator: + {{ _("You can require") }} {{ _("absence") }} {{ _("of one or more terms using either the") }} + {{ _("-") }} {{ _("or") }} {{ _("NOT") }} {{ _("operator:") }}

- Examples: + {{ _("Examples:") }} -open +science{{ _("-open +science") }} - or + {{ _("or") }} NOT open AND science{{ _("NOT open AND science") }}

-

Phrase search

+

{{ _("Phrase search") }}

- Example: + {{ _("Example:") }} "open science"{{ _("\"open science\"") }}

- Results will match records with the phrase - open science in any field. + {{ _("Results will match records with the") }} {{ _("phrase") }} + {{ _("open science") }} {{ _("in") }} {{ _("any field") }}.

-

Field search

+

{{ _("Field search") }}

- Example: + {{ _("Example:") }} metadata.title:open{{ _("metadata.title:open") }}

- Results will match records with the term open in the - field metadata.title. If you want to search for multiple terms - in the title you must group the terms using parenthesis: + {{ _("Results will match records with the") }} {{ _("term") }} {{ _("open") }} {{ _("in the") }} + {{ _("field") }} {{ _("metadata.title") }}. {{ _("If you want to search for multiple terms") }} + {{ _("in the title you must") }} {{ _("group the terms") }} {{ _("using parenthesis:") }}

- Example: + {{ _("Example:") }} metadata.title:(open science){{ _("metadata.title:(open science)") }}

- See the InvenioRDM documentation for the full list of fields you can search. + {{ _("See") }} {{ _("the InvenioRDM documentation") }} {{ _("for the full list of fields you can search.") }}

-

Combined simple, phrase or field search

+

{{ _("Combined simple, phrase or field search") }}

- Example: + {{ _("Example:") }} +metadata.title:"open science" -metadata.title:policy{{ _("+metadata.title:\"open science\" -metadata.title:policy") }} - or e.g. + {{ _("or e.g.") }} metadata.title:(-open +science){{ _("metadata.title:(-open +science)") }}

- You can combine simple, phrase and field search to construct advanced search - queries. + {{ _("You can combine simple, phrase and field search to construct advanced search") }} + {{ _("queries.") }}

-

Range search

+

{{ _("Range search") }}

- Example: + {{ _("Example:") }} metadata.publication_date:[2017 TO 2018]{{ _("metadata.publication_date:[2017 TO 2018]") }} - (note, you must capitalize TO). + {{ _("(note, you must capitalize") }} {{ _("TO") }}).

- Results will match any record with a publication date between 2017-01-01 and - 2018-01-01 (both dates inclusive). + {{ _("Results will match any record with a publication date between 2017-01-01 and") }} + {{ _("2018-01-01 (both dates inclusive).") }}

-

Note that, partial dates are expanded to full dates, e.g.:

+

{{ _("Note that, partial dates are expanded to full dates, e.g.:") }}

- Use square brackets ([]) for inclusive ranges and use - curly brackets ({}) for exclusive ranges, e.g.: + {{ _("Use square brackets (") }}{{ _("[]") }}{{ _(") for") }} {{ _("inclusive") }} {{ _("ranges and use") }} + {{ _("curly brackets (") }}{{ _("{}") }}{{ _(") for") }} {{ _("exclusive") }} {{ _("ranges, e.g.:") }}

-

Examples of other ranges:

+

{{ _("Examples of other ranges:") }}

-

Ranking/Sorting

+

{{ _("Ranking/Sorting") }}

- By default all searches are sorted according to an internal ranking - algorithm that scores each match against your query. In both the user - interface and REST API, it's possible to sort the results by: + {{ _("By default all searches are sorted according to an internal ranking") }} + {{ _("algorithm that scores each match against your query. In both the user") }} + {{ _("interface and REST API, it's possible to sort the results by:") }}

-

Regular expressions

+

{{ _("Regular expressions") }}

- Regular expressions are a powerful pattern matching language that allow to - search for specific patterns in a field. For instance if we wanted to find - all records with a DOI-prefix 10.5281 we could use a regular expression - search: + {{ _("Regular expressions are a powerful pattern matching language that allow to") }} + {{ _("search for specific patterns in a field. For instance if we wanted to find") }} + {{ _("all records with a DOI-prefix 10.5281 we could use a regular expression") }} + {{ _("search:") }}

- Example: + {{ _("Example:") }} metadata.subjects.identifier:/03yrm5c2[1,6]/{{ _("metadata.subjects.identifier:/03yrm5c2[1,6]/") }}

- Careful, the regular expression must match the entire field value. - See the + {{ _("Careful, the regular expression must match the") }} {{ _("entire") }} {{ _("field value.") }} + {{ _("See the") }} regular expression syntax{{ _("regular expression syntax") }} - for further details. + {{ _("for further details.") }}

-

Missing values

+

{{ _("Missing values") }}

- It is possible to search for records that either are missing a value or have - a value in a specific field using the _exists_ and - not _exists_ field names. + {{ _("It is possible to search for records that either are missing a value or have") }} + {{ _("a value in a specific field using the") }} {{ _("_exists_") }} {{ _("and") }} + {{ _("not _exists_") }} {{ _("field names.") }}

- Example: + {{ _("Example:") }} not _exists_:metadata.additional_titles{{ _("not _exists_:metadata.additional_titles") }} - (all records without metadata.additional_titles) + {{ _("(all records without metadata.additional_titles)") }}

- Example: + {{ _("Example:") }} _exists_:metadata.creators{{ _("_exists_:metadata.creators") }} - (all records with metadata.creators) + {{ _("(all records with metadata.creators)") }}

-

Advanced concepts

-

Boosting

+

{{ _("Advanced concepts") }}

+

{{ _("Boosting") }}

- You can use the boost operator ^ when one term is more relevant - than another. For instance, you can search for all records with the phrase - open science in either title or - description field, but rank records with the phrase in the - title field higher: + {{ _("You can use the boost operator") }} {{ _("^") }} {{ _("when one term is more relevant") }} + {{ _("than another. For instance, you can search for all records with the phrase") }} + {{ _("open science") }} {{ _("in either") }} {{ _("title") }} {{ _("or") }} + {{ _("description") }} {{ _("field, but rank records with the phrase in the") }} + {{ _("title") }} {{ _("field higher:") }}

- Example: + {{ _("Example:") }} metadata.title:"open science"^5 metadata.description:"open science"{{ _("metadata.title:\"open science\"^5 metadata.description:\"open science\"") }}

-

Fuzziness

+

{{ _("Fuzziness") }}

- You can search for terms similar to but not exactly like your search term - using the fuzzy operator ~. + {{ _("You can search for terms similar to but not exactly like your search term") }} + {{ _("using the fuzzy operator") }} ~.

- Example: - oepn~ + {{ _("Example:") }} + {{ _("oepn~") }}

- Results will match records with terms similar to oepn which - would e.g. also match open. + {{ _("Results will match records with terms similar to") }} {{ _("oepn") }} {{ _("which") }} + {{ _("would e.g. also match") }} {{ _("open") }}.

-

Proximity searches

+

{{ _("Proximity searches") }}

- A phrase search like "open science" by default expect all terms - in exactly the same order, and thus for instance would not match a record - containing the phrase "open access and science". A proximity search - allows that the terms are not in the exact order and may include other terms - inbetween. The degree of flexiblity is specified by an integer afterwards: + {{ _("A phrase search like") }} {{ _("\"open science\"") }} {{ _("by default expect all terms") }} + {{ _("in exactly the same order, and thus for instance would not match a record") }} + {{ _("containing the phrase") }} {{ _("\"open access and science\"") }}. {{ _("A proximity search") }} + {{ _("allows that the terms are not in the exact order and may include other terms") }} + {{ _("inbetween. The degree of flexiblity is specified by an integer afterwards:") }}

- Example: + {{ _("Example:") }} "open science"~5{{ _("\"open science\"~5") }}

-

Wildcards

+

{{ _("Wildcards") }}

- You can use wildcards in search terms to replace a single character (using - ? operator) or zero or more characters (using - * operator). + {{ _("You can use wildcards in search terms to replace a single character (using") }} + ? {{ _("operator) or zero or more characters (using") }} + * {{ _("operator).") }}

- Example: + {{ _("Example:") }} ope? scien*{{ _("ope? scien*") }}

- Wildcard searches can be slow and should normally be avoided if possible. + {{ _("Wildcard searches can be slow and should normally be avoided if possible.") }}

{%- endblock page_body%}