Skip to content

Commit ed5fdc0

Browse files
authored
Revise Search & Retrieval Tools documentation
Updated the Search and Retrieval Tools documentation to enhance clarity and detail on search functionalities, including Free Search and parameter sets.
1 parent 5fd3e74 commit ed5fdc0

File tree

1 file changed

+56
-13
lines changed

1 file changed

+56
-13
lines changed

docs/abcd-modules/cataloguing/manual/searching.md

Lines changed: 56 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Located at the top of the cataloging interface, this is the fastest way to find
3030
---
3131

3232
## 2. Advanced Search (`buscar.php`)
33-
**Icon:** ![alt text](../../../media/abcd-modules/cataloguing/manual/data-entry/data-entry-search-icon.png) (Magnifying Glass)
33+
**Icon:** ![alt text](../../../media/abcd-modules/cataloguing/manual/data-entry/data-entry-search-icon.png)
3434

3535
The Advanced Search provides a structured form for building complex queries using Boolean Logic (`AND`, `OR`, `NOT`).
3636

@@ -44,7 +44,7 @@ The Advanced Search provides a structured form for building complex queries usin
4444
---
4545

4646
## 3. Search History & Management
47-
**Icon:** ![Search History & Management](../../../media/abcd-modules/cataloguing/manual/data-entry/data-entry-search-history-icon.png) (Clipboard)
47+
**Icon:** ![Search History & Management](../../../media/abcd-modules/cataloguing/manual/data-entry/data-entry-search-history-icon.png)
4848

4949
Cataloging is repetitive. The **Search History** (`search_history.php`) keeps track of your recent activities.
5050

@@ -57,7 +57,7 @@ Cataloging is repetitive. The **Search History** (`search_history.php`) keeps tr
5757
---
5858

5959
## 4. Search with Thesaurus
60-
**Icon:** ![Search with Thesaurus](../../../media/abcd-modules/cataloguing/manual/data-entry/data-entry-tesaurus.png) (Notebook)
60+
**Icon:** ![Search with Thesaurus](../../../media/abcd-modules/cataloguing/manual/data-entry/data-entry-tesaurus.png)
6161

6262
If your system is connected to a Thesaurus database, this tool allows you to search using **Controlled Vocabulary**.
6363

@@ -71,21 +71,63 @@ If your system is connected to a Thesaurus database, this tool allows you to sea
7171

7272
---
7373

74-
## 5. Free Search / Text Search (`freesearch.php`)
75-
**Icon:** ![Free Search](../../../media/abcd-modules/cataloguing/manual/data-entry/data-entry-search-list-icon.png) (Database Search)
74+
## 5. Search,result in list
75+
**Icon:** ![Free Search](../../../media/abcd-modules/cataloguing/manual/data-entry/data-entry-search-list-icon.png)
76+
This search method is also called **Free Search** as it has powerful options to model the applied search and the resulting output.
7677

77-
Unlike the other methods that rely solely on the Index (FST), the **Free Search** is a powerful tool that can perform **Sequential Searches** on the raw data. This allows you to find text in fields that are *not* indexed.
78+
Unlike the other methods that rely solely on the Index (FST), the **Free Search** is a powerful tool that can perform
7879

7980
**Key Capabilities:**
80-
* **Results in List:** Displays matches in a spreadsheet-like grid (defined in `freesearch_ex.php`), ideal for reviewing large sets of data.
81-
* **Field Targeting:** You can search for a string specifically within a chosen tag (e.g., "Find 'Biology' inside Tag 650").
82-
* **Range Search:** Filter by MFN range (e.g., "Search only records 100 to 500").
83-
81+
* **Results in List:** Displays matches in a spreadsheet-like grid (defined in `freesearch_ex.php`), ideal for comparing records.
82+
* **Mark string:** You can search for an arbitrary string within a chosen field (e.g., "Find 'Biology' inside Tag 650"). This allows you to find text in fields that are *not* indexed.
8483
![Free Search](../../../media/abcd-modules/cataloguing/manual/data-entry/forms-free-search.png)
8584

86-
:::info Sequential Search
87-
Since this method scans records one by one (if not using the index), it is the only way to find data in non-indexed fields (like Notes or internal URLs), though it may be slower on very large databases.
88-
:::
85+
### Form components
86+
A dropdown to use a `Saved parameterset`
87+
Click the name of a parameterset and all fields in the set will be copied to the form
88+
89+
#### Record Selection
90+
Main goal of the record selection is to limit the number of results for the resulting list. This limits also the time to search for arbitrary strings.
91+
- By an advanced search. See [Advanced Search](#2-advanced-search-buscarphp)
92+
Button Search` will copy the search expression to the form
93+
- By entering an MFN range
94+
This options is intended for checks and rarely used, so hidden during normal operation
95+
96+
#### Action on the selected records
97+
- Sort by a selected field. Sort in reverse order is optional
98+
- Mark a string. The entered string will be marked red in the text of the result list
99+
- Action if the marked string is present in the results:
100+
- Omit record if no hits will still find the number of the search results, but records with no hits will not be displayed.
101+
- Omit field if no hits will omit displayed fields for a record if that field does not contain the Mark string
102+
103+
#### Display field(s) and/or PFT
104+
This component determines the shown results.
105+
The shown Fields can be selected in the multiselect list. The radio buttons modify the content:
106+
- Repeatable occurrences can be shown as a single line (concatenated and separated by a ";") or as multiple lines
107+
- The text of a field is preceded by a field indicator. This is either the Title (e.g. "Collectie") or the tag (e.g. "100")
108+
109+
The field `Apply PFT` gives the option to show something extra in front of the standard selected Fields.
110+
- Text example: `if p(v250) then v250 fi`
111+
- Related picture example: `if p(v250) then '<img src="../../bases/snr/snrbld/'v250'" width=225>'fi`
112+
113+
#### Action buttons
114+
115+
Action buttons on the bottom of the form:
116+
- Button `Save parameterset` is used to save a set. See Parameterset
117+
- Button `Delete parameterset` is used to delete set. See Parameterset
118+
- Button `Executes` the search, sorts and marks the results and shows the [Result form](#-result-form)
119+
120+
### Result form
121+
122+
Note the buttons on the right of the form:
123+
- ![Select](../../../media/abcd-modules/cataloguing/manual/data-entry/but_select.jpg) Check box is used to add the record to the set of selected records. Equivalent to Check box in [Toolbar record](../data-entry.md#2-the-record-toolbar-toolbar_recordphp)
124+
- ![Select](../../../media/abcd-modules/cataloguing/manual/data-entry/but_view.jpg) Shows the selected record in a pop-up window with the default display format. Each clicked record gets its own pop-up window. This allows to visually compare the complete records.
125+
126+
### Parameter set
127+
128+
The parametersets are administrated in file `<base>/pfts/<lang>/freesearch_save.tab`. Each line of this file contains the name of the parameterset and the values of the parameters
129+
- Button `Save parameterset` gives options to update an existing set or to create a new set
130+
- Button `Delete parameterset` gives the option to delete an existing parameterset
89131

90132
---
91133

@@ -106,3 +148,4 @@ In bibliographic databases mostly the title field.
106148
* *Tip:* You can select multiple terms to perform an `OR` search (e.g., "Smith" OR "Smyth").
107149

108150

151+

0 commit comments

Comments
 (0)