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

VERIFIED FIXED

Status

SeaMonkey
Help Documentation
VERIFIED FIXED
14 years ago
13 years ago

People

(Reporter: R.J. Keller, Assigned: R.J. Keller)

Tracking

Trunk
x86
Windows 2000

Firefox Tracking Flags

(Not tracked)

Details

Attachments

(1 attachment, 6 obsolete attachments)

(Assignee)

Description

14 years ago
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.
(Assignee)

Comment 1

14 years ago
Created attachment 142483 [details] [diff] [review]
Patch - CSS only
(Assignee)

Comment 2

14 years ago
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.
Attachment #142483 - Attachment description: Patch → Patch - CSS only
Attachment #142483 - Flags: review?(neil.parkwaycc.co.uk)
(Assignee)

Comment 3

14 years ago
Created attachment 142492 [details] [diff] [review]
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).
Attachment #142483 - Attachment is obsolete: true
(Assignee)

Updated

14 years ago
Attachment #142483 - Flags: review?(neil.parkwaycc.co.uk)
(Assignee)

Updated

14 years ago
Attachment #142492 - Flags: review?(neil.parkwaycc.co.uk)

Comment 4

14 years ago
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.
(Assignee)

Comment 5

14 years ago
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.
Status: NEW → ASSIGNED

Comment 6

14 years ago
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; }
(Assignee)

Updated

14 years ago
Attachment #142492 - Flags: review?(neil.parkwaycc.co.uk)
(Assignee)

Comment 7

14 years ago
Created attachment 142647 [details] [diff] [review]
Patch - uses classes instead of actual tags.
Attachment #142492 - Attachment is obsolete: true
(Assignee)

Updated

14 years ago
Attachment #142647 - Flags: review?(neil.parkwaycc.co.uk)

Comment 8

14 years ago
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

14 years ago
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

14 years ago
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; }
Attachment #142647 - Flags: review?(neil.parkwaycc.co.uk) → review-
(Assignee)

Comment 11

14 years ago
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

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

Comment 13

14 years ago
Created attachment 142711 [details] [diff] [review]
Patch with neil's comments.
Attachment #142647 - Attachment is obsolete: true
(Assignee)

Comment 14

14 years ago
Created attachment 142956 [details] [diff] [review]
Patch v2

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

Updated

14 years ago
Attachment #142711 - Attachment is obsolete: true
(Assignee)

Updated

14 years ago
Attachment #142956 - Flags: review?(neil.parkwaycc.co.uk)
(Assignee)

Comment 15

14 years ago
Created attachment 143143 [details] [diff] [review]
patch v2.1
Attachment #142956 - Attachment is obsolete: true
(Assignee)

Comment 16

14 years ago
Created attachment 143145 [details] [diff] [review]
patch v2.2
Attachment #143143 - Attachment is obsolete: true
(Assignee)

Updated

14 years ago
Attachment #143145 - Flags: review?(neil.parkwaycc.co.uk)

Updated

14 years ago
Attachment #143145 - Flags: review?(neil.parkwaycc.co.uk) → review+
(Assignee)

Updated

14 years ago
Attachment #142956 - Flags: review?(neil.parkwaycc.co.uk)
(Assignee)

Comment 17

14 years ago
Fix checked in.
Status: ASSIGNED → RESOLVED
Last Resolved: 14 years ago
Resolution: --- → FIXED
Summary: Add <win>, <mac>, <pc>, and <unix> tags to show platform-specific help content → Add .win, .mac, .pc and .unix classes to show platform-specific help content

Updated

14 years ago
Status: RESOLVED → VERIFIED
Product: Browser → Seamonkey
You need to log in before you can comment on or make changes to this bug.