php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #44736 standardize title and titleabbr usage
Submitted: 2008-04-15 20:37 UTC Modified: 2008-05-30 17:27 UTC
From: philip@php.net Assigned: philip
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS: Mac
Private report: No CVE-ID:
 [2008-04-15 20:37 UTC] philip@php.net
Description:
------------
The <title>'s and <titleabbr>'s within book.xml and reference.xml needs standardization. This bug is a reminder to implement such standardization.

The standardization rules:

- Only use &Functions; inside reference.xml (and not book.xml)
- Only optionally use <titleabbrev> in book.xml (and not reference.xml)
- Ensure <title> is always used
- If <titleabbrev> exists, use its contents in the reference.xml <title> and append &Functions;

As for how PhD creates the TOC currently:

If <titleabbrev> exists, it's used as the TOC link with the <title> appended as its description. Otherwise, the TOC simply uses <title> as a link with no description.




Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2008-05-30 17:27 UTC] philip@php.net
This change has now been implemented.
 
PHP Copyright © 2001-2014 The PHP Group
All rights reserved.
Last updated: Thu Apr 17 12:01:59 2014 UTC