Your message dated Fri, 4 Mar 2011 23:13:54 +0900
with message-id <[email protected]>
and subject line Re: debian-policy: anchor issues in HTML version
has caused the Debian Bug report #616042,
regarding debiandoc2html: <link> titles should not have embedded tags
to be marked as done.
This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
Bug report if necessary, and/or fix the problem forthwith.
(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact [email protected]
immediately.)
--
616042: http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=616042
Debian Bug Tracking System
Contact [email protected] with problems
--- Begin Message ---
Package: debian-policy
Version: 3.8.0.1
Severity: minor
When you view the HTML version of the Debian Policy with a browser
like Lynx or SeaMonkey/IceApe (which interpret <link> elements in
the header), you'll notice some unfiltered tags like:
| 4.4 Debian changelog: <code>debian/changelog</code>
or
| 7.2 Binary Dependencies - <samp>Depends</samp>
Apparently, <code> and <samp> etc. should be filtered out in the title
text of the link elements.
Another tight related issue are the anchors that serve as destination
for those link elements. Currently, they are declared like this:
| <h2><a name="s-binarydeps"></a>7.2 Binary Dependencies -
| <samp>Depends</samp>, <samp>Recommends</samp>, <samp>Suggests</samp>,
| <samp>Enhances</samp>, <samp>Pre-Depends</samp></h2>
There is no link text. A better solution would be:
| <h2><a name="s-binarydeps">7.2 Binary Dependencies -
| <samp>Depends</samp>, <samp>Recommends</samp>, <samp>Suggests</samp>,
| <samp>Enhances</samp>, <samp>Pre-Depends</samp></a></h2>
This will meet the recommendations of the WCAG for links.
(<http://www.w3.org/TR/2008/REC-WCAG20-20081211/#navigation-mechanisms>)
Main purpose: I like to use CSS to highlight anchor targets.
This is useful when you want to link to some sub-heading in
your documentation et al. It looks like this:
| h1[id]:hover:after,
| h2[id]:hover:after,
| h3[id]:hover:after,
| h4[id]:hover:after {
| content:" #"attr(id);
| font-size: smaller;
| }
| a[name]:hover:after {
| content:" #"attr(name);
| font-size: smaller;
| }
When you hover over an heading h1 .. h4 or anchor, the browser will
show the id or name at the end of the line. Empty anchors sabotage
this, as they take no space and cannot be hovered. Changing the
anchors or switching to headings with ids should fix that problem,
too.
Regards,
Christoph
P.S.: Version 3.9.1.0 seems to have the same issues.
-- System Information:
Debian Release: 5.0.8
APT prefers oldstable
APT policy: (500, 'oldstable')
Architecture: i386 (i686)
Kernel: Linux 2.6.26-2-686 (SMP w/2 CPU cores)
Locale: LANG=en_US.UTF-8, LC_CTYPE=de_DE.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
debian-policy depends on no packages.
debian-policy recommends no packages.
Versions of packages debian-policy suggests:
pn doc-base <none> (no description available)
-- no debconf information
--- End Message ---
--- Begin Message ---
severity 616043 wishlist
tags 616043 wontfix
severity 613946 wishlist
thanks
Hi,
Before I start, let me remind people that it is more important to
convert all these SGML documents to DocBook XML. So far, I am having
good success for maint-guide. I will work on this document once I get
comfortable doing this conversion.
http://wiki.debian.org/DocbookXmlTransition
But policy is such a high profile document, I will work on this later.
On Tue, Mar 01, 2011 at 10:24:05PM -0600, Jonathan Nieder wrote:
> user [email protected]
> clone 613946 -1 -2
> retitle -1 debiandoc2html: <link> titles should not have embedded tags
What debiandoc2html should do as default is pure taste issue.
I know there have been many flip-flopping. Its enough.
The user of debiandoc2html can disable this by using -L option.
So this is not bug for debiandoc-sgml.
Please see http://bugs.debian.org/402122 first and read on to:
http://bugs.debian.org/402122 (current default rationale)
http://bugs.debian.org/140677 (old history)
On this basis, I am closing this bug #616042 for debiandoc-sgml.
If bug reporter carefully read all these bug reports, this aspect of bug
#613946 is at best wishlist and debian-policy maintainer should assign
wontfix tag unless submitter gives good rationale. I think we provide
document for most browsers with decent capability. We do not cut down
good feature useful for most user just for lowest denominator
application. There are some console browsers such as w3m which can
handle this OK.
> retitle -2 debiandoc2html: <a name> anchors should enclose heading text
Hmmm... this aspect of this bug has been so for long time. I was
wondering on this when I took over this package. I do not see any real
negative so this is purely aesthetic concern. If you can cite some RFC
etc., then this is real minor bug otherwise this is wishlist bug which I
will mark as wontfix since I am not going to change this old program's
behavior any more unless it is gross problem. Until I get clear
argument, I am marking this as wishlist/wontfix so I will not get
similar complain.
> severity -1 normal
> severity -2 minor
> reassign -1 debiandoc-sgml 1.2.20
> reassign -2 debiandoc-sgml 1.2.20
> usertags 613946 + packaging
I see you are doing BTS cleaning.
> See http://bugs.debian.org/613946 for more details. Thoughts?
It has been answered.
This should be fixed on Lynx side. They show up since this does not
understand as I think. But I have not fully investigated so not ready to
reassign this to them.
Properly displaying provided feature-rich HTML is burden of clients. I
think we should not blame generating software and created data. That is
my thought.
Thus I think this is not really a bug of debian-policy. At best it is
wishlist bug. Sevrity changed to wishlist.
If bug triage people think this is not a bug of debian-policy, please
feel free to close this bug.
I should say the more useful wishlist bug is "debian-policy should use
DocBook XML for source" :-)
Osamu
--- End Message ---
