# cosmetic but obnoxious :)
found 607498 doc-base/0.9.5
quit
Russ Allbery wrote:
> Aron Xu <happyaron...@gmail.com> writes:
>> For example, in fcitx 1:4.0.1-1, the doc-base entry must be like this:
>
>> Format: text
>> Files: /usr/share/doc/fcitx/Develop_Readme /usr/share/doc/fcitx/API.txt.gz
>> /usr/share/doc/fcitx/pinyin.txt
>
>> If I list all three files in three lines, it will result in an
>> installation error:
>
>> Format: text
>> Files: /usr/share/doc/fcitx/Develop_Readme
>> /usr/share/doc/fcitx/API.txt.gz
>> /usr/share/doc/fcitx/pinyin.txt
>From perl/Debian/DocBase/Programs/Scrollkeeper.pm, around line 85:
if (defined $omf_category) {
for my $omf_format (@omf_formats) {
$format_data = $doc->GetFormat($omf_format);
next unless defined $format_data;
my $file = defined $$format_data{'index'} ? $$format_data{'index'} :
$$format_data{'files'};
next unless -f $file;
$omf_serial_id = $doc->GetStatus('Scrollkeeper-sid');
# chomp ($omf_serial_id = `$scrollkeeper_gen_seriesid`) unless defined
$omf_serial_id;
$omf_serial_id = _GetUUID() unless $omf_serial_id;
$new_omf_file = _WriteOmfFile($doc, $file,$omf_format,$omf_category,
$omf_serial_id);
$do_update = 1;
last; # register only the first format found
}
}
At this point, for
Files: /foo
/bar
/baz
$$format_data{'files'} would contain "/foo\n/bar\n/baz". WriteOmfFile uses
$file
like so:
<identifier url="$file"/>
The OMF documentation[1] explains <identifier> like so:
A specification of a unique ID by which the resource may be
identified and from which the resource may be retrieved.
(e.g. a URL or URN)
It is optional but presumably the scrollkeeper entry would not be very
useful for yelp without it. But wait --- do the graphical help tools
even use OMF any more? Perhaps we should be targetting rarian
directly?
Separate question: is Text documentation allowed to have an index?
If not, how should one get started in reading some text documentation
listed in /usr/share/doc-base?
Thanks,
Jonathan
[1] http://www.ibiblio.org/osrt/omf/omf_elements
--
To UNSUBSCRIBE, email to debian-bugs-dist-requ...@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmas...@lists.debian.org
