| 1 |
--- |
| 2 |
author: |
| 3 |
- Robert Alessi |
| 4 |
title: 'The ekdosis package – README file' |
| 5 |
--- |
| 6 |
|
| 7 |
Overview |
| 8 |
======== |
| 9 |
`ekdosis` is a LuaLaTeX package designed for multilingual critical |
| 10 |
editions. It can be used to typeset texts and different layers of |
| 11 |
critical notes in any direction accepted by LuaTeX. Texts can be |
| 12 |
arranged in running paragraphs or on facing pages, in any number of |
| 13 |
columns which in turn can be synchronized or not. In addition to |
| 14 |
printed texts, `ekdosis` can convert `.tex` source files so as to |
| 15 |
produce `TEI xml`-compliant critical editions. Database-driven |
| 16 |
encoding under LaTeX then allows extraction of texts entered segment |
| 17 |
by segment according to various criteria: main edited text, variant |
| 18 |
readings, translations or annotated borrowings between texts. It is |
| 19 |
published under the terms of the GNU General Public License (GPL) |
| 20 |
version 3. |
| 21 |
|
| 22 |
License and Disclamer |
| 23 |
===================== |
| 24 |
ekdosis – Typesetting TEI xml-Compliant Critical Editions |
| 25 |
|
| 26 |
Copyright ⓒ 2020--2021 Robert Alessi |
| 27 |
|
| 28 |
Please send error reports and suggestions for improvements to Robert |
| 29 |
Alessi: |
| 30 |
|
| 31 |
- email: <[email protected]> |
| 32 |
|
| 33 |
- website: <http://www.ekdosis.org> |
| 34 |
|
| 35 |
- comments, feature requests, bug reports: |
| 36 |
<http://www.ekdosis.org/issues> |
| 37 |
|
| 38 |
- mailing list, support: <http://www.ekdosis.org/mailman/listinfo/ekdosis> [[mailing list archives](http://www.ekdosis.org/pipermail/ekdosis/)] |
| 39 |
|
| 40 |
This program is free software: you can redistribute it and/or modify it |
| 41 |
under the terms of the GNU General Public License as published by the |
| 42 |
Free Software Foundation, either version 3 of the License, or (at your |
| 43 |
option) any later version. |
| 44 |
|
| 45 |
This program is distributed in the hope that it will be useful, but |
| 46 |
WITHOUT ANY WARRANTY; without even the implied warranty of |
| 47 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General |
| 48 |
Public License for more details. |
| 49 |
|
| 50 |
You should have received a copy of the GNU General Public License along |
| 51 |
with this program. If not, see <http://www.gnu.org/licenses/>. |
| 52 |
|
| 53 |
This release of ekdosis consists of the following source files: |
| 54 |
|
| 55 |
- `ekdosis.dtx` |
| 56 |
|
| 57 |
- `ekdosis.ins` |
| 58 |
|
| 59 |
- `ekdosis.el` |
| 60 |
|
| 61 |
- `Makefile` |
| 62 |
|
| 63 |
License Applicable to the Documentation |
| 64 |
--------------------------------------- |
| 65 |
Copyright ⓒ 2020--2021 Robert Alessi |
| 66 |
|
| 67 |
The documentation file `ekdosis.pdf` that is generated from the |
| 68 |
`ekdosis.dtx` source file is licensed under the GNU Free Documentation |
| 69 |
License, as follows:--- |
| 70 |
|
| 71 |
Permission is granted to copy, distribute and/or modify this document |
| 72 |
under the terms of the GNU Free Documentation License, Version 1.3 |
| 73 |
or any later version published by the Free Software Foundation; with |
| 74 |
no Invariant Sections, no Front-Cover Texts, and no Back-Cover |
| 75 |
Texts. A copy of the license is included in the section entitled |
| 76 |
“GNU Free Documentation License”. |
| 77 |
|
| 78 |
Installation |
| 79 |
============ |
| 80 |
1. Run `'latex ekdosis.ins'` to produce the `ekdosis.sty` and |
| 81 |
`ekdosis.lua` files. |
| 82 |
|
| 83 |
2. To finish the installation you have to move the `ekdosis.sty` and |
| 84 |
`ekdosis.lua` files into a directory where LaTeX can find them. See |
| 85 |
the FAQ on `texfaq.org` at <https://texfaq.org/FAQ-inst-wlcf> for |
| 86 |
more on this. |
| 87 |
|
| 88 |
Development, Git Repository |
| 89 |
=========================== |
| 90 |
|
| 91 |
Browse the Code |
| 92 |
--------------- |
| 93 |
You can browse ekdosis repository on the web: |
| 94 |
<http://git.robertalessi.net/ekdosis> |
| 95 |
|
| 96 |
From this page, you can download all the releases of `ekdosis`. For |
| 97 |
instructions on how to install `ekdosis`, please see above. |
| 98 |
|
| 99 |
Comments, Feature Requests, Bug Reports |
| 100 |
--------------------------------------- |
| 101 |
<http://www.ekdosis.org/issues> |
| 102 |
|
| 103 |
|
| 104 |
Download the Repository |
| 105 |
----------------------- |
| 106 |
`ekdosis` development is facilitated by git, a distributed version |
| 107 |
control system. You will need to install git (most GNU/Linux |
| 108 |
distributions package it in their repositories). |
| 109 |
|
| 110 |
Use this command to download the repository |
| 111 |
|
| 112 |
git clone http://git.robertalessi.net/ekdosis |
| 113 |
|
| 114 |
A new directory named ekdosis will have been created, containing |
| 115 |
`ekdosis`. |
| 116 |
|
| 117 |
Git Hosting |
| 118 |
----------- |
| 119 |
Make an account on <https://gitlab.com> and navigate (while logged in) |
| 120 |
to <https://gitlab.com/ralessi/ekdosis>. Click *Fork* and you will |
| 121 |
have in your account your own repository of `ekdosis` where you will |
| 122 |
be able to make whatever changes you like to. |