Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Better default fonts in ScalaDoc #4499

Closed
scabug opened this issue Apr 20, 2011 · 4 comments
Closed

Better default fonts in ScalaDoc #4499

scabug opened this issue Apr 20, 2011 · 4 comments

Comments

@scabug
Copy link

@scabug scabug commented Apr 20, 2011

=== problem ===
ScalaDoc currently specifies "Arial".

=== analysis ===
Arial is not really engineered for technical documentation.
Additionally, not everyone has it.
To summarize, this is not good.

=== enhancement recommendation ===
After testing I came to the conclusion that something along the lines of "Ubuntu", "Droid Sans", "Trebuchet MS", "Lucida Grande", "Lucida Sans", "DejaVu Sans Condensed", sans-serif; would enable good quality font use on major platforms (Ubuntu/Linux/Android/Apple/Windows).

Ubuntu: Best differentiation between l/1/I and O/0 etc. Standard on Ubuntu, popular on Linux.

Droid Sans: Stable properties with wide range of supported glyphs. Standard on Android, popular on Linux.

Trebuchet MS: Stable font available on all Windows platforms, popular on Linux (with MS core fonts).

Lucida Grande: Available on all Apple machines.

Lucida Sans: Available on Windows, shipped with Sun Java.

DejaVu Sans Condensed: Available on Linux. Wide range of supported glyphs.

The chosen fonts have all the same glyph height and shouldn't cause any major differences (except the occasional different linebreak in texts).

The monospace font should be left undefined as currently.

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Apr 20, 2011

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented May 21, 2011

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Aug 2, 2011

@heathermiller said:
During the Scaladoc redesign, I made a design decision to go with Arial- which I still stand by for aesthetic reasons.
Actually, a lot of technical documentation lives in Arial.

In case a user doesn't have Arial installed, the font-family ordering "Arial, sans-serif;" ensures that the sans-serif browser/system default sans-serif font is used in Arial's place (after checking for Arial)- so in the case of a user running Ubuntu, that might be the Ubuntu font.

That browser/system default sans-serif font is also user-configurable. If unhappy with that font, a user can decide to change it.

Finally, high-traffic, professional websites like cnn.com and heise.de use Arial and have as alternatives Helvetica and "sans-serif". Having more than one or two alternative fonts is generally not necessary.

(On an aside: the github pull request revealed that "sans-serif;" was missing in index.css, so that has been adjusted accordingly.)

@scabug

This comment has been minimized.

Copy link
Author

@scabug scabug commented Aug 2, 2011

Commit Message Bot (anonymous) said:
(heathermiller in r25434) Minor changes to the Scaladoc stylesheets, as suggested by Simon Ochsenreither. Closes #4499. No review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
1 participant
You can’t perform that action at this time.