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 #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 (profile)
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS: Mac
Private report: No CVE-ID: None
View Add Comment Developer Edit
Welcome back! If you're the original bug submitter, here's where you can edit the bug or add additional notes.
If this is not your bug, you can add a comment by following this link.
If this is your bug, but you forgot your password, you can retrieve your password here.
Password:
Status:
Package:
Bug Type:
Summary:
From: philip@php.net
New email:
PHP Version: OS:

 

 [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-2024 The PHP Group
All rights reserved. 		Last updated: Thu Apr 25 19:01:33 2024 UTC