summaryrefslogtreecommitdiff
path: root/Documentation/gitweb.conf.txt
diff options
context:
space:
mode:
authorTony Finch <dot@dotat.at>2013-07-04 17:02:12 (GMT)
committerJunio C Hamano <gitster@pobox.com>2013-07-05 04:52:15 (GMT)
commitad9c2e22cade795cf5f3ad3dbd9cf33d2012af77 (patch)
tree68f8df0fb892b1bec4c2aa4a4e3b0a115c7d677f /Documentation/gitweb.conf.txt
parent8c4e4ec3ff053331c845331645a437b01b1f0de6 (diff)
downloadgit-ad9c2e22cade795cf5f3ad3dbd9cf33d2012af77.zip
git-ad9c2e22cade795cf5f3ad3dbd9cf33d2012af77.tar.gz
git-ad9c2e22cade795cf5f3ad3dbd9cf33d2012af77.tar.bz2
gitweb: allow extra breadcrumbs to prefix the trail
There are often parent pages logically above the gitweb projects list, e.g. home pages of the organization and department that host the gitweb server. This change allows you to include links to those pages in gitweb's breadcrumb trail. Signed-off-by: Tony Finch <dot@dotat.at> Reviewed-by: Jonathan Nieder <jrnieder@gmail.com> Acked-by: Jakub Narebski <jnareb@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/gitweb.conf.txt')
-rw-r--r--Documentation/gitweb.conf.txt22
1 files changed, 20 insertions, 2 deletions
diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt
index ea0526e..305db63 100644
--- a/Documentation/gitweb.conf.txt
+++ b/Documentation/gitweb.conf.txt
@@ -336,8 +336,26 @@ $home_link_str::
used as the first component of gitweb's "breadcrumb trail":
`<home link> / <project> / <action>`. Can be set at build time using
the `GITWEB_HOME_LINK_STR` variable. By default it is set to "projects",
- as this link leads to the list of projects. Other popular choice it to
- set it to the name of site.
+ as this link leads to the list of projects. Another popular choice is to
+ set it to the name of site. Note that it is treated as raw HTML so it
+ should not be set from untrusted sources.
+
+@extra_breadcrumbs::
+ Additional links to be added to the start of the breadcrumb trail before
+ the home link, to pages that are logically "above" the gitweb projects
+ list, such as the organization and department which host the gitweb
+ server. Each element of the list is a reference to an array, in which
+ element 0 is the link text (equivalent to `$home_link_str`) and element
+ 1 is the target URL (equivalent to `$home_link`).
++
+For example, the following setting produces a breadcrumb trail like
+"home / dev / projects / ..." where "projects" is the home link.
+----------------------------------------------------------------------------
+ our @extra_breadcrumbs = (
+ [ 'home' => 'https://www.example.org/' ],
+ [ 'dev' => 'https://dev.example.org/' ],
+ );
+----------------------------------------------------------------------------
$logo_url::
$logo_label::