NAME

FileWiki::Plugin::Git - Git variable provider plugin for FileWiki

SYNOPSIS

PLUGINS=Git

DESCRIPTION

Provides page variables from source files under git control.

CONFIGURATION VARIABLES

PLUGIN_GIT_MATCH

Defines a match on file names for the git plugin. The git plugin will only be enabled if the file matches the expression. Defaults to '.*' (all files).

GIT_BIN

Git binary, defaults to 'git'.

GIT_TIME_FORMAT

Time format to be used for dates. Corresponds to the C library routines "strftime" and "ctime". Defaults to TIME_FORMAT page variable, which again defaults to "%C".

VARIABLE PRESETS

GIT_COMMIT_HASH

The git "commit hash" of the source file.

GIT_AUTHOR_NAME

The git "author name" of the source file.

GIT_AUTHOR_EMAIL

The git "author email" of the source file.

GIT_AUTHOR_DATE

The git "author date" of the source file, formatted by the GIT_TIME_FORMAT variable.

GIT_AUTHOR_DATE_UNIX

The git "author date" of the source file, UNIX timestamp.

GIT_COMMITTER_NAME

The git "committer name" of the source file.

GIT_COMMITTER_EMAIL

The git "committer email" of the source file.

GIT_COMMITTER_DATE

The git "committer email" of the source file, formatted by the GIT_TIME_FORMAT variable.

GIT_COMMITTER_DATE_UNIX

The git "committer email" of the source file, UNIX timestamp.

AUTHOR

Axel Burri <axel@tty0.ch>

COPYRIGHT AND LICENSE

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.