aboutsummaryrefslogtreecommitdiff
path: root/about.html
diff options
context:
space:
mode:
Diffstat (limited to 'about.html')
-rw-r--r--about.html118
1 files changed, 72 insertions, 46 deletions
diff --git a/about.html b/about.html
index 9d7d8df..0894bda 100644
--- a/about.html
+++ b/about.html
@@ -1,38 +1,47 @@
1<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="" xml:lang="">
3<head>
4 <meta charset="utf-8" />
5 <meta name="generator" content="pandoc" />
6 <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
7 <meta name="author" content="Robert Alessi" />
8 <title>The ekdosis package – README file</title>
9 <style type="text/css">
10 code{white-space: pre-wrap;}
11 span.smallcaps{font-variant: small-caps;}
12 span.underline{text-decoration: underline;}
13 div.column{display: inline-block; vertical-align: top; width: 50%;}
14 </style>
15</head>
16<body>
17<header>
18<h1 class="title">The ekdosis package – README file</h1>
19<p class="author">Robert Alessi</p>
20</header>
21<h1 id="overview">Overview</h1> 1<h1 id="overview">Overview</h1>
22<p><code>ekdosis</code> is a LuaLaTeX package designed for multilingual critical editions. It can be used to typeset texts and different layers of critical notes in any direction accepted by LuaTeX. Texts can be arranged in running paragraphs or on facing pages, in any number of columns which in turn can be synchronized or not. In addition to printed texts, <code>ekdosis</code> can convert <code>.tex</code> source files so as to produce <code>TEI xml</code>-compliant critical editions. Database-driven encoding under LaTeX then allows extraction of texts entered segment by segment according to various criteria: main edited text, variant readings, translations or annotated borrowings between texts. It is published under the terms of the GNU General Public License (GPL) version 3.</p> 2<p><code>ekdosis</code> is a LuaLaTeX package designed for multilingual
3critical editions. It can be used to typeset texts and different layers
4of critical notes in any direction accepted by LuaTeX. Texts can be
5arranged in running paragraphs or on facing pages, in any number of
6columns which in turn can be synchronized or not. In addition to printed
7texts, <code>ekdosis</code> can convert <code>.tex</code> source files
8so as to produce <code>TEI xml</code>-compliant critical editions.
9Database-driven encoding under LaTeX then allows extraction of texts
10entered segment by segment according to various criteria: main edited
11text, variant readings, translations or annotated borrowings between
12texts. It is published under the terms of the OpenBSD license.</p>
23<h1 id="license-and-disclamer">License and Disclamer</h1> 13<h1 id="license-and-disclamer">License and Disclamer</h1>
24<p>ekdosis – Typesetting TEI xml-Compliant Critical Editions</p> 14<p>ekdosis – Typesetting TEI xml-Compliant Critical Editions</p>
25<p>Copyright ⓒ 2020–2021 Robert Alessi</p> 15<p>Copyright ⓒ 2020, 2021, 2022, 2023 Robert Alessi <a
26<p>Please send error reports and suggestions for improvements to Robert Alessi:</p> 16href="mailto:alessi@robertalessi.net"
17class="email">alessi@robertalessi.net</a></p>
18<p>Permission to use, copy, modify, and distribute this software for any
19purpose with or without fee is hereby granted, provided that the above
20copyright notice and this permission notice appear in all copies.</p>
21<p>THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL
22WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
23OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
24FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
25DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
26IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
27OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
28SOFTWARE.</p>
29<p>Please send error reports and suggestions for improvements to Robert
30Alessi:</p>
27<ul> 31<ul>
28<li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li> 32<li><p>email: <a href="mailto:alessi@robertalessi.net"
29<li><p>website: <a href="http://www.robertalessi.net/ekdosis" class="uri">http://www.robertalessi.net/ekdosis</a></p></li> 33class="email">alessi@robertalessi.net</a></p></li>
30<li><p>comments, feature requests, bug reports: <a href="https://gitlab.com/ralessi/ekdosis/issues" class="uri">https://gitlab.com/ralessi/ekdosis/issues</a></p></li> 34<li><p>website: <a href="http://www.ekdosis.org"
31<li><p>mailing list, support: <a href="http://www.robertalessi.net/mailman/listinfo/ekdosis" class="uri">http://www.robertalessi.net/mailman/listinfo/ekdosis</a> [<a href="http://www.robertalessi.net/pipermail/ekdosis/">mailing list archives</a>]</p></li> 35class="uri">http://www.ekdosis.org</a></p></li>
36<li><p>comments, feature requests, bug reports: <a
37href="http://www.ekdosis.org/issues.html"
38class="uri">http://www.ekdosis.org/issues.html</a></p></li>
39<li><p>mailing list, support: <a
40href="https://listes.services.cnrs.fr/wws/info/ekdosis"
41class="uri">https://listes.services.cnrs.fr/wws/info/ekdosis</a> [<a
42href="https://listes.services.cnrs.fr/wws/arc/ekdosis">mailing list
43archives</a>]</p></li>
32</ul> 44</ul>
33<p>This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.</p>
34<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
35<p>You should have received a copy of the GNU General Public License along with this program. If not, see <a href="http://www.gnu.org/licenses/" class="uri">http://www.gnu.org/licenses/</a>.</p>
36<p>This release of ekdosis consists of the following source files:</p> 45<p>This release of ekdosis consists of the following source files:</p>
37<ul> 46<ul>
38<li><p><code>ekdosis.dtx</code></p></li> 47<li><p><code>ekdosis.dtx</code></p></li>
@@ -40,27 +49,44 @@
40<li><p><code>ekdosis.el</code></p></li> 49<li><p><code>ekdosis.el</code></p></li>
41<li><p><code>Makefile</code></p></li> 50<li><p><code>Makefile</code></p></li>
42</ul> 51</ul>
43<h2 id="license-applicable-to-the-documentation">License Applicable to the Documentation</h2>
44<p>Copyright ⓒ 2020–2021 Robert Alessi</p>
45<p>The documentation file <code>ekdosis.pdf</code> that is generated from the <code>ekdosis.dtx</code> source file is licensed under the GNU Free Documentation License, as follows:—</p>
46<p>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled “GNU Free Documentation License”.</p>
47<h1 id="installation">Installation</h1> 52<h1 id="installation">Installation</h1>
48<ol type="1"> 53<ol type="1">
49<li><p>Run <code>'latex ekdosis.ins'</code> to produce the <code>ekdosis.sty</code> and <code>ekdosis.lua</code> files.</p></li> 54<li><p>Run <code>'latex ekdosis.ins'</code> to produce the
50<li><p>To finish the installation you have to move the <code>ekdosis.sty</code> and <code>ekdosis.lua</code> files into a directory where LaTeX can find them. See the FAQ on <code>texfaq.org</code> at <a href="https://texfaq.org/FAQ-inst-wlcf" class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on this.</p></li> 55<code>ekdosis.sty</code> and <code>ekdosis.lua</code> files.</p></li>
56<li><p>To finish the installation you have to move the
57<code>ekdosis.sty</code> and <code>ekdosis.lua</code> files into a
58directory where LaTeX can find them. See the FAQ on
59<code>texfaq.org</code> at <a href="https://texfaq.org/FAQ-inst-wlcf"
60class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on
61this.</p></li>
51</ol> 62</ol>
52<h1 id="development-git-repository">Development, Git Repository</h1> 63<h1 id="development-git-repository">Development, Git Repository</h1>
53<h2 id="browse-the-code">Browse the Code</h2> 64<h2 id="browse-the-code">Browse the Code</h2>
54<p>You can browse ekdosis repository on the web: <a href="http://git.robertalessi.net/ekdosis" class="uri">http://git.robertalessi.net/ekdosis</a></p> 65<p>You can browse ekdosis repository on the web: <a
55<p>From this page, you can download all the releases of <code>ekdosis</code>. For instructions on how to install <code>ekdosis</code>, please see above.</p> 66href="http://git.robertalessi.net/ekdosis"
56<h2 id="comments-feature-requests-bug-reports">Comments, Feature Requests, Bug Reports</h2> 67class="uri">http://git.robertalessi.net/ekdosis</a></p>
57<p><a href="https://gitlab.com/ralessi/ekdosis/issues" class="uri">https://gitlab.com/ralessi/ekdosis/issues</a></p> 68<p>From this page, you can download all the releases of
69<code>ekdosis</code>. For instructions on how to install
70<code>ekdosis</code>, please see above.</p>
71<h2 id="comments-feature-requests-bug-reports">Comments, Feature
72Requests, Bug Reports</h2>
73<p><a href="http://www.ekdosis.org/issues.html"
74class="uri">http://www.ekdosis.org/issues.html</a></p>
58<h2 id="download-the-repository">Download the Repository</h2> 75<h2 id="download-the-repository">Download the Repository</h2>
59<p><code>ekdosis</code> development is facilitated by git, a distributed version control system. You will need to install git (most GNU/Linux distributions package it in their repositories).</p> 76<p><code>ekdosis</code> development is facilitated by git, a distributed
77version control system. You will need to install git (most Unix/Linux
78distributions package it in their repositories).</p>
60<p>Use this command to download the repository</p> 79<p>Use this command to download the repository</p>
61<pre><code>git clone http://git.robertalessi.net/ekdosis</code></pre> 80<pre><code>git clone https://git.robertalessi.net/ekdosis</code></pre>
62<p>A new directory named ekdosis will have been created, containing <code>ekdosis</code>.</p> 81<p>or</p>
82<pre><code>git clone https://git.sr.ht/~ralessi/ekdosis</code></pre>
83<p>A new directory named ekdosis will have been created, containing
84<code>ekdosis</code>.</p>
63<h2 id="git-hosting">Git Hosting</h2> 85<h2 id="git-hosting">Git Hosting</h2>
64<p>Make an account on <a href="https://gitlab.com" class="uri">https://gitlab.com</a> and navigate (while logged in) to <a href="https://gitlab.com/ralessi/ekdosis" class="uri">https://gitlab.com/ralessi/ekdosis</a>. Click <em>Fork</em> and you will have in your account your own repository of <code>ekdosis</code> where you will be able to make whatever changes you like to.</p> 86<p>Make an account on <a href="https://sr.ht"
65</body> 87class="uri">https://sr.ht</a> and navigate (while logged in) to <a
66</html> 88href="https://git.sr.ht/~ralessi/ekdosis"
89class="uri">https://git.sr.ht/~ralessi/ekdosis</a>. Click <em>Clone repo
90to your account</em> and you will have in your account your own
91repository of <code>ekdosis</code> where you will be able to make
92whatever changes you like to.</p>
generated by cgit v1.2.3 (git 2.25.1) at 2024-05-07 12:59:26 +0000