summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/eledmac/README
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/latex/eledmac/README')
-rw-r--r--Master/texmf-dist/doc/latex/eledmac/README178
1 files changed, 110 insertions, 68 deletions
diff --git a/Master/texmf-dist/doc/latex/eledmac/README b/Master/texmf-dist/doc/latex/eledmac/README
index 0b2537830d2..6d548bdad29 100644
--- a/Master/texmf-dist/doc/latex/eledmac/README
+++ b/Master/texmf-dist/doc/latex/eledmac/README
@@ -1,72 +1,114 @@
- The eledmac package is for typesetting critical editions. It is a
-LaTeX port, and extension, of the plain TeX EDMAC, TABMAC and EDSTANZA
-macros. The eledpar package is an extension of eledmac enabling parallel
-typesetting in columns or on facing pages.
+Overview
+========
+
+The eledmac package is for typesetting critical editions. It is a LaTeX
+port, and extension, of the plain TeX EDMAC, TABMAC and EDSTANZA macros.
+The eledpar package is an extension of eledmac enabling parallel
+typesetting in columns or on facing pages.
Eledmac and eledpar are successors of ledmac and ledpar.
- Bug reports and suggestions are welcome.
-
-This version of the package is stored in github https://github.com/maieul/ledmac
-
-Please use ledmac "issues" https://github.com/maieul/ledmac/issues
-
-URL in the CTAN : http://www.ctan.org/pkg/eledmac
-
-Users list : https://lists.berlios.de/pipermail/ledmac-users/
---------------------------------------------------------------------
- Author: Peter Wilson (Herries Press) herries dot press at earthlink dot net, Maïeul Rouquette (new maintainer since june 2011)
- Copyright 2003 --- 2005 Peter R. Wilson
- Copyright 2011 --- .. Maïeul Rouquette
-
- This work may be distributed and/or modified under the
- conditions of the LaTeX Project Public License, either
- version 1.3 of this license or (at your option) any
- later version.
- The latest version of the license is in
- http://www.latex-project.org/lppl.txt
- and version 1.3 or later is part of all distributions of
- LaTeX version 2003/06/01 or later.
-
- This work has the LPPL maintenance status "maintained".
-
- This work consists of the files:
- README (this file),
- eledmac.dtx,
- eledmac.ins,
- eledmac.pdf (200+ pages)
- eledpar.dtx,
- eledpar.ins,
- eledpar.pdf (100+ pages)
-and the derived files
- eledmac.sty,
- eledpar.sty,
-
---------------------------------------------------------------------
-
- The distribution consists of the following files:
-README (this file)
-eledmac.dtx
-eledmac.ins
-eledmac.pdf
-eledpar.dtx
-eledpar.ins
-eledpar.pdf
-makefile
-
-
- To install the eledmac package:
-o run: latex eledmac.ins (which will generate eledmac.sty)
-o Move ledmac.sty (and ledpatch.sty if it exists) to a location where
- LaTeX will find it (for more information on this see the FAQ).
-
- To generate a second copy of the manual (which is already supplied as a PDF file):
-o run: make eledmac.pdf
-
- Installation of the other packages (via eledpar.ins)
-is similar.
-
-2012/08/14
-Maïeul Rouquette
-maieul at maieul dot net
+The package is available on [CTAN](http://www.ctan.org/pkg/eledmac). \#
+Copyright and Licence \#\# Authors - Peter Wilson (Herries Press)
+herries dot press at earthlink dot net, - Maïeul Rouquette (new
+maintainer since june 2011)
+
+Copyright
+---------
+
+- Copyright 2003 --- 2005 Peter R. Wilson
+- Copyright 2011 --- .. Maïeul Rouquette
+
+Licence
+-------
+
+This work may be distributed and/or modified under the conditions of the
+LaTeX Project Public License, either version 1.3 of this license or (at
+your option) any later version.
+
+The latest version of the license is in
+<http://www.latex-project.org/lppl.txt> and version 1.3 or later is part
+of all distributions of LaTeX version 2003/06/01 or later.
+
+This work has the LPPL maintenance status "maintained".
+
+This work consists of the files:
+
+- README (this file),
+- eledmac.dtx,
+- eledmac.ins,
+- eledpar.dtx,
+- eledpar.ins,
+
+and the derived files:
+
+- eledmac.sty,
+- eledpar.sty,
+- eledmac.pdf, (200+ pages)
+- eledpar.pdf, (100+ pages)
+
+The distribution consists of the following files:
+
+- README (this file)
+- eledmac.dtx
+- eledmac.ins
+- eledmac.pdf
+- eledpar.dtx
+- eledpar.ins
+- eledpar.pdf
+- makefile
+- latexmrc
+- examples/
+ - \*.tex
+ - \*.pdf
+ - makefile
+
+Installation
+============
+
+- run: `latex eledmac.ins` (which will generate eledmac.sty) and
+ `latex eledpar.ins` (which will generate eledmac.sty)
+- move eledmac.sty and eledpar.sty to a location where LaTeX will find
+ it (for more information on this see the FAQ).
+
+To generate a second copy of the manual (which is already supplied as a
+PDF file):
+
+- run: `make eledmac.pdf`
+
+Help
+====
+
+- [Users list](https://lists.berlios.de/pipermail/ledmac-users/)
+- [StackExchange](https://tex.stackexchange.com/questions/tagged/eledmac),
+ see also the [older
+ tag](https://tex.stackexchange.com/questions/tagged/eledmac)
+
+ Debug
+======
+
+Suggestions and bug reports are welcome.
+
+Maïeul Rouquette is the only one maintainer. To help him in his work,
+please follow these rules:
+
+- Go to the [issues page](https://github.com/maieul/ledmac/issues);
+- Open *one issue by problem*, even if problems are similar.
+- Add a [minimal working
+ example](http://www.tex.ac.uk/cgi-bin/texfaq2html?label=minxampl).
+- If your report is really a bug, Maïeul Rouquette will open a
+ "branch" to solve your problem. This branch will be called
+ "issueXXX", where "XXX" is the issue number.
+- Once the problem has a possible solution, Maïeul Rouquette will send
+ you a zip file and ask you to test it:
+ - Download the zip file of the branch (or, if you know Git, go to
+ the branch there):
+ - Go to [the project page](https://github.com/maieul/ledmac/).
+ - Choose the correct branch in the "branch" menu.
+ - Click on the cloud, in the right side.
+
+ - Run the `.ins` files with pdflatex, to obtain the `.sty` files.
+ - Put the `.sty` files with your test files (in the same folder).
+ - Make your report.
+