tour.tour.search-api-index-fields.yml 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. id: search-api-index-fields
  2. module: search_api
  3. label: Fields indexed in this index
  4. langcode: en
  5. routes:
  6. - route_name: entity.search_api_index.fields
  7. dependencies:
  8. module:
  9. - search_api
  10. tips:
  11. search-api-index-fields-introduction:
  12. id: search-api-index-fields-introduction
  13. plugin: text
  14. label: Fields indexed in this index
  15. 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.
  16. weight: 1
  17. search-api-index-fields-add:
  18. id: search-api-index-fields-add
  19. plugin: text
  20. label: Add fields
  21. body: With the "Add fields" button you can add additional fields to this index.
  22. weight: 2
  23. attributes:
  24. data-class: button-action[data-drupal-selector="edit-add-field"]
  25. search-api-index-fields-label:
  26. id: search-api-index-fields-label
  27. plugin: text
  28. label: Label
  29. body: A label for the field that will be used to refer to the field in most places in the user interface.
  30. weight: 3
  31. attributes:
  32. data-class: details-wrapper:nth(0) table thead th:nth(0)
  33. search-api-index-fields-machine-name:
  34. id: search-api-index-fields-machine-name
  35. plugin: text
  36. label: Machine name
  37. 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.
  38. weight: 4
  39. attributes:
  40. data-class: details-wrapper:nth(0) table thead th:nth(1)
  41. search-api-index-fields-property-path:
  42. id: search-api-index-fields-property-path
  43. plugin: text
  44. label: Property path
  45. 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.
  46. weight: 5
  47. attributes:
  48. data-class: details-wrapper:nth(0) table thead th:nth(2)
  49. search-api-index-fields-type:
  50. id: search-api-index-fields-type
  51. plugin: text
  52. label: Type
  53. 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.
  54. weight: 6
  55. attributes:
  56. data-class: details-wrapper:nth(0) table thead th:nth(3)
  57. search-api-index-fields-boost:
  58. id: search-api-index-fields-boost
  59. plugin: text
  60. label: Boost
  61. body: Only applicable for fulltext fields. Determines how "important" the field is compared to other fulltext fields, to influence scoring of fulltext searches.
  62. weight: 7
  63. attributes:
  64. data-class: details-wrapper:nth(0) table thead th:nth(4)
  65. search-api-index-fields-edit:
  66. id: search-api-index-fields-edit
  67. plugin: text
  68. label: Edit field
  69. body: Some fields have additional configuration available, in which case an "Edit" link is displayed in the "Operations" column.
  70. weight: 8
  71. attributes:
  72. data-class: details-wrapper:nth(0) table tbody td:nth(5) a
  73. search-api-index-fields-remove:
  74. id: search-api-index-fields-remove
  75. plugin: text
  76. label: Remove field
  77. body: "Removes a field from the index again. (Note: Sometimes, a field is required (for example, by a processor) and cannot be removed.)"
  78. weight: 9
  79. attributes:
  80. data-class: details-wrapper:nth(0) table tbody td:nth(6) a
  81. search-api-index-fields-submit:
  82. id: search-api-index-fields-submit
  83. plugin: text
  84. label: Save changes
  85. 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.
  86. weight: 10
  87. attributes:
  88. data-id: edit-actions-submit
  89. search-api-index-fields-cancel:
  90. id: search-api-index-fields-cancel
  91. plugin: text
  92. label: Cancel changes
  93. body: If you have made changes to the index's fields but not yet saved them, the "Cancel" link lets you discard those changes.
  94. weight: 10
  95. attributes:
  96. data-id: edit-actions-cancel