feat(admin-plugin): add help text for common form controls #280

site/plugins/admin/lang/en_US.yaml

@@ -200,11 +200,11 @@ admin_sqlite3_table: "SQLite3 Table"
 admin_error_name_empty_input: "Name has to be an alphanumeric value (from 1 chars)"
 admin_error_title_empty_input: "Title has to be an alphanumeric value (from 1 chars)"
 admin_error_icon_empty_input: "Icon has to be an alphanumeric value (from 1 chars)"
-admin_help_text_for_fieldsets_label: "The fieldsets label shown in the Admin Panel."
-admin_help_text_for_fieldsets_name: "The fieldsets unique name in lowercase chars only."
-admin_help_text_for_fieldsets_icon: "The fieldsets valid :link icon class."
-admin_help_text_for_snippets_name: "The snippets unique name in lowercase chars only."
-admin_help_text_for_temlates_name: "The unique name in lowercase chars only."
+admin_help_text_for_fieldsets_label: "Fieldsets label shown in the Admin Panel."
+admin_help_text_for_fieldsets_name: "Fieldsets unique name in lowercase chars only."
+admin_help_text_for_fieldsets_icon: "Fieldsets valid :link icon class."
+admin_help_text_for_snippets_name: "Snippets unique name in lowercase chars only."
+admin_help_text_for_temlates_name: "Unique name in lowercase chars only."
 admin_entries_visible: "Visible"
 admin_entries_draft: "Draft"
 admin_entries_hidden: "Hidden"
@@ -261,3 +261,29 @@ admin_published_at: "Published at"
 admin_licence: "Licence"
 admin_plugin: "Plugin"
 admin_icon: "Icon"
+admin_help_text_for_settings_site_title_label: "Title for your site."
+admin_help_text_for_settings_site_robots_label: "Robots settings for your site."
+admin_help_text_for_settings_site_keywords_label: "Keywords for your site."
+admin_help_text_for_settings_site_description_label: "Description for your site."
+admin_help_text_for_settings_site_author_name_label: "Author name for your site."
+admin_help_text_for_settings_site_author_email_label: "Author email for your site."
+admin_help_text_for_settings_content_main_entry_label: "Entry that Flextype will use as the default landing page."
+admin_help_text_for_settings_content_timezone_label: "Timezone you want your site to operate under."
+admin_help_text_for_settings_content_theme_label: "Theme for Flextype."
+admin_help_text_for_settings_content_date_format_label: "Date format used by Flextype."
+admin_help_text_for_settings_content_display_date_format_label: "Display date format used by Flextype."
+admin_help_text_for_settings_content_character_label: "Internal character encoding."
+admin_help_text_for_settings_content_locale_label: "Locale that'll be used by the Flextype."
+admin_help_text_for_settings_media_image_quality_label: "Image quality. Use values between 0 and 100."
+admin_help_text_for_settings_media_image_width_label: "Image width in pixels."
+admin_help_text_for_settings_media_image_height_label: "Image height in pixels."
+admin_help_text_for_settings_media_accept_file_types_label: "List of accept file types."
+admin_help_text_for_settings_image_driver_label: "Image driver. In some cases ImageMagick can be faster, but isn't available on all servers."
+admin_help_text_for_settings_twig_templating_debug_label: "Enable or disable Twig debug mode."
+admin_help_text_for_settings_twig_templating_cache_label: "Set to true to enable Twig caching."
+admin_help_text_for_settings_twig_templating_autoreload_label: "Refresh cache on changes."
+admin_help_text_for_settings_twig_templating_charset_label: "Templates charset."
+admin_help_text_for_settings_errors_display_label: "Display errors."
+admin_help_text_for_settings_errors_display_datails_label: "Display errors details."
+admin_help_text_for_settings_errors_whoops_editor_label: "Whoops editor."
+admin_help_text_for_settings_errors_whoops_page_title_label: "Whoops page title."

site/plugins/admin/views/templates/system/settings/index.html

@@ -17,28 +17,34 @@
                         <div class="form-group">
                             <label for="title">{{ tr('admin_site_title') }}</label>
                             <input type="text" id="systemSettingsSiteTitle" name="title" value="{{ registry.settings.title }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_site_title_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="description">{{ tr('admin_site_description') }}</label>
                             <input type="text" id="systemSettingsSiteDescription" name="description" value="{{ registry.settings.description }}" class="form-control margin-hard-bottom">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_site_description_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="keywords">{{ tr('admin_site_keywords') }}</label>
                             <input type="text" id="systemSettingsSiteKeywords" name="keywords" value="{{ registry.settings.keywords }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_site_keywords_label') }}</small>
                         </div>
                     </div>
                     <div class="col-md-6">
                         <div class="form-group">
                             <label for="robots">{{ tr('admin_site_robots') }}</label>
                             <input type="text" id="systemSettingsSiteRobots" name="robots" value="{{ registry.settings.robots }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_site_robots_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="author[name]">{{ tr('admin_author_name') }}</label>
                             <input type="text" id="systemSettingsSiteAuthorName" name="author[name]" value="{{ registry.settings.author.name }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_site_author_name_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="author[email]">{{ tr('admin_author_email') }}</label>
                             <input type="text" id="systemSettingsSiteAuthorEmail" name="author[email]" value="{{ registry.settings.author.email }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_site_author_email_label') }}</small>
                         </div>
                     </div>
                 </div>
@@ -58,6 +64,7 @@
                                     <option value="{{ key }}" {% if key == registry.settings.entries.main %}selected{% endif %}>{{ value }}</option>
                                 {% endfor %}
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_content_main_entry_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="theme">{{ tr('admin_theme') }}</label>
@@ -66,10 +73,12 @@
                                     <option value="{{ key }}" {% if key == registry.settings.theme %}selected{% endif %}>{{ value }}</option>
                                 {% endfor %}
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_content_theme_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="charset">{{ tr('admin_charset') }}</label>
                             <input type="text" id="systemSettingsSystemCharset" name="charset" value="{{ registry.settings.charset }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_content_character_label') }}</small>
                         </div>
                     </div>
                     <div class="col-md-6">
@@ -80,6 +89,7 @@
                                     <option value="{{ key }}" {% if key == registry.settings.timezone %}selected{% endif %}>{{ value }}</option>
                                 {% endfor %}
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_content_timezone_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="date_format">{{ tr('admin_date_format') }}</label>
@@ -88,6 +98,7 @@
                                     <option value="{{ key }}" {% if key == registry.settings.date_format %}selected{% endif %}>{{ value }}</option>
                                 {% endfor %}
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_content_date_format_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="date_display_format">{{ tr('admin_date_display_format') }}</label>
@@ -96,6 +107,7 @@
                                     <option value="{{ key }}" {% if key == registry.settings.date_display_format %}selected{% endif %}>{{ value }}</option>
                                 {% endfor %}
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_content_display_date_format_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="locale">{{ tr('admin_locale') }}</label>
@@ -104,6 +116,7 @@
                                     <option value="{{ key }}" {% if key == registry.settings.locale %}selected{% endif %}>{{ value }}</option>
                                 {% endfor %}
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_content_locale_label') }}</small>
                         </div>
                     </div>
                 </div>
@@ -119,10 +132,12 @@
                         <div class="form-group">
                             <label for="entries[media][upload_images_quality]">{{ tr('admin_quality') }}</label>
                             <input type="text" id="systemSettingsSystemTheme" name="entries[media][upload_images_quality]" value="{{ registry.settings.entries.media.upload_images_quality }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_media_image_quality_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="entries[media][accept_file_types]">{{ tr('admin_accept_file_types') }}</label>
                             <input type="text" id="systemSettingsSystemTheme" name="entries[media][accept_file_types]" value="{{ registry.settings.entries.media.accept_file_types }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_media_accept_file_types_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="image[driver]">{{ tr('admin_image_driver') }}</label>
@@ -131,16 +146,19 @@
                                     <option value="{{ key }}" {% if key == registry.settings.image.driver %}selected{% endif %}>{{ value }}</option>
                                 {% endfor %}
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_image_driver_label') }}</small>
                         </div>
                     </div>
                     <div class="col-md-6">
                         <div class="form-group">
                             <label for="entries[media][upload_images_width]">{{ tr('admin_width') }}</label>
                             <input type="text" id="systemSettingsSystemTheme" name="entries[media][upload_images_width]" value="{{ registry.settings.entries.media.upload_images_width }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_media_image_width_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="entries[media][upload_images_height]">{{ tr('admin_height') }}</label>
                             <input type="text" id="systemSettingsSystemEntriesMain" name="entries[media][upload_images_height]" value="{{ registry.settings.entries.media.upload_images_height }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_media_image_height_label') }}</small>
                         </div>
                     </div>
                 </div>
@@ -190,6 +208,7 @@
                                 <option value="0" {% if registry.settings.twig.debug == 0 %}selected{% endif %}>{{ tr('admin_disabled') }}</option>
                                 <option value="1" {% if registry.settings.twig.debug == 1 %}selected{% endif %}>{{ tr('admin_enabled') }}</option>
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_twig_templating_debug_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="twig[auto_reload]">{{ tr('admin_twig_auto_reload') }}</label>
@@ -197,6 +216,7 @@
                                 <option value="0" {% if registry.settings.twig.auto_reload == 0 %}selected{% endif %}>{{ tr('admin_disabled') }}</option>
                                 <option value="1" {% if registry.settings.twig.auto_reload == 1 %}selected{% endif %}>{{ tr('admin_enabled') }}</option>
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_twig_templating_autoreload_label') }}</small>
                         </div>
                     </div>
                     <div class="col-md-6">
@@ -206,10 +226,12 @@
                                 <option value="0" {% if registry.settings.twig.cache == 0 %}selected{% endif %}>{{ tr('admin_disabled') }}</option>
                                 <option value="1" {% if registry.settings.twig.cache == 1 %}selected{% endif %}>{{ tr('admin_enabled') }}</option>
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_twig_templating_cache_label') }}</small>
                         </div>
                         <div class="form-group">
                             <label for="twig[charset]">{{ tr('admin_twig_charset') }}</label>
                             <input type="text" id="systemSettingsTwigCharset" name="twig[charset]" value="{{ registry.settings.twig.charset }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_twig_templating_charset_label') }}</small>
                         </div>
                     </div>
                 </div>
@@ -228,6 +250,7 @@
                                 <option value="0" {% if registry.settings.errors.display == 0 %}selected{% endif %}>{{ tr('admin_disabled') }}</option>
                                 <option value="1" {% if registry.settings.errors.display == 1 %}selected{% endif %}>{{ tr('admin_enabled') }}</option>
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_errors_display_label') }}</small>
                         </div>
                     </div>
                     <div class="col-md-6">
@@ -237,6 +260,7 @@
                                 <option value="0" {% if registry.settings.display_error_details == 0 %}selected{% endif %}>{{ tr('admin_disabled') }}</option>
                                 <option value="1" {% if registry.settings.display_error_details == 1 %}selected{% endif %}>{{ tr('admin_enabled') }}</option>
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_errors_display_datails_label') }}</small>
                         </div>
                     </div>
                     <div class="col-md-6">
@@ -247,12 +271,14 @@
                                     <option value="{{ key }}" {% if key == registry.settings.whoops.editor %}selected{% endif %}>{{ value }}</option>
                                 {% endfor %}
                             </select>
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_errors_whoops_editor_label') }}</small>
                         </div>
                     </div>
                     <div class="col-md-6">
                         <div class="form-group">
                             <label for="whoops[page_title]">{{ tr('admin_whoops_page_title') }}</label>
                             <input type="text" id="systemSettingsWhoopsPageTitle" name="whoops[page_title]" value="{{ registry.settings.whoops.page_title }}" class="form-control" required="required">
+                            <small class="form-text text-muted">{{ tr('admin_help_text_for_settings_errors_whoops_page_title_label') }}</small>
                         </div>
                     </div>
                 </div>