Skip to content

Commit e6f25e4

Browse files
committed
update docs
1 parent c72da6b commit e6f25e4

4 files changed

Lines changed: 17 additions & 15 deletions

File tree

colrev/packages/open_alex/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,8 @@ Links meta data from OpenAlex to existing records.
1717
## Debugging
1818

1919
To test the metadata provided for a particular `open_alex_id` use:
20-
```
20+
21+
```text
2122
https://api.openalex.org/works/OPEN_ALEX_ID
2223
```
2324

colrev/packages/prospero/docs/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ colrev install colrev.prospero
1111
### search
1212

1313
Download the search results and store them in the data/search/ directory.
14+
1415
```bash
1516
colrev search --add colrev.prospero
1617
```
@@ -19,7 +20,8 @@ The search is done using keywords that can be entered into the console.
1920

2021
### load
2122

22-
It is possible to save the records after search. All records that were found during the search will be saved to a data/records.bib file. Load function will add the records to the file or update existing one.
23+
It is possible to save the records after search. All records that were found during the search will be saved to a data/records.bib file.
24+
Load function will add the records to the file or update existing one.
2325

2426
```bash
2527
colrev load

colrev/packages/springer_link/README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The search for is launched with the following command in your ColRev project:
1313
colrev search --add colrev.springer_link
1414
```
1515

16-
Upon entering the above command the user is asked to choose between `DB search` and `API search` (For more details on the searchtypes see manual of CoLRev).
16+
Upon entering the above command the user is asked to choose between `DB search` and `API search` (For more details on the searchtypes see manual of CoLRev).
1717
The user can select the search type by navigating through the list with `uparrow` and `downarrow` and confirm the choice with `enter`.
1818

1919
### DB search
@@ -72,7 +72,7 @@ The user can choose between `complete_search_string` for searching with a comple
7272

7373
#### API search: complex query
7474

75-
The user can type the individual search constraints that can also use the boolean `AND`, `OR` , `NOT`, `NEAR` for a specified search. Following conditions have to be followed:
75+
The user can type the individual search constraints that can also use the boolean `AND`, `OR`, `NOT`, `NEAR` for a specified search. Following conditions have to be followed:
7676

7777
- Search terms must be enclosed in double quotes `"`
7878
- The entire logical condition must be enclosed in parentheses `()`
@@ -91,11 +91,8 @@ The user can type the individual search constraints that can also use the boolea
9191

9292
- `doi:` 10.1007/s11214-017-0458-1
9393
- `pub:` Extremes
94-
- `onlinedate:` 2019-03-29
95-
96-
- also wildcard, e.g., `onlinedate:` 2019-01-*
97-
- `onlinedatefrom:` 2019-09-01%20 `onlinedateto:` 2019-12-31
98-
94+
- `onlinedate:` 2019-03-29 (supports wildcards, e.g., `onlinedate:` 2019-01-*)
95+
- `onlinedatefrom:` 2019-09-01%20 `onlinedateto:` 2019-12-31
9996
- `country:` %22New%20Zealand%22
10097
- `isbn:` 978-0-387-79148-7
10198
- `issn:` 1861-0692
@@ -110,12 +107,14 @@ For additional constraints visit the SpringerLink API Documentation (Link below)
110107
#### API search: entering the search parameters
111108

112109
In this step the user can enter the search parameters into the console.
113-
The user can provide values for the following parameters: keyword, subject, language, year and type. Pressing `enter` will confirm the choice. If the field is blank, this parameter will be skipped. The parameters should be entered as followed:
110+
The user can provide values for the following parameters: keyword, subject, language, year and type.
111+
Pressing `enter` will confirm the choice. If the field is blank, this parameter will be skipped.
112+
The parameters should be entered as followed:
114113

115114
- `keyword:` e.g. onlinear.
116-
- `subject:` Springer Nature supports the subject areas (see below)
115+
- `subject:` Springer Nature supports the subject areas (see below)
117116

118-
- `language:` please use country codes, e.g. "de" for "Germany".
117+
- `language:` Please use country codes, e.g. "de" for "Germany".
119118
- `year:` e.g. 2024.
120119
- `type:` limit search to Book or Journal (case sensitive!).
121120

colrev/packages/unpaywall/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,14 @@ Download search results and store them in the `data/search/` directory. When sea
2828

2929
#### Option 1: Search with keywords
3030

31-
1. Use the following command to add the endpoint:
31+
Use the following command to add the endpoint:
3232

3333
```bash
3434
colrev search --add colrev.unpaywall
3535
```
3636

37-
2. Upon entering the command above with no additional parameters, a console interface opens up, in which the user is asked to enter the parameters and query for their search.
38-
Enter the keywords for the search by following the [Query & Keyword format](#api-search-query--keyword-format) like described underneath.
37+
Upon entering the command above with no additional parameters, a console interface opens up, in which the user is asked to enter the parameters and query for their search.
38+
Enter the keywords for the search by following the [Query & Keyword format](#api-search-query--keyword-format) like described underneath.
3939

4040
#### API search: Query & Keyword format
4141

0 commit comments

Comments
 (0)