mirror of
https://github.com/git/git.git
synced 2025-01-27 09:53:42 +08:00
337da8d2b0
The esc_html_match_hl() subroutine added in this commit will be used
to highlight *all* matches of given regexp, using 'match' class.
Ultimately it is to be used in all match highlighting, starting
with project search, which does not have it yet.
It uses the esc_html_hl_regions() subroutine, which is meant to
highlight in a given string a list of regions (given as a list of
[ beg, end ] pairs of positions in string), using HTML <span> element
with given class. It could probably be used in other places that
do highlighting of part of ready line, like highlighting of changes
in a diff (diff refinement highlighting).
Implementation and enhancement notes:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Currently esc_html_hl_regions() subroutine doesn't accept any
parameters, like esc_html() does. We might want for example to
pass nbsp=>1 to it.
It can easily be done with the following code:
my %opts = grep { ref($_) ne "ARRAY" } @sel;
@sel = grep { ref($_) eq "ARRAY" } @sel;
This allow adding parameters after or before regions, e.g.:
esc_html_hl_regions("foo bar", "mark", [ 0, 3 ], -nbsp => 1);
* esc_html_hl_regions() escapes like esc_html(); if we wanted to
highlight with esc_path(), we could pass subroutine reference
to now named esc_gen_hl_regions().
esc_html_hl_regions("foo bar", "mark", \&esc_path, [ 0, 3 ]);
Note that this way we can handle -nbsp=>1 case automatically,
e.g.
esc_html_hl_regions("foo bar", "mark",
sub { esc_html(@_, -nbsp=>1) },
[ 0, 3 ]);
* Alternate solution for highlighting region of a string would be to
use the idea that strings are to be HTML-escaped, and references to
scalars are HTML (like in the idea for generic committags).
This would require modifying gitweb code or esc_html to get list of
fragments, e.g.:
esc_html(\'<span class="mark">', 'foo', \'</span>', ' bar',
{ -nbsp => 1 });
or
esc_html([\'<span class="mark">', 'foo', \'</span>', ' bar'],
-nbsp=>1);
esc_html_match_hl() could be then simple wrapper around "match
formatter", e.g.
esc_html([ render_match_hl($str, $regexp) ], -nbsp=>1);
Signed-off-by: Jakub Narebski <jnareb@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
|
||
|---|---|---|
| .. | ||
| static | ||
| gitweb.perl | ||
| INSTALL | ||
| Makefile | ||
| README | ||
GIT web Interface ================= The one working on: http://git.kernel.org/ From the git version 1.4.0 gitweb is bundled with git. Build time gitweb configuration ------------------------------- There are many configuration variables which affect building gitweb (among others creating gitweb.cgi out of gitweb.perl by replacing placeholders such as `++GIT_BINDIR++` by their build-time values). Building and installing gitweb is described in gitweb's INSTALL file (in 'gitweb/INSTALL'). Runtime gitweb configuration ---------------------------- Gitweb obtains configuration data from the following sources in the following order: 1. built-in values (some set during build stage), 2. common system-wide configuration file (`GITWEB_CONFIG_COMMON`, defaults to '/etc/gitweb-common.conf'), 3. either per-instance configuration file (`GITWEB_CONFIG`, defaults to 'gitweb_config.perl' in the same directory as the installed gitweb), or if it does not exists then system-wide configuration file (`GITWEB_CONFIG_SYSTEM`, defaults to '/etc/gitweb.conf'). Values obtained in later configuration files override values obtained earlier in above sequence. You can read defaults in system-wide GITWEB_CONFIG_SYSTEM from GITWEB_CONFIG by adding read_config_file($GITWEB_CONFIG_SYSTEM); at very beginning of per-instance GITWEB_CONFIG file. In this case settings in said per-instance file will override settings from system-wide configuration file. Note that read_config_file checks itself that the $GITWEB_CONFIG_SYSTEM file exists. The most notable thing that is not configurable at compile time are the optional features, stored in the '%features' variable. Ultimate description on how to reconfigure the default features setting in your `GITWEB_CONFIG` or per-project in `project.git/config` can be found as comments inside 'gitweb.cgi'. See also gitweb.conf(5) manpage. Web server configuration ------------------------ Gitweb can be run as CGI script, as legacy mod_perl application (using ModPerl::Registry), and as FastCGI script. You can find some simple examples in "Example web server configuration" section in INSTALL file for gitweb (in gitweb/INSTALL). See "Webserver configuration" and "Advanced web server setup" sections in gitweb(1) manpage. AUTHORS ------- Originally written by: Kay Sievers <kay.sievers@vrfy.org> Any comment/question/concern to: Git mailing list <git@vger.kernel.org>