You are here

README.txt in Webform Localization 7

Same filename and directory in other branches
  1. 7.4 README.txt
Description
-----------
This module provides multilingual features to the Webform Module. Special
options in the webform and component configuration let you enable different
ways to manage translation of forms and questionnaires.

You can choose two different ways to manage localization that cover this
scenarios:

A) If you want to keep a single webform across all nodes in a translation set or
you are using field translation:
Use i18n_string integration to translate webform strings. This module expose
webform properties, components and emails strings through the i18n module. All
submissions results are related to the source node only.
(You have a "localization by string translation" fieldset in the form settings
to enable this)

B) If you want to keep a webform per node per language but synchronized:
The entire webform structure is replicated when a translated node is created
then you can customize it at will. You can add specific options or components
per language and choose to keep sync: webform properties, components properties,
roles and emails recipients. In this scenario make no sense of having results
attached to one node since each webform could have a different structure with
only a few components in sync.
(You have a "localization by sync" fieldset in the form settings to enable this)

Requirements
------------
Drupal 7.x
Webform Module
i18n Module

Installation
------------
1. Copy the entire webform localization directory the Drupal sites/all/modules
directory.

2. Login as an administrator. Enable the module in the "Administer" -> "Modules"

3. Create a webform node at node/add/webform or edit a existing webform.

3. Enable one of the localization features provided in the webform at "Form
settings". See examples below.


Example A: Manage localization for node/1 using string translation
------------------------------------------------------------------

1. Go to the Webform tab for that node at node/1/webform.

2. Go to the Webform Form settings at node/1/webform/configure.

3. In the "localization by string translation" fieldset enable "Expose webform
component strings suitable for translation." checkbox. That will expose defined
strings to the i18n_string module.

4. [OPTIONAL] In the "localization by string translation" fieldset enable "Keep
a single webform across a translation set." checkbox. This will render the
webform in the source language node, in all nodes within a translation set, so
activate this feature to create a single webform for appear in every translated
node.

5. If you are dealing with a already existing webform you have to do an
additional action for refreshing the string pool for all components.You can
ommit this step if you enable string translation before adding the components.

    - Go to Configuration -> Translate interface -> Strings
    (admin/config/regional/translate/i18n_string)

    - Enable "Webform localization" checkbox

    - Click "Refresh Strings"
    
6. The actual translation is made at
Configuration -> Translate interface -> Translate
(admin/config/regional/translate/translate)
Here you can filter the strings available for translation by "webform" text
group.



Example B: Manage localization for node/1 using translation by sync
------------------------------------------------------------------

0. Create all webform components in the node/1 webform. Enable the Content
translation module and be sure that the webform content type has enabled the
multilanguage support (Enabled, with translation) at Publishing options.

1. Go to the Webform tab for that node at node/1/webform.

2. Go to the Webform Form settings at node/1/webform/configure.

3. In the "localization by sync" fieldset enable the webform properties
checkboxes in "Synchronize webform properties across node translations.". Choose
what properties you will need to keep synchronize in all webforms across a
translation set.

4. In the "localization by sync" fieldset enable the "Synchronize webform
components across node translations." checkbox. This will clone the entire
webform when you create a translation and will enable specific options per
component for you to synchronize properties.

5. In the "localization by sync" fieldset enable the "Synchronize webform
submission access roles across node translations." checkbox. This will keep the
roles changes synchronize in all webforms across a translation set.
    
6. In the "localization by sync" fieldset enable the "Synchronize webform e-mail
recipients across node translations." checkbox. This will keep all email changes
synchronize in all webforms across a translation set.

7. Create a translation for node/1 at node/1/translate. You will notice that the
new language node will had a new webform instance with the original structure
from the source node.
Now you we will have to translate all pertinent texts in the webform and
components. All properties changes in the source webform will be synchronized in
all translates nodes as you have specified in the  previous steps.

File

README.txt
View source
  1. Description
  2. -----------
  3. This module provides multilingual features to the Webform Module. Special
  4. options in the webform and component configuration let you enable different
  5. ways to manage translation of forms and questionnaires.
  6. You can choose two different ways to manage localization that cover this
  7. scenarios:
  8. A) If you want to keep a single webform across all nodes in a translation set or
  9. you are using field translation:
  10. Use i18n_string integration to translate webform strings. This module expose
  11. webform properties, components and emails strings through the i18n module. All
  12. submissions results are related to the source node only.
  13. (You have a "localization by string translation" fieldset in the form settings
  14. to enable this)
  15. B) If you want to keep a webform per node per language but synchronized:
  16. The entire webform structure is replicated when a translated node is created
  17. then you can customize it at will. You can add specific options or components
  18. per language and choose to keep sync: webform properties, components properties,
  19. roles and emails recipients. In this scenario make no sense of having results
  20. attached to one node since each webform could have a different structure with
  21. only a few components in sync.
  22. (You have a "localization by sync" fieldset in the form settings to enable this)
  23. Requirements
  24. ------------
  25. Drupal 7.x
  26. Webform Module
  27. i18n Module
  28. Installation
  29. ------------
  30. 1. Copy the entire webform localization directory the Drupal sites/all/modules
  31. directory.
  32. 2. Login as an administrator. Enable the module in the "Administer" -> "Modules"
  33. 3. Create a webform node at node/add/webform or edit a existing webform.
  34. 3. Enable one of the localization features provided in the webform at "Form
  35. settings". See examples below.
  36. Example A: Manage localization for node/1 using string translation
  37. ------------------------------------------------------------------
  38. 1. Go to the Webform tab for that node at node/1/webform.
  39. 2. Go to the Webform Form settings at node/1/webform/configure.
  40. 3. In the "localization by string translation" fieldset enable "Expose webform
  41. component strings suitable for translation." checkbox. That will expose defined
  42. strings to the i18n_string module.
  43. 4. [OPTIONAL] In the "localization by string translation" fieldset enable "Keep
  44. a single webform across a translation set." checkbox. This will render the
  45. webform in the source language node, in all nodes within a translation set, so
  46. activate this feature to create a single webform for appear in every translated
  47. node.
  48. 5. If you are dealing with a already existing webform you have to do an
  49. additional action for refreshing the string pool for all components.You can
  50. ommit this step if you enable string translation before adding the components.
  51. - Go to Configuration -> Translate interface -> Strings
  52. (admin/config/regional/translate/i18n_string)
  53. - Enable "Webform localization" checkbox
  54. - Click "Refresh Strings"
  55. 6. The actual translation is made at
  56. Configuration -> Translate interface -> Translate
  57. (admin/config/regional/translate/translate)
  58. Here you can filter the strings available for translation by "webform" text
  59. group.
  60. Example B: Manage localization for node/1 using translation by sync
  61. ------------------------------------------------------------------
  62. 0. Create all webform components in the node/1 webform. Enable the Content
  63. translation module and be sure that the webform content type has enabled the
  64. multilanguage support (Enabled, with translation) at Publishing options.
  65. 1. Go to the Webform tab for that node at node/1/webform.
  66. 2. Go to the Webform Form settings at node/1/webform/configure.
  67. 3. In the "localization by sync" fieldset enable the webform properties
  68. checkboxes in "Synchronize webform properties across node translations.". Choose
  69. what properties you will need to keep synchronize in all webforms across a
  70. translation set.
  71. 4. In the "localization by sync" fieldset enable the "Synchronize webform
  72. components across node translations." checkbox. This will clone the entire
  73. webform when you create a translation and will enable specific options per
  74. component for you to synchronize properties.
  75. 5. In the "localization by sync" fieldset enable the "Synchronize webform
  76. submission access roles across node translations." checkbox. This will keep the
  77. roles changes synchronize in all webforms across a translation set.
  78. 6. In the "localization by sync" fieldset enable the "Synchronize webform e-mail
  79. recipients across node translations." checkbox. This will keep all email changes
  80. synchronize in all webforms across a translation set.
  81. 7. Create a translation for node/1 at node/1/translate. You will notice that the
  82. new language node will had a new webform instance with the original structure
  83. from the source node.
  84. Now you we will have to translate all pertinent texts in the webform and
  85. components. All properties changes in the source webform will be synchronized in
  86. all translates nodes as you have specified in the previous steps.