#44736 [NEW]: standardize title and titleabbr usage

From: Date: Tue, 15 Apr 2008 20:37:06 +0000
Subject: #44736 [NEW]: standardize title and titleabbr usage
Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-712@lists.php.net to get a copy of this message 
From:             philip@php.net
Operating system: Mac
PHP version:      Irrelevant
PHP Bug Type:     Documentation problem
Bug description:  standardize title and titleabbr usage

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 bug report at http://bugs.php.net/?id=44736&edit=1
-- 
Try a CVS snapshot (PHP 5.2): http://bugs.php.net/fix.php?id=44736&r=trysnapshot52
Try a CVS snapshot (PHP 5.3): http://bugs.php.net/fix.php?id=44736&r=trysnapshot53
Try a CVS snapshot (PHP 6.0): http://bugs.php.net/fix.php?id=44736&r=trysnapshot60
Fixed in CVS:                 http://bugs.php.net/fix.php?id=44736&r=fixedcvs
Fixed in release:             http://bugs.php.net/fix.php?id=44736&r=alreadyfixed
Need backtrace:               http://bugs.php.net/fix.php?id=44736&r=needtrace
Need Reproduce Script:        http://bugs.php.net/fix.php?id=44736&r=needscript
Try newer version:            http://bugs.php.net/fix.php?id=44736&r=oldversion
Not developer issue:          http://bugs.php.net/fix.php?id=44736&r=support
Expected behavior:            http://bugs.php.net/fix.php?id=44736&r=notwrong
Not enough info:              http://bugs.php.net/fix.php?id=44736&r=notenoughinfo
Submitted twice:              http://bugs.php.net/fix.php?id=44736&r=submittedtwice
register_globals:             http://bugs.php.net/fix.php?id=44736&r=globals
PHP 4 support discontinued:   http://bugs.php.net/fix.php?id=44736&r=php4
Daylight Savings:             http://bugs.php.net/fix.php?id=44736&r=dst
IIS Stability:                http://bugs.php.net/fix.php?id=44736&r=isapi
Install GNU Sed:              http://bugs.php.net/fix.php?id=44736&r=gnused
Floating point limitations:   http://bugs.php.net/fix.php?id=44736&r=float
No Zend Extensions:           http://bugs.php.net/fix.php?id=44736&r=nozend
MySQL Configuration Error:    http://bugs.php.net/fix.php?id=44736&r=mysqlcfg

Thread (3 messages)

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