php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login

go to bug id or search bugs for

Doc Bug #36448 Meaningless <acronym> tag in docs
Submitted: 2006-02-18 21:13 UTC Modified: 2007-05-10 13:41 UTC
From: gareth dot adams at gmail dot com Assigned: philip (profile)
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS: N/A
Private report: No CVE-ID: None
View Developer Edit
 [2006-02-18 21:13 UTC] gareth dot adams at gmail dot com 
Description:
------------
The introduction to PHP page on the website contains an <acronym> tag with no title attribute, thereby making it useless as an acronym tag.

From http://php.net/manual/en/introduction.php

<h1 class="sect1"><a name="intro-whatis">What is PHP?</a></h1><p>
    <acronym class="acronym">PHP</acronym> (recursive ...

I'm pretty sure the master manual is not stored in HTML format, so either this is a simple mistake in the documentation or a problem with the HTML converter

I think the problem was pointed out at http://bugs.php.net/bug.php?id=10498 but marked bogus due to a bad description

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2006-02-18 22:18 UTC] goba@php.net 
Quoting from the HTML spec:

---
The ABBR and ACRONYM elements allow authors to clearly indicate occurrences of abbreviations and acronyms.

[...]

Marking up these constructs provides useful information to user agents and tools such as spell checkers, speech synthesizers, translation systems and search-engine indexers.

[...]

The content of the ABBR and ACRONYM elements specifies the abbreviated expression itself, as it would normally appear in running text. The title attribute of these elements may be used to provide the full or expanded form of the expression.
---

It is clear from this text, that the title attribute is not required, and it is quite useful to mark up such content with the acronym tag regardless.
 [2006-02-19 04:39 UTC] philip@php.net 
On the phpdoc TODO list is a "Implement the Acronym tag" TODO. It's been there for awhile and most likely will wait until livedocs is "online" but anyway... :)

Here's a thread on the topic:
http://marc.theaimsgroup.com/?l=phpdoc&m=103679111400458
 [2006-02-27 01:00 UTC] phpdoc at lists dot php dot net 
No feedback was provided for this bug for over a week, so it is
being suspended automatically. If you are able to provide the
information that was originally requested, please do so and change
the status of the bug back to "Open".
 [2007-05-10 13:41 UTC] philip@php.net 
Fixed in livedocs CVS... meaningful acronym tags will show up online sometime in the future.

The tags:
http://cvs.php.net/viewvc.cgi/phpdoc/entities/acronyms.xml

The livedocs patch:
http://news.php.net/php.doc/969376292
 
PHP Copyright © 2001-2025 The PHP Group
All rights reserved. 		Last updated: Mon Jul 14 03:01:31 2025 UTC