You are here

Home » API reference » Super Term Reference Autocomplete Widget 8

README.txt in Super Term Reference Autocomplete Widget 8 

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Basic usage
 * Maintainers

INTRODUCTION
------------

The Straw (Super Term Reference Autocomplete Widget) module provides a new
interface for associating taxonomy terms with content using a term reference
field. It looks just like a normal placeholder select widget, but it shows the
whole tag hierarchy both when displaying existing values, and it both shows and
searches the whole hierarchy and when finding matches for the autocomplete
dropdown. If term creation is enabled, it also allows a new term to be created
along with all of its parents that don't exist already.

* To submit bug reports and feature suggestions, or to track changes:
- https://www.drupal.org/project/issues/straw


REQUIREMENTS
------------

At this time Straw can only be used with term reference fields. As such, the
core taxonomy module must be enabled in order to make use of it.


INSTALLATION
------------

Install this module via composer by running the following command:

* composer require drupal/straw


CONFIGURATION
------------
Configuring a field widget to use Straw requires two steps. First, in the
settings for the field, choose the "Straw selection" reference method. Then, for
the field widget settings on the Manage Form Display tab, choose "Autocomplete
(Straw style)".


BASIC USAGE
------------

Once Straw is configured for a field, that field will show all the parents of
the selected terms in addition to the term itself. Each level of the hierarchy
is separated from the others by two right-facing arrows (>>), and if term
creation is enabled for the field, these same separators can also be used
between levels of the hierarchy when typing in a new term, and all terms in the
hierarchy that don't already exist will get created. For instance, entering
"Travel >> Tourist Destinations" will create two terms, "Travel" and "Tourist
Destinations", with the latter as a child of the former.


MAINTAINERS
------------

Current maintainers:
 * Clint Randall (camprandall) - https://drupal.org/u/camprandall
 * Jay Kerschner (JKerschner) - https://drupal.org/u/jkerschner
 * Brian Seek (brian.seek) - https://drupal.org/u/brianseek
 * Mike Goulding (mikeegoulding) - https://drupal.org/user/mikeegoulding

This project has been sponsored by:
 * Ashday Interactive Systems
   Building your digital ecosystem can be daunting. Elaborate websites,
   complex cloud applications, mountains of data, endless virtual wires
   of integrations.

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Basic usage

  9.  * Maintainers

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. The Straw (Super Term Reference Autocomplete Widget) module provides a new

  15. interface for associating taxonomy terms with content using a term reference

  16. field. It looks just like a normal placeholder select widget, but it shows the

  17. whole tag hierarchy both when displaying existing values, and it both shows and

  18. searches the whole hierarchy and when finding matches for the autocomplete

  19. dropdown. If term creation is enabled, it also allows a new term to be created

  20. along with all of its parents that don't exist already.

  21. 

  22. * To submit bug reports and feature suggestions, or to track changes:

  23. - https://www.drupal.org/project/issues/straw

  24. 

  25. 

  26. REQUIREMENTS

  27. ------------

  28. 

  29. At this time Straw can only be used with term reference fields. As such, the

  30. core taxonomy module must be enabled in order to make use of it.

  31. 

  32. 

  33. INSTALLATION

  34. ------------

  35. 

  36. Install this module via composer by running the following command:

  37. 

  38. * composer require drupal/straw

  39. 

  40. 

  41. CONFIGURATION

  42. ------------

  43. Configuring a field widget to use Straw requires two steps. First, in the

  44. settings for the field, choose the "Straw selection" reference method. Then, for

  45. the field widget settings on the Manage Form Display tab, choose "Autocomplete

  46. (Straw style)".

  47. 

  48. 

  49. BASIC USAGE

  50. ------------

  51. 

  52. Once Straw is configured for a field, that field will show all the parents of

  53. the selected terms in addition to the term itself. Each level of the hierarchy

  54. is separated from the others by two right-facing arrows (>>), and if term

  55. creation is enabled for the field, these same separators can also be used

  56. between levels of the hierarchy when typing in a new term, and all terms in the

  57. hierarchy that don't already exist will get created. For instance, entering

  58. "Travel >> Tourist Destinations" will create two terms, "Travel" and "Tourist

  59. Destinations", with the latter as a child of the former.

  60. 

  61. 

  62. MAINTAINERS

  63. ------------

  64. 

  65. Current maintainers:

  66.  * Clint Randall (camprandall) - https://drupal.org/u/camprandall

  67.  * Jay Kerschner (JKerschner) - https://drupal.org/u/jkerschner

  68.  * Brian Seek (brian.seek) - https://drupal.org/u/brianseek

  69.  * Mike Goulding (mikeegoulding) - https://drupal.org/user/mikeegoulding

  70. 

  71. This project has been sponsored by:

  72.  * Ashday Interactive Systems

  73.    Building your digital ecosystem can be daunting. Elaborate websites,

  74.    complex cloud applications, mountains of data, endless virtual wires

  75.    of integrations.