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

Include an image of the font glyphs in the documentation #76

Open
Pharap opened this issue Aug 12, 2023 · 3 comments
Open

Include an image of the font glyphs in the documentation #76

Pharap opened this issue Aug 12, 2023 · 3 comments

Comments

@Pharap
Copy link
Contributor

Pharap commented Aug 12, 2023

It would be handy to have an image that showed all the glyphs of the font in the documentation, so people can gauge what the font looks like and whether it suits their purposes without having to write some code and upload it.

@Pharap Pharap changed the title Include an image of the font glyphs in the documentation. Include an image of the font glyphs in the documentation Aug 12, 2023
@MLXXXp
Copy link
Owner

MLXXXp commented Aug 12, 2023

If someone wants to provide the image, I could look into including it somewhere.

Since I release both HTML and PDF versions, it appears that two images would be required; one for each version. E.g. PNG for HTML and EPS for PDF.

https://stackoverflow.com/questions/30863422/doxygen-how-to-embed-images-on-main-page-for-all-output-formats

It's possible that the PDF compatible one could be created using the HTML compatible image as the source for a conversion utility.

EDIT: Only one image file may be sufficient, as some image formats are compatible with both outputs.

https://www.doxygen.nl/manual/commands.html#cmdimage

@Pharap
Copy link
Contributor Author

Pharap commented Aug 12, 2023

I don't mind doing it if I get a few minutes to sit down and wade through the data, but I'm not sure when that might be.

I wasn't sure if I would be able to produce an EPS, but I checked and fortunately GIMP does support EPS as an export format.

Though Adobe's Acrobat documentation seems to suggest that PDFs do in fact support PNG, among other image formats. (The other formats being JPEG, BMP, GIF, and TIFF.)

@MLXXXp
Copy link
Owner

MLXXXp commented Aug 12, 2023

I think something like the images in section Codepage & Co. on aspell.net, with the actual dot matrix glyphs, would be good. Colouring the boxes around the two special characters (0x0A, 0X0D) red, or highlighting them in some other way, would be useful.

I suggest that the image be added to the documentation for Arduboy2::font5x7. It could also be put in a new a page in the Related Pages section.

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

No branches or pull requests

2 participants