diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/ctanbib |
Initial commit
Diffstat (limited to 'support/ctanbib')
-rw-r--r-- | support/ctanbib/README.md | 25 | ||||
-rwxr-xr-x | support/ctanbib/ctanbib | 169 | ||||
-rw-r--r-- | support/ctanbib/ctanbib-doc.pdf | bin | 0 -> 34395 bytes | |||
-rw-r--r-- | support/ctanbib/ctanbib-doc.tex | 118 | ||||
-rw-r--r-- | support/ctanbib/ctanbib.1 | 72 |
5 files changed, 384 insertions, 0 deletions
diff --git a/support/ctanbib/README.md b/support/ctanbib/README.md new file mode 100644 index 0000000000..edd016e561 --- /dev/null +++ b/support/ctanbib/README.md @@ -0,0 +1,25 @@ +# The `ctanbib` package + +This script can generate BibTeX records for LaTeX packages hosted on CTAN. + + +## Usage + + ctanbib graphicx + +More details can be found on [TeX.sx](https://tex.stackexchange.com/a/200856/2891) + + +Copyright: 2018 Michal Hoftich + +This work may be distributed and/or modified under the +conditions of the LaTeX Project Public License, either version 1.3 +of this license or (at your option) any later version. +The latest version of this license is in + http://www.latex-project.org/lppl.txt +and version 1.3 or later is part of all distributions of LaTeX +version 2005/12/01 or later. + +This work has the LPPL maintenance status `maintained'. + +The Current Maintainer of this work is Michal Hoftich. diff --git a/support/ctanbib/ctanbib b/support/ctanbib/ctanbib new file mode 100755 index 0000000000..10666696b5 --- /dev/null +++ b/support/ctanbib/ctanbib @@ -0,0 +1,169 @@ +#!/usr/bin/env texlua +kpse.set_program_name("luatex") +-- ctanbib -- export ctan entries to bib format +-- Copyright: Michal Hoftich <michal.h21@gmail.com> (2014-2018) +-- +-- This work may be distributed and/or modified under the +-- conditions of the LaTeX Project Public License, either version 1.3 +-- of this license or (at your option) any later version. +-- The latest version of this license is in +-- http://www.latex-project.org/lppl.txt +-- and version 1.3 or later is part of all distributions of LaTeX +-- version 2005/12/01 or later. +-- +-- This work has the LPPL maintenance status `maintained'. +-- +-- The Current Maintainer of this work is Michal Hoftich + +local bibtype = "manual" +if #arg < 1 or arg[1]=="--help" or arg[1]=="-h" then + print([[ctanbib - convert ctan package information to bibtex format +Usage: +ctanbib [options] <package name> +Available options: + -c,--ctan Use @ctan type instead of @manual + -h,--help Print this message + -v,--version Print version info + ]]) + os.exit(1) +elseif arg[1]=="--version" or arg[1]=="-v" then + print "ctanbib version v0.1c" + os.exit(1) +elseif arg[1]=="--ctan" or arg[1]=="-c" then + table.remove(arg, 1) + bibtype = "ctan" +end + +local pkgname = arg[1] +local url = "https://www.ctan.org/xml/pkg/" .. pkgname + +-- change that for different title scheme +local titleformat = "The %s package" + +local bibtexformat = [[ +@manual{$package, +title = {$title}, +subtitle = {$subtitle}, +author = {$author}, +url = {$url}, +urldate = {$urldate}, +date = {$date}, +version = {$version} +} +]] + +local dom = require('luaxml-domobject') + + +local load_xml = function(url) + -- local command = io.popen("wget -qO- ".. url,"r") + local command = io.popen("curl -sS ".. url,"r") + + local info = command:read("*all") + command:close() + + if string.len(info) == 0 then + return false + end + return dom.parse(info) +end + +local bibtex_escape = function(a) + local a = a or "" + return a:gsub("([%$%{%}%\\])", function(x) + if x == "\\" then return "\\textbackslash " end + return '\\'..x + end) +end + +local get_authors = function(a) + local retrieved_authors = {} + for _, author in ipairs(a) do + local current = {} + current[#current+1] = author:get_attribute("familyname") + current[#current+1] = author:get_attribute("givenname") + -- the author is an organization + if #current == 1 then + table.insert(retrieved_authors, "{" .. current[1] .. "}") + else + table.insert(retrieved_authors, table.concat(current, ", ")) + end + end + return table.concat(retrieved_authors," and ") +end + +local get_title = function(record) + local title = record:query_selector("name")[1] + if title then + title = title:get_text() + title = title:gsub("^(.)", function(a) return unicode.utf8.upper(a) end) + else + title = pkgname + end + return string.format(titleformat, bibtex_escape(title)) +end + + +local get_url = function(record) + local home = record:query_selector("home")[1] + if home then return home:get_attribute("href") end + return "http://www.ctan.org/pkg/"..pkgname +end + +local get_caption = function(record) + local caption = record:query_selector("caption")[1] + if caption then return bibtex_escape(caption:get_text()) end + return nil +end + +local get_version = function(record) + local version = record:query_selector("version")[1] + if version then + return version:get_attribute("number"), version:get_attribute("date") + end +end + +local ctan_url = function(record) + local ctan = record:query_selector("ctan")[1] + -- some package don't contain the CTAN path + if not ctan then return get_url(record) end + local path = ctan:get_attribute("path") + return path +end + + +local compile = function(template, records) + return template:gsub("$([a-z]+)", function(a) + return records[a] or "" + end) +end + +local record = load_xml(url) + +if not record then + print("Cannot find entry for package "..pkgname) + os.exit(1) +end + +-- root element is also saved, so we use this trick +-- local record = entry.entry + +local e = {} + +e.author = get_authors(record:query_selector("authorref")) +e.package = pkgname +e.title = get_title(record) +e.subtitle = get_caption(record) +e.url = get_url(record) +-- use the CTAN path as url for the CTAN type +if bibtype == "ctan" then + e.url = ctan_url(record) +end +e.version, e.date = get_version(record) +e.urldate = os.date("%Y-%m-%d") + +local result = compile(bibtexformat, e) +-- update the bibliography type +result = result:gsub("^@manual", "@" .. bibtype) + +print(result) diff --git a/support/ctanbib/ctanbib-doc.pdf b/support/ctanbib/ctanbib-doc.pdf Binary files differnew file mode 100644 index 0000000000..f82b9bba95 --- /dev/null +++ b/support/ctanbib/ctanbib-doc.pdf diff --git a/support/ctanbib/ctanbib-doc.tex b/support/ctanbib/ctanbib-doc.tex new file mode 100644 index 0000000000..23a6525fd9 --- /dev/null +++ b/support/ctanbib/ctanbib-doc.tex @@ -0,0 +1,118 @@ +\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 [options] $\langle$packagename$\rangle$ > filename.bib} + +The \texttt{curl} utility needs to be installed on the user's system in order to support the package info download. + + +\section{Available options} + +\begin{description} + \item[-c,-\/-ctan] use the \texttt{@ctan} type instead of \texttt{@manual}. + The difference between the two is that the url field contains packages CTAN + path, instead of a link to the package. + \item[-h,-\/-help] print the help message. + \item[-v,-\/-version] print the version info. +\end{description} + + +\section{Examples} + +\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} + +The \texttt{--ctan} option: + +\begin{verbatim} +ctanbib -c hyperref +\end{verbatim} + +\noindent This produces a bib record with the \texttt{@ctan} type: + +\begin{verbatim} +@ctan{hyperref, +title = {The Hyperref package}, +subtitle = {Extensive support for hypertext in LaTeX}, +author = {Rahtz, Sebastian and Oberdiek, Heiko}, +url = {/macros/latex/contrib/hyperref}, +urldate = {2018-08-27}, +date = {}, +version = {6.86b} +} +\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. + +\newpage +\section{Changelog} + +\begin{changelog} + \change{2019-05-04}{Version 0.1c released} + \change{2019-05-04}{Use the \texttt{curl} command to download the package info} + \change{2019-05-04}{Added information about the need to have the \texttt{curl} command installed} + \change{2019-03-11}{Version 0.1b released} + \change{2018-09-10}{Added support for institutional names} + \change{2018-09-10}{Escape TeX commands in the title and subtitle} + \change{2018-08-29}{Added man page} + \change{2018-08-27}{Added --ctan option} + \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} diff --git a/support/ctanbib/ctanbib.1 b/support/ctanbib/ctanbib.1 new file mode 100644 index 0000000000..baa40b1190 --- /dev/null +++ b/support/ctanbib/ctanbib.1 @@ -0,0 +1,72 @@ +.\" Manpage for ctanbib. +.\" Contact michal.h21@gmail.com to correct errors or typos. +.TH ctanbib 1 "28 aug 2018" "0.1" "ctanbib man page" +.SH NAME +ctanbib +\- retrieve bibliographic information for packages hosted on CTAN. +.SH SYNOPSIS +ctanbib <options> [package name] +.SH DESCRIPTION +This command can retrieve bibliographic information for TeX packages hosted on +CTAN in the BibTeX format. +.SH OPTIONS +.IP -c,--ctan +use @ctan type instead of @manual. The difference between the two is that the +url field contains package CTAN path, instead of link to the package. +.IP -h,--help +print the help message. +.IP -v,--version +print the version info. +.SH EXAMPLES + +$ ctanbib latex + +.Pp +This invocation will print data in the BibLaTeX format to the standard output: + +.nf +.ft CW +@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} +} +.ft R +.fi + +.Pp +The --ctan option: + +$ ctanbib -c hyperref + +.Pp +This produces bib record with the @ctan type: + +.nf +.ft CW +@ctan{hyperref, +title = {The Hyperref package}, +subtitle = {Extensive support for hypertext in LaTeX}, +author = {Rahtz, Sebastian and Oberdiek, Heiko}, +url = {/macros/latex/contrib/hyperref}, +urldate = {2018-08-27}, +date = {}, +version = {6.86b} +} +.ft R +.fi + +.SH See also +See ctanbib-doc.pdf for more details +.SH BUGS +No known bugs. +.SH AUTHOR +Michal Hoftich (michal.h21@gmail.com) +.SH LICENSE +Permission is granted to copy, distribute and/or modify this software +under the terms of the LaTeX Project Public License, version 1.3. + |