Comments (20)
One of the considerations made when choosing the font for the datasheets was printing, the legibility when printed on paper was a significant factor in the choice
Assuming that the fonts/colors used are the same in the "getting started with micropython ..." book that HAS been printed, there are similar complaints there:
https://www.eevblog.com/forum/microcontrollers/raspberry-pi-pico/msg3444954/#msg3444954
The book is written for an absolute beginner with exceptional eyesight. Damn the font is small! These people have no respect for old people!
from pico-feedback.
After some internal discussion we're going to be updating the fonts as you can see below when the next PDF documentation release happens, probably at the end of next week. Reflowable ePub versions of the documentation will be released at the same time.
from pico-feedback.
Is it also possible that the font color is set to something other than "black"?
Yes. It is 80% dark gray. Figures seem to use 89% dark gray. This could be the core issue (though the font is also spindly and small).
from pico-feedback.
I have to agree -- as someone who spends a lot of time looking through TRMs, UMs, and Datasheets in PDF, the RP2040 stands out as unusually high quality content and the absolute worst readability of any I've dealt with (even full screen on a 30" display). Please consider 100% black for text (reducing contrast hurts) and a heavier font. The thin vertical stems really do impact readability.
from pico-feedback.
The toolchain also generates reflowable ePub, although it's still a little buggy in places, and we're thinking about releasing that. Would that resolve your issues?
from pico-feedback.
Printed the shorter docs on my colour laser (Xerox VersaLink C400) - looks good but font rather slender for a 600dpi entry level printer. Printed the C SDK docs on my black & white laser (Brother HL-5250DN) - font is somewhat pixelated and the typeface where it is in colour is even worse. Having the grey box behind is wasted toner - it doesn't help readability.
For visual access reasons alone for those with old eye balls or ones that aren't working as well, a 'fatter' font would be appropriate.
from pico-feedback.
Maybe we should use Comic Sans 🤣
from pico-feedback.
One of the considerations made when choosing the font for the datasheets was printing, the legibility when printed on paper was a significant factor in the choice, as it's possible that the books may be made available in print at some point in the future.
If you're having problems reading the text on screen, using your PDF viewer's zoom function might be an option?
from pico-feedback.
Unfortunately this is precisely what PDF, DVI etc are designed to be bad at - they were meant to keep exact layout and font choices. Zooming, particularly with as dense a document as this, easily leads to being unable to see the whole column, let alone page. I wound up rotating my monitor 90 degrees to be able to view a whole page large enough to read comfortably. Perhaps you could consider also publishing a more reformatting friendly format, such as ePub, HTML or ODT?
Getting old is a normal thing, and enabling a broader audience is good, particularly when the difficulty is unrelated to the subject matter and a solution can be provided as an additional option.
As a workaround, Calibre can convert documents between a variety of formats, and has a rudimentary viewer too. Sadly, it does a poor job with some formatting in the RP2040 datasheet, e.g. losing all the figures and tables. Most reflowing PDF viewers do similarly.
Calibre is also good for keeping track of hundreds of reference manuals.
from pico-feedback.
I'll take the thumbs up as a yes. Okay, good to know. I'll generate an internal Jira for myself to look at this sometime this week. Thanks for the feedback!
from pico-feedback.
Possibly a bit quick to close, as I'm not the submitter, nor have either of us had a chance to try the ePub version. But I think it's worth a try.
PS: Another reflow tool that did better with the figures is k2pdfopt. It misplaced some stray words and turned the whole document into bitmap form, though.
from pico-feedback.
Oops! Sorry, I'm triaging a bunch of feedback, didn't spot you weren't the OP. Reopened! 😄
from pico-feedback.
WRT "reflow tools", note that the PDFs' licence doesn't allow redistribution of modified versions.
from pico-feedback.
I'm comparing the RP2040 datasheet to many other data sheets that I've read, from many vendors, and it has the worst legibility.
Zooming in obviously helps, but it seems to help less than I expect.
Is it also possible that the font color is set to something other than "black"? I thought I had zoomed in enough to eliminate that as a possibility, but perhaps not. Here's a "way zoomed in" (~1inch line spacing on my 4k 29inch monitor) comparison with a Microchip datasheet...
from pico-feedback.
Incidentally, I found that the reader I prefer on my Kobo eink tablet, koreader, supports not only reflow but even contrast adjustment and cropping, both of which help read this document. Koreader is available for many platforms but its UI may be awkward, as it's designed for e-readers. http://koreader.rocks/
from pico-feedback.
I agree that the (PDF) documents are too difficult to read. On screen and when printed. It does appear that the font strokes are too thin. I suggest a change of font is required.
from pico-feedback.
Due to the way the PDFs are generated there are some formatting issues that we're keeping track of internally. We're also going to explore some options around fonts. I'm hoping to release some reflowable ePub versions of the documentation either this week or next, which might be useful for folks. We're absolutely going to look at this, but right now we're still very close of launch and there is a lot of feedback around content to get through. Due to toolchain issues just switching out the font isn't necessarily a simple matter.
from pico-feedback.
Due to toolchain issues just switching out the font isn't necessarily a simple matter.
Huh - what witch craft is this?
As suggested on the forum, change control like Word would be useful - or strike throughs - so we can see what's changed - with searchable text like "Here be changes". Only until things settle down.
from pico-feedback.
Updated PDFs are now available on the Getting Started pages.
from pico-feedback.
Thanks! The new docs are significantly more readable.
from pico-feedback.
Related Issues (20)
- OpenOCD install error on Ubuntu 22.04 HOT 2
- PLL Post-Divider Enable Behavior HOT 1
- Add some documentation on pico-sdk memory usage HOT 2
- [Pi 5]: Does SDK Tool chain also work on Pi 5 HOT 2
- Sleep mode current consumption fluctuating
- Synchronizing two state machines with one Clock Signal in Raspberry Pi Pico PIO HOT 8
- Incomplete and mis-formatted OpenOCD compilation documentation leads to broken build HOT 1
- Documentation for setting up VS Code should be more clear about changes necessary for using the Pi Pico debug adapter HOT 1
- Documentation for Pi Pico Debug Probe is out of date after name change HOT 1
- [QUESTION] For datasheet documentation typos, how to submit a correction? HOT 10
- [RESOLVED] USB Host raises TRANS_COMPLETE when it shouldn't HOT 9
- [QUESTION] How to deal with RP2040-E4 HOT 2
- [TYPO] Datasheet: USB Host description HOT 3
- [TYPO] Datasheet: USB buffer control register HOT 1
- [TYPO] Datasheet: USB buffer control register
- USB device erratum for aborted control transfers? HOT 5
- [TYPO] Datasheet: USB device controller IN behavior
- [DOCUMENTATION] No information on how to use RESET_BUS in USB Host mode HOT 7
- Error in wget command in "Getting started with Raspberry Pi Pico" HOT 4
- Documentation needs update on DDEBUG_ON_PICO=ON HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pico-feedback.