WordPress.org

Make WordPress Core

Opened 5 years ago

Closed 5 years ago

#9371 closed enhancement (fixed)

Change excerpt info link to a Codex page for END users

Reported by: demetris Owned by:
Milestone: 2.8 Priority: normal
Severity: normal Version: 2.8
Component: Administration Keywords: has-patch commit
Focuses: Cc:

Description

Currently, the decription in the Excerpt metabox links to a Codex article which is more for developers and tinkerers:

http://codex.wordpress.org/Template_Tags/the_excerpt

I started a Codex article with information for people who just want to USE the excerpt and learn what it does:

http://codex.wordpress.org/Excerpt

... and I am submitting a patch to link to that page instead.

Please, feel free to edit the Codex page — or to dismiss the idea of this patch completely, if you don’t agree. :-)

The Codex draft article is a super-condensed summary of an article I recently wrote about the manual Excerpt in WordPress:

http://op111.net/67

Attachments (2)

r10828-excerpt-info-codex-link.diff (991 bytes) - added by demetris 5 years ago.
Changes the info link for Excerpts to a Codex page for end users
r10828-excerpt-info-codex-link-20090511.diff (991 bytes) - added by demetris 5 years ago.
Patch updated for r11262

Download all attachments as: .zip

Change History (9)

demetris5 years ago

Changes the info link for Excerpts to a Codex page for end users

comment:1 Denis-de-Bernardy5 years ago

Suggesting wontfix and that the two codex pages be merged.

comment:2 demetris5 years ago

Thanks for reviewing this!

The reason I made a new Codex page (and didn’t just add to the existing page) is that, I think, developer documentation and user documentation should be separate:

People use WordPress to manage content, not to write PHP functions. So, PHP code has no place in a page for *end users*.

Then, having PHP code in a page for end users gives a wrong impression, because you don’t need any of that stuff to *use* WordPress or, even, in this particular case, to take full advantage of the possibilities of the excerpt.

So, in my view, mixing dev docs with user docs is bad both for users (does not help them) and for WordPress (gives a wrong impression).

comment:3 Denis-de-Bernardy5 years ago

  • Keywords 2nd-opinion added

comment:4 Denis-de-Bernardy5 years ago

  • Keywords needs-patch added; has-patch removed
  • Milestone changed from 2.8 to Future Release

patch is b0rke

demetris5 years ago

Patch updated for r11262

comment:5 demetris5 years ago

  • Keywords has-patch added; needs-patch removed
  • Milestone changed from Future Release to 2.8

comment:6 Denis-de-Bernardy5 years ago

  • Keywords commit added; 2nd-opinion removed

+1 then. maybe a dev will pick this up and like it

comment:7 ryan5 years ago

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

(In [11267]) Better excerpt text and linkage. Props demetris, Denis-de-Bernardy. fixes #9371

Note: See TracTickets for help on using tickets.