summaryrefslogtreecommitdiff
path: root/support/zblbuild/zblbuild.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/zblbuild/zblbuild.tex
Initial commit
Diffstat (limited to 'support/zblbuild/zblbuild.tex')
-rw-r--r--support/zblbuild/zblbuild.tex116
1 files changed, 116 insertions, 0 deletions
diff --git a/support/zblbuild/zblbuild.tex b/support/zblbuild/zblbuild.tex
new file mode 100644
index 0000000000..39de2e3e88
--- /dev/null
+++ b/support/zblbuild/zblbuild.tex
@@ -0,0 +1,116 @@
+% Documentation for zblbuild
+% Guido Milanese - guido.milanese@unicatt.it
+% Version 0.1c -- 2019.08.28
+%
+\documentclass[a4paper,12pt,british]{article}
+\usepackage[T1]{fontenc}
+\usepackage[utf8]{inputenc}
+\usepackage{url}
+\renewcommand{\UrlFont}{\footnotesize\tt}
+\usepackage{babel}
+\usepackage{graphicx}
+\usepackage[osf]{libertine}
+\usepackage{beramono}[scaled=0.8]
+\begin{document}
+\title{The zblbuild utility\\
+Version 0.1c}
+\author{Guido Milanese <\url{guido.milanese@unicatt.it}>}
+\date{28th August 2019}
+\maketitle
+\thispagestyle{empty}
+%
+\begin{abstract}
+\noindent{}Zblbuild is a shell + GUI script designed to make the
+choice of Biblatex styles and options easier. The script generates either a
+LaTeX or a Markdown - YAML snippet. The script has been tested only
+on a Linux platform, but should work on any platform running bash + zenity.
+\end{abstract}%
+%\tableofcontents{}
+%
+\section{Dependencies}
+The programme requires a bash shell and \textsf{zenity} version 3.xx.
+\textsf{Zenity} is a GTK+ lightweight tool -- standard in most Linux
+distributions -- that outputs message windows, error windows and the like. See \url{https://help.gnome.org/users/zenity/stable/}.
+%
+\section{Installation}
+From a terminal:
+ \begin{enumerate}
+ \setlength\itemsep{-0.5em}
+ \item download zblbuild-01c.zip
+ \item cd to the Downloads folder
+ \item \texttt{unzip zblbuild-01c.zip}
+ \item \texttt{cd zblbuild-01c}
+ \item \texttt{sudo ./install} -- enter your username when required
+ \item run the script from the desktop icon or from the command line
+ \end{enumerate}
+If wished, edit the paths in the \textsf{install} file and run
+\texttt{install}, or manually copy the files to your preferred locations.
+%If you prefer the same operations can be performed from a GUI:
+% \begin{enumerate}
+ % \setlength\itemsep{-0.5em}
+ % \item download \textsf{zblbuild.zip}
+ % \item Open the \textsf{Downloads} folder
+ % \item click on \textsf{zblbuild.zip}
+ % \item click on the \textsf{zblbuild} folder
+ % \item click on \textsf{install} -- enter password when required.
+ % \item run the script from the desktop icon or from the command line
+% \end{enumerate}
+%
+\section{Usage}\label{sec:usage}
+Simply run the program. At the end, copy and paste the output to your
+\LaTeX{} or Markdown file.
+%
+\section{Uninstallation}
+Run \textsf{unistall} script: \texttt{sudo ./uninstall} -- enter your username when required
+%
+\section{Bugs and TODO}
+List of features that I would like to add:
+\begin{enumerate}
+ \setlength\itemsep{-0.5em}
+\item A Windows version, if requested by users.
+\item Complete the script with more choices.
+\end{enumerate}
+%
+%
+\section{History}
+\begin{tabular}{l l p{8cm}}
+2019.08.28 & 0.1c\\
+ & Added Markdown -- YAML choice\\
+ & install and README rewritten\\
+ & Added uninstall\\
+ & typos and inaccuracies in the documentation fixed\\
+2019.08.16 & 0.1b\\
+ & added author-title in general choice\\
+ & References to philosophy manual updated\\
+2015.10.16 & 0.1a\\
+ & Added editionformat=superscript (philosophy-verbose)\\
+ & Minor improvements (e.g. English wording)\\
+ & New license: LPPL\\
+2015.09.20 & 0.1\\
+ & First usable version.
+\end{tabular}
+%
+\section{Author, copyright, license, disclaimer}
+\sffamily%
+ Copyright (C) 2019 Guido Milanese <guido.milanese@unicatt.it>
+
+ License: LaTeX Project Public License (LPPL 1.3c)
+
+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
+%
+\begin{quote}
+ \url{http://www.latex-project.org/lppl.txt}
+\end{quote}
+%
+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 Guido Milanese.
+
+This work consists of the files bibtex\_icon.png, install, README, unistall, zblbuild, zblbuild.desktop,
+zblbuild.pdf, zblbuild.tex.
+\end{document}
+