This repository has been archived on 2022-07-13. You can view files and clone it, but cannot push or open issues or pull requests.
opencase_composer/config/tour.tour.search-api-index-fields.yml

102 lines
4.4 KiB
YAML

uuid: 6c162404-f155-469e-800b-ec4726a6ca4e
langcode: en
status: true
dependencies:
module:
- search_api
_core:
default_config_hash: mP2RtTYiDo6dp1q8hXxx2Wgr_1ZvtN7AijjXrwFQV_k
id: search-api-index-fields
label: 'Fields indexed in this index'
module: search_api
routes:
-
route_name: entity.search_api_index.fields
tips:
search-api-index-fields-introduction:
id: search-api-index-fields-introduction
plugin: text
label: 'Fields indexed in this index'
body: 'This page lists which fields are indexed in this index, grouped by datasource. (Datasource-independent fields are listed under "General".) Indexed fields can be used to add filters or sorting to views or other search displays based on the index. Fields with type "Fulltext" can also be used for fulltext searching.'
weight: 1
search-api-index-fields-add:
id: search-api-index-fields-add
plugin: text
label: 'Add fields'
body: 'With the "Add fields" button you can add additional fields to this index.'
weight: 2
attributes:
data-class: 'button-action[data-drupal-selector="edit-add-field"]'
search-api-index-fields-label:
id: search-api-index-fields-label
plugin: text
label: Label
body: 'A label for the field that will be used to refer to the field in most places in the user interface.'
weight: 3
attributes:
data-class: 'details-wrapper:nth(0) table thead th:nth(0)'
search-api-index-fields-machine-name:
id: search-api-index-fields-machine-name
plugin: text
label: 'Machine name'
body: 'The internal ID to use for this field. Can safely be ignored by inexperienced users in most cases. Changing a field''s machine name requires reindexing of the index.'
weight: 4
attributes:
data-class: 'details-wrapper:nth(0) table thead th:nth(1)'
search-api-index-fields-property-path:
id: search-api-index-fields-property-path
plugin: text
label: 'Property path'
body: 'The internal relationship linking the indexed item to the field, with links being separated by colons (:). This can be useful information for advanced users, but can otherwise be ignored.'
weight: 5
attributes:
data-class: 'details-wrapper:nth(0) table thead th:nth(2)'
search-api-index-fields-type:
id: search-api-index-fields-type
plugin: text
label: Type
body: 'The data type to use when indexing the field. Determines how a field can be used in searches. For information on the available types, see the <a href="#search-api-data-types-table">"Data types" box</a> at the bottom of the page.'
weight: 6
attributes:
data-class: 'details-wrapper:nth(0) table thead th:nth(3)'
search-api-index-fields-boost:
id: search-api-index-fields-boost
plugin: text
label: Boost
body: 'Only applicable for fulltext fields. Determines how "important" the field is compared to other fulltext fields, to influence scoring of fulltext searches.'
weight: 7
attributes:
data-class: 'details-wrapper:nth(0) table thead th:nth(4)'
search-api-index-fields-edit:
id: search-api-index-fields-edit
plugin: text
label: 'Edit field'
body: 'Some fields have additional configuration available, in which case an "Edit" link is displayed in the "Operations" column.'
weight: 8
attributes:
data-class: 'details-wrapper:nth(0) table tbody td:nth(5) a'
search-api-index-fields-remove:
id: search-api-index-fields-remove
plugin: text
label: 'Remove field'
body: 'Removes a field from the index again. (Note: Sometimes, a field is required (for example, by a processor) and cannot be removed.)'
weight: 9
attributes:
data-class: 'details-wrapper:nth(0) table tbody td:nth(6) a'
search-api-index-fields-submit:
id: search-api-index-fields-submit
plugin: text
label: 'Save changes'
body: 'This saves all changes made to the fields for this index. Until this button is pressed, all added, changed or removed fields will only be stored temporarily and not effect the actual index used in the rest of the site.'
weight: 10
attributes:
data-id: edit-actions-submit
search-api-index-fields-cancel:
id: search-api-index-fields-cancel
plugin: text
label: 'Cancel changes'
body: 'If you have made changes to the index''s fields but not yet saved them, the "Cancel" link lets you discard those changes.'
weight: 10
attributes:
data-id: edit-actions-cancel