Ticket #6362 (assigned defect)

Opened 8 months ago

Last modified 4 months ago

Suggests for improving tech instruction

Reported by: RanYanivHartstein Assigned to: ninjaWR (accepted)
Priority: normal Milestone: 2.9
Component: Administration Version: 2.5
Severity: normal Keywords: dev-feedback has-patch
Cc:

Description

2.5 introduced inline documentation in the administration areas - many options now have short descriptions.

However, some of these could be made superfluous if only the options they were documenting were properly explained in the first place.

For e.g., in the post edit page, the option for allowing pingbacks and trackbacks reads "Allow pings", and is followed by and explanation that reads "pings are trackbacks and pingbacks". Isn't it easier to just say "Allow trackbacks and pingbacks", and this way be more consistent with other mentions of these concepts elsewhere in the admin?

A more obvious example is in the link edit page. Options for setting the target value are just the meaningless "_blank", "_top" and "none", and these are followed by an explanation that reads "Essentially this means if you choose _blank your link will open in a new window" (i.e., "We confused you with too many options you don't care about, but this is how to get what you really want here"). I would suggest simply explaining what these options do - "_blank (new window/tab)", "_top (breaks out of frames), "none (same window)".

I suppose there are more examples, these are just a few that stood out.

Attachments

6362.patch (8.0 kB) - added by ninjaWR on 05/05/08 03:47:18.
6362.diff (8.0 kB) - added by Otto42 on 08/04/08 19:29:17.
Refreshed patch for trunk

Change History

03/24/08 21:09:11 changed by markjaquith

Good points. Inline documentation is nice, not needing it is better.

03/24/08 21:42:49 changed by lloydbudd

  • summary changed from Inline documentation introduced in 2.5 to Suggests for improving tech instruction.
  • version set to 2.5.
  • milestone changed from 2.5 to 2.6.

03/25/08 19:15:01 changed by ninjaWR

  • owner changed from anonymous to ninjaWR.
  • status changed from new to assigned.

this sounds like something I can do

04/25/08 21:46:37 changed by RanYanivHartstein

I opened a separate ticket #6615 that deals specifically with the link edit page issue. It includes a patch

05/05/08 03:47:18 changed by ninjaWR

  • attachment 6362.patch added.

05/05/08 03:50:30 changed by ninjaWR

Patch takes care of some of the more obvious things... other than those, I didn't really see anything that I'd remove/change

05/05/08 16:49:38 changed by Otto42

+1, I noticed the "Allow Pings" one today, and thought that it seemed a bit silly.

06/23/08 21:42:49 changed by ninjaWR

  • keywords set to dev-feedback has-patch.

possible for 2.6?

(follow-up: ↓ 9 ) 08/04/08 19:14:53 changed by RanYanivHartstein

These are rather simple fixes, some related to #6615. Couldn't this be easily done in time for 2.7?

(in reply to: ↑ 8 ) 08/04/08 19:18:39 changed by santosj

Replying to RanYanivHartstein:

These are rather simple fixes, some related to #6615. Couldn't this be easily done in time for 2.7?


Patch is most likely stale since it has been 3 months. Someone will need to update the patch and double check that the same areas need improvement.

08/04/08 19:29:17 changed by Otto42

  • attachment 6362.diff added.

Refreshed patch for trunk

08/04/08 20:17:43 changed by Otto42

Patch seems relevant to me. Attached refreshed patch for current trunk.

08/09/08 01:13:09 changed by jacobsantos

Can this get into 2.7? Are there any suggestions that would be holding this ticket back from inclusion into core?