olink.docbook-xsl.params.olink.lang.fallback.sequence.xml Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of olink-maven-plugin Show documentation

There is a newer version: 1.2.6

 
 
olink.lang.fallback.sequence 
string 
 
 
olink.lang.fallback.sequence 
look up translated documents if olink not found?

 
 

 
 
Description 
 

This parameter defines a list of lang values
to search among to resolve olinks.


Normally an olink tries to resolve to a document in the same
language as the olink itself.  The language of an olink
is determined by its nearest ancestor element with a
lang attribute, otherwise the
value of the l10n.gentext.default.lang
parameter.


An olink database can contain target data for the same
document in multiple languages.  Each set of data has the
same value for the targetdoc attribute in
the document element in the database, but with a 
different lang attribute value.


When an olink is being resolved, the target is first
sought in the document with the same language as the olink.
If no match is found there, then this parameter is consulted
for additional languages to try.

The olink.lang.fallback.sequence
must be a whitespace separated list of lang values to
try.  The first one with a match in the olink database is used.
The default value is empty.

For example, a document might be written in German
and contain an olink with
targetdoc="adminguide".
When the document is processed, the processor
first looks for a target dataset in the
olink database starting with:

<document targetdoc="adminguide" lang="de">.


If there is no such element, then the
olink.lang.fallback.sequence 
parameter is consulted.
If its value is, for example, fr en, then the processor next
looks for targetdoc="adminguide" lang="fr", and
then for targetdoc="adminguide" lang="en".
If there is still no match, it looks for
targetdoc="adminguide" with no
lang attribute.


This parameter is useful when a set of documents is only
partially translated, or is in the process of being translated.  
If a target of an olink has not yet been translated, then this
parameter permits the processor to look for the document in
other languages.  This assumes the reader would rather have
a link to a document in a different language than to have
a broken link.