You are here

Home » API reference » E-Sign 7

README.txt in E-Sign 7 

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

 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration
 * Troubleshooting
 * FAQ
 * Maintainers

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

This module allows for integration of Signature Pad, an electronic-signing
script, into Drupal for both nodes (content) and the Field API (FAPI).

 * For a full description of the module, visit the project page:
   https://drupal.org/project/esign

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

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

This module requires the following module:

 * Libraries (https://www.drupal.org/project/libraries)
 * Field API (core)

It also requires the following third-party library:

 * Signature Pad 1.6+ (https://github.com/szimek/signature_pad)

RECOMMENDED MODULES
-------------------

 None

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

 * Install as you would normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-7
   for further information.

 * Download and extract the Signature Pad library into the libraries directory
   (usually "sites/all/libraries").

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

 * For content, you can change the options within the field settings.
   - For FAPI, you can change the field options by setting the '#esign_options'
     parameter, and using the following keys in an associative array:

   - dotSize (default: 1)

   - minWidth (default: 0.5)

   - maxWidth (default: 2.5)

   - backgroundColor (default: 'rgba(0,0,0,0)')

   - penColor (default: 'rgba(0,0,0,1)')

   - velocityFilterWeight (default: 0.7)

TROUBLESHOOTING
---------------

 * If the signature field does not display, check the following:

   - Did you set the field to display?

   - Does your CSS allow the field to display?

FAQ
---

Q: The signature field isn't working!

A: Please make sure you're using the correct version of Signature Pad.

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

Current maintainers:
 * Adam Weiss (greatmatter) - https://www.drupal.org/u/greatmatter

This project has been sponsored by:
 * Great Matter
   We create the software you need most.
   Specializing in Drupal-based systems, Great Matter designs, develops,
   and supports amazing software solutions for the most complicated needs.
   Visit https://www.greatmatter.com for more information.

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

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

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Recommended modules

  7.  * Installation

  8.  * Configuration

  9.  * Troubleshooting

  10.  * FAQ

  11.  * Maintainers

  12. 

  13. INTRODUCTION

  14. ------------

  15. 

  16. This module allows for integration of Signature Pad, an electronic-signing

  17. script, into Drupal for both nodes (content) and the Field API (FAPI).

  18. 

  19.  * For a full description of the module, visit the project page:

  20.    https://drupal.org/project/esign

  21. 

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

  23.    https://drupal.org/project/issues/esign

  24. 

  25. REQUIREMENTS

  26. ------------

  27. 

  28. This module requires the following module:

  29. 

  30.  * Libraries (https://www.drupal.org/project/libraries)

  31.  * Field API (core)

  32. 

  33. It also requires the following third-party library:

  34. 

  35.  * Signature Pad 1.6+ (https://github.com/szimek/signature_pad)

  36. 

  37. RECOMMENDED MODULES

  38. -------------------

  39. 

  40.  None

  41. 

  42. INSTALLATION

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

  44. 

  45.  * Install as you would normally install a contributed Drupal module. See:

  46.    https://drupal.org/documentation/install/modules-themes/modules-7

  47.    for further information.

  48. 

  49.  * Download and extract the Signature Pad library into the libraries directory

  50.    (usually "sites/all/libraries").

  51. 

  52. CONFIGURATION

  53. -------------

  54. 

  55.  * For content, you can change the options within the field settings.

  56.    - For FAPI, you can change the field options by setting the '#esign_options'

  57.      parameter, and using the following keys in an associative array:

  58. 

  59.    - dotSize (default: 1)

  60. 

  61.    - minWidth (default: 0.5)

  62. 

  63.    - maxWidth (default: 2.5)

  64. 

  65.    - backgroundColor (default: 'rgba(0,0,0,0)')

  66. 

  67.    - penColor (default: 'rgba(0,0,0,1)')

  68. 

  69.    - velocityFilterWeight (default: 0.7)

  70. 

  71. TROUBLESHOOTING

  72. ---------------

  73. 

  74.  * If the signature field does not display, check the following:

  75. 

  76.    - Did you set the field to display?

  77. 

  78.    - Does your CSS allow the field to display?

  79. 

  80. FAQ

  81. ---

  82. 

  83. Q: The signature field isn't working!

  84. 

  85. A: Please make sure you're using the correct version of Signature Pad.

  86. 

  87. MAINTAINERS

  88. -----------

  89. 

  90. Current maintainers:

  91.  * Adam Weiss (greatmatter) - https://www.drupal.org/u/greatmatter

  92. 

  93. This project has been sponsored by:

  94.  * Great Matter

  95.    We create the software you need most.

  96.    Specializing in Drupal-based systems, Great Matter designs, develops,

  97.    and supports amazing software solutions for the most complicated needs.

  98.    Visit https://www.greatmatter.com for more information.