summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/bxorigcapt
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2022-04-17 20:01:37 +0000
committerKarl Berry <karl@freefriends.org>2022-04-17 20:01:37 +0000
commit6d094cfbee914369cd4e980a6b47763c13d1cd5e (patch)
treeeedace725eae6ee4a3d3e8cc2b5154c7a3b52ccc /Master/texmf-dist/doc/latex/bxorigcapt
parent69562d9c7c80d271d23091ad9994e1a658f73b0b (diff)
bxorigcapt (17apr22)
git-svn-id: svn://tug.org/texlive/trunk@63058 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/bxorigcapt')
-rw-r--r--Master/texmf-dist/doc/latex/bxorigcapt/README.md56
-rw-r--r--Master/texmf-dist/doc/latex/bxorigcapt/bxorigcapt.pdfbin0 -> 256321 bytes
-rw-r--r--Master/texmf-dist/doc/latex/bxorigcapt/bxorigcapt.tex112
3 files changed, 122 insertions, 46 deletions
diff --git a/Master/texmf-dist/doc/latex/bxorigcapt/README.md b/Master/texmf-dist/doc/latex/bxorigcapt/README.md
index 577af79fa96..a17c825fadb 100644
--- a/Master/texmf-dist/doc/latex/bxorigcapt/README.md
+++ b/Master/texmf-dist/doc/latex/bxorigcapt/README.md
@@ -12,9 +12,10 @@ Starting from version 0.3, this package also supports Polyglossia.
### System requirement
* TeX format: LaTeX.
- * TeX engine: Anything.
+ * TeX engine: Any engine with e-TeX extension.
* Dependent packages:
- babel or polyglossia
+ - etoolbox v2.1+
### Installation
@@ -24,59 +25,22 @@ Starting from version 0.3, this package also supports Polyglossia.
This package is distributed under the MIT License.
+
The bxorigcapt Package
----------------------
-### Introduction
-
-Suppose you have designed a document class tailored for the Esperanto
-language. The class has the following definition of caption names and you
-like it:
-
- \newcommand\contentsname{Tabelo de Enhavo}
-
-If a document is written solely in Esperanto, then there is no need to
-employ the Babel package. (Yes, the document class should select the
-hyphenation rule for the language.) However, when you want to create
-document that contains Esperanto and German, then you have to utilize
-Babel, to have correct hyphenations for both languages.
-
- \usepackage[ngerman,esperanto]{babel}
-
-But unfortunately, this changes `\contentsname` from “Tabelo de Enhavo”
-(what you have chosen) to “Enhavo” (what is declared in the language
-definition file of Babel), which is unfavorable.
-
-In fact, when using a document class for a specific language, the most
-suitable caption names *for that language* should be the ones provided by
-the class. The bxorigcapt package realizes this natual request, that is,
-it enables you to make the caption names declared in the current document
-class treated as the caption names for a specific language.
-
-### Package Loading
-
- \usepackage[<option>,...]{bxorigcapt}
-
-Available options are:
-
- - a Babel language name: Specifies the target language. The default
- target language is the main language of Babel.
- - `warn`: Issues a warning (instead of an info) if Babel is never
- loaded in the preamble.
-
-### Usage
-
-Once this package is loaded, the caption names provided by the document
-class (actually the ones that are effective when this package is loaded)
-will be used as the caption names for the target language (which is
-specified by the package option).
-
-This package has no public commands.
+See the manual bxorigcapt.pdf for detail.
Revision History
----------------
+ * Version 1.0 〈2022/04/10〉
+ - Now e-TeX and etoolbox are required.
+ - Add option `main`.
+ * Version 0.4a 〈2022/04/08〉
+ - Add option `nowarn`.
+ - Bug fix.
* Version 0.4 〈2022/03/12〉
- Adjustment for new version of Babel.
- Add option `warn`.
diff --git a/Master/texmf-dist/doc/latex/bxorigcapt/bxorigcapt.pdf b/Master/texmf-dist/doc/latex/bxorigcapt/bxorigcapt.pdf
new file mode 100644
index 00000000000..8206ebbd695
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxorigcapt/bxorigcapt.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/bxorigcapt/bxorigcapt.tex b/Master/texmf-dist/doc/latex/bxorigcapt/bxorigcapt.tex
new file mode 100644
index 00000000000..83dffe4c8a3
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/bxorigcapt/bxorigcapt.tex
@@ -0,0 +1,112 @@
+\documentclass[a4paper]{article}
+\usepackage[scale=0.75]{geometry}
+\usepackage[T1]{fontenc}
+\usepackage{lmodern,textcomp}
+\usepackage{color}
+\definecolor{myblue}{rgb}{0,0,0.75}
+\definecolor{mygreen}{rgb}{0,0.45,0}
+\usepackage[colorlinks]{hyperref}
+\hypersetup{linkcolor=myblue,urlcolor=mygreen,
+ pdftitle={The bxorigcapt package},
+ pdfauthor={Takayuki YATO}}
+\usepackage{bxtexlogo}
+\bxtexlogoimport{*}
+\usepackage{shortvrb}
+\MakeShortVerb{\|}
+\newcommand{\PkgVersion}{1.0}
+\newcommand{\PkgDate}{2022/04/10}
+\newcommand{\Pkg}[1]{\textsf{#1}}
+\newcommand{\Meta}[1]{$\langle$#1$\rangle$}
+\newcommand{\Note}{\par\noindent\emph{Note.}}
+\newcommand{\Means}{:\quad}
+%-----------------------------------------------------------
+\begin{document}
+\title{The \Pkg{bxorigcapt} package}
+\author{Takayuki YATO\quad (aka.~``ZR'')}
+\date{v\PkgVersion\quad[\PkgDate]}
+\maketitle
+%\tableofcontents
+\begin{abstract}
+This package forces the caption names (|\chaptername|, |\today|, etc.)\ %
+declared by the document class in use to be used as the caption names
+for a specific language introduced by the Babel package.
+
+Starting from version 0.3, this package also supports Polyglossia.
+\end{abstract}
+
+%===========================================================
+\section{Introduction}
+\label{sec:Introduction}
+
+Suppose you have designed a document class
+tailored for the Esperanto language.
+The class has the following definition of caption names
+and you like it:
+\begin{quote}
+|\newcommand\contentsname{Tabelo de Enhavo}|
+\end{quote}
+
+If a document is written solely in Esperanto,
+then there is no need to employ the Babel package.
+(Yes, the document class should select the hyphenation rule
+for the language.)
+However, when you want to create document
+that contains Esperanto and German,
+then you have to utilize Babel,
+to have correct hyphenations for both languages.
+\begin{quote}
+|\usepackage[ngerman,esperanto]{babel}|
+\end{quote}
+
+But unfortunately, this changes |\contentsname|
+from ``Tabelo de Enhavo'' (what you have chosen)
+to ``Enhavo''
+(what is declared in the language definition file of Babel),
+which is unfavorable.
+
+In fact, when using a document class for a specific language,
+the most suitable caption names \emph{for that language}
+should be the ones provided by the class.
+The \Pkg{bxorigcapt} package realizes this natural request,
+that is, it enables you
+to make the caption names declared in the current document class
+treated as the caption names for a specific language.
+
+
+%===========================================================
+\section{Package Loading}
+\label{sec:Package-Loading}
+
+\begin{quote}
+|\usepackage[|\Meta{option}|,...]{bxorigcapt}|
+\end{quote}
+
+Available options are:
+\begin{itemize}
+\item |main| (default)\Means
+ Sets the main language of Babel to the default target language.
+\item \emph{a Babel language name}\Means
+ Specifies the target language.
+\item |warn|\Means
+ Issues a warning (instead of an info)
+ if Babel is never loaded in the preamble.
+\item |nowarn| (default)\Means
+ Negation of |warn|.
+\end{itemize}
+
+
+%===========================================================
+\section{Usage}
+\label{sec:Usage}
+
+Once this package is loaded,
+the caption names provided by the document class
+(actually the ones that are effective when this package is loaded)
+will be used as the caption names for the target language
+(which is specified by the package option).
+
+This package has no public commands.
+
+
+%===========================================================
+\end{document}