546340 - Change <a name> anchors to use @id

Status: RESOLVED FIXED

(Bugzilla :: Bugzilla-General, enhancement, P1)

Description

[Gordon P. Hemsley [:GPHemsley]]

(This is the offshoot bug from bug 529201 comment 7 that neither I nor Max got around to filing until now.)

Using <a name> wrappers to specify anchors has long been deprecated behavior and, as noted in bug 529201 comment 6, support for using @id for this purpose goes all the way back to IE5 (but not NN4).

Thus, I think it is time that these obsolete tags are removed and replaced with the more modern usage of @id. For one thing, it would help prevent problems such as that of bug 546338.

Comment 1

[Max Kanat-Alexander]

Yes, agreed, if @id works then there's no reason to use <a name>. (This won't happen for 3.6, though, which is feature-frozen, and until somebody takes assignment of this bug, then we won't TM it.)

Comment 2

[Gordon P. Hemsley [:GPHemsley]]

Attachment: Change <a name> to @id (excluding release notes)

This patch touches 17 template files, changing instances of <a name> to use @id instead. I've modified the surrounding markup in some places to have things make a little more sense (e.g. using <h3> instead of <b> or <p><b>).

This patch does not touch any other elements that use @name, since they have a valid usecase on form elements. This patch also doesn't touch the release notes template, as that has 99 lines worth of <a name> instances. I'll have a separate patch for that later.

Comment 3

[Max Kanat-Alexander]

Comment on attachment 427028 [details] [diff] [review]
Change <a name> to @id (excluding release notes)

>=== modified file 'template/en/default/bug/edit.html.tmpl'
>-        <table class="status" cellspacing="0" cellpadding="0">
>+        <table id="bug_status_bottom"
>+          class="status" cellspacing="0" cellpadding="0">

  Nit: Our more normal spacing is like:

 <table id=
        class=

>=== modified file 'template/en/default/bug/votes/list-for-user.html.tmpl'

  This template is now extensions/Voting/template/en/default/pages/voting/user.html.tmpl.

>=== modified file 'template/en/default/pages/fields.html.tmpl'

  This file is awaiting an enormous patch in bug 529201 that's just about ready, so you might want to base your work on that patch instead.

>=== modified file 'template/en/default/pages/quicksearch.html.tmpl'
>=== modified file 'template/en/default/reports/components.html.tmpl'
>+  <tr id="[% comp.name FILTER html %]">

  You know, come to think of it, this doesn't have to be a valid id--it can start with a number or anything imaginable. Also, it can have just about *any* character in it.

>=== modified file 'template/en/default/reports/duplicates.html.tmpl'
>+<h3 id="explanation">
>+  What are "Most Frequently Reported [% terms.Bugs %]"?
> </b>

  Cool. But </b> -> </h3>.

Comment 4

[Gordon P. Hemsley [:GPHemsley]]

Attachment: Change <a name> to @id (excluding release notes), v2

Hopefully, this addresses your concerns. It was applied after attachment 425729 [details] [diff] [review]. Otherwise, same conditions apply as before.

Comment 5

[Max Kanat-Alexander]

Comment on attachment 427042 [details] [diff] [review]
Change <a name> to @id (excluding release notes), v2

The only thing that's fixed in this patch is the spacing, and everything else seems to be the same.

Comment 6

[Max Kanat-Alexander]

  By the way, you'll want to request review from specific people, or there's a chance that your review request won't be gotten to. See our development process here for details:

  http://wiki.mozilla.org/Bugzilla:Developers

Comment 7

[Gordon P. Hemsley [:GPHemsley]]

Attachment: Change <a name> to @id (excluding release notes), v3

Forgot to pull the latest revisions when I generated the last patch. This one should do it.

Comment 8

[Max Kanat-Alexander]

Comment on attachment 427067 [details] [diff] [review]
Change <a name> to @id (excluding release notes), v3

Okay, this looks good! :-)

Comment 9

[Gordon P. Hemsley [:GPHemsley]]

Attachment: Change <a name> to @id in release notes

Separate patch for release notes, since there were 99 lines of change. This was done mostly via a couple of regexps.

Comment 10

[:glob ✱]

won't this generate invalid id's?

eg. css id's can't start with a number, however a filename can start with a number..

  <table id="[% file.filename FILTER html %]


see http://www.w3.org/TR/CSS2/syndata.html#tokenization

Comment 11

[Gordon P. Hemsley [:GPHemsley]]

(In reply to comment #10)
> won't this generate invalid id's?

Yes, it will. But the existing code already does, too. So we decided we'll address that issue in another bug, after this one has been applied.

Comment 12

[Max Kanat-Alexander]

Comment on attachment 427074 [details] [diff] [review]
Change <a name> to @id in release notes

Sweet! :-) Looks good. :-)

Comment 13

[Max Kanat-Alexander]

Thanks for the patch, gphemsley! :-)

Committing to: bzr+ssh://bzr.mozilla.org/bugzilla/trunk/                       
modified template/en/default/account/auth/login.html.tmpl
modified template/en/default/account/prefs/email.html.tmpl
modified template/en/default/admin/params/common.html.tmpl
modified template/en/default/attachment/diff-file.html.tmpl
modified template/en/default/attachment/list.html.tmpl
modified template/en/default/bug/comments.html.tmpl
modified template/en/default/bug/dependency-tree.html.tmpl
modified template/en/default/bug/edit.html.tmpl
modified template/en/default/bug/create/create-guided.html.tmpl
modified template/en/default/list/table.html.tmpl
modified template/en/default/pages/fields.html.tmpl
modified template/en/default/pages/quicksearch.html.tmpl                       
modified template/en/default/pages/release-notes.html.tmpl
modified template/en/default/reports/components.html.tmpl
modified template/en/default/reports/duplicates.html.tmpl
modified template/en/default/reports/keywords.html.tmpl
modified template/en/default/search/boolean-charts.html.tmpl
Committed revision 6998.

Comment 14

[Max Kanat-Alexander]

I backported just the release notes patch to 3.6, so that the trunk release notes and the branch release notes will be identical.

Committing to: bzr+ssh://bzr.mozilla.org/bugzilla/3.6/                         
modified template/en/default/pages/release-notes.html.tmpl
Committed revision 7001.