From e7ac33cda34d52663b4f9ad1f8cb183205fc1e93 Mon Sep 17 00:00:00 2001 From: Pius Date: Sun, 18 Aug 2019 13:20:03 -0700 Subject: [PATCH] Clarify substitution use case Setting destination to be the same as field (i.e, the source field) does not work unless override is also set to true. This clarifies the configuration required for the substitution use case. --- docs/index.asciidoc | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 27e15c0..adbeabe 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -113,9 +113,8 @@ filter plugins. * Default value is `"translation"` The destination field you wish to populate with the translated code. The default -is a field named `translation`. Set this to the same value as source if you want -to do a substitution, in this case filter will allways succeed. This will clobber -the old value of the source field! +is a field named `translation`. If you want to do a substitution, set this to the +same value as `field` and set `override` to `true`. [id="plugins-{type}s-{plugin}-dictionary"] ===== `dictionary`