From ed2c35ad0afb06cded6c3cd811b6aa1a65032556 Mon Sep 17 00:00:00 2001 From: koopersmith Date: Tue, 29 Nov 2011 16:58:58 +0000 Subject: [PATCH] Update help text on settings pages. props Ipstenu, see #19020. git-svn-id: http://svn.automattic.com/wordpress/trunk@19472 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/network.php | 17 ++++++++++---- wp-admin/options-discussion.php | 10 ++++---- wp-admin/options-general.php | 18 ++++++++------- wp-admin/options-media.php | 20 +++++++++++----- wp-admin/options-permalink.php | 16 +++++++------ wp-admin/options-privacy.php | 12 ++++++---- wp-admin/options-reading.php | 14 ++++++----- wp-admin/options-writing.php | 41 +++++++++++++++++++++++++++++---- 8 files changed, 103 insertions(+), 45 deletions(-) diff --git a/wp-admin/network.php b/wp-admin/network.php index d58f054d12..d1a0fe3b70 100644 --- a/wp-admin/network.php +++ b/wp-admin/network.php @@ -103,14 +103,21 @@ if ( is_network_admin() ) { $parent_file = 'tools.php'; } -add_contextual_help($current_screen, - '

' . __('This screen allows you to configure a network as having subdomains (site1.example.com) or subdirectories (example.com/site1). Subdomains require wildcard subdomains to be enabled in Apache and DNS records, if your host allows it.') . '

' . +$network_help = '

' . __('This screen allows you to configure a network as having subdomains (site1.example.com) or subdirectories (example.com/site1). Subdomains require wildcard subdomains to be enabled in Apache and DNS records, if your host allows it.') . '

' . '

' . __('Choose subdomains or subdirectories; this can only be switched afterwards by reconfiguring your install. Fill out the network details, and click install. If this does not work, you may have to add a wildcard DNS record (for subdomains) or change to another setting in Permalinks (for subdirectories).') . '

' . '

' . __('The next screen for Network Setup will give you individually-generated lines of code to add to your wp-config.php and .htaccess files. Make sure the settings of your FTP client make files starting with a dot visible, so that you can find .htaccess; you may have to create this file if it really is not there. Make backup copies of those two files.') . '

' . '

' . __('Add a blogs.dir directory under /wp-content and add the designated lines of code to wp-config.php (just before /*...stop editing...*/) and .htaccess (replacing the existing WordPress rules).') . '

' . - '

' . __('Once you add this code and refresh your browser, multisite should be enabled. This screen will keep an archive of the added code. You can toggle between Network Admin and Site Admin by clicking on the Howdy (Username) dropdown in the upper right of the administration area.') . '

' . - '

' . __('The choice of subdirectory sites is disabled if this setup is more than a month old because of permalink problems with “/blog/” from the main site. This disabling will be addressed soon in a future version.') . '

' -); + '

' . __('Once you add this code and refresh your browser, multisite should be enabled. This screen, now in the Network Admin navigation menu, will keep an archive of the added code. You can toggle between Network Admin and Site Admin by clicking on the Network Admin or an individual site name under the My Sites dropdown in the Admin Bar.') . '

' . + '

' . __('The choice of subdirectory sites is disabled if this setup is more than a month old because of permalink problems with “/blog/” from the main site. This disabling will be addressed in a future version.') . '

' . + '

' . __('For more information:') . '

' . + '

' . __('Documentation on Creating a Network') . '

' . + '

' . __('Documentation on the Network Screen') . '

'; + +get_current_screen()->add_help_tab( array( + 'id' => 'network', + 'title' => __('Network'), + 'content' => $network_help, +) ); get_current_screen()->set_help_sidebar( '

' . __('For more information:') . '

' . diff --git a/wp-admin/options-discussion.php b/wp-admin/options-discussion.php index 3f5fb9a69f..b511f5a291 100644 --- a/wp-admin/options-discussion.php +++ b/wp-admin/options-discussion.php @@ -15,10 +15,12 @@ if ( ! current_user_can( 'manage_options' ) ) $title = __('Discussion Settings'); $parent_file = 'options-general.php'; -add_contextual_help($current_screen, - '

' . __('This screen provides many options for controlling the management and display of comments and links to your posts/pages. So many, in fact, they won’t all fit here! :) Use the documentation link below to get information on what each discussion setting does.') . '

' . - '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

' -); +get_current_screen()->add_help_tab( array( + 'id' => 'options-discussion', + 'title' => __('Discussion Options'), + 'content' => '

' . __('This screen provides many options for controlling the management and display of comments and links to your posts/pages. So many, in fact, they won’t all fit here! :) Use the documentation links to get information on what each discussion setting does.') . '

' . + '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

', +) ); get_current_screen()->set_help_sidebar( '

' . __('For more information:') . '

' . diff --git a/wp-admin/options-general.php b/wp-admin/options-general.php index 8f76e0b2e7..eb28ae43e5 100644 --- a/wp-admin/options-general.php +++ b/wp-admin/options-general.php @@ -58,14 +58,16 @@ function add_js() { } add_action('admin_head', 'add_js'); -add_contextual_help($current_screen, - '

' . __('The fields on this screen determine some of the basics of your site setup.') . '

' . - '

' . __('Most themes display the site title at the top of every page, in the title bar of the browser, and as the identifying name for syndicated feeds. The tagline is also displayed by many themes.') . '

' . - '

' . __('The WordPress URL and the Site URL can be the same (example.com) or different; for example, having the WordPress core files (example.com/wordpress) in a subdirectory instead of the root directory.') . '

' . - '

' . __('If you want site visitors to be able to register themselves, as opposed to being registered by the site administrator, check the membership box. A default user role can be set for all new users, whether self-registered or registered by the site administrator.') . '

' . - '

' . __('UTC means Coordinated Universal Time.') . '

' . - '

' . __('Remember to click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

' -); +get_current_screen()->add_help_tab( array( + 'id' => 'options', + 'title' => __('Options'), + 'content' => '

' . __('The fields on this screen determine some of the basics of your site setup.') . '

' . + '

' . __('Most themes display the site title at the top of every page, in the title bar of the browser, and as the identifying name for syndicated feeds. The tagline is also displayed by many themes.') . '

' . + '

' . __('The WordPress URL and the Site URL can be the same (example.com) or different; for example, having the WordPress core files (example.com/wordpress) in a subdirectory instead of the root directory.') . '

' . + '

' . __('If you want site visitors to be able to register themselves, as opposed to being registered by the site administrator, check the membership box. A default user role can be set for all new users, whether self-registered or registered by the site administrator.') . '

' . + '

' . __('UTC means Coordinated Universal Time.') . '

' . + '

' . __('Remember to click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

', +) ); get_current_screen()->set_help_sidebar( '

' . __('For more information:') . '

' . diff --git a/wp-admin/options-media.php b/wp-admin/options-media.php index fc128bac56..7ecfa32488 100644 --- a/wp-admin/options-media.php +++ b/wp-admin/options-media.php @@ -15,12 +15,20 @@ if ( ! current_user_can( 'manage_options' ) ) $title = __('Media Settings'); $parent_file = 'options-general.php'; -add_contextual_help($current_screen, - '

' . __('You can set maximum sizes for images inserted into your written content; you can also insert an image as Full Size.') . '

' . - '

' . __('The Embed option allows you embed a video, image, or other media content into your content automatically by typing the URL (of the web page where the file lives) on its own line when you create your content.') . '

' . - ( is_multisite() ? '' : '

' . __('Uploading Options gives you folder and path choices for storing your files in your installation’s directory.') . '

' ) . - '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

' -); +$media_options_help = '

' . __('You can set maximum sizes for images inserted into your written content; you can also insert an image as Full Size.') . '

' . + '

' . __('The Embed option allows you embed a video, image, or other media content into your content automatically by typing the URL (of the web page where the file lives) on its own line when you create your content.') . '

'; + +if ( ! is_multisite() ) { + $media_options_help .= '

' . __('Uploading Options gives you folder and path choices for storing your files in your installation’s directory.') . '

'; +} + +$media_options_help .= '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

'; + +get_current_screen()->add_help_tab( array( + 'id' => 'options-media', + 'title' => __('Media Options'), + 'content' => $media_options_help, +) ); get_current_screen()->set_help_sidebar( '

' . __('For more information:') . '

' . diff --git a/wp-admin/options-permalink.php b/wp-admin/options-permalink.php index 0ba1876ece..dd2b494825 100644 --- a/wp-admin/options-permalink.php +++ b/wp-admin/options-permalink.php @@ -15,13 +15,15 @@ if ( ! current_user_can( 'manage_options' ) ) $title = __('Permalink Settings'); $parent_file = 'options-general.php'; -add_contextual_help($current_screen, - '

' . __('This screen provides some common options for your default permalinks URL structure.') . '

' . - '

' . __('If you pick an option other than Default, your general URL path with structure tags, terms surrounded by %, will also appear in the custom structure field and your path can be further modified there.') . '

' . - '

' . __('When you assign multiple categories or tags to a post, only one can show up in the permalink: the lowest numbered category. This applies if your custom structure includes %category% or %tag%.') . '

' . - '

' . __('The Optional fields let you customize the “category” and “tag” base names that will appear in archive URLs. For example, the page listing all posts in the “Uncategorized” category could be /topics/uncategorized instead of /category/uncategorized.') . '

' . - '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

' -); +get_current_screen()->add_help_tab( array( + 'id' => 'options-permalinks', + 'title' => __('Permalink Options'), + 'content' => '

' . __('This screen provides some common options for your default permalinks URL structure.') . '

' . + '

' . __('If you pick an option other than Default, your general URL path with structure tags, terms surrounded by %, will also appear in the custom structure field and your path can be further modified there.') . '

' . + '

' . __('When you assign multiple categories or tags to a post, only one can show up in the permalink: the lowest numbered category. This applies if your custom structure includes %category% or %tag%.') . '

' . + '

' . __('The Optional fields let you customize the “category” and “tag” base names that will appear in archive URLs. For example, the page listing all posts in the “Uncategorized” category could be /topics/uncategorized instead of /category/uncategorized.') . '

' . + '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

', +) ); get_current_screen()->set_help_sidebar( '

' . __('For more information:') . '

' . diff --git a/wp-admin/options-privacy.php b/wp-admin/options-privacy.php index e7df3d50fc..7811d25414 100644 --- a/wp-admin/options-privacy.php +++ b/wp-admin/options-privacy.php @@ -15,11 +15,13 @@ if ( ! current_user_can( 'manage_options' ) ) $title = __('Privacy Settings'); $parent_file = 'options-general.php'; -add_contextual_help($current_screen, - '

' . __('You can choose whether or not your site will be crawled by robots, ping services, and spiders. If you want those services to ignore your site, click the second option here. Note that your privacy is not complete; your site is still visible on the web.') . '

' . - '

' . __('When this setting is in effect a reminder is shown in the Right Now box of the Dashboard that says, “Search Engines Blocked,” to remind you that your site is not being crawled.') . '

' . - '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

' -); +get_current_screen()->add_help_tab( array( + 'id' => 'options-privacy', + 'title' => __('Privacy Options'), + 'content' => '

' . __('You can choose whether or not your site will be crawled by robots, ping services, and spiders. If you want those services to ignore your site, click the second option here. Note that your privacy is not complete; your site is still visible on the web.') . '

' . + '

' . __('When this setting is in effect a reminder is shown in the Right Now box of the Dashboard that says, “Search Engines Blocked,” to remind you that your site is not being crawled.') . '

' . + '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

', +) ); get_current_screen()->set_help_sidebar( '

' . __('For more information:') . '

' . diff --git a/wp-admin/options-reading.php b/wp-admin/options-reading.php index 45788d68f9..b699cb83a4 100644 --- a/wp-admin/options-reading.php +++ b/wp-admin/options-reading.php @@ -41,12 +41,14 @@ function add_js() { } add_action('admin_head', 'add_js'); -add_contextual_help($current_screen, - '

' . __('This screen contains the settings that affect the display of your content.') . '

' . - '

' . sprintf(__('You can choose what’s displayed on the front page of your site. It can be posts in reverse chronological order (classic blog), or a fixed/static page. To set a static home page, you first need to create two Pages. One will become the front page, and the other will be where your posts are displayed.'), 'post-new.php?post_type=page') . '

' . - '

' . __('You can also control the display of your content in RSS feeds, including the maximum numbers of posts to display, whether to show full text or a summary, and the character set encoding.') . '

' . - '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

' -); +get_current_screen()->add_help_tab( array( + 'id' => 'options-reading', + 'title' => __('Reading Options'), + 'content' => '

' . __('This screen contains the settings that affect the display of your content.') . '

' . + '

' . sprintf(__('You can choose what’s displayed on the front page of your site. It can be posts in reverse chronological order (classic blog), or a fixed/static page. To set a static home page, you first need to create two Pages. One will become the front page, and the other will be where your posts are displayed.'), 'post-new.php?post_type=page') . '

' . + '

' . __('You can also control the display of your content in RSS feeds, including the maximum numbers of posts to display, whether to show full text or a summary, and the character set encoding.') . '

' . + '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

', +) ); get_current_screen()->set_help_sidebar( '

' . __('For more information:') . '

' . diff --git a/wp-admin/options-writing.php b/wp-admin/options-writing.php index 8ca6130806..c03e91fbfc 100644 --- a/wp-admin/options-writing.php +++ b/wp-admin/options-writing.php @@ -15,10 +15,43 @@ if ( ! current_user_can( 'manage_options' ) ) $title = __('Writing Settings'); $parent_file = 'options-general.php'; -add_contextual_help($current_screen, - '

' . __('You can submit content in several different ways; this screen holds the settings for all of them. The top section controls the editor within these administration screens, while the rest control external publishing methods. For more information on any of these methods, use the documentation links below.') . '

' . - '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

' -); +get_current_screen()->add_help_tab( array( + 'id' => 'options-writing', + 'title' => __('Writing Options'), + 'content' => '

' . __('You can submit content in several different ways; this screen holds the settings for all of them. The top section controls the editor within these administration screens, while the rest control external publishing methods. For more information on any of these methods, use the documentation links.') . '

' . + '

' . __('You must click the Save Changes button at the bottom of the screen for new settings to take effect.') . '

', +) ); + +get_current_screen()->add_help_tab( array( + 'id' => 'options-press', + 'title' => __('Press This'), + 'content' => '

' . __('Press This is a bookmarklet that makes it easy to blog about something you come across on the web. You can use it to just grab a link, or to post an excerpt. Press This will even allow you to choose from images included on the page and use them in your post. Just drag the Press This link on this screen to your bookmarks bar in your browser, and you’ll be on your way to easier content creation. Clicking on it while on another website opens a popup window with all these options.') . '

', +) ); + + +if ( is_multisite() ) { + $post_email_help = '

' . __('Due to security issues, you cannot use Post By Email on Multisite Installs.') . '

'; +} else { + $post_email_help = '

' . __('Post via email settings allow you to send your WordPress install an email with the content of your post. You must set up a secret e-mail account with POP3 access to use this, and any mail received at this address will be posted, so it’s a good idea to keep this address very secret.') . '

'; +} + +get_current_screen()->add_help_tab( array( + 'id' => 'options-postemail', + 'title' => __('Post Via Email'), + 'content' => $post_email_help, +) ); + +get_current_screen()->add_help_tab( array( + 'id' => 'options-remote', + 'title' => __('Remote Publishing'), + 'content' => '

' . __('Remote Publishing allows you to use an external editor (like the iOS or Android app) to write your posts.') . '

', +) ); + +get_current_screen()->add_help_tab( array( + 'id' => 'options-services', + 'title' => __('Update Services'), + 'content' => '

' . __('If desired, WordPress will automatically alert various services of your new posts.') . '

', +) ); get_current_screen()->set_help_sidebar( '

' . __('For more information:') . '

' .