Package: doc-base
Version: 0.10.7
Severity: normal
Tags: patch
Dear Maintainer,
When generating omf files for scrollkeeper (or rarian), the generated
omf file contains an url without the protocol (so this isn't a valid url).
For example, the blender-C.omf file contains the following tag:
--
<identifier url="/usr/share/doc/blender-data/readme.html"/>
--
According to the documentation [1], the url attribute should contains a
valid url with a protocol (here: "file://"):
--
<identifier url="file:///usr/share/doc/blender-data/readme.html"/>
--
The consequence is that rarian expect the url to have "file://" and
rarian-sk-get-cl outputs a bad file path
("are/doc/blender-data/readme.html" for blender)
Because of this, khelpcenter is not able to show anything and shows
errors about bad file path (which begin with are/doc/).
Is this url writting behavior expected ?
If not, I added in attachment a patch to Scrollkeeper.pm to add
"file://" in front of the file path in the url attribute.
(I think rarian need a change too instead of blindly removing the first
7 bytes of the url attribute, but that's another story)
[1]
http://scrollkeeper.sourceforge.net/documentation/writing_scrollkeeper_omf_files/ar01s05.html
-- System Information:
Debian Release: 9.0
APT prefers unstable
APT policy: (950, 'unstable'), (500, 'unstable-debug'), (500,
'testing'), (500, 'stable'), (1, 'experimental')
Architecture: amd64 (x86_64)
Foreign Architectures: i386
Kernel: Linux 4.9.0-2-amd64 (SMP w/4 CPU cores)
Locale: LANG=fr_FR.UTF-8, LC_CTYPE=fr_FR.UTF-8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash
Init: systemd (via /run/systemd/system)
Versions of packages doc-base depends on:
ii libuuid-perl 0.27-1
ii libyaml-tiny-perl 1.70-1
doc-base recommends no packages.
Versions of packages doc-base suggests:
pn dhelp | dwww | doc-central | yelp | khelpcenter4 <none>
ii rarian-compat 0.8.1-6+b1
-- no debconf information
--- /usr/share/perl5/Debian/DocBase/Programs/Scrollkeeper.pm 2016-01-27
22:53:27.000000000 +0100
+++ Scrollkeeper.pm 2017-04-14 01:51:28.102831810 +0200
@@ -247,7 +247,7 @@
print OMF "\t\t<subject category=\"$category\"/>\n";
print OMF
"\t\t<description>".&_HTMLEncode($doc->GetAbstract())."</description>\n";
print OMF "\t\t<format ".&_GetMimeType($file,$format)." />\n";
- print OMF "\t\t<identifier url=\"$file\"/>\n";
+ print OMF "\t\t<identifier url=\"file://$file\"/>\n";
print OMF "\t\t<language code=\"C\"/>\n";
print OMF "\t\t<relation seriesid=\"$serial_id\"/>\n";
