summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/bxorigcapt/README.md
blob: 83095fa7de2d6337aef620d367ae817df5184924 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
BXorigcapt Package
==================

LaTeX: To retain the original caption names when using Babel

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.
                                                            
### System requirement

  * TeX format: LaTeX.
  * TeX engine: Anything.
  * Dependent packages:
      - babel

### Installation

  - `*.sty` → $TEXMF/tex/latex/BXorigcapt

### License

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[<language>]{bxorigcapt}

The package option specifies a Babel language, and requires that the
caption names provided by the document class (actually the ones that are
effective when this package is loaded) should be used as the caption names
for that language.

The option can be omitted; in that case, the main language of Babel will
be assumed.

### Usage

For present, this package has no public commands. All the settings are
done through the package option.

Revision History
----------------

  * Version 0.2a 〈2017/05/03〉
      - Minor fix.
  * Version 0.2  〈2016/04/01〉
      - The first public version.

--------------------
Takayuki YATO (aka. "ZR")  
https://github.com/zr-tex8r