summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/multilang/README.md
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 /macros/latex/contrib/multilang/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/multilang/README.md')
-rw-r--r--macros/latex/contrib/multilang/README.md90
1 files changed, 90 insertions, 0 deletions
diff --git a/macros/latex/contrib/multilang/README.md b/macros/latex/contrib/multilang/README.md
new file mode 100644
index 0000000000..265908ada0
--- /dev/null
+++ b/macros/latex/contrib/multilang/README.md
@@ -0,0 +1,90 @@
+The multilang Package
+=======================
+
+Copyright (C) 2016-2018 Richard Grewe
+
+Released under the [LaTeX Project Public License](http://www.latex-project.org/lppl/) version 1.2 or later
+
+## Abstract
+
+Maintaining a LaTeX document with translations for multiple languages
+can be cumbersome and error-prone.
+The `multilang` package provides a set of macros for defining macros and
+environments as wrappers around existing macros and environments.
+These wrappers allow one to clearly specify multiple translations for the
+arguments to the wrapped macros and environments while only the
+translation of the document's language is actually shown.
+Choosing a translation then is as simple as choosing the document's
+language via `babel` or `polyglossia`.
+
+## Availability
+
+The `multilang` package is on [CTAN](http://www.ctan.org/pkg/multilang),
+where you can also find the [documentation](http://mirrors.ctan.org/macros/latex/contrib/multilang/multilang.pdf),
+as well as on [github](https://github.com/Ri-Ga/multilang).
+
+## Manual Installation
+
+The `multilang` package comes with (at least) the following files
+* multilang.ins
+* multilang.dtx
+* README.md
+
+and possibly also with
+* Makefile
+* multilang.pdf (generated from multilang.dtx)
+* multilang.sty (generated from multilang.dtx)
+
+To install the `multilang` package, you additionally need
+* docstrip.tex
+
+To build the package (`multilang.sty`), run one of the following
+```
+ latex multilang.ins
+ make package (needs Makefile)
+```
+
+Put the resulting `multilang.sty` somewhere where LaTeX can find it.
+Read the documentation of your LaTeX system to find out where this
+might be.
+
+## Building Documentation
+
+To build the documentation of the `multilang` package, you additionally
+need the following classes and packages (including their dependencies)
+* ltxdoc
+* babel
+* cleveref
+* csquotes
+* datetime2
+* enumitem
+* environ
+* etoolbox
+* hypdoc
+* idxlayout
+* pbox
+* pgfkeys
+* pgfopts
+* sectionbox
+* showexpl
+* translations
+* xcolor
+* xspace
+
+as well as
+* pdflatex
+
+To build the documentation (`multilang.pdf`), either run
+```
+ make docs
+```
+or the following sequence of commands
+```
+ pdflatex multilang.dtx
+ makeindex -s gind.ist -o multilang.ind multilang.idx
+ makeindex -s gglo.ist -o multilang.gls multilang.glo
+ pdflatex multilang.dtx
+ pdflatex multilang.dtx
+```
+
+Happy TeX'ing