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.

Sign up for GitHub

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

alt option for image() #559

Merged
merged 6 commits into from
Apr 13, 2021
Merged

alt option for image() #559

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6c8c24d
alt option for image()
Alex-Jordan Apr 6, 2021
688f63a
use encode_pg_and_html and drop ternary operator
Alex-Jordan Apr 6, 2021
f897f52
update image() POD and code commentary
Alex-Jordan Apr 7, 2021
1bad7b3
let image() have array ref for alt, and return a joined string in str…
Alex-Jordan Apr 8, 2021
6a58442
Improve the generated POD output from PGbasicmacros.pl.
drgrice1 Apr 10, 2021
6082581
Merge pull request #2 from drgrice1/image-pod-improve
Alex-Jordan Apr 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 31 additions & 11 deletions macros/PGbasicmacros.pl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2905,15 +2905,20 @@ sub row {
$out;
}

=head2 Macros for displaying static images
=head2 Macros for displaying images

Usage:
$string = image($image, width => 100, height => 100, tex_size => 800)
$string = image($image, width => 100, height => 100, extra_html_tags => 'align="middle"', tex_size => 800)
$string = image([$image1, $image2], width => 100, height => 100, tex_size => 800)
Alex-Jordan marked this conversation as resolved.
Show resolved Hide resolved
$string = caption($string);
$string = imageRow([$image1, $image2 ], [$caption1, $caption2]);
# produces a complete table with rows of pictures.
Usage:

image($image, width => 100, height => 100, tex_size => 800, alt => 'alt text', extra_html_tags => 'style="border:solid black 1pt"');

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 C<' '> in scalar context

=cut

Expand All @@ -2929,6 +2934,8 @@ sub image {
width => 100,
height => '',
tex_size => 800,
# default value for alt is undef, since an empty string is the explicit indicator of a decorative image
alt => undef,
extra_html_tags => '',
);
# handle options
Expand All @@ -2944,8 +2951,10 @@ sub image {
my $width = $out_options{width};
my $height = $out_options{height};
my $tex_size = $out_options{tex_size};
my $alt = $out_options{alt};
my $width_ratio = $tex_size*(.001);
my @image_list = ();
my @alt_list = ();

# if height was explicitly given, create string for height attribute to be used in HTML, LaTeX2HTML
# otherwise omit a height attribute and allow the browser to use aspect ratio preservation
Expand All @@ -2957,6 +2966,11 @@ sub image {
} else {
push(@image_list, $image_ref);
}
if (ref($alt) =~ /ARRAY/ ) {
@alt_list = @{$alt};
} else {
for my $i (@image_list) {push(@alt_list, $alt)};
}

my @output_list = ();
while(@image_list) {
Expand Down Expand Up @@ -2994,16 +3008,22 @@ sub image {
|| $displayMode eq 'HTML_asciimath'
|| $displayMode eq 'HTML_LaTeXMathML'
|| $displayMode eq 'HTML_img') {
$out = qq!<IMG SRC="$imageURL" class="image-view-elt" tabindex="0" role="button" WIDTH="$width" $height_attrib $out_options{extra_html_tags}>!
my $altattrib = '';
if (defined $alt_list[0]) {$altattrib = 'alt="' . encode_pg_and_html(shift @alt_list) . '"'};
$out = qq!<IMG SRC="$imageURL" class="image-view-elt" tabindex="0" role="button" WIDTH="$width" $height_attrib $out_options{extra_html_tags} $altattrib>!
drgrice1 marked this conversation as resolved.
Show resolved Hide resolved
} elsif ($displayMode eq 'PTX') {
my $ptxwidth = 100*$width/600;
$out = qq!<image width="$ptxwidth%" source="$imageURL" />!
if (defined $alt) {
$out = qq!<image width="$ptxwidth%" source="$imageURL"><description>$alt</description></image>!
} else {
$out = qq!<image width="$ptxwidth%" source="$imageURL" />!
}
} else {
$out = "Error: PGbasicmacros: image: Unknown displayMode: $displayMode.\n";
}
push(@output_list, $out);
}
return wantarray ? @output_list : $output_list[0];
return wantarray ? @output_list : join(' ',@output_list);
}

#This is bare bones code for embedding svg
Expand Down