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