You are here

Home » API reference » Inline Form Errors 7.2

README.txt in Inline Form Errors 7.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * FAQ
 * Maintainers


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

IFE or Inline Form Errors allows you to place form submission error inline with
the form elements. Three options are provided for setting your inline error
behavior. You can configure the default behavior or override the behavior on
a per form basis.


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

 * Chaos tool suite (ctools) - https://www.drupal.org/project/ctools


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

Install as usual, https://www.drupal.org/node/895232

     1. Copy the entire ife directory the Drupal modules directory.

     2. To enable the module navigate to Administration > Modules
        (admin/modules), select IFE and Save.

     3. (Required) To edit the IFE settings, navigate to Administration >
        Configuration > User Interface > Inline Form Errors.
        (admin/config/user-interface/ife)


CONFIGURATION
-------------

On the settings page (see step 3 above) you can configure which forms are
enabled with inline form errors. In Drupal, every form has a unique ID. This
ID must be used to target a form. You can enter a new form id at the bottom of
the settings page. By default all the forms will have a general error message
and general display setting.


FAQ
---

Q: How can I retrieve the unique form ID from a specific form?
A: You can switch on the 'Show form_ids on form' option at the settings page.
   Only users with the permission 'administer inline form errors' will see an
   indication above all the forms with the unique form ID.

Q: Which types of error behaviors are supported?
A: IFE provides three 'display types' for the configured forms:

     1. Leave the messages in place: this option will copy the error messages
        and place them inline. The original error messages set by Drupal will
        remain in place.
     2. Show an alternative message: this option will replace the original
        messages with a generic error message such as 'Please correct all
        errors.'. This message can be set in the IFE configuration page. The
        original error messages are placed inline with the form elements.
     3. Remove all messages: this option will remove all error messages and
        place them inline with the form element.


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

Current maintainers:
 * Ra Mänd (ram4nd) - https://www.drupal.org/u/ram4nd
 * Stijn De Meyere (stijndm) - https://www.drupal.org/u/stijndm

This project has been sponsored by:
 * Development is sponsored by nascom.be and villaviscom.be

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

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

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * FAQ

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

  13. ------------

  14. 

  15. IFE or Inline Form Errors allows you to place form submission error inline with

  16. the form elements. Three options are provided for setting your inline error

  17. behavior. You can configure the default behavior or override the behavior on

  18. a per form basis.

  19. 

  20. 

  21. REQUIREMENTS

  22. ------------

  23. 

  24.  * Chaos tool suite (ctools) - https://www.drupal.org/project/ctools

  25. 

  26. 

  27. INSTALLATION

  28. ------------

  29. 

  30. Install as usual, https://www.drupal.org/node/895232

  31. 

  32.      1. Copy the entire ife directory the Drupal modules directory.

  33. 

  34.      2. To enable the module navigate to Administration > Modules

  35.         (admin/modules), select IFE and Save.

  36. 

  37.      3. (Required) To edit the IFE settings, navigate to Administration >

  38.         Configuration > User Interface > Inline Form Errors.

  39.         (admin/config/user-interface/ife)

  40. 

  41. 

  42. CONFIGURATION

  43. -------------

  44. 

  45. On the settings page (see step 3 above) you can configure which forms are

  46. enabled with inline form errors. In Drupal, every form has a unique ID. This

  47. ID must be used to target a form. You can enter a new form id at the bottom of

  48. the settings page. By default all the forms will have a general error message

  49. and general display setting.

  50. 

  51. 

  52. FAQ

  53. ---

  54. 

  55. Q: How can I retrieve the unique form ID from a specific form?

  56. A: You can switch on the 'Show form_ids on form' option at the settings page.

  57.    Only users with the permission 'administer inline form errors' will see an

  58.    indication above all the forms with the unique form ID.

  59. 

  60. Q: Which types of error behaviors are supported?

  61. A: IFE provides three 'display types' for the configured forms:

  62. 

  63.      1. Leave the messages in place: this option will copy the error messages

  64.         and place them inline. The original error messages set by Drupal will

  65.         remain in place.

  66.      2. Show an alternative message: this option will replace the original

  67.         messages with a generic error message such as 'Please correct all

  68.         errors.'. This message can be set in the IFE configuration page. The

  69.         original error messages are placed inline with the form elements.

  70.      3. Remove all messages: this option will remove all error messages and

  71.         place them inline with the form element.

  72. 

  73. 

  74. MAINTAINERS

  75. -----------

  76. 

  77. Current maintainers:

  78.  * Ra Mänd (ram4nd) - https://www.drupal.org/u/ram4nd

  79.  * Stijn De Meyere (stijndm) - https://www.drupal.org/u/stijndm

  80. 

  81. This project has been sponsored by:

  82.  * Development is sponsored by nascom.be and villaviscom.be