summaryrefslogtreecommitdiff
path: root/support/latex2nemeth/README
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-03-19 03:01:18 +0000
committerNorbert Preining <norbert@preining.info>2020-03-19 03:01:18 +0000
commitc8b8ea37fe9cd71b53223dff23f291b2f158fc0f (patch)
tree4b91fec7c54c33edfbd023be9ccbdac673504483 /support/latex2nemeth/README
parent701be49cc7a592cc192c0f28e45a763a4c745282 (diff)
CTAN sync 202003190301
Diffstat (limited to 'support/latex2nemeth/README')
-rw-r--r--support/latex2nemeth/README26
1 files changed, 18 insertions, 8 deletions
diff --git a/support/latex2nemeth/README b/support/latex2nemeth/README
index a6f6011dd9..e5a7588528 100644
--- a/support/latex2nemeth/README
+++ b/support/latex2nemeth/README
@@ -1,6 +1,16 @@
Latex2Nemeth
============
-Version 1.0.1
+Version 1.0.2
+
+====================================
+
+New addition in this version (compared to 1.0.1)
+is basic macro support. The program supports
+simple replacement commands (such as \newcommand{}{})
+and commands with optional arguments
+(such as \newcommand{\inner}[2]{\langle#1,#2\rangle}).
+
+=====================================
This is the source tree for Latex2Nemeth, a tool for translating TeX files to Braille.
@@ -13,7 +23,7 @@ This is the source tree for Latex2Nemeth, a tool for translating TeX files to Br
Licence
-------
-Copyright 2016-2017 by Andreas Papasalοuros, Antonis Tsolomitis.
+Copyright 2016-2020 by Andreas Papasalοuros, Antonis Tsolomitis.
This program is distributed under the GPL, version 3 or later. Please see the COPYING file for details.
@@ -53,7 +63,7 @@ Usage
-----
After compiling the tool the executable `jar` will be located in the `target/` directory,
-e.g. `target/latex2nemeth-v1.0.1.jar`.
+e.g. `target/latex2nemeth-v1.0.2.jar`.
A simple to way to run the tool is
@@ -69,13 +79,13 @@ A simple to way to run the tool is
**Examples**
A simple example:
- java -jar target/latex2nemeth-v1.0.1.jar src/test/resources/com/latex2nemeth/bootstrap/mathtest.tex src/test/resources/com/latex2nemeth/bootstrap/mathtest.aux
+ java -jar target/latex2nemeth-v1.0.2.jar src/test/resources/com/latex2nemeth/bootstrap/mathtest.tex src/test/resources/com/latex2nemeth/bootstrap/mathtest.aux
A more complicated example:
- java -jar target/latex2nemeth-v1.0.1.jar src/test/resources/com/latex2nemeth/bootstrap/mathtest.tex src/test/resources/com/latex2nemeth/bootstrap/mathtest.aux -o ch -m nemeth -e src/test/resources/com/latex2nemeth/bootstrap/nemeth.json
+ java -jar target/latex2nemeth-v1.0.2.jar src/test/resources/com/latex2nemeth/bootstrap/mathtest.tex src/test/resources/com/latex2nemeth/bootstrap/mathtest.aux -o ch -m nemeth -e src/test/resources/com/latex2nemeth/bootstrap/nemeth.json
An example with pictures:
- java -jar target/latex2nemeth-v1.0.1.jar src/test/resources/com/latex2nemeth/bootstrap/mathpics.tex src/test/resources/com/latex2nemeth/bootstrap/mathpics.aux
+ java -jar target/latex2nemeth-v1.0.2.jar src/test/resources/com/latex2nemeth/bootstrap/mathpics.tex src/test/resources/com/latex2nemeth/bootstrap/mathpics.aux
**Notes**
-------------
@@ -85,7 +95,7 @@ A simple to way to run the tool is
iconv -f iso8859-7 -t utf-8 source.tex > source-utf8.tex
- or using your editor. Now run "java -jar latex2nemeth-v1.0.1.jar" as above with
+ or using your editor. Now run "java -jar latex2nemeth-v1.0.2.jar" as above with
source-utf8.tex as the tex file and source.aux as the aux file. If errors are
produced you need to modify the source-utf8.tex at the line indicated.
Usually the errors have to do either with non supported shortcuts for macros
@@ -119,7 +129,7 @@ smoothly a \newcommand can be introduced in the preamble, such as
6. It is possible to translate TeX files using different Braille alphabets. A different Braille alphabet
is encoded in a JSON file. For example, in order to translate a texfile into polytonic Greek, the command is as follows:
- java -jar latex2nemeth-v1.0.1.jar texfile.tex auxfile.aux -e /path/to/polytonic.json
+ java -jar latex2nemeth-v1.0.2.jar texfile.tex auxfile.aux -e /path/to/polytonic.json
Please report issues related to erratic output to a n d p a p a s [AT] a e g e a n . g r
and issues related to the tex file handling/modifying to a n t o n i s . t s o l o m i t i s [AT] g m a i l . c o m