[Bug 18817] New: Screenshots not appearing in the manual linked to the Help tab
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Bug ID: 18817 Summary: Screenshots not appearing in the manual linked to the Help tab Change sponsored?: --- Product: Koha Version: 16.11 Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Documentation Assignee: koha-bugs@lists.koha-community.org Reporter: karen@bywatersolutions.com QA Contact: testopia@bugs.koha-community.org Created attachment 64407 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=64407&action=edit Screenshots not displaying in manual connected to the staff client No screenshots are displaying in the manual that is connected to the Help link in the staff client. They are displaying in other versions of the manual, just not the one connected to the staff client. I've attached a screenshot of this. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Joy Nelson <joy@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff Patch complexity|--- |Trivial patch -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #1 from Joy Nelson <joy@bywatersolutions.com> --- Created attachment 64427 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=64427&action=edit Bug 18817 Correct Manual URL Corrected the manual url in the help screen for 17.05 onward. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Joy Nelson <joy@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |joy@bywatersolutions.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |chris@bigballofwax.co.nz, | |jonathan.druart@bugs.koha-c | |ommunity.org Version|16.11 |master Severity|enhancement |major --- Comment #2 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- What is the difference between manual.k-c.org and k-c.org/manual? Should not they be the same? -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |katrin.fischer@bsz-bw.de --- Comment #3 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I talked to Chris this morning and I think he prefers the k-c.org so this patch should be fine. I will try to test. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Michael Kuhn <mik@adminkuhn.ch> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |mik@adminkuhn.ch --- Comment #4 from Michael Kuhn <mik@adminkuhn.ch> --- The patch will solve the problem only on one single page (the mainpage). But since the Koha help is context-sensitive all the hundreds of other pages linking to the manual are still linking to the old manual with the broken image links. This was already the case in Koha 16.11. And I'm afraid it applies to every single help page in EVERY additional language (not only English) which do all link to the respective pages of the English manual. -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #5 from Joy Nelson <joy@bywatersolutions.com> --- The link was found 212 times in the system. I suppose we could updated each one individually. But is this the most efficient way? Additionally, I cannot find how the translations are done for the new 17.05 manual. for example, what is the url for the spanish translation? -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #6 from Chris Cormack <chris@bigballofwax.co.nz> --- It doesn't exist yet, but if it did it would be /es/ instead of /en/ -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Larry Baerveldt <larry@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |larry@bywatersolutions.com --- Comment #7 from Larry Baerveldt <larry@bywatersolutions.com> --- Some comments on this: The current manual links on the help page, up through 17.05, are pointing to 'manual.koha-community.org'. That site is maintained by ByWater, but the actual manual pages are generated using this git repository: git://git.koha-community.org/kohadocs.git On that repository, the branch for manual16.05.x includes images in directory en/images. However I just checked and discovered that for the 16.11 and 17.05 branches, the images are now in en/source/images. I've updated the links on the manual.koha-community.org site, and now images are showing up in the manual pages. It sounds like the Community wants to get away from using the manual.k-c site. We will leave the manual.k-c site up until such time as the links for the help pages have all been changed over to use the new address. Let me know when that has been done, and we'll shut down the manual.k-c site. - Larry -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #8 from Chris Cormack <chris@bigballofwax.co.nz> --- Hi All The main difference is 17.05 and up do not use docbook XML anymore, but use sphinx This is a markdown style syntax that is way way easier to edit (we already have more different people submitting doc than we did in the last 5 years, docbook xml was just too hard) The readme is here http://git.koha-community.org/gitweb/?p=kohadocs.git;a=blob;f=README.md;h=5d... The upshot is, 17.05 generated from docbook is old and out of date and missing a chunk. So if we can leave the old manuals on manual.koha-community.org and new ones on koha-community.org that should be the simplest -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 M. Tompsett <mtompset@hotmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #64427|0 |1 is obsolete| | --- Comment #9 from M. Tompsett <mtompset@hotmail.com> --- Created attachment 64731 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=64731&action=edit [SIGNED-OFF] Bug 18817 Correct Manual URL Corrected the manual url in the help screen for 17.05 onward. Signed-off-by: Mark Tompsett <mtompset@hotmail.com> -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Severity|major |minor --- Comment #10 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- The screenshots/images on manual.koha-community.org have been fixed, so this is no longer major. Maybe we should switch all links on master for the 17.11 release - as it can't be done automatically (changed headings/achors) and it's a lot of help files to fix. This here will only link from the start page to the new manual. -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |joy@bywatersolutions.com |ity.org | -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Keywords| |Manual -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #11 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Created attachment 65973 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=65973&action=edit Bug 18817: Update links with anchor automatically I generate a mapping files (old anchor > new anchor) from the doc files. Here are the links that have been updated automatically -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #12 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Created attachment 65974 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=65974&action=edit Bug 18817: Update links manually Without the anchor it is not possible to retrieve the html page, so these occurrences have been updated manually (and yes it was painful) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|joy@bywatersolutions.com |jonathan.druart@bugs.koha-c | |ommunity.org Status|Signed Off |ASSIGNED --- Comment #13 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- (In reply to Katrin Fischer from comment #10)
The screenshots/images on manual.koha-community.org have been fixed, so this is no longer major.
Maybe we should switch all links on master for the 17.11 release - as it can't be done automatically (changed headings/achors) and it's a lot of help files to fix. This here will only link from the start page to the new manual.
Manual changes were not imaginable, I script things. I will update the manual first, then come back here. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #14 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Automatic replacement has been done with: use Modern::Perl; use File::Slurp; # examplelistemail:18_miscellaneous.html#example-email-from-list my $mappings; for my $line ( split "\n", read_file('mappings.txt') ) { chomp $line; next unless $line; my ( $old_anchor, $link ) = split ':', $line; $mappings->{$old_anchor} = $link; } my @files = `git grep -l manual.koha-community.org`; for my $file ( @files ) { chomp $file; next if $file =~ 'misc/release_notes'; # FIXME What do we do with release notes? say $file; my $content = read_file( $file ); my @content; for my $line ( split "\n", $content ) { chomp $line; # http://manual.koha-community.org/[% helpVersion %]/en/aboutkoha.html if ( $line =~ m|manual.koha-community.org/\[% helpVersion %\]/en/.*\.html#([^"]+)"| ) { my $old_anchor = $1; if ( exists $mappings->{$old_anchor} ) { my $new_anchor = $mappings->{$old_anchor}; $line =~ s|manual.koha-community.org/\[% helpVersion %\]/en/[^"]+"|koha-community.org/manual/[% helpVersion %]/html/$new_anchor"|g; } else { warn "$old_anchor DOES NOT HAVE A MAPPING"; } } push @content, $line; } write_file( $file, join( "\n", @content ) . "\n" ); } Just for the record. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #15 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 66007 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=66007&action=edit [SIGNED OFF] Bug 18817 Correct Manual URL Corrected the manual url in the help screen for 17.05 onward. Signed-off-by: Mark Tompsett <mtompset@hotmail.com> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #16 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 66008 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=66008&action=edit [SIGNED OFF] Bug 18817: Update links with anchor automatically I generate a mapping files (old anchor > new anchor) from the doc files. Here are the links that have been updated automatically Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #17 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Created attachment 66009 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=66009&action=edit [SIGNED OFF] Bug 18817: Update links manually Without the anchor it is not possible to retrieve the html page, so these occurrences have been updated manually (and yes it was painful) Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |Needs Signoff -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #64731|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #65973|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #65974|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #18 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Thx Jonathan, you are a hero! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|Screenshots not appearing |Update links in the help |in the manual linked to the |files for the new 17.11 |Help tab |manual -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #19 from Marcel de Rooy <m.de.rooy@rijksmuseum.nl> --- Created attachment 66453 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=66453&action=edit Bug 18817 Correct Manual URL Corrected the manual url in the help screen for 17.05 onward. Signed-off-by: Mark Tompsett <mtompset@hotmail.com> Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #20 from Marcel de Rooy <m.de.rooy@rijksmuseum.nl> --- Created attachment 66454 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=66454&action=edit Bug 18817: Update links with anchor automatically I generate a mapping files (old anchor > new anchor) from the doc files. Here are the links that have been updated automatically Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #21 from Marcel de Rooy <m.de.rooy@rijksmuseum.nl> --- Created attachment 66455 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=66455&action=edit Bug 18817: Update links manually Without the anchor it is not possible to retrieve the html page, so these occurrences have been updated manually (and yes it was painful) Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de> Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |m.de.rooy@rijksmuseum.nl QA Contact|testopia@bugs.koha-communit |m.de.rooy@rijksmuseum.nl |y.org | Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #22 from Marcel de Rooy <m.de.rooy@rijksmuseum.nl> --- Aarg those labels again ;) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #66008|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #66009|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Marcel de Rooy <m.de.rooy@rijksmuseum.nl> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #66007|0 |1 is obsolete| | -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Jonathan Druart <jonathan.druart@bugs.koha-community.org> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Passed QA |Pushed to Master --- Comment #23 from Jonathan Druart <jonathan.druart@bugs.koha-community.org> --- Pushed to master for 17.11, thanks to everybody involved! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Fridolin SOMERS <fridolin.somers@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |fridolin.somers@biblibre.co | |m Status|Pushed to Master |Pushed to Stable --- Comment #24 from Fridolin SOMERS <fridolin.somers@biblibre.com> --- Pushed to 17.05.x, will be in 17.05.05. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #25 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- I think we had agreed to use the old manual still for 17.05 and do the final switch with 17.11 - which means this shouldn't be pushed to 17.11. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 --- Comment #26 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Not applying to 16.11.x (still the old manual there) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=18817 Fridolin SOMERS <fridolin.somers@biblibre.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Resolution|--- |FIXED Status|Pushed to Stable |RESOLVED --- Comment #27 from Fridolin SOMERS <fridolin.somers@biblibre.com> --- (In reply to Katrin Fischer from comment #25)
I think we had agreed to use the old manual still for 17.05 and do the final switch with 17.11 - which means this shouldn't be pushed to 17.11.
Ah ok i revert and set resolved. -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org