#44736 [Opn->Asn]: standardize title and titleabbr usage

From: Date: Tue, 15 Apr 2008 20:37:45 +0000
Subject: #44736 [Opn->Asn]: standardize title and titleabbr usage
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-713@lists.php.net to get a copy of this message 
 ID:               44736
 Updated by:       philip@php.net
 Reported By:      philip@php.net
-Status:           Open
+Status:           Assigned
 Bug Type:         Documentation problem
 Operating System: Mac
 PHP Version:      Irrelevant
 Assigned To:      philip


Previous Comments:
------------------------------------------------------------------------

[2008-04-15 20:37:06] 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.





------------------------------------------------------------------------


-- 
Edit this bug report at http://bugs.php.net/?id=44736&edit=1

Thread (3 messages)

« previous php.doc.bugs (#713) next »