197776 - Add "quirks" to Help

Status: RESOLVED WONTFIX

(Documentation Graveyard :: Help Viewer, defect)

Description

[Ralf Hauser]

User-Agent:       Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.4a) Gecko/20030304
Build Identifier: Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.4a) Gecko/20030304

Quirks appears to be an important concept why certain pages are rendered the way
they are. Unfortunately, there is no reference to it in the browser's help function.

Reproducible: Always

Steps to Reproduce:
1.
2.
3.



Also, it appears to be assumed that everybody knows what "quirks" is
http://bugzilla.mozilla.org/show_bug.cgi?id=197357

Other bugs apparently targeted to make the quirks concept more clear to end users
http://bugzilla.mozilla.org/show_bug.cgi?id=118147

Comment 1

[Boris Zbarsky [:bzbarsky]]

Just as a note, I doubt any end users would care.  People who do care are
perfectly capable of searching the Mozilla website or even the web and easily
finding the info they want.

Comment 2

[Daniel Wang]

-> doc:user

suggest wontfix

Comment 3

[Nilson Cain]

Oh, whe=at the heck?  I could add a small little page about it, for the web devs
that don't feel like searching ;)

Comment 4

[Nilson Cain]

Attachment: First attempt

I don't know how factually correct it is, or if it goes into enough detail, but
it's something to start with.

Comment 5

[R.J. Keller]

Nilson, these need to go into a CURRENT help menu HTML. not it's own.

Comment 6

[Nilson Cain]

So it need to be placeed into an exisating file?

Comment 7

[R.J. Keller]

yeah. I would browse through all of the HTML files in the locale directory and
get a feel for what should go under what.

It'd be like what you did to MozDev Bug 4573, except it'd be new content.

Comment 8

[Daniel Wang]

chrome://help/locale/page_info_help.html#pageinfo_general already explains quirk
mode. The extra info should probably go to Help glossary:
chrome://help/locale/glossary.html

-> Nilson

Comment 9

[Nilson Cain]

Attachment: patch1 - glossary.html

Added quirks to glossary.html

Comment 10

[Daniel Wang]

Comment on attachment 132326 [details] [diff] [review]
patch1 - glossary.html

The text referes to "Gecko" which cannot be found in either the Glossary or
Search.

Also, please break text into lines of ~70 chars

we shouldn't talke about html/xhtml/xml . The Help file is for users who don't
need to know this, not for web developers. I prefer the Help text for Page
Info.

oh, make sure you link to page_info_help.html#pageinfo_general (e.g. "You can
find the rendering mode of a page in the _Page Info_ dialog").