summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/texplate
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-02-02 22:30:34 +0000
committerKarl Berry <karl@freefriends.org>2020-02-02 22:30:34 +0000
commitdcd5707512610f13d8c26713c40b390010aac13b (patch)
treef3854e7e5df178ba3e689bc31e360ddce813a5d0 /Master/texmf-dist/doc/support/texplate
parent351e05dfb6e0abb819336efc60cd93ac1c478c1e (diff)
texplate (2feb20)
git-svn-id: svn://tug.org/texlive/trunk@53637 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/texplate')
-rw-r--r--Master/texmf-dist/doc/support/texplate/README.md8
-rw-r--r--Master/texmf-dist/doc/support/texplate/texplate-manual.pdfbin103717 -> 104886 bytes
-rw-r--r--Master/texmf-dist/doc/support/texplate/texplate-manual.tex44
3 files changed, 44 insertions, 8 deletions
diff --git a/Master/texmf-dist/doc/support/texplate/README.md b/Master/texmf-dist/doc/support/texplate/README.md
index 7fea81da09e..7428b21519f 100644
--- a/Master/texmf-dist/doc/support/texplate/README.md
+++ b/Master/texmf-dist/doc/support/texplate/README.md
@@ -1,6 +1,8 @@
# TeXplate
-![Language: Kotlin](https://img.shields.io/badge/Language-Kotlin-blue.svg?style=flat-square) ![Minimum JRE: 8.0](https://img.shields.io/badge/Minimum_JRE-8.0-blue.svg?style=flat-square) ![Current version: 1.0.1](https://img.shields.io/badge/Current_version-1.0.1-blue.svg?style=flat-square)
+![Language: Kotlin](https://img.shields.io/badge/Language-Kotlin-blue.svg?style=flat-square)
+![Minimum JRE: 8.0](https://img.shields.io/badge/Minimum_JRE-8.0-blue.svg?style=flat-square)
+![Current version](https://img.shields.io/badge/dynamic/json.svg?color=blue&label=Latest%20release&query=%24.0.name&url=https%3A%2F%2Fgitlab.com%2Fapi%2Fv4%2Fprojects%2F13793875%2Frepository%2Ftags&style=flat-square)
TeXplate is a tool for creating document structures based on templates. The application name is a word play on _TeX_ and _template_, so the purpose seems quite obvious: we want to provide an easy and straightforward framework for reducing the typical code boilerplate when writing TeX documents. Also note that one can easily extrapolate the use beyond articles and theses: the application is powerful enough to generate _any_ text-based structure, given that a corresponding template exists.
@@ -20,7 +22,7 @@ $ texplate
\ \_\
\/_/
-TeXplate 1.0.1, a document structure creation tool
+TeXplate 1.0.2, a document structure creation tool
Copyright (c) 2020, Island of TeX
All rights reserved.
@@ -83,7 +85,7 @@ $ texplate -t article -o doc1.tex
\ \_\
\/_/
-TeXplate 1.0.1, a document structure creation tool
+TeXplate 1.0.2, a document structure creation tool
Copyright (c) 2020, Island of TeX
All rights reserved.
diff --git a/Master/texmf-dist/doc/support/texplate/texplate-manual.pdf b/Master/texmf-dist/doc/support/texplate/texplate-manual.pdf
index 98d06b0ca4e..19afbe5c8f5 100644
--- a/Master/texmf-dist/doc/support/texplate/texplate-manual.pdf
+++ b/Master/texmf-dist/doc/support/texplate/texplate-manual.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/texplate/texplate-manual.tex b/Master/texmf-dist/doc/support/texplate/texplate-manual.tex
index 6fe19fb5e40..56dbe5e5f3c 100644
--- a/Master/texmf-dist/doc/support/texplate/texplate-manual.tex
+++ b/Master/texmf-dist/doc/support/texplate/texplate-manual.tex
@@ -17,7 +17,7 @@
\newcommand{\shortopt}[1]{{\ttfamily-#1}}
\newcommand{\longopt}[1]{{\ttfamily{-}{-}#1}}
\newcommand{\macro}[1]{{\ttfamily\textbackslash#1}}
-\newcommand{\texplateversion}{1.0.1}
+\newcommand{\texplateversion}{1.0.2}
\title{A gentle introduction to \texplate:\\ a document structure creation tool}
\author{Island of \TeX}
@@ -242,7 +242,7 @@ For starters, a template has an identifier, a name that logically represents the
Observe that \texplate's lookup system is case-sensitive, so make sure to always reference the correct name.
\end{disclaimer}
-Although there are no hard limitations on a template name, it is advisable to keep it short and concise, with no spaces whatsoever\footnote{Another Carlislean statement would remind us that people that put spaces in their file names deserve no sympathy. At all.}. As a consequence, potential issues with extended characters in the Unicode range and command line escaping are avoided, and thus our beloved tool might just work as expected.
+Although there are no hard limitations on a template name, it is advisable to keep it short and concise, with no spaces whatsoever\footnote{Another Carlislean statement would remind us that people who put spaces in their file names deserve no sympathy. At all.}. As a consequence, potential issues with extended characters in the Unicode range and command line escaping are avoided, and thus our beloved tool might just work as expected.
\section{Directory lookup}
\label{sec:directorylookup}
@@ -252,7 +252,7 @@ Although there are no hard limitations on a template name, it is advisable to ke
\begin{enumerate}
\item\inline{\textasciitilde/.texplate/templates} which refers to a path structure from the user home directory.
-\item\inline{<APP>/templates} which refers to a path structure from the application directory (with \inline{<APP>} denoting the location where \texplate\ is installed).
+\item The application's resources which refers to a files within the JAR file. You can use a ZIP viewer to look at the templates there.
\end{enumerate}
For instance, as a means to illustrate the concept of directory lookup, consider the following command line command:
@@ -396,7 +396,7 @@ The output (i.e., the template merged with the provided data) will be written to
\item When running \texplate, this is the expected output to be displayed in the command line (note that the layout is slightly modified due to space constraints in this user manual):
\begin{code}
-TeXplate 1.0.1, a document structure creation tool
+TeXplate 1.0.2, a document structure creation tool
Copyright (c) 2020, Island of TeX
All rights reserved.
@@ -597,8 +597,42 @@ gitlab.com/islandoftex/texplate
Happy \TeX ing with \texplate!
-\section*{License}
+\chapter*{License}
\texplate\ is licensed under the New BSD License. Please note that the New BSD License has been verified as a GPL-compatible free software license by the Free Software Foundation, and has been vetted as an open source license by the Open Source Initiative.
+\chapter*{Changelog}
+
+\section*{1.0.2 (current)}
+
+\subsection*{Fixed}
+
+\begin{itemize}
+\item \texplate\ now finds its templates even on Windows.
+\end{itemize}
+
+\subsection*{Changed}
+
+\begin{itemize}
+\item \texplate\ now finishes its transition to Kotlin. We did not change any functionality in the course of this change.
+\item Templates are now provided as resources from the JAR instead of a separate folder on the hard drive.
+\end{itemize}
+
+\section*{1.0.1 (2020-01-17)}
+
+\subsection*{Changed}
+
+\begin{itemize}
+\item \texplate\ will now distribute only non-generic template file names. In the system's template directory, we search for \inline{texplate-<name>.toml} as well.
+\end{itemize}
+
+\section*{1.0.0 (2020-01-15)}
+
+\subsection*{Added}
+
+\begin{itemize}
+\item Base functionality and default templates.
+\item User manual.
+\end{itemize}
+
\end{document}