summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/bxcalc
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-06-06 21:57:28 +0000
committerKarl Berry <karl@freefriends.org>2017-06-06 21:57:28 +0000
commit289116fcf3cec3b7fe8d462c6563c1c46ba9e13f (patch)
tree27eff31a0ff70f4e10e5a646dfbcc310c03dc8ee /Master/texmf-dist/doc/latex/bxcalc
parentd6136de4d8066d5be6ce0996a3e1ff0b01527f14 (diff)
bxcalc (22may17)
git-svn-id: svn://tug.org/texlive/trunk@44514 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/bxcalc')
-rw-r--r--Master/texmf-dist/doc/latex/bxcalc/LICENSE21
-rw-r--r--Master/texmf-dist/doc/latex/bxcalc/README-ja.md59
-rw-r--r--Master/texmf-dist/doc/latex/bxcalc/README.md61
-rw-r--r--Master/texmf-dist/doc/latex/bxcalc/bxcalcize.pdfbin0 -> 120279 bytes
-rw-r--r--Master/texmf-dist/doc/latex/bxcalc/bxcalcize.tex56
-rw-r--r--Master/texmf-dist/doc/latex/bxcalc/bxcalcux.pdfbin0 -> 169922 bytes
-rw-r--r--Master/texmf-dist/doc/latex/bxcalc/bxcalcux.tex86
-rw-r--r--Master/texmf-dist/doc/latex/bxcalc/sample-bxcalc.pdfbin0 -> 49697 bytes
-rw-r--r--Master/texmf-dist/doc/latex/bxcalc/sample-bxcalc.tex29
9 files changed, 312 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/latex/bxcalc/LICENSE b/Master/texmf-dist/doc/latex/bxcalc/LICENSE
new file mode 100644
index 00000000000..8ada757fbc8
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxcalc/LICENSE
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2017 Takayuki YATO (aka. "ZR")
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/Master/texmf-dist/doc/latex/bxcalc/README-ja.md b/Master/texmf-dist/doc/latex/bxcalc/README-ja.md
new file mode 100644
index 00000000000..66c8d4dceea
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxcalc/README-ja.md
@@ -0,0 +1,59 @@
+BXcalc パッケージ
+=================
+
+LaTeX: calc パッケージの機能を拡張する
+
+本パッケージバンドルは、以下のパッケージからなる:
+
+ * bxcalcize: calc 数式の適応範囲の拡大
+
+ * bxcalcux: 新しい長さ単位の追加
+
+この他に、このバンドルは bxcalc パッケージを含む。このパッケージは単に内部
+で上記のパッケージを一括して読み込む。
+
+### 前提環境
+
+ * フォーマット: LaTeX
+ * エンジン: 不問
+ - 一部の機能は e-TeX 拡張を必要とする。
+ * 依存パッケージ:
+ - calc
+
+### インストール
+
+ - `*.sty` → $TEXMF/tex/latex/BXcalc
+
+### ライセンス
+
+本パッケージは MIT ライセンスの下で配布される。
+
+bxcalc パッケージ ― 本体
+-------------------------
+
+本バンドルに含まれる他のパッケージを一括して読み込む。
+
+bxcalcize パッケージ ― calc 数式の適応範囲の拡大
+-------------------------------------------------
+
+LaTeX 標準命令中の長さ指定でこれまで calc パッケージの数式の使用が
+不可だった箇所を可能にする。
+
+詳細は解説文書 bxcalcize.pdf を参照。
+
+bxcalcux パッケージ ― 新しい長さ単位の追加
+-------------------------------------------
+
+ユーザが新しい長さ単位を定義して calc 数式で使えるようにする。
+
+詳細は解説文書 bxcalcux.pdf を参照。
+
+更新履歴
+--------
+
+ * Version 1.0 〈2017/05/21〉
+ - 本バンドルとしての最初の公開版。(元々は BXjatool の一部だった。)
+
+--------------------
+Takayuki YATO (aka. "ZR")
+https://github.com/zr-tex8r
diff --git a/Master/texmf-dist/doc/latex/bxcalc/README.md b/Master/texmf-dist/doc/latex/bxcalc/README.md
new file mode 100644
index 00000000000..5f2993abb43
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxcalc/README.md
@@ -0,0 +1,61 @@
+BXcalc Package
+==============
+
+LaTeX: To extend the functionality of the calc package
+
+This package bundle consists of the following packages:
+
+ * bxcalcize: To make calc expressions available in more places.
+
+ * bxcalcux: To add user-defined units to the calc syntax.
+
+In addition, this bundle provides the bxcalc package, which simply loads
+the above-mentioned packages internally.
+
+### System requirement
+
+ * TeX format: LaTeX.
+ * TeX engine: Anything.
+ - Some functions requires the e-TeX extension.
+ * Dependent packages:
+ - calc
+
+### Installation
+
+ - `*.sty` → $TEXMF/tex/latex/BXcalc
+
+### License
+
+This package is distributed under the MIT License.
+
+bxcalc package ― main
+----------------------
+
+This package simply loads all other packages in this bundle.
+
+bxcalcize package ― to make calc expressions available in more places
+----------------------------------------------------------------------
+
+Some standard LaTeX commands involving length specification do not allow
+the use of calc expressions. This package makes such uses possible.
+
+See the manual bxcalcize.pdf for detail.
+
+bxcalcux package ― to add user-defined units to the calc syntax
+----------------------------------------------------------------
+
+This package enables users to define new length units and use them in
+calc expressions.
+
+See the manual bxcalcux.pdf for detail.
+
+Revision History
+----------------
+
+ * Version 1.0 〈2017/05/21〉
+ - The first public version as this bundle, which has been seperated
+ from the old BXjatool bundle.
+
+--------------------
+Takayuki YATO (aka. "ZR")
+https://github.com/zr-tex8r
diff --git a/Master/texmf-dist/doc/latex/bxcalc/bxcalcize.pdf b/Master/texmf-dist/doc/latex/bxcalc/bxcalcize.pdf
new file mode 100644
index 00000000000..45f50a47045
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxcalc/bxcalcize.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/bxcalc/bxcalcize.tex b/Master/texmf-dist/doc/latex/bxcalc/bxcalcize.tex
new file mode 100644
index 00000000000..c8644da2980
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxcalc/bxcalcize.tex
@@ -0,0 +1,56 @@
+\documentclass[a4paper]{article}
+\usepackage[scale=0.75]{geometry}
+\usepackage{shortvrb}
+\MakeShortVerb{\|}
+\newcommand{\PkgVersion}{1.0}
+\newcommand{\PkgDate}{2017/05/21}
+\newcommand{\Pkg}[1]{\textsf{#1}}
+\newcommand{\Meta}[1]{$\langle$\textit{#1}$\rangle$}
+\newcommand{\Note}{\par\noindent \textbf{NB:}\quad}
+\newcommand{\Means}{~:\quad}
+\providecommand{\eTeX}{$\varepsilon$-{\TeX}}
+%-----------------------------------------------------------
+\begin{document}
+\title{The \Pkg{bxcalcize} package}
+\author{Takayuki YATO\quad (aka.~``ZR'')}
+\date{v\PkgVersion \quad[\PkgDate]}
+\maketitle
+
+%===========================================================
+\section{Overview}
+
+After loading \Pkg{calc}, most of the length specifications
+in {\LaTeX} become aware of that package--- i.e.\
+\Pkg{calc} expressions can be written in place of
+simple lengths.
+However some commands remain \Pkg{calc}-unaware; for example
+one cannot use expressions in the argument of |\hspace|.
+This package patches to the {\LaTeX} kernel and eliminates
+remaining \Pkg{calc}-unawareness
+(as far as I know).
+
+\paragraph{Supported format} \LaTeX.
+\paragraph{Supported engine} Any engine with {\eTeX} extensions.
+\paragraph{Prerequisite packages} \Pkg{calc} package.
+
+%===========================================================
+\section{Package Loading}
+
+Use |\usepackage| as usual, with no options.
+\begin{quote}\small\begin{verbatim}
+\usepackage{bxcalcize}
+\end{verbatim}\end{quote}
+
+%===========================================================
+\section{Usage}
+
+After loading the package, one can use \Pkg{calc} expressions
+in the following places:
+\begin{itemize}
+\item the sole argument of |\hspace|(|*|), |\vspace|(|*|),
+and |\addvspace|;
+\item the sole optional argument of |\\|.
+\end{itemize}
+
+%===========================================================
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/bxcalc/bxcalcux.pdf b/Master/texmf-dist/doc/latex/bxcalc/bxcalcux.pdf
new file mode 100644
index 00000000000..e4892f0e3be
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxcalc/bxcalcux.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/bxcalc/bxcalcux.tex b/Master/texmf-dist/doc/latex/bxcalc/bxcalcux.tex
new file mode 100644
index 00000000000..19eeda4a18d
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxcalc/bxcalcux.tex
@@ -0,0 +1,86 @@
+\documentclass[a4paper]{article}
+\usepackage[scale=0.75]{geometry}
+\usepackage{shortvrb}
+\MakeShortVerb{\|}
+\newcommand{\PkgVersion}{1.0}
+\newcommand{\PkgDate}{2017/05/21}
+\newcommand{\Pkg}[1]{\textsf{#1}}
+\newcommand{\Meta}[1]{$\langle$\textit{#1}$\rangle$}
+\newcommand{\Note}{\par\noindent \textbf{NB:}\quad}
+\newcommand{\Means}{~:\quad}
+\providecommand{\eTeX}{$\varepsilon$-{\TeX}}
+%-----------------------------------------------------------
+\begin{document}
+\title{The \Pkg{bxcalcux} package}
+\author{Takayuki YATO\quad (aka.~``ZR'')}
+\date{v\PkgVersion \quad[\PkgDate]}
+\maketitle
+
+%===========================================================
+\section{Overview}
+
+This package allows one to create a new unit of length
+that can be used in length expressions
+of the \Pkg{calc} package.
+For example,
+\begin{quote}\small\begin{verbatim}
+\newcalcunit{thou}{0.07227pt}% thousandth of inch
+\setlength{\lengthA}{10thou}
+\end{verbatim}\end{quote}
+will assign 0.72266\,pt to |\lengthA|.%
+\footnote{Using \texttt{0.001in} instead of
+\texttt{0.07227pt} will give rather inaccurate results,
+since \texttt{0.001in} is evaluated to 0.7277\,pt.}
+
+\paragraph{Supported format} \LaTeX.
+\paragraph{Supported engine} Any engine with {\eTeX} extension.
+\paragraph{Prerequisite packages}
+\Pkg{calc}, \Pkg{etoolbox}.
+
+%===========================================================
+\section{Package Loading}
+
+Use |\usepackage| as usual, with no options.
+\begin{quote}\small\begin{verbatim}
+\usepackage{bxcalcux}
+\end{verbatim}\end{quote}
+
+%===========================================================
+\section{Usage}
+
+\begin{itemize}
+\item |\newcalcunit{|\Meta{unit}|}{|\Meta{length}|}|\Means
+Declares a new unit \Meta{unit} as equal to \Meta{length}.
+The unit name must consist only of alphabets.
+You can use relative units such as |0.5em| in \Meta{length},
+and such relative units are resolved
+when \Pkg{calc} expressions are evaluated.
+
+\item |\DeclareCalcUnit{|\Meta{unit}|}{|\Meta{text}|}|\Means
+\textsl{(for {\TeX}nicians)}
+Declares a new unit \Meta{unit} as equal to the unit
+expressed by a token list \Meta{text},
+which must form a ``unit of dimen'' (in {\TeX} terminology).
+Here is an example.
+\begin{quote}\small\begin{verbatim}
+\DeclareCalcUnit{ls}{\baselineskip}% current line skip
+\end{verbatim}\end{quote}
+
+\end{itemize}
+
+%===========================================================
+\section{Notices}
+
+\begin{itemize}
+\item Usually unit names are treated as case-insensitive;
+but as exception, unit names with a single letter are
+case-sensitive.
+\item You must not create a unit name that coincides
+with a prefix of existing (built-in or created) units
+or any keywords that could be used in \Pkg{calc} expressions
+(such as |plus|, |fil|, etc.); otherwise unexpected
+things would occur.
+\end{itemize}
+
+%===========================================================
+\end{document}
diff --git a/Master/texmf-dist/doc/latex/bxcalc/sample-bxcalc.pdf b/Master/texmf-dist/doc/latex/bxcalc/sample-bxcalc.pdf
new file mode 100644
index 00000000000..bcfc5628a51
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxcalc/sample-bxcalc.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/bxcalc/sample-bxcalc.tex b/Master/texmf-dist/doc/latex/bxcalc/sample-bxcalc.tex
new file mode 100644
index 00000000000..48ed1487101
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxcalc/sample-bxcalc.tex
@@ -0,0 +1,29 @@
+\documentclass[a4paper]{article}
+\usepackage{bxcalc}
+% Declares new units
+\newcalcunit{ls}{\baselineskip}
+\newcalcunit{tm}{0.05em}
+%
+\title{Sample document of \textsf{bxcalc}}
+\author{ZR}
+\date{}
+\begin{document}
+\maketitle
+
+\section{Example 1}
+
+\noindent
+The quick brown fox\\[1ex-1ls]% so line skip is 1ex
+jump\hspace{6tm}s\hspace{12tm}ov\hspace{2tm}er\\[1ex-1ls]
+\hspace*{3tm}t\hspace{4tm}he\hspace{9tm}lazy\hspace{4tm}dog.
+
+\section{Example 2}
+
+\noindent
+AAAAAAAAAAAAAAAAAAAA\\[\heightof{A}-1ls+2tm]
+A\hspace{\widthof{A}*18}A\\[\heightof{A}-1ls+2tm]
+A\hspace{\widthof{A}*18}A\\[\heightof{A}-1ls+2tm]
+A\hspace{\widthof{A}*18}A\\[\heightof{A}-1ls+2tm]
+AAAAAAAAAAAAAAAAAAAA
+
+\end{document}