Commit 1d1bb369 authored by Gervase Markham's avatar Gervase Markham Committed by Gervase Markham

Bug 399068: Remove the docs_urlbase parameter. r=LpSolit, a=glob.

parent 5d0b206a
......@@ -25,13 +25,6 @@ use constant get_param_list => (
},
{
name => 'docs_urlbase',
type => 't',
default => 'docs/%lang%/html/',
checker => \&check_url
},
{
name => 'utf8',
type => 'b',
default => '0',
......
......@@ -1037,10 +1037,38 @@ sub create {
'urlbase' => sub { return Bugzilla::Util::correct_urlbase(); },
# Allow templates to access docs url with users' preferred language
'docs_urlbase' => sub {
my $language = Bugzilla->current_language;
my $docs_urlbase = Bugzilla->params->{'docs_urlbase'};
$docs_urlbase =~ s/\%lang\%/$language/;
# We fall back to English if documentation in the preferred
# language is not available
'docs_urlbase' => sub {
my $docs_urlbase;
my $lang = Bugzilla->current_language;
# Translations currently available on readthedocs.org
my @rtd_translations = ('en', 'fr');
if ($lang ne 'en' && -f "docs/$lang/html/index.html") {
$docs_urlbase = "docs/$lang/html/";
}
elsif (-f "docs/en/html/index.html") {
$docs_urlbase = "docs/en/html/";
}
else {
if (!grep { $_ eq $lang } @rtd_translations) {
$lang = "en";
}
my $version = BUGZILLA_VERSION;
$version =~ /^(\d+)\.(\d+)/;
if ($2 % 2 == 1) {
# second number is odd; development version
$version = 'latest';
}
else {
$version = "$1.$2";
}
$docs_urlbase = "https://bugzilla.readthedocs.org/$lang/$version/";
}
return $docs_urlbase;
},
......
......@@ -59,9 +59,6 @@ maintainer
responsible for maintaining this Bugzilla installation.
The address need not be that of a valid Bugzilla account.
docs_urlbase
The URL that is the common initial leading part of all Bugzilla documentation URLs. It may be an absolute URL, or a URL relative to the :param:`urlbase` parameter. Leave this empty to suppress links to the documentation. ``%lang%`` will be replaced by user's preferred language (if documentation is available in that language).
utf8
Use UTF-8 (Unicode) encoding for all text in Bugzilla. Installations where
this parameter is set to :paramval:`off` should set it to :paramval:`on` only
......
......@@ -16,14 +16,6 @@
"The email address of the person who maintains this installation "
_ " of Bugzilla.",
docs_urlbase =>
"The URL that is the common initial leading part of all"
_ " $terms.Bugzilla documentation URLs. It may be an absolute URL,"
_ " or a URL relative to the <var>urlbase</var> parameter. Leave this"
_ " empty to suppress links to the documentation."
_ "'%lang%' will be replaced by user's preferred language (if"
_ " documentation is available in that language).",
utf8 =>
"Use UTF-8 (Unicode) encoding for all text in ${terms.Bugzilla}. New"
_ " installations should set this to true to avoid character encoding"
......
......@@ -100,7 +100,7 @@
[% Hook.process("link-row") %]
[% BLOCK link_to_documentation %]
[% IF doc_section && Param('docs_urlbase') %]
[% IF doc_section %]
<li>
<span class="separator">| </span>
<a href="[% docs_urlbase _ doc_section FILTER html %]" target="_blank">Help</a>
......
......@@ -22,8 +22,7 @@
# members of the admin group.
#%]
[% IF Param('docs_urlbase') &&
docslinks.keys.size || (admindocslinks.keys.size && user.in_group('admin')) %]
[% IF docslinks.keys.size || (admindocslinks.keys.size && user.in_group('admin')) %]
<div id="docslinks">
<h2>Related documentation</h2>
<ul>
......
......@@ -83,11 +83,9 @@
href="?GoAheadAndLogIn=1"><span>Log In</span></a>
[% END %]
</li>
[% IF Param("docs_urlbase") %]
<li>
<a id="help" href="[% docs_urlbase FILTER html %]using.html"><span>Documentation</span></a>
</li>
[% END %]
<li>
<a id="help" href="[% docs_urlbase FILTER html %]using/index.html"><span>Documentation</span></a>
</li>
</ul>
</div>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment