summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/ctanbib/ctanbib-doc.tex
blob: 3a6c3a77ee682b78a2c68e28314b5f70ab5fb592 (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
\documentclass{ltxdoc}
\newcommand\package[1]{\texttt{#1}}
\usepackage{longtable}
\usepackage{tabularx}
\newenvironment{changelog}{\longtable{@{} l p{30em}}}{\endlongtable}
\newcommand\change[2]{#1 & #2\\}
\title{The \texttt{ctanbib} package}
\author{Michal Hoftich\\\url{michal.h21@gmail.com}}
\date{\gitdate, version \gitversion}
\usepackage{hyperref}
\usepackage{fontspec}
\setmainfont{TeX Gyre Schola}
\setmonofont[Scale=MatchLowercase]{Inconsolatazi4}
\usepackage{microtype}
\begin{document}
\maketitle

\section{Introduction}
This package provides script named \package{ctanbib} which can be used for retrieving of the bibliographic information for packages hosted on CTAN.

\section{Usage}


It can be used in the following way:


\noindent\package{ctanbib $\langle$packagename$\rangle$ > filename.bib}

\section{Example}

\begin{verbatim}
ctanbib latex  
\end{verbatim}

\noindent This invocation will print data in the Bib\LaTeX\ format to the standard output:

\begin{verbatim}
@manual{latex,
title = {The Latex package},
subtitle = {A TeX macro package that defines LaTeX},
author = {Lamport, Leslie and The LaTeX Team},
url = {http://www.latex-project.org/},
urldate = {2018-08-23}, 
date = {2018-04-01},
version = {PL 5}
}
\end{verbatim}

\section{License}

Permission is granted to copy, distribute and/or modify this software
under the terms of the LaTeX Project Public License, version 1.3.

\section{Acknowledgements}

This package was created thanks to TeX.sx user
Daniel\footnote{\url{https://tex.stackexchange.com/users/3751/daniel}}. Lukas
C. Bossert had useful comments which led to update of the original script and
it's eventual release on CTAN.

\section{Changelog}

\begin{changelog}
  \change{2018-08-23}{Version 0.1 released.}
  \change{2018-08-23}{Created documentation.}
  \change{2018-08-21}{Rewrote the script to use the DOM api provided by LuaXML. This provides greater flexibility in the XML processing.}
  \change{2018-08-20}{Fixed the script for the current XML format provided by CTAN.}
  \change{2014-09-12}{Initial version of the script have been released in answer on TeX.sx\footnote{\url{https://tex.stackexchange.com/a/200856/2891}}.}
\end{changelog}


\end{document}