Skip to content

Commit

Permalink
Improve the generated POD output from PGbasicmacros.pl.
Browse files Browse the repository at this point in the history
Note:  Don't use comments in POD.  POD is not Perl code.
  • Loading branch information
drgrice1 committed Apr 10, 2021
1 parent 1bad7b3 commit 6a58442
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions macros/PGbasicmacros.pl
Original file line number Diff line number Diff line change
Expand Up @@ -2907,13 +2907,18 @@ sub row {

=head2 Macros for displaying images

Usage:
Usage:

image($image, width => 100, height => 100, tex_size => 800, alt => 'alt text', extra_html_tags => 'style="border:solid black 1pt"');
# where $image can be a local file path or URL
# width and height are pixel counts for HTML display, while tex_size is per 1000 applied to linewidth (for example 800 leads to 0.8\linewidth)

where C<$image> can be a local file path or URL, C<width> and C<height> are
pixel counts for HTML display, while C<tex_size> is per 1000 applied to
linewidth (for example 800 leads to 0.8\linewidth)

image([$image1,$image2], width => 100, height => 100, tex_size => 800, alt => ['alt text 1','alt text 2'], extra_html_tags => 'style="border:solid black 1pt"');
image([$image1,$image2], width => 100, height => 100, tex_size => 800, alt => 'common alt text', extra_html_tags => 'style="border:solid black 1pt"');
# this produces an array in array context and joins the elements with ' ' in scalar context

this produces an array in array context and joins the elements with C<' '> in scalar context

=cut

Expand Down

0 comments on commit 6a58442

Please sign in to comment.