diff options
Diffstat (limited to 'browser/extensions/formautofill/docs/heuristics.rst')
| -rw-r--r-- | browser/extensions/formautofill/docs/heuristics.rst | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/browser/extensions/formautofill/docs/heuristics.rst b/browser/extensions/formautofill/docs/heuristics.rst new file mode 100644 index 0000000000..cf6e49da39 --- /dev/null +++ b/browser/extensions/formautofill/docs/heuristics.rst @@ -0,0 +1,36 @@ +Form Autofill Heuristics +======================== + +Form Autofill Heuristics module is for detecting the field type based on `autocomplete attribute <https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill>`_, `the regular expressions <http://searchfox.org/mozilla-central/source/browser/extensions/formautofill/content/heuristicsRegexp.js>`_ and the customized logic in each parser. + +Debugging +--------- + +The pref ``extensions.formautofill.heuristics.enabled`` is "true" in default. Set it to "false" could be useful to verify the result of autocomplete attribute. + +Dependent APIs +-------------- + +``element.getAutocompleteInfo()`` provides the parsed result of ``autocomplete`` attribute which includes the field name and section information defined in `autofill spec <https://html.spec.whatwg.org/multipage/form-control-infrastructure.html#autofill>`_ + +Regular Expressions +------------------- + +This section is about how the regular expression is applied during parsing fields. All regular expressions are in `heuristicsRegexp.js <https://searchfox.org/mozilla-central/source/browser/extensions/formautofill/content/heuristicsRegexp.js>`_. + +Parser Implementations +---------------------- + +The parsers are for detecting the field type more accurately based on the near context of a field. Each parser uses ``FieldScanner`` to traverse the interested fields with the result from the regular expressions and adjust each field type when it matches to a grammar. + +* _parsePhoneFields + + * related type: ``tel``, ``tel-*`` + +* _parseAddressFields + + * related type: ``address-line[1-3]`` + +* _parseCreditCardExpirationDateFields + + * related type: ``cc-exp``, ``cc-exp-month``, ``cc-exp-year`` |