#36448 [Fbk]: Meaningless <acronym> tag in docs

ID: 36448 Updated by: philip@php.net Reported By: gareth dot adams at gmail dot com Status: Feedback Bug Type: Documentation problem Operating System: N/A PHP Version: Irrelevant New Comment: 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 Previous Comments: ------------------------------------------------------------------------ [2006-02-18 22:18:36] 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-18 21:13:22] 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 ------------------------------------------------------------------------ -- Edit this bug report at http://bugs.php.net/?id=36448&edit=1