You are here

README.txt in Better Formats 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 6.2 README.txt
  3. 7 README.txt
Better formats is a module to add more flexibility to Drupal's core input format system.
Features

    * Set the default format per role.
    * Set the default format per content type.
    * Control allowed formats per content type.
    * Hide format tips.
    * Hide format selection, forcing the default to be used.
    * Expand the selection fieldset by default.
    * Disable the expand/collapse of the selection fieldset.
    * Set selection fieldset title.
    * Set default formats for nodes, comments, and blocks separately.
    * Works with CCK textareas.
    * Panels comment support.
    * I18n module support.
    * and more.

-------------------------------------------------------------------

Installation:

1. Copy the module folder to your server.
2. Enable the module via the modules page.

-------------------------------------------------------------------

Simple 4-step usage:

1. Go to user permissions (/admin/user/permissions) and set your permissions for
    what and how to show the format selection and tips.
2. Navigate to Site Configuration > Input formats (/admin/settings/filters)
3. There you will find 2 tabs where you can change your settings.
    Defaults (/admin/settings/filters/defauts)
    Settings (/admin/settings/filters/settings)
4. If you enable the "Control formats per node type" option. Go to your content
   type admin page to set those settings (example /admin/content/node-type/page).
   The settings are under the Input format settings fieldset.

-------------------------------------------------------------------

Important:

When setting default formats ensure that you arranged the roles correctly
placing roles in their order of precedence. This is used to determine what
default a user will get when they have more than 1 role.

NOTE:
All logged in users are automatically assigned the authenticated user role
so this role must be below all other roles that you want to set a default for or
they will get the authenticated user role default instead.

Example:
Let's say you have the 2 roles that come with Drupal and have added an
'admin' role. You would most likely want to arrange the roles in this order:

  admin
  authenticated user
  anonymous user

-------------------------------------------------------------------

Extended usage and notes:

* To adjust how the format selection is shown to the user, edit the permissions
  at /admin/user/permissions.

* To control whether or not the format help tips and help link are shown, edit
  the permissions at /admin/user/permissions.

* The default format will only be set on NEW nodes and comments. The format
  selected when the form is submitted is used for future editing purposes.

* The module is designed to always fall back to default settings when needed.
  This means that when you enable the module before you change any settings,
  it will use your current Drupal settings. Also when you enable conrol per node
  type it will use your global settings until you save the content type with new
  settings.

* The permissions "collapse format fieldset by default" and
  "collapsible format selection" will only work if "Show format selection" is
  also given. This is because those 2 perms only have an effect when there is
  a format selection.

* The permission "collapse format fieldset by default" will only work if
  "collapsible format selection" is also given. This is because the
  fieldset can only be collapsed by default if it is collapsible.

* If you dis-allow a format that is already being used by content, the module
  will do its best to set the correct format. The precidence of the formats are:
  1. Existing format selected when last saved
  2. Content type default format
  3. Global default format
  4. First allowed format
  5. Drupal core site default format

* User 1 is treated the same as all other users when it comes to a default
  format. If user 1 has not been assigned any roles then it will be assigned
  the authenticated user role's default format. If you want user 1 to have the
  default of another role assign that role to user 1.

* Ensure you read the important notes in the previous section marked important.
  It explains how you must order your roles to effectively get your defaults.

File

README.txt
View source
  1. Better formats is a module to add more flexibility to Drupal's core input format system.
  2. Features
  3. * Set the default format per role.
  4. * Set the default format per content type.
  5. * Control allowed formats per content type.
  6. * Hide format tips.
  7. * Hide format selection, forcing the default to be used.
  8. * Expand the selection fieldset by default.
  9. * Disable the expand/collapse of the selection fieldset.
  10. * Set selection fieldset title.
  11. * Set default formats for nodes, comments, and blocks separately.
  12. * Works with CCK textareas.
  13. * Panels comment support.
  14. * I18n module support.
  15. * and more.
  16. -------------------------------------------------------------------
  17. Installation:
  18. 1. Copy the module folder to your server.
  19. 2. Enable the module via the modules page.
  20. -------------------------------------------------------------------
  21. Simple 4-step usage:
  22. 1. Go to user permissions (/admin/user/permissions) and set your permissions for
  23. what and how to show the format selection and tips.
  24. 2. Navigate to Site Configuration > Input formats (/admin/settings/filters)
  25. 3. There you will find 2 tabs where you can change your settings.
  26. Defaults (/admin/settings/filters/defauts)
  27. Settings (/admin/settings/filters/settings)
  28. 4. If you enable the "Control formats per node type" option. Go to your content
  29. type admin page to set those settings (example /admin/content/node-type/page).
  30. The settings are under the Input format settings fieldset.
  31. -------------------------------------------------------------------
  32. Important:
  33. When setting default formats ensure that you arranged the roles correctly
  34. placing roles in their order of precedence. This is used to determine what
  35. default a user will get when they have more than 1 role.
  36. NOTE:
  37. All logged in users are automatically assigned the authenticated user role
  38. so this role must be below all other roles that you want to set a default for or
  39. they will get the authenticated user role default instead.
  40. Example:
  41. Let's say you have the 2 roles that come with Drupal and have added an
  42. 'admin' role. You would most likely want to arrange the roles in this order:
  43. admin
  44. authenticated user
  45. anonymous user
  46. -------------------------------------------------------------------
  47. Extended usage and notes:
  48. * To adjust how the format selection is shown to the user, edit the permissions
  49. at /admin/user/permissions.
  50. * To control whether or not the format help tips and help link are shown, edit
  51. the permissions at /admin/user/permissions.
  52. * The default format will only be set on NEW nodes and comments. The format
  53. selected when the form is submitted is used for future editing purposes.
  54. * The module is designed to always fall back to default settings when needed.
  55. This means that when you enable the module before you change any settings,
  56. it will use your current Drupal settings. Also when you enable conrol per node
  57. type it will use your global settings until you save the content type with new
  58. settings.
  59. * The permissions "collapse format fieldset by default" and
  60. "collapsible format selection" will only work if "Show format selection" is
  61. also given. This is because those 2 perms only have an effect when there is
  62. a format selection.
  63. * The permission "collapse format fieldset by default" will only work if
  64. "collapsible format selection" is also given. This is because the
  65. fieldset can only be collapsed by default if it is collapsible.
  66. * If you dis-allow a format that is already being used by content, the module
  67. will do its best to set the correct format. The precidence of the formats are:
  68. 1. Existing format selected when last saved
  69. 2. Content type default format
  70. 3. Global default format
  71. 4. First allowed format
  72. 5. Drupal core site default format
  73. * User 1 is treated the same as all other users when it comes to a default
  74. format. If user 1 has not been assigned any roles then it will be assigned
  75. the authenticated user role's default format. If you want user 1 to have the
  76. default of another role assign that role to user 1.
  77. * Ensure you read the important notes in the previous section marked important.
  78. It explains how you must order your roles to effectively get your defaults.