<dfn/> elements, except for those in your configured stop list. This filter is only useful along with the <dfn/> conversion filter, and must be applied before it."),
+ * weight = -1,
+ * )
+ */
+class Automatic extends FilterBase {
+
+ /**
+ * The name of the single settings for this filter.
+ */
+ const STOP = 'stop_list';
+
+ /**
+ * {@inheritdoc}
+ */
+ public function settingsForm(array $form, FormStateInterface $formState) {
+ $form[static::STOP] = [
+ '#type' => 'textarea',
+ '#title' => $this->t('Stop list'),
+ '#default_value' => $this->settings[static::STOP] ?? '',
+ '#description' => $this->t('Enter G2 entries that must never be automatically wrapped in a <dfn/> element, one per line. You will still be able to define them by adding the <dfn/> element manually.'),
+ '#element_validate' => [[$this, 'validateStopList']],
+ ];
+ return $form;
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function process($text, $langcode) {
+ // @DCG Process text here.
+ $example = $this->settings['example'];
+ $text = str_replace($example, "$example", $text);
+ return new FilterProcessResult($text);
+ }
+
+ /**
+ * {@inheritdoc}
+ */
+ public function tips($long = FALSE) {
+ return $this->t('Some filter tips here.');
+ }
+
+ /**
+ * Form element validation handler.
+ *
+ * Deduplicates and sorts entries.
+ *
+ * @param array $element
+ * The stop_list form element.
+ * @param \Drupal\Core\Form\FormStateInterface $formState
+ * The form state.
+ */
+ public function validateStopList(array &$element, FormStateInterface $formState) {
+ // Web submissions add CR, just ignore them.
+ $nocr = str_replace("\r", "", $element['#value']);
+ $array = explode("\n", $nocr);
+ $filtered = array_map("trim", $array);
+ $nonEmpty = array_filter($filtered);
+ sort($nonEmpty);
+ $values = array_unique($nonEmpty);
+ $value = implode("\n", $values);
+ $formState->setValueForElement($element, $value);
+ if ($value !== $nocr) {
+ $this->messenger()
+ ->addStatus("Your G2 stop list has been filtered and reordered.");
+ }
+ }
+
+}
diff --git a/src/Plugin/Filter/Definition.php b/src/Plugin/Filter/Definition.php
index 64f560b..c105a82 100644
--- a/src/Plugin/Filter/Definition.php
+++ b/src/Plugin/Filter/Definition.php
@@ -4,7 +4,6 @@ namespace Drupal\g2\Plugin\Filter;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
-use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Link;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Render\RendererInterface;
@@ -20,13 +19,12 @@ use Symfony\Component\DependencyInjection\ContainerInterface;
*
* @Filter(
* id = "g2:dfn",
- * title = @Translation("Link to G2 definitions using <dfn>
- * elements."),
+ * title = @Translation("Convert <dfn/> elements into links to definitions in the G2 glossary."),
* type = Drupal\filter\Plugin\FilterInterface::TYPE_TRANSFORM_IRREVERSIBLE,
* settings = {},
- * description=@Translation("Wrap <dfn> elements around the words for
- * which you want a link to the matching G2 entries, like this:
- * <dfn>UTF-8</dfn>"), weight = 0,
+ * description=@Translation("Wrap <dfn> elements around the words for which you want a link to the matching G2 entries, like this: <dfn>UTF-8</dfn>. This filter must appear after the automatic <dfn/> wrapping filter."),
+ * description=@Translation("Converts <dfn>some entry</dfn> elements into links to the matching G2 entry, or a homonyms disambiguation page if multiple entries match the given string. This filter must be applied after the automatic <dfn/> wrapping filter."),
+ * weight = 0,
* )
*/
class Definition extends FilterBase implements ContainerFactoryPluginInterface {
@@ -223,18 +221,6 @@ class Definition extends FilterBase implements ContainerFactoryPluginInterface {
return $result;
}
- /**
- * {@inheritDoc}
- */
- public function settingsForm(array $form, FormStateInterface $form_state) {
- // No settings at this point. To add some, insert elements in the existing
- // $form, including a #element_validate to validate them.
- $form['description'] = [
- '#markup' => 'Wrap <dfn> elements around the words for which you want a link to the matching G2 entries, like this: <dfn>UTF-8</dfn>