Skip to content

Commit 52ba264

Browse files
author
Gerit Wagner
committed
add documentation for platforms
1 parent 1beaf64 commit 52ba264

File tree

3 files changed

+111
-24
lines changed

3 files changed

+111
-24
lines changed

docs/source/platforms/ebsco.rst

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,46 @@
11
.. _ebsco:
22

33
EBSCOHost
4-
====================
4+
=========
55

6+
EBSCOHost provides access to a wide range of academic databases across disciplines, including business, education, psychology, and health sciences.
67

7-
TODO : interface, fields, ...
8+
Run a Query
9+
-----------
10+
11+
EBSCOHost queries can be constructed using:
12+
13+
- the standard `EBSCOHost advanced search interface <https://search.ebscohost.com/>`_ (requires institutional access), or
14+
- the **persistent link feature**, which captures the full query string for reproducibility.
15+
16+
When working with `search-query`, we recommend extracting the **Search terms** from the **Search History** panel or persistent URL for use as the `search_string`.
17+
18+
.. note::
19+
20+
EBSCOHost query syntax includes field tags such as `AB`, `TI`, `SU`, etc. These should be included directly in the `search_string`.
21+
22+
Avoid setting a `general_search_field` unless the entire query targets the same field (e.g., all terms limited to `AB` for Abstract). Mixed fields should keep `general_search_field` empty.
23+
24+
Store a Query
25+
-------------
26+
27+
When storing an EBSCOHost query in a `.json` file or as a string:
28+
29+
- Use the **Search History** or the **Search Terms** as the `search_string`.
30+
- Leave the `general_search_field` empty **unless** the same field is used consistently across all terms.
31+
32+
.. tip::
33+
34+
To ensure reproducibility, consider including the EBSCO database used (e.g., Business Source Complete) in the `database` field.
35+
36+
Best Practices and Recommendations
37+
----------------------------------
38+
39+
- **Use field tags** (e.g., `AB`, `TI`) explicitly in the query string.
40+
- **Group nexted queries** using parentheses to preserve logic.
41+
42+
Resources
43+
---------
44+
45+
- `EBSCO Search Help <https://connect.ebsco.com/s/article/Searching-EBSCO-Databases?language=en_US>`_
46+
- `EBSCO Search Fields Guide <https://connect.ebsco.com/s/article/Field-Codes-Searchable-EBSCOhost?language=en_US>`_

docs/source/platforms/pubmed.rst

Lines changed: 30 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,46 @@
1+
12
.. _pubmed:
23

34
PubMed
4-
====================
5+
======
6+
7+
PubMed is a free resource supporting the search and retrieval of biomedical and life sciences literature.
8+
9+
Run a Query
10+
-----------
11+
12+
Queries can be entered using either:
13+
14+
- the `basic search box <https://pubmed.ncbi.nlm.nih.gov/>`_, or
15+
- the `advanced Query builder <https://pubmed.ncbi.nlm.nih.gov/advanced/>`_.
16+
17+
These interfaces are functionally equivalent for the purposes of `search-query`. We recommend users always **copy and store the full query string** from either interface.
518

6-
Run a query
7-
--------------
19+
.. note::
820

9-
Queries can be executed in the [basic search box](https://pubmed.ncbi.nlm.nih.gov/) or the advanced [Query box](https://pubmed.ncbi.nlm.nih.gov/advanced/).
21+
For parsing PubMed queries, we recommend using the queries entered in the basic or advanced box as the *search_string* and leave the *general_search_field* empty.
1022

11-
Report a query
12-
-----------------
23+
When running the same query with different serach fields, as in this `example <https://www.cabidigitallibrary.org/doi/10.1079/SEARCHRXIV.2023.00236>`_, *search-query* will assume that the queries are added with an "OR" operator.
1324

14-
It is recommended to store the queries entered in the basic or advanced box as the *search_string* and leave the *general_search_field* empty.
25+
Store a Query
26+
-------------
1527

16-
TODO : interface illustration?
28+
When storing a PubMed query in a `.json` file or as a string:
1729

18-
The advanced search page also offers the option to "Add terms to the query box" (by selecting specific fields in the drop-down).
19-
This box offers a convenient way to add queries and apply the same search field (from the drop-down menu) to the whole query.
20-
Here, it is important to
21-
- use search fields only in the *general_search_field*
22-
- when running the same query with different serach fields, as in this `example <https://www.cabidigitallibrary.org/doi/10.1079/SEARCHRXIV.2023.00236>`_, *search-query* will assume that the queries are added with an "OR" operator.
30+
- Use the content of the **Query box** or **Search details** section as the `search_string`.
31+
- Leave the `general_search_field` empty.
2332

24-
TODO : interface illustration (highlight "OR" button)
2533

26-
TODO : add a linter warning (convention) when multiple general_search_fields are given? (operator unclear)
34+
Best Practices and Recommendations
35+
----------------------------------
2736

37+
The advanced PubMed interface offers a dropdown for search fields such as `[Title/Abstract]`, `[Author]`, etc. When using this feature:
2838

29-
Note: We assume that the [basic search box](https://pubmed.ncbi.nlm.nih.gov/) and the advanced [Query box](https://pubmed.ncbi.nlm.nih.gov/advanced/) handle queries equivalently.
39+
- If you apply the **same field** to the entire query, it is safe to store this value in the `general_search_field`.
40+
- If the query contains **multiple search fields**, `search-query` will treat each term individually, and **leaving `general_search_field` empty is preferred**.
3041

31-
Resources:
42+
Resources
43+
---------
3244

3345
- `PubMed User Guide <https://pubmed.ncbi.nlm.nih.gov/help/>`_
46+
- `Search Builder Help <https://pubmed.ncbi.nlm.nih.gov/advanced/>`_

docs/source/platforms/wos.rst

Lines changed: 40 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,50 @@
11
.. _wos:
22

33
Web of Science
4-
====================
4+
==============
55

6+
Web of Science (WoS) is a multidisciplinary citation database that supports structured search queries with field tags and Boolean operators.
67

7-
TODO : interface, fields, ...
8+
Run a Query
9+
-----------
810

11+
Queries in Web of Science can be constructed using:
912

10-
Note:
11-
Field tags on the following page are outdated (e.g., "DI" no longer works)
12-
https://images.webofknowledge.com/images/help/WOS/hs_wos_fieldtags.html
13+
- the `Basic search interface <https://www.webofscience.com/wos/woscc/basic-search>`_, or
14+
- the `Advanced search interface <https://www.webofscience.com/wos/woscc/advanced-search>`_, which allows for precise control using field tags (e.g., `TI=`, `TS=`, `AU=`).
1315

16+
When working with `search-query`, we recommend copying the **Advanced search query string** directly for use as the `search_string`.
1417

18+
.. note::
19+
20+
Web of Science supports structured queries using field tags such as `TS=` (Topic), `TI=` (Title), `AB=` (Abstract), `AU=` (Author), etc.
21+
22+
You should include these tags explicitly in the `search_string`. Leave the `general_search_field` empty unless the entire query is uniformly scoped to a single field.
23+
24+
Store a Query
25+
-------------
26+
27+
When storing a Web of Science query:
28+
29+
- Use the **Advanced search query string** as the `search_string`.
30+
- Leave the `general_search_field` empty unless all terms share the same field tag.
31+
32+
Example::
33+
34+
(TS="digital health") AND (TS="privacy")
35+
36+
Best Practices and Recommendations
37+
----------------------------------
38+
39+
- Prefer **Advanced Search** for reproducible and structured queries.
40+
- Use **explicit field tags** (`TS=`, `TI=`, `AB=`, etc.) instead of relying on default fields.
41+
42+
43+
Resources
44+
---------
45+
46+
- `Field Tags Reference <https://webofscience.help.clarivate.com/Content/wos-core-collection/woscc-search-field-tags.htm>`_
1547
- `Web of Science Errors <https://images.webofknowledge.com/WOKRS528R6/help/TCT/ht_errors.html>`_
48+
49+
.. note::
50+
Field tags on `this page <https://images.webofknowledge.com/images/help/WOS/hs_wos_fieldtags.html>`_ are outdated (e.g., "DI" no longer works).

0 commit comments

Comments
 (0)