blob: aaaae180109d48ea71dd740edaf198a9f4835b6c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# latex-git-log
This program will output the entire version history as table written in LaTeX
if it is executed within a git repository.
It is intended that you redirect the standard output of this script to a file
which can then be included from your main TeX document.
Because the table can be very large you might want to put the thing on a
landscape page.
## Dependencies
### Of this script
This module requires these other modules and libraries:
IPC::System::Simple
Locale::Maketext::Simple
Everything else should already be installed.
### To compile the output
The table is using the *longtable* package and the links to a web resource for
each commit use the `\href` macro from *hyperref*. So these two packages have
to be loaded.
Furthermore you need to defined the macro `\longtableendfoot` which will be
expanded on the bottom of every page if the table will be continued on the next
page. You can defined it to a localized message to inform the reader that this
table is not complete and will be continued.
## License and development
Copyright (C) by Robin Schneider <ypid23@aol.de> <br />
Source code repository: https://github.com/ypid/typesetting/tree/master/scripts/latex-git-log <br />
Please report bugs and feature requests at https://github.com/ypid/typesetting/issues <br />
## Usage
latex-git-log [options]
Options:
--author set this if you want the author included
--startcommit set the start value of count commit
--width set the width in cm of the commit message field in the LaTeX table
--git-c-add set an base URL to link to a commit
--user set a github user to derive the base URL
--repo set a github repository to derive the base URL
--lang language of the legend and all strings in the output
--version, -v print version of this script
--help brief help message
--man full documentation
### Description of some options
--width Set the width in cm of the commit message field in the LaTeX
table. If this parameter is not set then the table is not
vertically limited. That means that if you have a very long
commit message then the table will probably not fit on the page
and you will get a "Overfull" error message from TeX.
In this case you should specify the width of the column
containing the commit messages. I normally use something like
--width=14 for DIN A4 in landscape.
--git-c-add
Set an base URL to link to a commit. This script will
automatically try to use the base URL for github.
--lang Set the language of the legend and all strings in the output. Be
default the language of your system is used but you can
overwrite this with this parameter.
Currently this script only supports English and German. If you
need a translation to another language then you can either
create a .po file or I can register this project on one of those
websites for online translation.
|
