ahilbig/gitfile-info
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Dokumentation verschönert

Browse Source
This commit is contained in:
André Hilbig 2016-06-27 11:53:01 +02:00
parent 4c8616c309
commit 1cd06f4b7c
2 changed files with 8 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
dokumentation.tex
View File

@ -364,8 +364,7 @@ pdftitle = {\LaTeX-package for reading git commit info for specific files}
Im Hauptdokument werden die Metadaten automatisch beim Beginn geladen. Sofern eine weitere Datei
per \wM{include} oder \wM{input} geladen werden sollen, müssen dafür die Befehle
|\gfiInclude|\marg{Datei} bzw. |\gfiInput|\marg{Datei}
|\gfiInclude|\marg{Datei} bzw. |\gfiInput|\marg{Datei}\\
genutzt werden. Die Endung der Datei sollte dabei \textbf{nicht} mit angegeben werden. Intern
werden die jeweiligen Befehle zum Laden einer weiteren Datei entsprechend genutzt. Außerdem wird
die zugehörige Hilfsdatei eingebunden, um die notwendigen Metadaten zu erhalten. Nachdem die
@ -384,24 +383,20 @@ pdftitle = {\LaTeX-package for reading git commit info for specific files}
\TeX-Datei und enthält passende Aufrufe des \wM{gfiSet*}-Makros.
\DescribeMacro{\gfiSetDate}
|\gfiSetDate|\marg{Tag}\marg{Monat}\marg{Jahr}\marg{Stunde}\marg{Minute}\marg{Lokalisierte
Langfassung}
|\gfiSetDate|\marg{Tag}\marg{Monat}\marg{Jahr}\\
\hspace*{5em}\marg{Stunde}\marg{Minute}\marg{Lokalisierte Langfassung}\\
Tag, Monat, Stunde und Minute sind jeweils als zweistellige Ziffern einzulesen. Das Jahr wird
als vierstellige Ziffer eingelesen und in der Langassung kann beliebiger Text stehen, der
einer durch die Scripte lokalisierten Version entspricht. Entsprechend werden dadurch die
\wM{gfiGet*}-Makros definiert. \wM{gfiGetDate} entspricht der Langfassung.
\DescribeMacro{\gfiSetAuthor}
|\gfiSetAuthor|\marg{Name}\marg{E-Mail}
|\gfiSetAuthor|\marg{Name}\marg{E-Mail}\\
Name und E-Mail sollten die zugehörigen Daten enthalten und werden mit den \wM{gfiGet*}-Makros
verknüpft.
\DescribeMacro{\gfiSetCommit}
|\gfiSetCommit|\marg{Hash}\marg{Hash-Abr}
|\gfiSetCommit|\marg{Hash}\marg{Hash-Abr}\\
Die volle Fassung des Commits wird im Hash, die kurze Version im Hash-Abr eingegeben und
entsprechend mit \wM{gfiGet*} verknüpft.
@ -451,7 +446,6 @@ pdftitle = {\LaTeX-package for reading git commit info for specific files}
\lstinputlisting[language=python,title=Quelltext von post-merge]{post-merge}
\clearpage
\addcontentsline{toc}{section}{Literatur}
\printbibliography
\printbibliography[title=Weiterführende Quellen]
\end{document}