Dist::Zilla::Plugin::InsertDistImage - Insert images contained in distribution into POD as HTML snippets
This document describes version 0.005 of Dist::Zilla::Plugin::InsertDistImage (from Perl distribution Dist-Zilla-Plugin-InsertDistImage), released on 2017-06-09.
In share/images, put some images e.g. img1.jpg and img2.png.
In dist.ini:
[InsertDistImage] ;hosting=metacpan ;include_files=... ;exclude_files=... ;include_file_pattern=... ;exclude_file_pattern=...
In lib/Foo.pm or bin/bar:
... # IMAGE: share/images/img1.jpg # IMAGE: share/images/img2.png ...
After build, lib/Foo.pm will contain:
... =begin html <img src="https://st.aticpan.org/source/CPANID/Your-Dist-Name-0.123/share/images/img1.jpg" /> =end html =begin html <img src="https://st.aticpan.org/source/CPANID/Your-Dist-Name-0.123/share/images/img2.png" /> =end html
This plugin finds # IMAGE directive in your POD/code and replace it with a POD containing HTML snippet to load the images, using the selected hosting provider's URL scheme.
# IMAGE
Rationale: sometimes documentation needs some images. Sometimes the proper (not to mention convenient) place to put the images is within the distribution itself. And you want to be able to view the images when you browse the POD in HTML form.
The #IMAGE directive must occur at the beginning of line and must be followed by path to the image (relative to the distribution's root). It is recommended to put the images in share/images.
#IMAGE
You can put alternate locations by using |, e.g.:
|
# IMAGE: location1.jpg|location2.jpg
This can be useful if you are using hosting=data (where this plugin needs to read the content of the file) and location1.jpg is produced by another plugin and might not be ready or added to the build at the time this plugin runs (but location2.jpg is the temporary version of the file that already exists).
location1.jpg
location2.jpg
Shared image files deployed inside a tarball (such as one created using Dist::Zilla::Plugin::ShareDir::Tarball) are not yet supported.
Choose hosting provider. Available choices:
metacpan
This is the default because all distributions uploaded to PAUSE/CPAN will normally show up on metacpan.org. Note that some people advise not to abuse metacpan.org to host images because metacpan.org is not an image hosting service. However, at the time of this writing, I couldn't find any mention of this in the metacpan.org FAQ or About pages.
github
This can only be used if the distribution specifies its repository in its metadata, and the repository URL's host is github.com.
gitlab
This can only be used if the distribution specifies its repository in its metadata, and the repository URL's host is gitlab.com.
bitbucket
This can only be used if the distribution specifies its repository in its metadata, and the repository URL's host is bitbucket.org.
data
Instead of using a remote http/https hosting provider, this will instead use data: URIs where the image data is directly embedded in the URL.
data:
Please visit the project's homepage at https://metacpan.org/release/Dist-Zilla-Plugin-InsertDistImage.
Source repository is at https://github.com/perlancar/perl-Dist-Zilla-Plugin-InsertDistImage.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Dist-Zilla-Plugin-InsertDistImage
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2017, 2016 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Dist::Zilla::Plugin::InsertDistImage, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Dist::Zilla::Plugin::InsertDistImage
CPAN shell
perl -MCPAN -e shell install Dist::Zilla::Plugin::InsertDistImage
For more information on module installation, please visit the detailed CPAN module installation guide.