You are here

README.txt in Field Hidden 7

Same filename and directory in other branches
  1. 2.x README.txt
(Drupal Field Hidden module)

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

 * Introduction
 * Hidden in forms
 * Optionally displayed in content
 * Visible default value
 * Validation and escaping
 * Requirements
 * Installation and uninstallation
 * Permissions
 * Configuration
 * Documentation
 * Suggestions and bug reporting

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

Maintainer: Jacob Friis Mathiasen <jacob.friis@simple-complex.net>

Field Hidden defines five hidden field types
 * text, long text
 * integer, decimal, floating-point
 
HIDDEN IN FORMS
---------------

Hidden fields are always rendered as <input type="hidden" /> elements in forms.

OPTIONALLY DISPLAYED IN CONTENT
-------------------------------

The value of a Field Hidden field defaults to be hidden in content - as in not
rendered at all.
It may however be displayed in content, if another format than <Hidden> is
selected in the content type's 'Manage Display' section.
The numeric types have exactly the same formatting options as ordinary numeric
fields (the Number field module, e.g. prefix, suffix, thousand marker, decimal
marker).

VISIBLE DEFAULT VALUE
---------------------

Setting the default value of a field - in instance settings - is kind of hard
when it's hidden.
For ease of access, this module includes a small feature which turns the
default value field into a visible text field. May be turned off via the
administrative settings.

VALIDATION AND ESCAPING
-----------------------

The values of all the field types are being validated and escaped according
to coding standards, or stricter.
None of the text types allow for HTML/PHP input (nor output).
The only difference between text and long text is the database data type used
- varchar versus text.

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

 * Drupal 7.x
 
INSTALLATION AND UNINSTALLATION
-------------------------------

Ordinary installation and unstallation.

Introduces persistent variables; these are automatically deleted when
uninstalling.

The module cannot be uninstalled if an entity/content type still has a
hidden field (of a Field Hidden type).
 * delete the entity's hidden field(s)
 * run cron
 * do uninstall

PERMISSIONS
-----------

'Administer hidden fields' - see
http://your-drupal-site.tld/admin/people/permissions#module-field_hidden

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

Check the modules administrative page (requires that a role of your user
has the 'Administer hidden fields' privilege):
http://your-drupal-site.tld/admin/config/fields/field_hidden

DOCUMENTATION
-------------

PHP documentation, phpdoc Doxygen dialect:
http://www.simple-complex.net/docs/drupal/modules/field_hidden/php/field__hidden_8module.html

SUGGESTIONS AND BUG REPORTING
-----------------------------

It's your civil duty as a subject of the state of Drupal to report bugs ;-)

Please create an issue at http://drupal.org/project/field_hidden,
or mail to <jacob.friis@simple-complex.net>.

File

README.txt
View source
  1. (Drupal Field Hidden module)
  2. CONTENTS OF THIS FILE
  3. ---------------------
  4. * Introduction
  5. * Hidden in forms
  6. * Optionally displayed in content
  7. * Visible default value
  8. * Validation and escaping
  9. * Requirements
  10. * Installation and uninstallation
  11. * Permissions
  12. * Configuration
  13. * Documentation
  14. * Suggestions and bug reporting
  15. INTRODUCTION
  16. ------------
  17. Maintainer: Jacob Friis Mathiasen
  18. Field Hidden defines five hidden field types
  19. * text, long text
  20. * integer, decimal, floating-point
  21. HIDDEN IN FORMS
  22. ---------------
  23. Hidden fields are always rendered as elements in forms.
  24. OPTIONALLY DISPLAYED IN CONTENT
  25. -------------------------------
  26. The value of a Field Hidden field defaults to be hidden in content - as in not
  27. rendered at all.
  28. It may however be displayed in content, if another format than is
  29. selected in the content type's 'Manage Display' section.
  30. The numeric types have exactly the same formatting options as ordinary numeric
  31. fields (the Number field module, e.g. prefix, suffix, thousand marker, decimal
  32. marker).
  33. VISIBLE DEFAULT VALUE
  34. ---------------------
  35. Setting the default value of a field - in instance settings - is kind of hard
  36. when it's hidden.
  37. For ease of access, this module includes a small feature which turns the
  38. default value field into a visible text field. May be turned off via the
  39. administrative settings.
  40. VALIDATION AND ESCAPING
  41. -----------------------
  42. The values of all the field types are being validated and escaped according
  43. to coding standards, or stricter.
  44. None of the text types allow for HTML/PHP input (nor output).
  45. The only difference between text and long text is the database data type used
  46. - varchar versus text.
  47. REQUIREMENTS
  48. ------------
  49. * Drupal 7.x
  50. INSTALLATION AND UNINSTALLATION
  51. -------------------------------
  52. Ordinary installation and unstallation.
  53. Introduces persistent variables; these are automatically deleted when
  54. uninstalling.
  55. The module cannot be uninstalled if an entity/content type still has a
  56. hidden field (of a Field Hidden type).
  57. * delete the entity's hidden field(s)
  58. * run cron
  59. * do uninstall
  60. PERMISSIONS
  61. -----------
  62. 'Administer hidden fields' - see
  63. http://your-drupal-site.tld/admin/people/permissions#module-field_hidden
  64. CONFIGURATION
  65. -------------
  66. Check the modules administrative page (requires that a role of your user
  67. has the 'Administer hidden fields' privilege):
  68. http://your-drupal-site.tld/admin/config/fields/field_hidden
  69. DOCUMENTATION
  70. -------------
  71. PHP documentation, phpdoc Doxygen dialect:
  72. http://www.simple-complex.net/docs/drupal/modules/field_hidden/php/field__hidden_8module.html
  73. SUGGESTIONS AND BUG REPORTING
  74. -----------------------------
  75. It's your civil duty as a subject of the state of Drupal to report bugs ;-)
  76. Please create an issue at http://drupal.org/project/field_hidden,
  77. or mail to .