WordPress.org

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

Last modified 6 years ago

#15346 closed defect (bug) (fixed)

Contextual Help Tabs Cleanup

Reported by: dougwrites Owned by:
Milestone: 3.1 Priority: normal
Severity: normal Version:
Component: Administration Keywords: has-patch i18n-change
Focuses: Cc:

Description

For all the help tabs not covered by ticket #15314 (Network Admin).

Two screens are missing text currently except for generic links to the Codex and Support Forums. These screens are "Edit Media" and "Link Categories." I have draft text for these and will put that into comments below.

Also, how much time is left, if any, to make small modifications in wording to existing help screens for the sake of describing new/changed features or to be less confusing? If that window is still open, I have a list of about twenty such items.

Finally, did we want to clean up the Codex links so that they are all in the format of "Documentation on X Y" instead of having 15 still "X Y Documentation"?

Attachments (27)

commentshelp.patch (1004 bytes) - added by dougwrites 6 years ago.
dashboardadd.patch (3.1 KB) - added by dougwrites 6 years ago.
Two features added (admin bar, dev blog) and doc on
editcomments.patch (1.9 KB) - added by dougwrites 6 years ago.
doc on xy rather than xy doc for 3 codex links
medialibrary.patch (1.3 KB) - added by dougwrites 6 years ago.
change to "Documentation on Media Library"
editmediahelp.patch (1.5 KB) - added by dougwrites 6 years ago.
added contextual help to file where none was before; apparently it had defaulted to generic links previously
widgetshelp.php (2.6 KB) - added by dougwrites 6 years ago.
Adds a "The" and a doc on to the widget help screen
15346.diff (14.3 KB) - added by markmcwilliams 6 years ago.
removes the few spaces that entered the url text of r16326 and adds some spacing
edit-tags.php (15.2 KB) - added by dougwrites 6 years ago.
So that file can call 3 help screens (cats, tags, link cats) instead of 2.
edit-tags.patch (5.7 KB) - added by dougwrites 6 years ago.
edit-tags2.patch (6.8 KB) - added by dougwrites 6 years ago.
improved spacing and logic; still doesn't fix hiccup in lines 164-165; does output 3 correct help screens
edit-tags3.patch (6.5 KB) - added by dougwrites 6 years ago.
3 help screens for tags. Revised version of same patch to include more current Codex links; also more directly from nightly build
managingpostspages.patch (1.9 KB) - added by dougwrites 6 years ago.
Updated Codex links for 2 screens: Posts and Pages
plugineditorhelp.patch (1.9 KB) - added by dougwrites 6 years ago.
Expanded one sentence and added a second Codex link
usershelp.patch (2.0 KB) - added by dougwrites 6 years ago.
Added a phrase and updated Codex links for Users screen help tab
usershelp.2.patch (2.0 KB) - added by dougwrites 6 years ago.
Added a phrase and updated Codex links for Users screen help tab
AddEditPostAddEditPagehelp.patch (5.2 KB) - added by dougwrites 6 years ago.
For 4 screens in Pages and Post (Edit same as Add New): add 2 Post features, fixes Codex links
ToolsHelp.patch (2.0 KB) - added by dougwrites 6 years ago.
Added text for Press This and Cats/Tags Coverter; Codex link changed to Doc on XY
ImportHelp.patch (1.2 KB) - added by dougwrites 6 years ago.
Changed Codex link to Doc on XY rather than XY Doc
LinksScreenHelp.patch (914 bytes) - added by dougwrites 6 years ago.
change in Codex link
DashboardHelpImproved.patch (2.7 KB) - added by dougwrites 6 years ago.
clearer wording for Admin Bar and Seperator Lines
PartlyComprehensiveHelpTabs.patch (22.0 KB) - added by dougwrites 6 years ago.
@PeteMall: this isn't everything in a single patch; sorry. These 14 are fairly routine; I have another 5 files with more complex problems/questions/issues. I'll list those in a comment below.
AddEditPostPageHelpTab.patch (5.7 KB) - added by dougwrites 6 years ago.
Extensive cleanup for edit-form-advanced.php; separated from other help tab patches because this file/screen also has tickets #15376 and #15638 working on improving the help text about Formats (not addressed by this patch). Now includes changes in Screen Options (nod to WP-Testers).
LinkCatsMenusPermalinks.patch (12.4 KB) - added by dougwrites 6 years ago.
Second try to upload same patch for 3 files; put it in just before the upgrade this morning and it disappeared. At this point, would it help to put all the diffs for all 18 files into a single patch?
Comprehensive15346Patch.patch (40.8 KB) - added by dougwrites 6 years ago.
@Nacin: This should cover everything. I hope the diff from root is done the right way.
15346-edit-tags.php.diff (3.2 KB) - added by zeo 6 years ago.
Minor fix to edit-tags.php
15346-documentation-on-xy.diff (4.2 KB) - added by zeo 6 years ago.
Documentation on x y
15346-nav-menus.patch (2.5 KB) - added by SergeyBiryukov 6 years ago.
Minor typo fix

Download all attachments as: .zip

Change History (64)

#1 @dougwrites
6 years ago

draft help text for "Edit Media" screen:

This screen allows you to edit five fields for metadata in a file within the media library.

For images only, you can click on Edit Image under the thumbnail to expand out an inline image editor with icons for cropping, rotating, or flipping the image as well as for undoing and redoing. The boxes on the right give you more options for scaling the image, for cropping it, and for cropping the thumbnail in a different way than you crop the original image. You can click on Help in those boxes to get more information. Note that you crop the image by clicking on it (the Crop icon is already selected) and dragging the cropping frame to select the desired part. Then click Save to retain the cropping.

Remember to click Update Media to save metadata entered or changed.

Edit Media in Codex http://codex.wordpress.org/Media_Add_New_SubPanel#Edit_Media

#2 @nacin
6 years ago

  • Milestone changed from Awaiting Review to 3.1

Go for it. String freeze won't be for another month. Sooner the better.

#3 @dougwrites
6 years ago

draft help text for "Link Categories" screen:

You can create groups of links by using link categories. Link category names must be unique and link categories are separate from the categories you use for posts.

You can delete link categories in the Bulk Action pulldown, but that action does not delete the links within the category. Instead, it moves them to the default link category.

For more information:

Documentation on Link Categories: http://codex.wordpress.org/Links_Link_Categories_SubPanel

#4 @zeo
6 years ago

Finally, did we want to clean up the Codex links so that they are all in the format of "Documentation on X Y" instead of having 15 still "X Y Documentation"?

See this old patch that need refresh, http://core.trac.wordpress.org/attachment/ticket/13736/13736.diff

@dougwrites
6 years ago

Two features added (admin bar, dev blog) and doc on

@dougwrites
6 years ago

doc on xy rather than xy doc for 3 codex links

@dougwrites
6 years ago

change to "Documentation on Media Library"

@dougwrites
6 years ago

added contextual help to file where none was before; apparently it had defaulted to generic links previously

@dougwrites
6 years ago

Adds a "The" and a doc on to the widget help screen

#5 @dougwrites
6 years ago

Can anyone help me figure out where to place the code for the help screen for "Link Categories?" Changeset 15820 moved edit-link-categories.php into edt-tags.php and I'm having trouble figuring how that file calls help screens. Said file does call a help tab for the Posts > Category screen.

#6 @nacin
6 years ago

In edit-tags.php, we build the contextual help sentence by sentence, based on the taxonomy we're dealing with. In trunk, this starts around line 161 and ends at 196.

#7 @dougwrites
6 years ago

So to build it this way to call three help screens instead of two, would the following syntax be on the right track?:

if ( 'category' == $taxonomy
'link_category' == $taxonomy 'post_tag' == $taxonomy ) {

if ( 'category' == $taxonomy )
elseif ( 'link_category' == $taxonomy )
else

#8 @nacin
6 years ago

Yep. (Your formatting came through correctly in the email. You can surround code with {{{ and '}}}`.)

Though at that point we'd probably do if ( in_array( $taxonomy, array( 'category', 'link_category', 'post_tag' ) ) ), but that's something for me to worry about :-)

#9 @ryan
6 years ago

(In [16326]) Contextual help updates. Props dougwrites. see #15346

@markmcwilliams
6 years ago

removes the few spaces that entered the url text of r16326 and adds some spacing

@dougwrites
6 years ago

So that file can call 3 help screens (cats, tags, link cats) instead of 2.

#10 follow-up: @dougwrites
6 years ago

Sorry, uploaded the wrong file version of edit-tags. In the .patch, there is still a problem with lines 164-165 and 172 (partially redundant); the elseif prevents the link cat help from calling line 167, which is for another screen. I'm pretty sure there's a more elegant way to do this...

#11 @ryan
6 years ago

(In [16333]) Whitespace cleanup in contextual help. Props markmcwilliams. see #15346

#12 in reply to: ↑ 10 @zeo
6 years ago

Replying to dougwrites:

Sorry, uploaded the wrong file version of edit-tags. In the .patch, there is still a problem with lines 164-165 and 172 (partially redundant); the elseif prevents the link cat help from calling line 167, which is for another screen. I'm pretty sure there's a more elegant way to do this...

You might wanna double check and refresh your patch for unnecessary whitespace. See markmcwilliams patch.

@dougwrites
6 years ago

improved spacing and logic; still doesn't fix hiccup in lines 164-165; does output 3 correct help screens

#13 @zeo
6 years ago

@dougwrites,

Post Tags: http://codex.wordpress.org/Posts_Post_Tags_SubPanel
Categories: http://codex.wordpress.org/Posts_Categories_SubPanel

Please refresh your edit-tags2.patch with the new link.

Also it's best to create patch or diff from WP root dir.

@dougwrites
6 years ago

3 help screens for tags. Revised version of same patch to include more current Codex links; also more directly from nightly build

#14 @dougwrites
6 years ago

Zeo: thanks for the catch on the Codex links. I deleted the file locally and re-did the SVN Update from the nightly build, which I believe fixes your patch creation concern.

Obviously, my hope is for edit-tags3.patch (or a revision fixing the hiccup still in 164-5) to be committed instead of edit-tags.patch or edit-tags2.patch, which should be ignored now.

#15 @zeo
6 years ago

@dougwrites, line 170 should be $help .= and not $help =

If not mistaken, it seems the help content for link categories seems incomplete. Perhaps asking Jane Wells or the wp-docs team for 2nd oppinion or more content?

@dougwrites
6 years ago

Updated Codex links for 2 screens: Posts and Pages

@dougwrites
6 years ago

Expanded one sentence and added a second Codex link

@dougwrites
6 years ago

Added a phrase and updated Codex links for Users screen help tab

@dougwrites
6 years ago

Added a phrase and updated Codex links for Users screen help tab

@dougwrites
6 years ago

For 4 screens in Pages and Post (Edit same as Add New): add 2 Post features, fixes Codex links

@dougwrites
6 years ago

Added text for Press This and Cats/Tags Coverter; Codex link changed to Doc on XY

@dougwrites
6 years ago

Changed Codex link to Doc on XY rather than XY Doc

@dougwrites
6 years ago

change in Codex link

#16 @dougwrites
6 years ago

Are the filters still coming back for Tools>Export in this cycle? I'm looking at tickets #14750, #15197, #15219, and most of the mentions of their temporary removal are about 3 weeks old. When the filters are restored, we'll need to put back the help tab text with some tweaks and explanation of the new UI for filters.

#17 @dougwrites
6 years ago

Note that the Formats part but not all of AddEditPostAddEditPagehelp.patch has been surpassed by ticket #15376. I'd still like to see a mention of the full screen toggle and a rewording of the Codex link; that page really does discuss Add, Editing, and Writing neatly bundled together.

@dougwrites
6 years ago

clearer wording for Admin Bar and Seperator Lines

#18 @dougwrites
6 years ago

And the dashboard needs yet more fixing. There's a "the the" where a "the" will suffice, and we probably want to look at the paragraph that keeps saying "modules" instead of "boxes." My sense is that I shouldn't keep lobbing more tiny patches at the same index.php file until a core person has had time to deal with it. Guidance?

#19 @PeteMall
6 years ago

Can you submit this as a single patch? I'm going to look at the contextual help tickets with Jane tomorrow.

@dougwrites
6 years ago

@PeteMall: this isn't everything in a single patch; sorry. These 14 are fairly routine; I have another 5 files with more complex problems/questions/issues. I'll list those in a comment below.

#20 @dougwrites
6 years ago

The five files I think need even more scrutiny are edit-tags.php (possible problems in the PHP logic, see edit-tags3.patch above) and edit-form-advanced (all kinds of stuff) as well as themes.php, menu.php, and options-permalink.php (smaller questions I still don't have answers for).

#21 @zeo
6 years ago

@dougwrites did u even read my previous reply? I already gave u the fix.

#22 follow-up: @dougwrites
6 years ago

@zeo: I believe you're referring to comment 15 in this ticket... I did read and appreciate it. Sorry for not saying so. The ongoing problem, even when I tested the change of

$help .= 

and not

 $help =

is that I cannot work the

if, ifelse

logic to call more than one paragraph on the Link Categories help tab. Thus I had to put the exact same content that was in two paragraphs in 3.0 into one big paragraph for this version. I suspect there are even more problems still there. If anyone wants to write another patch which solves all this for edit-tags.php, that would be great.

@dougwrites
6 years ago

Extensive cleanup for edit-form-advanced.php; separated from other help tab patches because this file/screen also has tickets #15376 and #15638 working on improving the help text about Formats (not addressed by this patch). Now includes changes in Screen Options (nod to WP-Testers).

#23 in reply to: ↑ 22 @zeo
6 years ago

Replying to dougwrites:

logic to call more than one paragraph on the Link Categories help tab. Thus I had to put the exact same content that was in two paragraphs in 3.0 into one big paragraph for this version. I suspect there are even more problems still there. If anyone wants to write another patch which solves all this for edit-tags.php, that would be great.

It would be easier if you put the text in .txt. It's easier to see what's exactly u trying to accomplish under Categories, Post Tags, Link Categories help tab. Example: http://core.trac.wordpress.org/attachment/ticket/13467/Media%20section.txt

#24 @azizur
6 years ago

  • Cc azizur added

@dougwrites
6 years ago

Second try to upload same patch for 3 files; put it in just before the upgrade this morning and it disappeared. At this point, would it help to put all the diffs for all 18 files into a single patch?

#25 @nacin
6 years ago

Yes. One patch with everything. There's no way we can reasonably work with 18 different patches, when I don't know if any of these succeed each other.

Please diff from the root, not from within wp-admin.

#26 @dougwrites
6 years ago

Good, working on it right now.

@dougwrites
6 years ago

@Nacin: This should cover everything. I hope the diff from root is done the right way.

#27 @dougwrites
6 years ago

  • Keywords has-patch added

#28 @nacin
6 years ago

  • Resolution set to fixed
  • Status changed from new to closed

(In [16980]) Help text edits. props dougwrites, fixes #15346.

#29 @nacin
6 years ago

Thanks Doug. Any deviations were via an editing session with Jane.

@zeo
6 years ago

Minor fix to edit-tags.php

@zeo
6 years ago

Documentation on x y

#30 @zeo
6 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

Reopen. Please review 2 of my latest patch.

#31 @zeo
6 years ago

Update: edit-tags thingy was fixed in #15845

#32 @nacin
6 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed

(In [17014]) Help fixes. props zeo, fixes #15346.

@SergeyBiryukov
6 years ago

Minor typo fix

#33 @SergeyBiryukov
6 years ago

Fixed typo, see the patch above.

#34 @SergeyBiryukov
6 years ago

  • Resolution fixed deleted
  • Status changed from closed to reopened

#35 @nacin
6 years ago

  • Resolution set to fixed
  • Status changed from reopened to closed

(In [17039]) Fix one of my typos. props SergeyBiryukov, fixes #15346.

#36 @nacin
6 years ago

  • Keywords i18n-change added

Please be sure to re-open if you find any other typos.

#37 @nacin
6 years ago

(In [17054]) Simplify this string. props jane, see #15346, see #15829.

Note: See TracTickets for help on using tickets.