Images in Haddock documentation: best practices?

Hi all, Although it doesn't seem to be documented in the user manual (!), Haddock supports inline images, using a <<url>> syntax. I'd like to include some images in the documentation for a package I'm writing, but not sure of the best way. I can, of course, just make the images available under my UPenn personal web space, and link to them from the documentation. But this seems fragile and ad-hoc. Ideally, I'd like to bundle the images along with the cabal package, and reference them locally from within the documentation. But I haven't figured out a way to do this. Any ideas? Has anyone ever included images in Haddock docs before? Is it possible to bundle them with the package and refer to them locally? Or does anyone have any other suggestions? Are there specific ways Haddock and/or cabal could be improved to make this easier? -Brent

On Sun, Dec 25, 2011 at 12:04 AM, Brent Yorgey
Hi all,
Although it doesn't seem to be documented in the user manual (!), Haddock supports inline images, using a <<url>> syntax. I'd like to include some images in the documentation for a package I'm writing, but not sure of the best way.
In case nothing else works out: http://en.wikipedia.org/wiki/Data_URI_scheme They do not work in IE 7, and in IE 9 they are limited to 32k. They also are not cached separately from the containing page. Antoine

On Sun, Dec 25, 2011 at 01:02:57AM -0500, Antoine Latter wrote:
On Sun, Dec 25, 2011 at 12:04 AM, Brent Yorgey
wrote: Hi all,
Although it doesn't seem to be documented in the user manual (!), Haddock supports inline images, using a <<url>> syntax. I'd like to include some images in the documentation for a package I'm writing, but not sure of the best way.
In case nothing else works out:
http://en.wikipedia.org/wiki/Data_URI_scheme
They do not work in IE 7, and in IE 9 they are limited to 32k.
Just a small correction, the page on wikipedia says that *IE 8* is limited to 32k, and that *IE 9* doesn't have that limitation. /M -- Magnus Therning OpenPGP: 0xAB4DFBA4 email: magnus@therning.org jabber: magnus@therning.org twitter: magthe http://therning.org/magnus Perl is another example of filling a tiny, short-term need, and then being a real problem in the longer term. -- Alan Kay
participants (3)
-
Antoine Latter
-
Brent Yorgey
-
Magnus Therning