Skip to content

Commit

Permalink
Add Index Cross-referencing HTML links (#1275)
Browse files Browse the repository at this point in the history 
Algorithm searches for "See..." references in the index and
attempts to link them to the relevant index entry. Where it is
unable to find a link due to differences in wording, etc., it
displays a list of errors which can be clicked in order to be
resolved manually.

The Error List has been implemented as a general feature that
other operations could easily use.

Fixes #1264
  • Loading branch information
@windymilla
windymilla authored Nov 19, 2023
1 parent 19fcf49 commit a0ff105
Show file tree
Hide file tree
Showing 2 changed files with 191 additions and 30 deletions.
51 changes: 37 additions & 14 deletions src/lib/Guiguts/ErrorCheck.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,13 @@ my $ENDMSG = "Check is complete:";
# Handles Bookloupe, Jeebies, HTML & CSS Validate, Tidy, Link Check,
# Unmatched Tag/Brackets/Double Quotes/Block Checks
# pphtml, pptxt, ppvimage, Spell Query, EPUBCheck,
# Illustration Fixup, Sidenote Fixup and Load External Checkfile.
# Illustration Fixup, Sidenote Fixup, Error List and Load External Checkfile.
sub errorcheckpop_up {
my ( $textwindow, $top, $errorchecktype ) = @_;
my ( $textwindow, $top, $errorchecktype, $errorlist_ref ) = @_;
my ( $line, $lincol );

return if $errorchecktype eq 'Error List' and not( $errorlist_ref and @$errorlist_ref );

errorchecksettype($errorchecktype);
::hidepagenums();
$textwindow->tagRemove( 'highlight', '1.0', 'end' ); # Remove any previous highlighting
Expand Down Expand Up @@ -60,16 +62,18 @@ sub errorcheckpop_up {
)->grid( -padx => 0, -row => 1, -column => $gcol++ );
}

# All types have a button to re-run the check
my $buttonlabel = 'Run Checks';
$buttonlabel = 'Load Checkfile' if $errorchecktype eq 'Load Checkfile';
my $opsbutton = $ptopframeb->Button(
-command => sub {
errorcheckpop_up( $textwindow, $top, $errorchecktype );
},
-text => $buttonlabel,
-width => 16
)->grid( -padx => 10, -row => 0, -column => $gcol++ );
# All types except Error List have a button to re-run the check
if ( $errorchecktype ne 'Error List' ) {
my $buttonlabel = 'Run Checks';
$buttonlabel = 'Load Checkfile' if $errorchecktype eq 'Load Checkfile';
my $opsbutton = $ptopframeb->Button(
-command => sub {
errorcheckpop_up( $textwindow, $top, $errorchecktype );
},
-text => $buttonlabel,
-width => 16
)->grid( -padx => 10, -row => 0, -column => $gcol++ );
}

# Spell Query bad word count sits under the Run Checks button
if ( $errorchecktype eq 'Spell Query' ) {
Expand Down Expand Up @@ -366,7 +370,7 @@ sub errorcheckpop_up {
$tmpfname =~ s/tmp$/xhtml/ if $errorchecktype eq 'Nu XHTML Check';
$errname = $d . 'errors.err';

if ( errorcheckrun( $errorchecktype, $tmpfname, $errname ) ) { # exit if error check failed to run
if ( errorcheckrun( $errorchecktype, $tmpfname, $errname, $errorlist_ref ) ) { # exit if error check failed to run
::killpopup('errorcheckpop');
::working();
return;
Expand All @@ -378,6 +382,7 @@ sub errorcheckpop_up {
and $errorchecktype ne "Spell Query"
and $errorchecktype ne "Illustration Fixup"
and $errorchecktype ne "Sidenote Fixup"
and $errorchecktype ne "Error List"
and $errorchecktype ne "Load Checkfile"
and $errorchecktype ne "Nu HTML Check"
and $errorchecktype ne "Nu XHTML Check"
Expand Down Expand Up @@ -778,7 +783,7 @@ sub ignorequery {
# temporary file, and any errors will be written to an error file
# to be processed later
sub errorcheckrun {
my ( $errorchecktype, $tmpfname, $errname ) = @_;
my ( $errorchecktype, $tmpfname, $errname, $errorlist_ref ) = @_;
my $textwindow = $::textwindow;
my $top = $::top;
::operationadd("$errorchecktype");
Expand Down Expand Up @@ -844,6 +849,7 @@ sub errorcheckrun {
and $errorchecktype ne 'Unmatched Brackets'
and $errorchecktype ne 'Unmatched Double Quotes'
and $errorchecktype ne 'Unmatched Block Markup'
and $errorchecktype ne 'Error List'
and $errorchecktype ne 'Illustration Fixup'
and $errorchecktype ne 'Sidenote Fixup' ) { # No external tool, so no temp file needed
savetoerrortmpfile( $tmpfname, $striptext );
Expand Down Expand Up @@ -891,6 +897,8 @@ sub errorcheckrun {
unmatcheddoublequotesrun($errname);
} elsif ( $errorchecktype eq 'Unmatched Block Markup' ) {
unmatchedblockrun($errname);
} elsif ( $errorchecktype eq 'Error List' ) {
errorlistrun( $errname, $errorlist_ref );
}
$top->Unbusy;
unlink $tmpfname unless $errorchecktype eq 'EPUBCheck'; # Don't delete the epub file
Expand Down Expand Up @@ -1771,6 +1779,21 @@ sub booklouperun {
}
} # end of variable-enclosing block

#
# No actual error checking - routine is given a list of errors, and just outputs
# them to the error file so main code can load and process it
sub errorlistrun {
my $errname = shift; # output filename
my $errorlist_ref = shift; # reference to list of errors

open my $logfile, ">", $errname or die "Error opening Error List output file: $errname";
for my $line (@$errorlist_ref) {
utf8::encode($line);
print $logfile "$line\n";
}
close $logfile;
}

#
# Check that all relevant opening items have a matching close item
# and vice versa
Expand Down
170 changes: 154 additions & 16 deletions src/lib/Guiguts/HTMLConvert.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ use warnings;

my $EMPX = 16.0; # 1em in px assumed to be 16
my ( $LANDX, $LANDY ) = ( 4, 3 ); # Common aspect ratio of landscape screen
my $IDXXREFPREFIX = 'Indexxref_'; # ID Prefix used for index cross-references
my $LDQ = "\x{201c}";
my $RDQ = "\x{201d}";
my $LSQ = "\x{2018}";
my $RSQ = "\x{2019}";

BEGIN {
use Exporter();
Expand All @@ -15,7 +20,7 @@ BEGIN {
qw(&htmlautoconvert &htmlgenpopup &htmlmarkpopup &makeanchor &autoindex &entity &named &tonamed
&fromnamed &fracconv &pageadjust &html_convert_pageanchors
&latex_quotes_convert &latex_preview_select &latex_preview_select_view &latex_svg_convert &latex_svg_convert_view
&latex_undo_autogen &latex_pagesep_convert);
&latex_undo_autogen &latex_pagesep_convert &indexxref);
}

#
Expand Down Expand Up @@ -2733,11 +2738,16 @@ sub htmlmarkpopup {
)->grid( -row => 1, -column => 2, -padx => 1, -pady => 2 );

my $f3 = $::lglobal{markpop}->Frame->pack( -side => 'top', -anchor => 'n' );
$f3->Button(
-command => sub { ::indexxref() },
-text => 'Add Index Cross-references',
-width => 24
)->grid( -row => 1, -column => 1, -padx => 1, -pady => 2 );
$f3->Button(
-command => sub { clearmarkupinselection() },
-text => 'Remove Markup from Selection',
-width => 24
)->grid( -row => 1, -column => 1, -padx => 1, -pady => 2 );
)->grid( -row => 1, -column => 2, -padx => 1, -pady => 2 );

::initialize_popup_with_deletebinding('markpop');
}
Expand Down Expand Up @@ -3001,11 +3011,12 @@ sub markup {
$linklistbox->delete( '0', 'end' );
linkpopulate( $linklistbox, \@intanchors );
},
)->pack(
-side => 'left',
)->grid(
-row => 0,
-column => 0,
-pady => 2,
-padx => 2,
-anchor => 'n'
-sticky => 'w'
);
$tframe->Checkbutton(
-variable => \$::lglobal{fnlinks},
Expand All @@ -3014,11 +3025,12 @@ sub markup {
$linklistbox->delete( '0', 'end' );
linkpopulate( $linklistbox, \@intanchors );
},
)->pack(
-side => 'left',
)->grid(
-row => 0,
-column => 1,
-pady => 2,
-padx => 2,
-anchor => 'n'
-sticky => 'w'
);
$tframe->Checkbutton(
-variable => \$::lglobal{pglinks},
Expand All @@ -3027,11 +3039,26 @@ sub markup {
$linklistbox->delete( '0', 'end' );
linkpopulate( $linklistbox, \@intanchors );
},
)->pack(
-side => 'left',
)->grid(
-row => 1,
-column => 0,
-pady => 2,
-padx => 2,
-anchor => 'n'
-sticky => 'w'
);
$tframe->Checkbutton(
-variable => \$::lglobal{idxlinks},
-text => 'Hide Index Links',
-command => sub {
$linklistbox->delete( '0', 'end' );
linkpopulate( $linklistbox, \@intanchors );
},
)->grid(
-row => 1,
-column => 1,
-pady => 2,
-padx => 2,
-sticky => 'w'
);
my $pframe = $::lglobal{linkpop}->Frame->pack( -fill => 'both', -expand => 'both' );
$linklistbox = $pframe->Scrolled(
Expand Down Expand Up @@ -3072,6 +3099,7 @@ sub markup {
&& $::lglobal{fnlinks} );
next
if ( ( $_ =~ /#$::htmllabels{pglabel}/ ) && $::lglobal{pglinks} );
next if ( ( $_ =~ /#$IDXXREFPREFIX/ ) && $::lglobal{idxlinks} );
next unless ( lc($_) eq '#' . $tempvar );
$linklistbox->insert( 'end', $_ );
$flag++;
Expand All @@ -3094,6 +3122,7 @@ sub markup {

next
if ( ( $_ =~ /#$::htmllabels{pglabel}/ ) && $::lglobal{pglinks} );
next if ( ( $_ =~ /#$IDXXREFPREFIX/ ) && $::lglobal{idxlinks} );
next
unless ( $entrarray[0]
and lc($_) =~ /\Q$entrarray[0]\E|\Q$entrarray[1]\E|\Q$entrarray[2]\E/ );
Expand Down Expand Up @@ -3595,6 +3624,7 @@ sub linkpopulate {
if ( ( ( $_ =~ /#$::htmllabels{fnlabel}/ ) || ( $_ =~ /#$::htmllabels{fnanchor}/ ) )
&& $::lglobal{fnlinks} );
next if ( ( $_ =~ /#$::htmllabels{pglabel}/ ) && $::lglobal{pglinks} );
next if ( ( $_ =~ /#$IDXXREFPREFIX/ ) && $::lglobal{idxlinks} );
$linklistbox->insert( 'end', $_ );
}
} else {
Expand All @@ -3603,6 +3633,7 @@ sub linkpopulate {
if ( ( ( $_ =~ /#$::htmllabels{fnlabel}/ ) || ( $_ =~ /#$::htmllabels{fnanchor}/ ) )
&& $::lglobal{fnlinks} );
next if ( ( $_ =~ /#$::htmllabels{pglabel}/ ) && $::lglobal{pglinks} );
next if ( ( $_ =~ /#$IDXXREFPREFIX/ ) && $::lglobal{idxlinks} );
$linklistbox->insert( 'end', $_ );
}
}
Expand Down Expand Up @@ -4200,14 +4231,122 @@ sub addpagelinks {
return $selection;
}

#
# Find "See xyz" cross-references in index, and link to relevant index entries if possible
sub indexxref {
my $textwindow = $::textwindow;
my @ranges = $textwindow->tagRanges('sel');
$textwindow->tagRemove( 'sel', '1.0', 'end' );
my $range_total = @ranges;
if ( $range_total == 0 ) {
$::top->messageBox(
-icon => 'error',
-message => "Select whole index before running cross-reference tool.",
-title => 'No text selected',
-type => 'Ok',
);
return;
}

my $indexend = pop(@ranges);
$textwindow->markSet( 'indexendmark', $indexend ); # Since row/col of indexend will change during insertions
my $indexstart = pop(@ranges);

my $SEESTR = '(also )*see'; # Change this if needed for different languages
my $SEESTRLEN = length($SEESTR); # Approx length just used for advancing search position
my $seepos = $indexstart;
my $seesawnum = 1;
my $IDXERRMARK = 'indexerr';
my $idxerrnum = 1;
my %idxerrmsg = ();

# Loop to end of index
while ( $textwindow->compare( $seepos, "<", $indexend ) ) {

# Find "See" - exit loop if not found
my $seelen;
$seepos =
$textwindow->search( '-regexp', '-nocase', '-count', \$seelen, '--', "\\b$SEESTR\\b",
"$seepos+${SEESTRLEN}c", 'indexendmark' );
last unless $seepos;

# Grab the string describing what to "See", trimming HTML tags and non-word characters
my $see = $textwindow->get( "$seepos+${seelen}c", "$seepos lineend" );
$see =~ s/ *<[^>]+> *//g;
$see =~ s/^\W*//;
$see =~ s/\W*$//;

# Find the text we want to enclose in <a>...</a>, and set marks in case we insert text before this point
my $len;
my $seeexactpos =
$textwindow->search( '-regexp', '-nocase', '-count', \$len, '--', "\\b$see\\b",
"$seepos+${seelen}c", "$seepos lineend" );

# Mark location of error and store message - shouldn't happen with well-formed index
unless ( $seeexactpos and $len > 0 ) {
my $idxerr = $IDXERRMARK . $idxerrnum++;
$textwindow->markSet( $idxerr, $seepos );
$idxerrmsg{$idxerr} = "Couldn't interpret 'See $see'";
next;
}
$seepos = $seeexactpos;
$textwindow->markSet( 'indexseestart', $seepos );
$textwindow->markSet( 'indexseeend', "$seepos +${len}c" );

# Find the target of the See with/without leading "The "
my $sawpos;
my $seethe = $see;
$seethe =~ s/^The *//i;
for my $seestr ( $see, $seethe ) {
last
if $sawpos =
$textwindow->search( '-regexp', '-nocase', '--',
"<li class=[^>]+>(<[^>]+>|[\"'$LDQ$RDQ$LSQ$RSQ ])*\\b$seestr\\b",
$indexstart, 'indexendmark' );
}

my $chkid;
if ($sawpos) {
$chkid = $textwindow->get( $sawpos, "$sawpos lineend" );
$chkid = undef unless $chkid =~ s/<li class=.+id=["']([^"']+)["'].*/$1/;
} else { # Target not found - Mark location of error and store message
my $idxerr = $IDXERRMARK . $idxerrnum++;
$textwindow->markSet( $idxerr, 'indexseestart' );
$idxerrmsg{$idxerr} = "'$see' target not found";
next;
}

# Find and mark closing ">" for target's list start tag
$sawpos =
$textwindow->search( '-regexp', '-nocase', '--', ">", $sawpos, "$sawpos lineend" );
$textwindow->markSet( 'indexsawpoint', $sawpos );

my $id = $chkid // "${IDXXREFPREFIX}$seesawnum"; # Using existing id if there is one
$textwindow->insert( 'indexseestart', "<a href=\"#$id\">" );
$textwindow->insert( 'indexseeend', "</a>" );
unless ($chkid) { # No need to add id if an existing one
$textwindow->insert( 'indexsawpoint', " id=\"$id\"" );
$seesawnum++;
}
}

# inform user of any errors, now there is no more insertion to do
if (%idxerrmsg) {
my @errorlist = ();
for my $errmark ( keys %idxerrmsg ) {
my $idx = $textwindow->index($errmark);
$idx =~ s/\./:/;
push( @errorlist, "$idx - " . $idxerrmsg{$errmark} . "\n" );
$textwindow->markUnset($errmark);
}
::errorcheckpop_up( $textwindow, $::top, 'Error List', \@errorlist );
}
}

#############################
# LaTeX conversion routines #
#############################

my $LDQ = "\x{201c}";
my $RDQ = "\x{201d}";
my $LSQ = "\x{2018}";
my $RSQ = "\x{2019}";
my $LDL = "``";
my $RDL = "''";
my $LSL = "`";
Expand Down Expand Up @@ -4634,5 +4773,4 @@ sub warnifconversionerror {
close $fh;
}
}

1;

0 comments on commit a0ff105

Please sign in to comment.