235887 - Add .win, .mac, .pc and .unix classes to show platform-specific help content

Status: VERIFIED FIXED

(SeaMonkey :: Help Documentation, defect)

Description

[R.J. Keller]

The problem with help now is that when we have lines that say:
"To do x, click on File (Mozilla menu on MacOS) and select y", it shows
information on both platforms. We should say:
"To do x, click on <pc>File</pc><mac>Mozilla menu</mac> and select y", where pc
would be displayed on Windows/Unix, and mac would be displayed on Mac. We would
also have <unix> and <win> in case we're dealing with Keyboard Shortcuts.

It'd be much easier to the user and reduce the amount of reading needed.

Comment 1

[R.J. Keller]

Attachment: Patch - CSS only

Comment 2

[R.J. Keller]

Comment on attachment 142483 [details] [diff] [review]
Patch - CSS only

Neil can you review this? This is only the CSS part. The help docs update will
come later.

Comment 3

[R.J. Keller]

Attachment: Patch - CSS only - uses display instead of visibility

Uses display: none; instead of visibility: hidden;, and implements attributes
(meaning, you can have <mac display="false"> to hide content for Mac users).

Comment 4

[Daniel Wang]

User documentation serve average users as well as advanced users. If you are a
tech support, it is useful to be able to see differences between platforms. I
don't see how occassional (for platform XXX do YYY) is any clutter.

Comment 5

[R.J. Keller]

yeah, but some areas of help it gets a bit crazy. Not only that, Mac users have
the frustration that there are a lot of times where the mac way isn't shown or
maybe don't see it right away. My biggest issue with this is keyboard shortcuts
in Help files. There are a lot of cases where they are totally different
depending on the OS.

Comment 6

[[e-mail]]

Comment on attachment 142492 [details] [diff] [review]
Patch - CSS only - uses display instead of visibility

If you put this in the xhtml it won't validate.
Perhaps you could use classes e.g.
.not.win, .mac, .unix { display: none; }

Comment 7

[R.J. Keller]

Attachment: Patch - uses classes instead of actual tags.

Comment 8

[[e-mail]]

BDS, please could you give me a quick rundown of the pros and cons of using the
preprocessor vs. using separate platform-specific CSS files?

Comment 9

[Benjamin Smedberg]

If CSS works for this platform-specific stuff, let's use it. In general, we
should only be using the preprocessor when we need global variable substitutions
or need to apply platform-specific overlays.

Comment 10

[[e-mail]]

Comment on attachment 142647 [details] [diff] [review]
Patch - uses classes instead of actual tags.

>+mac, win, unix { display: none; }
I think you missed the dots off here, but I don't see the point of mucking
about with multiple styles, use e.g. .notMac, .win, .unix { display: none; }

Comment 11

[R.J. Keller]

Neil: The reason is because what if we wanted to display something for Linux,
Windows, etc. but not for MacOS? This seems to be the only way. We could do a
.pc, but I think there are some cases where this happens for linux instead of
MacOS, so it would be useful.

Comment 12

[[e-mail]]

No, I meant just put separate versions of all the rules inside #if blocks, don't
try to combine rules between platforms.

Comment 13

[R.J. Keller]

Attachment: Patch with neil's comments.

Comment 14

[R.J. Keller]

Attachment: Patch v2

This is a patch incorporating some feedback I got on IRC.

Comment 15

[R.J. Keller]

Attachment: patch v2.1

Comment 16

[R.J. Keller]

Attachment: patch v2.2

Comment 17

[R.J. Keller]

Fix checked in.