Skip to content

Commit 82639c5

Browse files
committed
docs: Update usage documentation for clarity and consistency in field descriptions
1 parent d7234c4 commit 82639c5

2 files changed

Lines changed: 22 additions & 15 deletions

File tree

docs/source/content/usage.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ When you open the 'Load Data' menu, the Data Import Window will appear. This win
2222

2323
Each source file added via the 'Add' button can be configured to tailor the data set to specific requirements. Configuration options include:
2424

25-
**Fields**
25+
#### Fields
2626

2727
Fields represent the individual columns or attributes in the source file and can be assigned one of four types: **Text**, **Int**, **Float**, or **Boolean**. Each field type determines how the data is interpreted and processed by the application.
2828

@@ -35,29 +35,36 @@ Certain field types can have additional variants, which define how the data in t
3535
- **Index** (for Text fields): Adds properties such as:
3636
- **Language**: Specifies the language of the data for indexing purposes. Currently, only one language per field is supported.
3737
- **Default**: Marks the field as the default for searches, allowing queries to omit specifying the field explicitly. Only one default field is allowed per data set, and at least one index field is required. The source file containing the index field becomes the **main source file**, which is used to display all data from the source (e.g., if the source CSV file has columns like `text`, `author`, and `year`, all columns will be displayed unless disabled).
38-
- **Unique** (for Int fields): Adds the **Identifiable** property, which designates the field as the unique identifier for the source. While this does not affect search capabilities, it optimizes the initial data loading process.
38+
- **Unique** (for Int fields): Adds the **Identifiable** property, which designates the field as the unique identifier for the source. It optimizes the initial data loading process and is needed for the **Filter** feature for identification.
3939

4040
**Float** and **Boolean** fields do not support additional properties or variants.
4141

42-
Every field also includes a **Link** option, which is particularly useful for the main source file. This feature enables linking fields in the main source to fields in other source files, allowing for relationships between data sets. For example, if the main source contains a field called `author` and another source file contains detailed information about authors, the linked source can be used to fetch and display additional information during queries. Note that linked sources are not searchable, and links are unidirectional, flowing from the main source to the linked source (e.g., `main source -> linked source`).
42+
Every field also includes a **Link** option, which is particularly useful for the main source file. This feature enables linking fields in the main source to fields in other source files by identical fields, allowing for relationships between data sets. For example, if the main source contains a field called `author` and another source file contains detailed information about authors, the linked source can be used to fetch and display additional information during queries. Note that linked sources are not searchable, and links are unidirectional, flowing from the main source to the linked source (e.g., `main source -> linked source`).
4343

44-
**Filter**
44+
![Fields Configuration](../_static/fields.png)
4545

46-
In the Filter tab the pre-filtering is configured.
46+
#### Filter
47+
48+
The Filter tab is where pre-filtering is configured. Pre-filtering selects a set of entries based on linked conditions when used in a search. This configuration consists of setting filter conditions and links. For this configuration to work, a link must exist in the current source.
49+
50+
The filter configuration consists of three key elements:
51+
- **Key**: A field in the main source that uniquely identifies each entry.
52+
- **Link Key**: A field in the linked source whose value is used to evaluate conditions.
53+
- **Value**: A field in the current source that stores the value for conditional lookups.
4754

4855
![Filter Configuration](../_static/filter_config.png)
4956

50-
See <Link To Pre-filter> for more details.
57+
For more details on how to use variants in searches, see [Pre-filtering](#pre-filtering).
5158

52-
**Variant Mapping**
59+
#### Variant Mapping
5360

5461
Variant Mapping is used to unify multiple fields into a single representation.
5562

5663
The **Base Field** is the primary field used for the representation. For example, if a data set contains Greek names and their English translations, the base field would be the one containing the English names (e.g., "Jesus"). It is important to note that the base field itself is not used when searching for variants; only the values from the fields specified in the **Variants** textbox are considered during searches.
5764

5865
The **Variants** textbox accepts a comma-separated list of fields from the source file that contain the variations of the base field. For instance, these fields might include translations or alternative spellings of a name.
5966

60-
#### **Example**
67+
**Example**
6168

6269
Consider a data set where:
6370

@@ -67,7 +74,7 @@ Consider a data set where:
6774
The data should be structured as follows:
6875

6976
| label_en | label_el_norm | variant |
70-
| -------- | ------------- | -------- |
77+
|----------|---------------|----------|
7178
| name1 | translation1 | variant1 |
7279
| name1 | translation2 | variant2 |
7380
| name1 | translation1 | variant3 |
@@ -82,7 +89,7 @@ The application will then group all translations and variants (e.g., `translatio
8289

8390
![Variant Mapping](../_static/variant_mapping.png)
8491

85-
For more details on how to use variants in searches, see [Variant Search](<Link To Variant Search>).
92+
For more details on how to use variants in searches, see [Variant Search](#variant-search).
8693

8794
## Load a Plugin
8895

@@ -111,7 +118,7 @@ For a more precise search, wrap the query in quotes (e.g., "Term1 Term2 Term3")
111118

112119
![Exact search](../_static/exact_search.png)
113120

114-
**Boolean Search**
121+
#### Boolean Search
115122

116123
Boolean search allows you to refine your search by logically connecting terms using operators such as `AND`, `OR`, `AND NOT`, and parentheses `()` for grouping. For example:
117124

@@ -122,7 +129,7 @@ Boolean search allows you to refine your search by logically connecting terms us
122129

123130
![Boolean search](../_static/boolean_search.png)
124131

125-
**Field Search**
132+
#### Field Search
126133

127134
With field search, you can target specific fields in the dataset by specifying a field and its corresponding value. This allows precise filtering based on pre-defined field values. For instance:
128135

@@ -131,7 +138,7 @@ With field search, you can target specific fields in the dataset by specifying a
131138

132139
![Field search](../_static/field_search.png)
133140

134-
**Variant Search**
141+
#### Variant Search
135142

136143
Variant search enables you to search for different variations of terms that often represent the same concept. For example, terms like `America`, `USA`, `US`, and `United States` may all refer to the same entity in your data set. These variants are configured during the data set loading process (see [Load a Data Set](#load-a-data-set)).
137144

@@ -144,7 +151,7 @@ For instance:
144151

145152
- `@name:Jesus` searches all entries where the field `name` contains terms associated with the label _Jesus_.
146153

147-
**Pre filtering**
154+
#### Pre filtering
148155

149156
Pre-filtering enables the pre-selection of entries based on linked conditions and criteria, allowing for targeted filtering in cases where multiple data sources are interconnected. Unlike simple field searches, pre-filtering draws from data relationships configured during the data set loading process (see [Load a Data Set](#load-a-data-set)). These relationships point to different fields and values across multiple sources.
150157
For example, the example data set provided in the [installation section](installation.md) includes a file that indicates whether a specific name or token is present or missing in certain phrases. These conditions are established in the configuration of the data set itself, not by the application.

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Features:
1616
* **Text Search**: Quickly search through large text corpora to find specific terms or phrases.
1717
* **Text Comparison**: Easily compare different versions of texts to identify changes and variations.
1818
* **Word Tagging**: Annotate words with custom tags to categorize and analyze text data effectively.
19-
* **User-Friendly Interface**: Intuitive and easy-to-navigate interface for both novice and experienced users.
19+
* **User-Friendly Interface**: Intuitive and easy-to-navigate user interface.
2020
* **Extensible**: Built with extensibility in mind, allowing developers to add new features and functionalities.
2121

2222
Citation:

0 commit comments

Comments
 (0)