aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md32
-rw-r--r--about.html14
-rw-r--r--ekdosis.dtx2
-rw-r--r--ekdosis.ins7
4 files changed, 30 insertions, 25 deletions
diff --git a/README.md b/README.md
index f5abd41..4baa1e9 100644
--- a/README.md
+++ b/README.md
@@ -19,10 +19,18 @@ readings, translations or annotated borrowings between texts. It is
19published under the terms of the GNU General Public License (GPL) 19published under the terms of the GNU General Public License (GPL)
20version 3. 20version 3.
21 21
22 22Notice to the Gentle Reader
23License and disclamer 23===========================
24The current state of this documentation covers the basics of
25`ekdosis`, namely what should be enough to start a new document and
26see how it works. v1.0 with a full documentation should be out by the
27end of July. Until then, there is a web page that can be accessed,
28<http://www.robertalessi.net/ekdosis>, with a mailing list that one can
29subscribe to and a section entitled “Literature” where one will find
30some slides and a paper submitted to a journal.
31
32License and Disclamer
24===================== 33=====================
25
26ekdosis – Typesetting TEI xml Compliant Critical Editions 34ekdosis – Typesetting TEI xml Compliant Critical Editions
27 35
28Copyright ⓒ 2020 Robert Alessi 36Copyright ⓒ 2020 Robert Alessi
@@ -60,9 +68,8 @@ This release of icite consists of the following source files:
60 68
61- `Makefile` 69- `Makefile`
62 70
63License applicable to the documentation 71License Applicable to the Documentation
64--------------------------------------- 72---------------------------------------
65
66Copyright ⓒ 2020 Robert Alessi 73Copyright ⓒ 2020 Robert Alessi
67 74
68The documentation file `ekdosis.pdf` that is generated from the 75The documentation file `ekdosis.pdf` that is generated from the
@@ -78,7 +85,6 @@ Permission is granted to copy, distribute and/or modify this document
78 85
79Installation 86Installation
80============ 87============
81
821. Run `'latex ekdosis.ins'` to produce the `ekdosis.sty` and 881. Run `'latex ekdosis.ins'` to produce the `ekdosis.sty` and
83 `ekdosis.lua` files. 89 `ekdosis.lua` files.
84 90
@@ -90,23 +96,21 @@ Installation
90Development, Git Repository 96Development, Git Repository
91=========================== 97===========================
92 98
93Browse the code 99Browse the Code
94--------------- 100---------------
95
96You can browse icite repository on the web: 101You can browse icite repository on the web:
97<http://git.robertalessi.net/ekdosis> 102<http://git.robertalessi.net/ekdosis>
98 103
99From this page, you can download all the releases of `ekdosis`. For 104From this page, you can download all the releases of `ekdosis`. For
100instructions on how to install `ekdosis`, please see above. 105instructions on how to install `ekdosis`, please see above.
101 106
102Comments, Feature requests, Bug Reports 107Comments, Feature Requests, Bug Reports
103--------------------------------------- 108---------------------------------------
104
105<https://gitlab.com/ralessi/ekdosis/issues> 109<https://gitlab.com/ralessi/ekdosis/issues>
106 110
107Download the repository
108-----------------------
109 111
112Download the Repository
113-----------------------
110`ekdosis` development is facilitated by git, a distributed version 114`ekdosis` development is facilitated by git, a distributed version
111control system. You will need to install git (most GNU/Linux 115control system. You will need to install git (most GNU/Linux
112distributions package it in their repositories). 116distributions package it in their repositories).
@@ -118,11 +122,9 @@ Use this command to download the repository
118A new directory named icite will have been created, containing 122A new directory named icite will have been created, containing
119`ekdosis`. 123`ekdosis`.
120 124
121Git hosting 125Git Hosting
122----------- 126-----------
123
124Make an account on <https://gitlab.com> and navigate (while logged in) 127Make an account on <https://gitlab.com> and navigate (while logged in)
125to <https://gitlab.com/ralessi/ekdosis>. Click *Fork* and you will 128to <https://gitlab.com/ralessi/ekdosis>. Click *Fork* and you will
126have in your account your own repository of `ekdosis` where you will 129have in your account your own repository of `ekdosis` where you will
127be able to make whatever changes you like to. 130be able to make whatever changes you like to.
128
diff --git a/about.html b/about.html
index 80f474f..895b884 100644
--- a/about.html
+++ b/about.html
@@ -15,7 +15,9 @@
15</div> 15</div>
16<h1 id="overview">Overview</h1> 16<h1 id="overview">Overview</h1>
17<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> 17<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>
18<h1 id="license-and-disclamer">License and disclamer</h1> 18<h1 id="notice-to-the-gentle-reader">Notice to the Gentle Reader</h1>
19<p>The current state of this documentation covers the basics of <code>ekdosis</code>, namely what should be enough to start a new document and see how it works. v1.0 with a full documentation should be out by the end of July. Until then, there is a web page that can be accessed, <a href="http://www.robertalessi.net/ekdosis" class="uri">http://www.robertalessi.net/ekdosis</a>, with a mailing list that one can subscribe to and a section entitled “Literature” where one will find some slides and a paper submitted to a journal.</p>
20<h1 id="license-and-disclamer">License and Disclamer</h1>
19<p>ekdosis – Typesetting TEI xml Compliant Critical Editions</p> 21<p>ekdosis – Typesetting TEI xml Compliant Critical Editions</p>
20<p>Copyright ⓒ 2020 Robert Alessi</p> 22<p>Copyright ⓒ 2020 Robert Alessi</p>
21<p>Please send error reports and suggestions for improvements to Robert Alessi:</p> 23<p>Please send error reports and suggestions for improvements to Robert Alessi:</p>
@@ -34,7 +36,7 @@
34<li><p><code>ekdosis.el</code></p></li> 36<li><p><code>ekdosis.el</code></p></li>
35<li><p><code>Makefile</code></p></li> 37<li><p><code>Makefile</code></p></li>
36</ul> 38</ul>
37<h2 id="license-applicable-to-the-documentation">License applicable to the documentation</h2> 39<h2 id="license-applicable-to-the-documentation">License Applicable to the Documentation</h2>
38<p>Copyright ⓒ 2020 Robert Alessi</p> 40<p>Copyright ⓒ 2020 Robert Alessi</p>
39<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> 41<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>
40<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> 42<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>
@@ -44,17 +46,17 @@
44<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 it. 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> 46<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 it. 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>
45</ol> 47</ol>
46<h1 id="development-git-repository">Development, Git Repository</h1> 48<h1 id="development-git-repository">Development, Git Repository</h1>
47<h2 id="browse-the-code">Browse the code</h2> 49<h2 id="browse-the-code">Browse the Code</h2>
48<p>You can browse icite repository on the web: <a href="http://git.robertalessi.net/ekdosis" class="uri">http://git.robertalessi.net/ekdosis</a></p> 50<p>You can browse icite repository on the web: <a href="http://git.robertalessi.net/ekdosis" class="uri">http://git.robertalessi.net/ekdosis</a></p>
49<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> 51<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>
50<h2 id="comments-feature-requests-bug-reports">Comments, Feature requests, Bug Reports</h2> 52<h2 id="comments-feature-requests-bug-reports">Comments, Feature Requests, Bug Reports</h2>
51<p><a href="https://gitlab.com/ralessi/ekdosis/issues" class="uri">https://gitlab.com/ralessi/ekdosis/issues</a></p> 53<p><a href="https://gitlab.com/ralessi/ekdosis/issues" class="uri">https://gitlab.com/ralessi/ekdosis/issues</a></p>
52<h2 id="download-the-repository">Download the repository</h2> 54<h2 id="download-the-repository">Download the Repository</h2>
53<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> 55<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>
54<p>Use this command to download the repository</p> 56<p>Use this command to download the repository</p>
55<pre><code>git clone http://git.robertalessi.net/ekdosis</code></pre> 57<pre><code>git clone http://git.robertalessi.net/ekdosis</code></pre>
56<p>A new directory named icite will have been created, containing <code>ekdosis</code>.</p> 58<p>A new directory named icite will have been created, containing <code>ekdosis</code>.</p>
57<h2 id="git-hosting">Git hosting</h2> 59<h2 id="git-hosting">Git Hosting</h2>
58<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> 60<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>
59</body> 61</body>
60</html> 62</html>
diff --git a/ekdosis.dtx b/ekdosis.dtx
index a911944..f2700aa 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -1754,7 +1754,7 @@ texts=latin[xml:lang="la"]+\textcolor{red}{;}+
1754% any point of the document to set or to modify alignment settings. 1754% any point of the document to set or to modify alignment settings.
1755% 1755%
1756% \section{To Be Continued...} 1756% \section{To Be Continued...}
1757% v1.0 of \pkg{ekdosis} which should be available by the end of July 1757% v1.0 of \pkg{ekdosis}, which should be available by the end of July
1758% 2020, will include a full documentation. At the time of writing, the 1758% 2020, will include a full documentation. At the time of writing, the
1759% author is working on this part of the package. 1759% author is working on this part of the package.
1760% 1760%
diff --git a/ekdosis.ins b/ekdosis.ins
index 0f80333..6427d37 100644
--- a/ekdosis.ins
+++ b/ekdosis.ins
@@ -31,10 +31,11 @@ You should have received a copy of the GNU General Public License
31along with this program. If not, see 31along with this program. If not, see
32<http://www.gnu.org/licenses/>. 32<http://www.gnu.org/licenses/>.
33 33
34This work consists of the file ekdosis.dtx and a Makefile. 34This work consists of the files ekdosis.dtx, ekdosis.el, this file and
35Running "make" generates the derived files README, ekdosis.pdf and ekdosis.sty. 35a Makefile.
36Running "make" generates the derived files README, ekdosis.pdf and
37ekdosis.sty.
36Running "make inst" installs the files in the user's TeX tree. 38Running "make inst" installs the files in the user's TeX tree.
37Running "make install" installs the files in the local TeX tree.
38\endpreamble 39\endpreamble
39 40
40\usedir{tex/lualatex/ekdosis} 41\usedir{tex/lualatex/ekdosis}