Debian Codegraph @

texmf-dist/doc/support/latex-git-log/README.md

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