Closed Bug 369035 Opened 18 years ago Closed 12 years ago

NSS project webpages to meet m.o. guidelines (HTML 4.01 strict, markup, style, semantic, etc)

Categories

(www.mozilla.org :: General, defect)

Product:
www.mozilla.org
Component:
General
Type:
defect
Priority:
Not set
Severity:
normal

Tracking

(Not tracked)

Status:
RESOLVED WONTFIX

People

(Reporter: bugzilla, Unassigned)

References

(
URL
)

Details

To Wan-Teh Chang and Glen Beasley, I wish to upgrade all of the NSS project webpages so that they better meet the mozilla.org's requirements (validation, semantic markup, style, accessibility) and mozilla.org's guidelines given by mozilla.org Markup Reference http://www.mozilla.org/contribute/writing/markup mozilla.org Documentation Style Guide http://www.mozilla.org/contribute/writing/guidelines This is part of a colossal on-going effort to make mozilla.org's webpage closer to what they should be: conformant to known and widely acknowledged W3C web standards recommendations and sound and accessible webpage design principles. In the upgrade process, - I update links (if needed and if possible) so that they don't end up at a 404 Not Found webpage, - I may add intra-project navigation [crumbs] (for site navigation toolbar) with <link rel="..."> and/or intra-page anchors - I removed excessive &nbsp; and <br> left by WYSIWYG HTML editors (like Composer) used previously - I removed empty <p></p> - I remove empty anchors (e.g. <a name="top"></a>) and recode them accordingly - <tt> used for styling and <blockquote> used for indentation are removed "use <pre> if you need to; not <tt>" http://www.mozilla.org/contribute/writing/guidelines#format So, I convert <tt> into <code> (eg <code class="filename">) if/when suitable - <font>, <center> are always replace by upgraded code and usage of CSS - arbitrary combinations of <big> and/or <small> are usually replaced by <h>eadings - remove and convert bgcolor - fix improperly nested lists - overall, styling is done using the classes already defined in linked m.o. stylesheets When meeting a long and messy webpage (over 100 validation markup errors), I use HandCoder 0.3.4 (with the latest Tidy - feb. 2006) to "pretty print" the code. Tidy is *_extremely efficient_* for removing &nbsp;, <br>, <p></p>, lowercasing elements and attributes, adding optional closing tags, converting some deprecated attributes, line wrapping at a settable number of characters, etc.. and doing this sort of work. Webpages targeted for now are: ------------------------------ Network Security Services (NSS) http://www.mozilla.org/projects/security/pki/nss/ Invalid doctype declaration; 5 validation markup errors; Introduction to Network Security Services http://www.mozilla.org/projects/security/pki/nss/intro.html 61 validation markup errors; <font>, <center> in use S/MIME Toolkit http://www.mozilla.org/projects/security/pki/nss/smime/ no doctype declaration; <font>, <center> in use 48 validation markup errors with a HTML 4.01 strict DTD Using the Certificate Database Tool http://www.mozilla.org/projects/security/pki/nss/tools/certutil.html 242 validation markup errors; <font>, <center> in use Using the Security Module Database (modutil) http://www.mozilla.org/projects/security/pki/nss/tools/modutil.html 236 validation markup errors; <font>, <center> in use Using the SSL Debugging Tool (ssltap) http://www.mozilla.org/projects/security/pki/nss/tools/ssltap.html 60 validation markup errors; Some blocks of code should be using <pre class="code"> instead SSL Reference http://www.mozilla.org/projects/security/pki/nss/ref/ssl/ 410 validation markup errors when validating with a strict DTD; <font>, <center> in use Chapter 1: Overview of an SSL Application http://www.mozilla.org/projects/security/pki/nss/ref/ssl/sslintro.html no doctype declaration; 150 validation markup errors with strict DTD; Chapter 2: Getting Started With SSL http://www.mozilla.org/projects/security/pki/nss/ref/ssl/gtstd.html no doctype declaration; 98 validation markup errors; Chapter 3: Selected SSL Types and Structures http://www.mozilla.org/projects/security/pki/nss/ref/ssl/ssltyp.html no doctype declaration; 244 validation markup errors; Chapter 4: SSL Functions http://www.mozilla.org/projects/security/pki/nss/ref/ssl/sslfnc.html 1185 (!) validation markup errors Chapter 5: Certificate Functions http://www.mozilla.org/projects/security/pki/nss/ref/ssl/sslcrt.html no doctype declaration; 188 validation markup errors with strict DTD;; Chapter 6: Key Functions http://www.mozilla.org/projects/security/pki/nss/ref/ssl/sslkey.html no doctype declaration; 26 validation markup errors with strict DTD; Chapter 7: PKCS #11 Functions http://www.mozilla.org/projects/security/pki/nss/ref/ssl/pkfnc.html no doctype declaration; 116 validation markup errors with strict DTD; Chapter 8: NSS and SSL Error Codes http://www.mozilla.org/projects/security/pki/nss/ref/ssl/sslerr.html 11 validation markup errors; Using cmsutil http://www.mozilla.org/projects/security/pki/nss/tools/cmsutil.html no doctype declaration; 63 validation markup errors with strict DTD; NSS Security Tools: certutil Tasks http://www.mozilla.org/projects/security/pki/nss/tools/certutil-tasks.html no doctype declaration; 19 validation markup errors with strict DTD; Encryption Technologies Available in NSS 3.11 http://www.mozilla.org/projects/security/pki/nss/nss-3.11/nss-3.11-algorithms.html no doctype declaration; 321 validation markup errors with strict DTD; Content Version Numbers in the Certificate Database http://www.mozilla.org/projects/security/pki/nss/versioning.html 33 validation markup errors with strict DTD ...and many other webpages which will be encountered in the process of updating these webpages. ------------------ Example of a webpage upgrade I did recently: http://www.mozilla.org/hacking/portable-cpp.html Also, see several (if not, all) Rhino webpages (see bug 358668), Editor webpages (see bug 360039) and Minimo webpages (see bug 355468) for how the webpages look after the upgrade. If that's ok with you, please let me known in this bug report.
hello Gerard, I've added a few people, and would like to start the disscusion. First we recognize that we need to update our webpages and we welcome assistance! We have started a process of moving the information on www.mozilla.org/projects/security/pki/nss to http://developer.mozilla.org/en/docs/NSS. The goal then would be to update the wiki and remove the old info from www.mozilla.org/projects/security/pki/nss We are discussing how best to do the wiki.
Hello Glen, Thanks for getting back to me. If the process of moving the webpages and updating is already under way, in progress, then there is no real need, no point for this bug. I believe (am not sure), then, that you or someone should mention this migration+update movement in bug 345664 or elsewhere in another bug. Resolving as WORKSFORME If I'm wrong or something, then reopen this bug.
Status: NEW → RESOLVED
Closed: 18 years ago
Resolution: --- → WORKSFORME
(In reply to comment #3) > Gérard, > > It is still a good idea to fix the HTML errors in some of the > pages you listed: > http://www.mozilla.org/projects/security/pki/nss/ > http://www.mozilla.org/projects/security/pki/nss/intro.html > http://www.mozilla.org/projects/security/pki/nss/smime/ > http://www.mozilla.org/projects/security/pki/nss/nss-3.11/nss-3.11-algorithms.html > http://www.mozilla.org/projects/security/pki/nss/tools/certutil-tasks.html > http://www.mozilla.org/projects/security/pki/nss/versioning.html Ok, then. I will upgrade these 6 webpages. > > I'm using a Firefox extension called "TIDY Html Validator 0.7.9.5". Try instead version 0.8.3.5 http://users.skynet.be/mgueury/mozilla/index.html and once installed, set it to SMGL parser. It will report the same errors as the W3C markup validator. HTML Tidy (0.7.9.5) is not a true HTML validator: it fixes a lot of bad code though. > It says (with a green checkmark) that the following two pages have no errors: > http://www.mozilla.org/projects/security/pki/nss/ 6 errors with transitional DTD: http://validator.w3.org/check?uri=http://www.mozilla.org/projects/security/pki/nss/ 5 errors with strict DTD: http://validator.w3.org/check?uri=http%3A%2F%2Fwww.mozilla.org%2Fprojects%2Fsecurity%2Fpki%2Fnss%2F&charset=%28detect+automatically%29&doctype=HTML+4.01+Strict > http://www.mozilla.org/projects/security/pki/nss/nss-3.11/nss-3.11-algorithms.html > 322 errors with transitional DTD (because of invalid formal public identifier in the current doctype): http://validator.w3.org/check?uri=http://www.mozilla.org/projects/security/pki/nss/nss-3.11/nss-3.11-algorithms.html 321 errors with strict DTD: http://validator.w3.org/check?uri=http%3A%2F%2Fwww.mozilla.org%2Fprojects%2Fsecurity%2Fpki%2Fnss%2Fnss-3.11%2Fnss-3.11-algorithms.html&charset=%28detect+automatically%29&doctype=HTML+4.01+Strict > Do you know why? Marc Gueury explains the 2 versions and capabilities of his HTML validator. Best is to download and install 0.8.3.x and set it to serial mode. REOPENing to fix the 6 mentioned webpages.
Status: RESOLVED → REOPENED
Resolution: WORKSFORME → ---
Checking in mozilla-org/html/projects/security/pki/nss/index.html; /cvsroot/mozilla-org/html/projects/security/pki/nss/index.html,v <-- index.html new revision: 1.71; previous revision: 1.70 done
Checking in mozilla-org/html/projects/security/pki/nss/intro.html; /cvsroot/mozilla-org/html/projects/security/pki/nss/intro.html,v <-- intro.html new revision: 1.15; previous revision: 1.14 done Converted to HTML 4.01 strict; removed 61 validation markup errors; removed all (many!) named anchors created by DocBook (eg <A NAME="1030535"></a>); <tt> replaced accordingly by <code class="filename">; many intra-project navigation <link>s added; code indentation set a 72 by HTML Tidy (HandCoder 0.3.4 using latest available Tidy); many semantic improvements to markup code, etc.
Wan-Teh Chang and Glen, I will complete the upgrade of the remaining 4 webpages next week. I have to fix bug 360039 first. Until next week, I wish I could know from either of you if the removal of named anchors (eg <A NAME="1030535"></a>) most likely created by an edition software which abundantly populate the webpages is ok with you. I believe those are created by DocBook. When I use HTML Tidy, code indentation is set to 72. This brings 2 advantages. 1- consistent, predictable code layout; therefore easier to understand, to figure out 2- comparison of versions in diff-mode does not create horizontal scrollbar and necessary scrolling
(In reply to comment #8) > Until next week, I wish I could know from either of you if the removal > of named anchors (eg <A NAME="1030535"></a>) [...] is ok with you. In General, a blanket removal of those named anchors would NOT be ok. Ugly as they may be, there are many pages on the web that cite those anchors. We may wish to add new anchors that are more mnemonic and more plentiful, but we're stuck with the ones we have. I would like it if every section, every illustration (image file), every table, and (in some tables) every row of the table had its own mnemonic name anchor. But it is essential that, once established, those names be retained. An example of a page that has many such numeric names, and where MORE names are needed (one per each of its tables, and one per each row in each table) is http://www.mozilla.org/projects/security/pki/nss/ref/ssl/sslerr.html Example of per-row name http://www.mozilla.org/projects/security/pki/nss/ref/ssl/sslerr.html#1040292
A few comments. According to attachment 210867 [details] (coming from bug 151557), last year, there were precisely 1097 webpages from within the NSS project directory which had validation markup errors. 1097 webpages is a lot and approx. 12% of all invalid webpages on mozilla.org. Some of them have over 1000 validation markup errors. e.g.: http://www.mozilla.org/projects/security/pki/nss/fips/nss-source/mozilla/security/nss/lib/cryptohi/seckey.c.html has 2323 errors http://www.mozilla.org/projects/security/pki/nss/fips/nss-source/mozilla/security/nss/lib/cryptohi/secvfy.c.html has 1135 errors http://www.mozilla.org/projects/security/pki/nss/fips/nss-source/mozilla/security/nss/lib/dev/ckhelper.c.html has 1170 errors http://www.mozilla.org/projects/security/pki/nss/fips/nss-source/mozilla/security/nss/lib/dev/dev.h.html has 994 errors There is no way, not that I know of, which can convert those software-generated named anchors into meaningful, mnemonic ones, except by manual edition. Same thing with removing empty anchors (<a name="top"></a>) or lowercase-ing anchor. http://www.mozilla.org/contribute/writing/guidelines#linking states that anchors should be lower case and not empty. If all those 1097 webpages are going to stay within http://www.mozilla.org/projects/security/pki/nss/ on mozilla.org and not be migrated at Mozilla Developer Center (MDC), then I think everyone/anyone editing a NSS project webpage should be using HTML validator extension (version 0.8.3 or higher) from Marc Gueury (with Options/Algorithm set to SMGL Parser or Serial) and start improving the markup code when a webpage content needs to be updated. Even if all those webpages are migrated to MCD, then there would still be a lot of code upgrading and manual edition required.
In the document http://www.mozilla.org/projects/security/pki/nss/ there are still 3 links (reported by W3C link checker) which need updating: http://lasecwww.epfl.ch/memo_ssl.shtml What to do: The link is broken. Fix it NOW! Response status code: 404 Response message: Not Found Line: 211 http://www.uniras.gov.uk/vuls/2003/006489/tls.htm http://www.uniras.gov.uk/vuls/2003/006489/smime.htm What to do: This is a server side problem. Check the URI. Response status code: 500 Response message: Can't connect to www.uniras.gov.uk:80 (connect: Connection refused) Lines: 165 and 166 The link at line 432 http://www.mozilla.org/projects/security/pki/nss/ca-certificates/policy.html should now be redirected to http://www.mozilla.org/projects/security/certs/policy/
Checking in mozilla-org/html/projects/security/pki/nss/smime/index.html; /cvsroot/mozilla-org/html/projects/security/pki/nss/smime/index.html,v <-- index.html new revision: 1.7; previous revision: 1.6 done Checking in mozilla-org/html/projects/security/pki/nss/nss-3.11/nss-3.11-algorithms.html; /cvsroot/mozilla-org/html/projects/security/pki/nss/nss-3.11/nss-3.11-algorithms.html,v <-- nss-3.11-algorithms.html new revision: 1.6; previous revision: 1.5 done
Checking in mozilla-org/html/projects/security/pki/nss/tools/certutil-tasks.html; /cvsroot/mozilla-org/html/projects/security/pki/nss/tools/certutil-tasks.html,v <-- certutil-tasks.html new revision: 1.3; previous revision: 1.2 done Checking in mozilla-org/html/projects/security/pki/nss/versioning.html; /cvsroot/mozilla-org/html/projects/security/pki/nss/versioning.html,v <-- versioning.html new revision: 1.3; previous revision: 1.2 done
Checking in mozilla-org/html/projects/security/pki/nss/fips/nss-source/mozilla/security/nss/lib/cryptohi/seckey.c.html; /cvsroot/mozilla-org/html/projects/security/pki/nss/fips/nss-source/mozilla/security/nss/lib/cryptohi/seckey.c.html,v <-- seckey.c.html new revision: 1.3; previous revision: 1.2 done 2323 (!) validation markup errors fixed in this 4950 lines long of code in a 407 KB webpage. Please always validate the webpage you're working on before submitting/uploading it back on mozilla.org so that basic markup errors are eradicated. Cheers :)
Checking in mozilla-org/html/projects/security/pki/nss/fips/nss-source/mozilla/security/nss/lib/dev/ckhelper.c.html; /cvsroot/mozilla-org/html/projects/security/pki/nss/fips/nss-source/mozilla/security/nss/lib/dev/ckhelper.c.html,v <-- ckhelper.c.html new revision: 1.3; previous revision: 1.2 done Removed 1170 (!) validation markup errors.
> in a 407 KB webpage. err.; 40.7 KB webpage
Gérard, don't fix anything in mozilla-org/html/projects/security/pki/nss/fips/nss-source . Those pages are generated by a tool.
The new http://www.mozilla.org/projects/security/pki/nss/nss-3.11/nss-3.11-algorithms.html page looks different from before. The original big table was broken down to multiple small tables, but the small tables' widths are not all the same, and some of them have their table headings repeated at the bottom or in the middle. Could you restore the original one table format? Thanks.
> Gérard, don't fix anything in > mozilla-org/html/projects/security/pki/nss/fips/nss-source . > Those pages are generated by a tool. Wan-Teh Chang, I did not know that. It's an important information that, I believe, should be inserted into the document itself, say, at the beginning of the document. What is utterly important is that such tool starts from now on to output valid markup code and, in particular, without nested links. > The original big table was broken > down to multiple small tables, I did that: each set of tabular data should have its own column headers correct, printing a single table can be done, tabular info is logically grouped within a single and specific table, etc The same info as before is still available: it's presented differently though. > but the small tables' widths are not > all the same, I can arrange the tables' width to use 100% of the available width of their container. No problem: that's just 1 line of code in the locally embedded stylesheet. But why would you want to force/constrain tables to be a width that they don't need require by themselves? By design and by default, the best width for a table is the width that it needs. > and some of them have their table headings repeated > at the bottom or in the middle. That's an usability feature. When a table is long, you can repeat the table header with <tfoot> (appended at the bottom of the table) and when a table is very long, you can repeat it in the middle so that the viewer/visitor/reader does not have to scroll up and down to see/recall again what is/are the column header(s) for each cell. > Could you restore the original one table format? I can restore the original table format. Are you sure/can you confirm you still want me to do this?
Wan-Teh Chang, I removed 1 unneeded mid-table <tr> and 1 unneeded <tfoot> from http://www.mozilla.org/projects/security/pki/nss/nss-3.11/nss-3.11-algorithms.html
Gérard: I forgot to answer your questions in comment 19. Sorry. It would be nice to make all the tables equally wide. I suspected that the repeated table column headers are to improve usability. Thank you for the explanation. But I've never seen them used this way before. I wonder if it is a feature of the French or European locale. It is fine to leave them there, unless other people are also confused by them. Thanks.
All the tables are now equally wide.
Gérard: Very nice. Thanks!
Product: mozilla.org → Websites
Closing old Mozilla.org website bugs due to them not being relevant to the new Python-based Bedrock system. Re-open if this is a critical bug and should be resolved on the new system too.
Status: REOPENED → RESOLVED
Closed: 18 years ago → 13 years ago
Resolution: --- → WONTFIX
I'm guessing this is still in-progress, since there were no comments that it's complete. (Except now, HTML5 is probably the requirement.)
Status: RESOLVED → REOPENED
Resolution: WONTFIX → ---
Yeah, making sure all of the HTML on mozilla.org meets our guidelines is probably a never ending task. Like I mentioned in other bugs, the security content will need to find a new home. My team is focused on efforts that support B2G and mobile.
Component: www.mozilla.org → General
Product: Websites → www.mozilla.org
This page has been migrated to MDN. Redirect will be set up By 874525.
Status: REOPENED → RESOLVED
Closed: 13 years ago → 12 years ago
Resolution: --- → WONTFIX
You need to log in before you can comment on or make changes to this bug.