Req #77018 [NEW]: Generate 'link' elements in HTML head, for rel="next", "prev", "up", "start"
| From: | phil at catalyst dot net dot nz | Date: | Tue, 16 Oct 2018 01:55:24 +0000 |
| Subject: | Req #77018 [NEW]: Generate 'link' elements in HTML head, for rel="next", "prev", "up", "start" | ||
| Groups: | php.doc.bugs | ||
| Request: | Send a blank email to doc-bugs+get-16082@lists.php.net to get a copy of this message | ||
From: phil at catalyst dot net dot nz
Operating system:
PHP version: master-Git-2018-10-16 (Git)
Package: Doc Build problem
Bug Type: Feature/Change Request
Bug description:Generate 'link' elements in HTML head, for rel="next",
"prev", "up", "start"
Description:
------------
Certain web browsers can utilise navigation metadata to make life easier
for the user. By providing 'link' elements in the HTML 'head' with
'rel' attributes for the "next", "prev", "up", and
"start" pages, users
of these browsers can easily skip around the documentation.
Even better, some browsers can use this metadata to let the user
interactively search throughout the documentation, taking the user to
the next page in the sequence containing a match (by following the
"next" links until a page containing a match is arrived at). The web
browser built into Emacs is one such example.
When using the offline documentation, this search ability can be
incredibly useful, due to its sheer convenience for the user, in
combination with the speed of offline access.
It would be fantastic if the documentation contained these navigation
link elements. Especially in the downloadable archives (e.g.
php_manual_en.tar.gz), as the aforementioned searching is fast for local
files.
Note that this same data is already being established and generated as
the .manualnavbar div at the top of the page, so I believe this feature
request is just to add an additional rendering of that data, which is
hopefully quite straightforward to implement.
The following is an example for the "Variables" section landing page
language.variables.html:
<head>
<link rel="prev" title="Type Juggling"
href="language.types.type-juggling.html">
<link rel="next" title="Basics"
href="language.variables.basics.html">
<link rel="up" title="Language Reference" href="langref.html">
<link rel="start" title="PHP Manual" href="index.html">
</head>
Which is analogous to the following markup included in the <body>:
<div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a
href="language.types.type-juggling.html">Type Juggling</a></div>
<div class="next" style="text-align: right; float: right;"><a
href="language.variables.basics.html">Basics</a></div>
<div class="up"><a href="langref.html">Language
Reference</a></div>
<div class="home"><a href="index.html">PHP
Manual</a></div>
</div>
--
Edit bug report at https://bugs.php.net/bug.php?id=77018&edit=1
--
Try a snapshot (PHP 5.4): https://bugs.php.net/fix.php?id=77018&r=trysnapshot54
Try a snapshot (PHP 5.5): https://bugs.php.net/fix.php?id=77018&r=trysnapshot55
Try a snapshot (trunk): https://bugs.php.net/fix.php?id=77018&r=trysnapshottrunk
Fixed in SVN: https://bugs.php.net/fix.php?id=77018&r=fixed
Fixed in release: https://bugs.php.net/fix.php?id=77018&r=alreadyfixed
Need backtrace: https://bugs.php.net/fix.php?id=77018&r=needtrace
Need Reproduce Script: https://bugs.php.net/fix.php?id=77018&r=needscript
Try newer version: https://bugs.php.net/fix.php?id=77018&r=oldversion
Not developer issue: https://bugs.php.net/fix.php?id=77018&r=support
Expected behavior: https://bugs.php.net/fix.php?id=77018&r=notwrong
Not enough info: https://bugs.php.net/fix.php?id=77018&r=notenoughinfo
Submitted twice: https://bugs.php.net/fix.php?id=77018&r=submittedtwice
register_globals: https://bugs.php.net/fix.php?id=77018&r=globals
PHP 4 support discontinued: https://bugs.php.net/fix.php?id=77018&r=php4
Daylight Savings: https://bugs.php.net/fix.php?id=77018&r=dst
IIS Stability: https://bugs.php.net/fix.php?id=77018&r=isapi
Install GNU Sed: https://bugs.php.net/fix.php?id=77018&r=gnused
Floating point limitations: https://bugs.php.net/fix.php?id=77018&r=float
No Zend Extensions: https://bugs.php.net/fix.php?id=77018&r=nozend
MySQL Configuration Error: https://bugs.php.net/fix.php?id=77018&r=mysqlcfg