You are here

Home » API reference » Multistep Nodeform 7

README.txt in Multistep Nodeform 7

Same filename and directory in other branches
  1. 6 README.txt
-- SUMMARY --

"Multistep Nodeform" is a module to split the node creation and node editing
form into several steps.
This may be usefull for you if you have lots of fields in your content type and
would like to provide a wizard-like UI for content creation/editing.

-- REQUIREMENTS --

* ctools: http://drupal.org/project/ctools
* "Field UI" (core module) should be enabled to configure steps manually.

-- INSTALLATION --

* Install as usual, see http://drupal.org/documentation/install/modules-themes/modules-7
  for further information.


-- CONFIGURATION --

To configure steps for a content type go to "Manage fields" (e.g.
admin/structure/types/manage/page/fields) and add steps to the type as you would
add fields.
After adding a step you may configure the step details by clicking on the gear
in column "Operations". This opens a new settings form for the step where you
can set the label, add some descriptive text, define the labels for the step
buttons, ...

If you would like to display the progress of the form you may go to the block
configuration page (admin/structure/block) and enable the block
"Multistep Nodeform: Step information". This will display the list of steps for
your content.
The output of this block can be overridden by copying the template
msnf-block-step-info.tpl.php into your theme and modify it or using a preprocess
function "template_preprocess_msnf_block_step_info".

-- NOTES --

* Any field not assigned to a step will not be visible on the node form and
  therefore not editable!
* You may directly access a step by adding ?step={step_name} to the current url.
  E.g.: node/1/edit?step=step_article_additional will jump to the step named
  "step_article_additional".
  If there are steps with unfilled required fields (step is "not skippable") the
  first non-skippable step will be displayed instead of the one requested by
  url.
  Warning: using this feature may result in data loss while adding or editing a
  node. Any changes you have made to the node will get lost if you jump to a
  step using this feature, so this should be used only on node/[nid]/edit to
  skip some steps the user do not need to update.

-- MAINTAINERS --

Stefan Borchert (http://drupal.org/user/36942)

Development of this module is sponsored by undpaul (http://www.undpaul.de).

File

README.txt
View source 
  1. 

  2. -- SUMMARY --

  3. 

  4. "Multistep Nodeform" is a module to split the node creation and node editing

  5. form into several steps.

  6. This may be usefull for you if you have lots of fields in your content type and

  7. would like to provide a wizard-like UI for content creation/editing.

  8. 

  9. -- REQUIREMENTS --

  10. 

  11. * ctools: http://drupal.org/project/ctools

  12. * "Field UI" (core module) should be enabled to configure steps manually.

  13. 

  14. -- INSTALLATION --

  15. 

  16. * Install as usual, see http://drupal.org/documentation/install/modules-themes/modules-7

  17.   for further information.

  18. 

  19. 

  20. -- CONFIGURATION --

  21. 

  22. To configure steps for a content type go to "Manage fields" (e.g.

  23. admin/structure/types/manage/page/fields) and add steps to the type as you would

  24. add fields.

  25. After adding a step you may configure the step details by clicking on the gear

  26. in column "Operations". This opens a new settings form for the step where you

  27. can set the label, add some descriptive text, define the labels for the step

  28. buttons, ...

  29. 

  30. If you would like to display the progress of the form you may go to the block

  31. configuration page (admin/structure/block) and enable the block

  32. "Multistep Nodeform: Step information". This will display the list of steps for

  33. your content.

  34. The output of this block can be overridden by copying the template

  35. msnf-block-step-info.tpl.php into your theme and modify it or using a preprocess

  36. function "template_preprocess_msnf_block_step_info".

  37. 

  38. -- NOTES --

  39. 

  40. * Any field not assigned to a step will not be visible on the node form and

  41.   therefore not editable!

  42. * You may directly access a step by adding ?step={step_name} to the current url.

  43.   E.g.: node/1/edit?step=step_article_additional will jump to the step named

  44.   "step_article_additional".

  45.   If there are steps with unfilled required fields (step is "not skippable") the

  46.   first non-skippable step will be displayed instead of the one requested by

  47.   url.

  48.   Warning: using this feature may result in data loss while adding or editing a

  49.   node. Any changes you have made to the node will get lost if you jump to a

  50.   step using this feature, so this should be used only on node/[nid]/edit to

  51.   skip some steps the user do not need to update.

  52. 

  53. -- MAINTAINERS --

  54. 

  55. Stefan Borchert (http://drupal.org/user/36942)

  56. 

  57. Development of this module is sponsored by undpaul (http://www.undpaul.de).