README.md 2.52 KB
Newer Older
1 2
CONTENTS OF THIS FILE
---------------------
3

4 5 6 7 8
 * Introduction
 * Installation
 * Recommended modules
 * Configuration
 * Upgrading
9

10 11
INTRODUCTION
------------
12

13
The Webform module is a form builder and submission manager for Drupal 8.
14

15 16 17 18 19 20 21 22 23 24 25
 * The primary use case for this module is to:

  - **Build** a new webform or duplicate an existing template
  - **Publish** the webform as a page, node, or block
  - **Collect** submissions
  - **Send** confirmations and notifications
  - **Review** submissions online
  - **Download** submissions as a CSV

 * Goals:

26
  - A comprehensive form and survey building solution for Drupal 8.
27 28
  - A stable, maintainable, and tested API for building forms and handling submission.
  - A pluggable/extensible API for custom form elements and submission handling.
29

30 31 32 33 34
 * Demo:
  - Video review of the Webform module:
    http://youtu.be/sQGsfQ_LZJ4
  - Online evaluate by simplytest.me:
    https://simplytest.me/project/webform/8.x-5.x
35

36 37
 * Project status:
   [Webform Project Board] https://contribkanban.com/board/webform/8.x-5.x
38 39

 * Comparision with other modules:
40
   https://www.drupal.org/node/2083353
41

jrockowitz's avatar
jrockowitz committed
42

43 44
INSTALLATION
------------
45

46
The installation of this module is like other Drupal modules.
47

48
 1. Copy/upload the webform module to the modules directory of your Drupal
49 50
   installation.

51
 2. Enable the 'Webform' module and desired sub-modules in 'Extend'.
52 53
   (/admin/modules)

54
 3. Set up user permissions. (/admin/people/permissions#module-webform)
55 56


57 58
RECOMMENDED MODULES
-------------------
59

60 61
 * Third party libraries (/admin/help/webform)
 * Add-on contrib modules (/admin/structure/webform/addons)
62

63 64
CONFIGURATION
-------------
65

66 67
 * Build a new webform (/admin/structure/webform)
   or duplicate an existing template (/admin/structure/webform/templates).
68

69
 * Publish your webform as a:
70

71
   - **Page** by linking to the published webform. (/webform/contact)
72

73
   - **Node** by creating a new node that references the webform. (/node/add/webform)
74

75
   - **Block** by placing a Webform block on your site. (/admin/structure/block)
76 77


78 79
UPGRADING
---------
80

81 82 83
 * All existing configuration and submission data was maintained and updated
   through the beta and rc release cycles.
   **APIs have changed** during these release cycles.
84

85 86 87 88
 * Simply put, if you installed and used the Webform module out of the box AS-IS,
   and now you want to upgrade to a full release, then
   you _should_ be okay. If you extended webforms with plugins, altered
   hooks, and overrode templates, you will need to read each release's
89
   notes and assume that _things have changed_.