summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2013-06-27 16:44:39 +0000
committerKarl Berry <karl@freefriends.org>2013-06-27 16:44:39 +0000
commitd1e85bfb2d9a06c0d47bdb12cc9d3e53f4f4b7a2 (patch)
tree09d2f136eac81eb32bff92064569c1c4caf623c5 /Master/texmf-dist/doc/support
parent5d0a78fa69eddaec28febee79e47b450d57ada3f (diff)
new script latex-git-log (16jun13)
git-svn-id: svn://tug.org/texlive/trunk@30983 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support')
-rw-r--r--Master/texmf-dist/doc/support/latex-git-log/README75
-rw-r--r--Master/texmf-dist/doc/support/latex-git-log/example-output.tex70
-rw-r--r--Master/texmf-dist/doc/support/latex-git-log/example.pdfbin0 -> 77887 bytes
-rw-r--r--Master/texmf-dist/doc/support/latex-git-log/example.tex17
-rw-r--r--Master/texmf-dist/doc/support/latex-git-log/po/de.po57
5 files changed, 219 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/latex-git-log/README b/Master/texmf-dist/doc/support/latex-git-log/README
new file mode 100644
index 00000000000..aaaae180109
--- /dev/null
+++ b/Master/texmf-dist/doc/support/latex-git-log/README
@@ -0,0 +1,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.
diff --git a/Master/texmf-dist/doc/support/latex-git-log/example-output.tex b/Master/texmf-dist/doc/support/latex-git-log/example-output.tex
new file mode 100644
index 00000000000..da2c199b5c5
--- /dev/null
+++ b/Master/texmf-dist/doc/support/latex-git-log/example-output.tex
@@ -0,0 +1,70 @@
+%% This file was generated by the script latex-git-log
+%% Base git commit URL: https://github.com/ypid/typesetting/commit
+\begin{tabular}{lp{12cm}}
+ \label{tabular:legend:git-log}
+ \textbf{acronym} & \textbf{meaning} \\
+ V & \texttt{version} \\
+ tag & \texttt{git tag} \\
+ MF & Number of \texttt{modified files}. \\
+ AL & Number of \texttt{added lines}. \\
+ DL & Number of \texttt{deleted lines}. \\
+\end{tabular}
+
+\bigskip
+
+\iflanguage{ngerman}{\shorthandoff{"}}{}
+\begin{longtable}{|rllp{13cm}rrr|}
+\hline \multicolumn{1}{|c}{\textbf{V}} & \multicolumn{1}{c}{\textbf{tag}}
+& \multicolumn{1}{c}{\textbf{date}}
+& \multicolumn{1}{c}{\textbf{commit message}} & \multicolumn{1}{c}{\textbf{MF}}
+& \multicolumn{1}{c}{\textbf{AL}} & \multicolumn{1}{c|}{\textbf{DL}} \\ \hline
+\endhead
+
+\hline \multicolumn{7}{|r|}{\longtableendfoot} \\ \hline
+\endfoot
+
+\hline% \hline
+\endlastfoot
+
+\hline 1 & & 2012-08-18 & \href{https://github.com/ypid/typesetting/commit/3ff663fcfbc56662426740cf6bab2a840e320db6}{added template.dtx from http://texhacks.blogspot.de/2011/01/simpler-dtx-template.html} & 2 & 127 & 0 \\
+\hline 2 & & 2012-08-19 & \href{https://github.com/ypid/typesetting/commit/e9fc9a2847fe14067bb3ec8d4e4298ff8806f11f}{made my first changes on the docstrip template} & 2 & 40 & 48 \\
+\hline 3 & & 2012-08-19 & \href{https://github.com/ypid/typesetting/commit/cbc7bbcdda54f7b43f2039531d2a4f58c35f8964}{optimized} & 1 & 5 & 4 \\
+\hline 4 & & 2012-08-22 & \href{https://github.com/ypid/typesetting/commit/55d994c391c509897dd56a6a755c51a1e62bd4d4}{optimized} & 2 & 119 & 115 \\
+\hline 5 & & 2012-08-23 & \href{https://github.com/ypid/typesetting/commit/933466b223d70adeda6a865b4b13b4cdfa245070}{added my primary template} & 6 & 252 & 6 \\
+\hline 6 & & 2012-08-23 & \href{https://github.com/ypid/typesetting/commit/5995d70f82b680d3a529aa592558dcdde6f407b7}{added PDFs} & 2 & 0 & 0 \\
+\hline 7 & & 2012-08-23 & \href{https://github.com/ypid/typesetting/commit/7e1efb265b43fb9aad3fa94b22408951076016f3}{added README (Credits)} & 1 & 1 & 0 \\
+\hline 8 & & 2012-08-26 & \href{https://github.com/ypid/typesetting/commit/619a7f6db915bc1e05d0c9ee374aaff53195b257}{converted template.dtx and template.ins to a template for sty2dtx} & 7 & 49 & 62 \\
+\hline 9 & & 2012-08-27 & \href{https://github.com/ypid/typesetting/commit/06f948149a3b0bd2c81062078add19af6bb1ac5d}{optimized} & 6 & 48 & 22 \\
+\hline 10 & & 2012-08-27 & \href{https://github.com/ypid/typesetting/commit/09316b528dc90f45fa4ef6cf9cf5886c4e25c5bb}{added scripts} & 6 & 222 & 0 \\
+\hline 11 & & 2012-08-27 & \href{https://github.com/ypid/typesetting/commit/4c434dcd45aa4a73112b1393d096776eaa938b83}{added README for scripts} & 1 & 10 & 0 \\
+\hline 12 & & 2012-08-27 & \href{https://github.com/ypid/typesetting/commit/794a3db5bd4f0165a347f0628c78f32350731b2a}{optimized scripts} & 4 & 9 & 6 \\
+\hline 13 & & 2012-08-28 & \href{https://github.com/ypid/typesetting/commit/7c80a541828c3e7896c7f55c8b56d745b84a5414}{added MyPackages} & 22 & 1162 & 2 \\
+\hline 14 & & 2012-08-28 & \href{https://github.com/ypid/typesetting/commit/b408bc9fa5f91ff5a7687fc4903d520ab09a288d}{added my Makefile} & 5 & 106 & 0 \\
+\hline 15 & & 2012-08-28 & \href{https://github.com/ypid/typesetting/commit/d86bd28e3f0d0e14d7eb239eb6ad9afab2da47c0}{added more scripts} & 4 & 1465 & 0 \\
+\hline 16 & & 2012-08-28 & \href{https://github.com/ypid/typesetting/commit/ab0554ce8d44852a76b7ad0246e04268b8347acb}{optimized} & 5 & 4 & 1459 \\
+\hline 17 & & 2012-08-31 & \href{https://github.com/ypid/typesetting/commit/75a5b9d653b2798a9cb8f10535f50abf98e94cd2}{optimized} & 7 & 52 & 31 \\
+\hline 18 & & 2012-09-09 & \href{https://github.com/ypid/typesetting/commit/2a99a061ae89f5bd6bd6ace4aac66ad9a768b0fc}{optimized} & 4 & 23 & 10 \\
+\hline 19 & & 2012-09-16 & \href{https://github.com/ypid/typesetting/commit/c2463e8229fbc506a70b4efb157679ecf3aae795}{optimized} & 6 & 10 & 7 \\
+\hline 20 & & 2012-09-23 & \href{https://github.com/ypid/typesetting/commit/1b6cb46337c516e3042d94956e7bf4f097822a47}{added more packages} & 9 & 491 & 12 \\
+\hline 21 & & 2012-09-23 & \href{https://github.com/ypid/typesetting/commit/92a41f208a275b6fcdfe9c442be8c135ec0d1c92}{added school templates} & 25 & 502 & 25 \\
+\hline 22 & & 2012-09-30 & \href{https://github.com/ypid/typesetting/commit/32e21641dff2ffd9fecfe33b93def53d6a305963}{added more templates} & 20 & 537 & 4 \\
+\hline 23 & & 2012-11-03 & \href{https://github.com/ypid/typesetting/commit/2309fa9dd41d0acaf74d6de66976f7ae6f1e7c6b}{rewrote LaTeX-git-log as perl script} & 2 & 63 & 61 \\
+\hline 24 & & 2012-11-03 & \href{https://github.com/ypid/typesetting/commit/773e5b801cfd2ad9a2af8c9d379dd0e2f9afd3cf}{optimized} & 2 & 5 & 4 \\
+\hline 25 & & 2012-11-28 & \href{https://github.com/ypid/typesetting/commit/4ffc0488959ada2a97ba50d5a7db1390afce4a26}{added more templates and optimized} & 12 & 141 & 3 \\
+\hline 26 & & 2013-04-04 & \href{https://github.com/ypid/typesetting/commit/dc3b091e5e8d68daa1c4b73ab96e7bc201a6ed08}{Updated templates.} & 17 & 92 & 55 \\
+\hline 27 & & 2013-04-04 & \href{https://github.com/ypid/typesetting/commit/457664094f33618c62348fe5a9798cc98117bcad}{Added macro for showing the github URL and optimized.} & 8 & 26 & 38 \\
+\hline 28 & & 2013-04-04 & \href{https://github.com/ypid/typesetting/commit/71547c919a2b36548e65320be8ce0d318b473523}{Optimized} & 3 & 36 & 0 \\
+\hline 29 & & 2013-04-20 & \href{https://github.com/ypid/typesetting/commit/3681cf7bc6d18878ca03af4009bdfc9e8835dbcd}{Optimized.} & 5 & 40 & 12 \\
+\hline 30 & & 2013-04-20 & \href{https://github.com/ypid/typesetting/commit/c0ef81a414620007d6f39fa95e59888045fa5cf0}{Optimized.} & 12 & 67 & 22 \\
+\hline 31 & & 2013-04-21 & \href{https://github.com/ypid/typesetting/commit/782b0e0e51773b02cf909600444da892c890b926}{Optimized.} & 4 & 30 & 13 \\
+\hline 32 & & 2013-05-22 & \href{https://github.com/ypid/typesetting/commit/f3048459117aa782b32324bd08ce77bfde325a62}{Optimized (mainly LaTeX-git-wdiff).} & 9 & 229 & 78 \\
+\hline 33 & & 2013-06-15 & \href{https://github.com/ypid/typesetting/commit/c5c45122518ad0e6cf9712dc248b26fd3eea4cf0}{Optimized.} & 3 & 15 & 12 \\
+\hline 34 & v1.0 & 2013-06-15 & \href{https://github.com/ypid/typesetting/commit/af3d63d88a8e37c45c4dc7c8b54ee55091f7ea80}{Made latex-git-log ready for CTAN.} & 6 & 482 & 199 \\
+\hline 35 & & 2013-06-15 & \href{https://github.com/ypid/typesetting/commit/489927feca92be10ddb5bde1b8fb11dae6b37bbb}{Optimized latex-git-log.} & 6 & 12 & 15 \\
+\hline 36 & & 2013-06-16 & \href{https://github.com/ypid/typesetting/commit/6d0ff0a6ae2baba715704f7dea23ebb0ac9ddc02}{Optimized.} & 3 & 106 & 79 \\
+\hline 37 & & 2013-06-16 & \href{https://github.com/ypid/typesetting/commit/ff9d61b343971ca964ca5e2708253abe3dad4dab}{Fixed layout.} & 1 & 9 & 5 \\
+\hline 38 & & 2013-06-16 & \href{https://github.com/ypid/typesetting/commit/2c128bf3eb4d734a11f3e7ebfdc93c01eafbd6f4}{Taking care about special charters in the commit message.} & 2 & 48 & 10 \\
+\hline 39 & & 2013-06-16 & \href{https://github.com/ypid/typesetting/commit/7b1683a671fe687ca58f895564341ee4c82a7f7d}{Fixed problem with escaped $\backslash$href.} & 1 & 10 & 3 \\
+\hline 40 & & 2013-06-16 & \href{https://github.com/ypid/typesetting/commit/6b25666f78ff276bbe161a0a7b659ad0c836aa22}{Made the script prettier with perltidy.} & 1 & 33 & 25 \\
+\hline 41 & & 2013-06-16 & \href{https://github.com/ypid/typesetting/commit/38698ff91b2253abddacd135e332d9ace5127122}{Also escape the author field.} & 3 & 10 & 10 \\
+\end{longtable}
diff --git a/Master/texmf-dist/doc/support/latex-git-log/example.pdf b/Master/texmf-dist/doc/support/latex-git-log/example.pdf
new file mode 100644
index 00000000000..54c9c6093e9
--- /dev/null
+++ b/Master/texmf-dist/doc/support/latex-git-log/example.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/latex-git-log/example.tex b/Master/texmf-dist/doc/support/latex-git-log/example.tex
new file mode 100644
index 00000000000..fec2a0e31ff
--- /dev/null
+++ b/Master/texmf-dist/doc/support/latex-git-log/example.tex
@@ -0,0 +1,17 @@
+\documentclass[12pt,a4paper,english,landscape]{scrartcl}
+
+\usepackage[utf8]{inputenc}
+\usepackage[T1]{fontenc}
+\usepackage{babel}
+\usepackage{longtable,hyperref}
+\newcommand{\longtableendfoot}{Please continue at the next page}
+
+\begin{document}
+\input{example-output}
+
+The example-output.tex was generated with this command:
+\begin{verbatim}
+ latex-git-log --width=13 --lang=en > example-output.tex
+\end{verbatim}
+
+\end{document}
diff --git a/Master/texmf-dist/doc/support/latex-git-log/po/de.po b/Master/texmf-dist/doc/support/latex-git-log/po/de.po
new file mode 100644
index 00000000000..c5ecd8937aa
--- /dev/null
+++ b/Master/texmf-dist/doc/support/latex-git-log/po/de.po
@@ -0,0 +1,57 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: latex-git-log\n"
+"Report-Msgid-Bugs-To: ypid23@aol.de\n"
+"POT-Creation-Date: 2013-06-15 18:43+0200\n"
+"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
+"Last-Translator: Robin Scheider <ypid23@aol.de>\n"
+"Language-Team: LANGUAGE <LL@li.org>\n"
+"Language: DE\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+
+msgid "acronym"
+msgstr "Abkürzung"
+
+msgid "meaning"
+msgstr "Bedeutung"
+
+msgid "version"
+msgstr "Version"
+
+msgid "V"
+msgid "V"
+
+msgid "tag"
+msgstr "Tag"
+
+msgid "MF"
+msgstr "DV"
+
+msgid "AL"
+msgstr "ZH"
+
+msgid "DL"
+msgstr "ZG"
+
+msgid "\\texttt{git tag}"
+msgstr "\\texttt{Markierung} einer Menge von Dateien, aus denen sich zu einem beliebigen Zeitpunkt eine bestimmte Version wiederherstellen lässt"
+
+msgid "Number of \\texttt{modified files}."
+msgstr "Wie viele \\texttt{Dateien} innerhalb dieser Version \\texttt{verändert} wurden"
+
+msgid "Number of \\texttt{added lines}."
+msgstr "Wie viele \\texttt{Zeilen} innerhalb dieser Version neu \\texttt{hinzugekommen} sind"
+
+msgid "Number of \\texttt{deleted lines}."
+msgstr "Wie viele \\texttt{Zeilen} innerhalb dieser Version \\texttt{gelöscht} wurden"
+
+msgid "author"
+msgstr "Autor"
+
+msgid "date"
+msgstr "Datum"
+
+msgid "commit message"
+msgstr "Versionsbericht"