aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--Makefile6
-rw-r--r--README.md126
-rw-r--r--about.html59
-rw-r--r--ekdosis.dtx13
-rw-r--r--ekdosis.ins4
5 files changed, 188 insertions, 20 deletions
diff --git a/Makefile b/Makefile
index 43430a6..338813b 100644
--- a/Makefile
+++ b/Makefile
@@ -7,11 +7,11 @@ LOCAL = $(shell kpsewhich --var-value TEXMFLOCAL)
7UTREE = $(shell kpsewhich --var-value TEXMFHOME) 7UTREE = $(shell kpsewhich --var-value TEXMFHOME)
8HOMEDIR := $$HOME 8HOMEDIR := $$HOME
9 9
10exts := ins dtx el 10exts := md html ins dtx el
11findopts := $(foreach ext,$(exts),-or -iname "*.$(ext)") 11findopts := $(foreach ext,$(exts),-or -iname "*.$(ext)")
12 12
13all: sty $(NAME).pdf 13all: sty $(NAME).pdf
14 test -e README.txt && mv README.txt README || exit 0 14# test -e README.txt && mv README.txt README || exit 0
15 15
16sty: clean 16sty: clean
17 $(CMP) $(NAME).ins 17 $(CMP) $(NAME).ins
@@ -38,7 +38,7 @@ clean:
38 rm -rf * 38 rm -rf *
39 cp -p -r .backup/* . 39 cp -p -r .backup/* .
40 rm -rf .backup 40 rm -rf .backup
41# pandoc -s README.md -o about.html 41 pandoc -s README.md -o about.html
42 42
43auctex: 43auctex:
44 if [ ! -d "$(HOMEDIR)/.emacs.d/auctex/auto" ]; then \ 44 if [ ! -d "$(HOMEDIR)/.emacs.d/auctex/auto" ]; then \
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ab453a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,126 @@
1---
2author:
3- Robert Alessi
4title: 'The ekdosis package – README file'
5---
6
7Overview
8========
9`ekdosis` is a LuaLaTeX package designed for multilingual critical
10editions. It can be used to typeset texts and different layers of
11critical notes in any direction accepted by LuaTeX. Texts can be
12arranged in running paragraphs or on facing pages, in any number of
13columns which in turn can be synchronized or not. In addition to
14printed texts, `ekdosis` can convert `.tex` source files so as to
15produce `TEI xml` compliant critical editions. Database-driven
16encoding under LaTeX then allows extraction of texts entered segment
17by segment according to various criteria: main edited text, variant
18readings, translations or annotated borrowings between texts. It is
19published under the terms of the GNU General Public License (GPL)
20version 3.
21
22
23License and disclamer
24=====================
25
26ekdosis – Typesetting TEI xml compliant critical editions
27
28Copyright ⓒ 2020 Robert Alessi
29
30Please send error reports and suggestions for improvements to Robert
31Alessi:
32
33- email: <alessi@robertalessi.net>
34
35- website: <http://www.robertalessi.net/ekdosis>
36
37- comments, feature requests, bug reports:
38 <https://gitlab.com/ralessi/ekdosis/issues>
39
40This program is free software: you can redistribute it and/or modify it
41under the terms of the GNU General Public License as published by the
42Free Software Foundation, either version 3 of the License, or (at your
43option) any later version.
44
45This program is distributed in the hope that it will be useful, but
46WITHOUT ANY WARRANTY; without even the implied warranty of
47MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
48Public License for more details.
49
50You should have received a copy of the GNU General Public License along
51with this program. If not, see <http://www.gnu.org/licenses/>.
52
53This release of icite consists of the following source files:
54
55- `ekdosis.dtx`
56
57- `ekdosis.ins`
58
59- `Makefile`
60
61License applicable to the documentation
62---------------------------------------
63
64Copyright ⓒ 2020 Robert Alessi
65
66The documentation file `ekdosis.pdf` that is generated from the
67`ekdosis.dtx` source file is licensed under the GNU Free Documentation
68License, as follows:---
69
70Permission is granted to copy, distribute and/or modify this document
71 under the terms of the GNU Free Documentation License, Version 1.3
72 or any later version published by the Free Software Foundation; with
73 no Invariant Sections, no Front-Cover Texts, and no Back-Cover
74 Texts. A copy of the license is included in the section entitled
75 “GNU Free Documentation License”.
76
77Installation
78============
79
801. Run `'latex ekdosis.ins'` to produce the `ekdosis.sty` and
81 `ekdosis.lua` files.
82
832. To finish the installation you have to move the `ekdosis.sty` and
84 `ekdosis.lua` files into a directory where LaTeX can find it. See
85 the FAQ on `texfaq.org` at <https://texfaq.org/FAQ-inst-wlcf> for
86 more on this.
87
88Development, Git Repository
89===========================
90
91Browse the code
92---------------
93
94You can browse icite repository on the web:
95<http://git.robertalessi.net/ekdosis>
96
97From this page, you can download all the releases of `ekdosis`. For
98instructions on how to install `ekdosis`, please see above.
99
100Comments, Feature requests, Bug Reports
101---------------------------------------
102
103<https://gitlab.com/ralessi/ekdosis/issues>
104
105Download the repository
106-----------------------
107
108`ekdosis` development is facilitated by git, a distributed version
109control system. You will need to install git (most GNU/Linux
110distributions package it in their repositories).
111
112Use this command to download the repository
113
114 git clone http://git.robertalessi.net/ekdosis
115
116A new directory named icite will have been created, containing
117`ekdosis`.
118
119Git hosting
120-----------
121
122Make an account on <https://gitlab.com> and navigate (while logged in)
123to <https://gitlab.com/ralessi/ekdosis>. Click *Fork* and you will
124have in your account your own repository of `ekdosis` where you will
125be able to make whatever changes you like to.
126
diff --git a/about.html b/about.html
new file mode 100644
index 0000000..9fc50c0
--- /dev/null
+++ b/about.html
@@ -0,0 +1,59 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xmlns="http://www.w3.org/1999/xhtml">
3<head>
4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5 <meta http-equiv="Content-Style-Type" content="text/css" />
6 <meta name="generator" content="pandoc" />
7 <meta name="author" content="Robert Alessi" />
8 <title>The ekdosis package – README file</title>
9 <style type="text/css">code{white-space: pre;}</style>
10</head>
11<body>
12<div id="header">
13<h1 class="title">The ekdosis package – README file</h1>
14<h2 class="author">Robert Alessi</h2>
15</div>
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>
18<h1 id="license-and-disclamer">License and disclamer</h1>
19<p>ekdosis – Typesetting TEI xml compliant critical editions</p>
20<p>Copyright ⓒ 2020 Robert Alessi</p>
21<p>Please send error reports and suggestions for improvements to Robert Alessi:</p>
22<ul>
23<li><p>email: <a href="mailto:alessi@robertalessi.net">alessi@robertalessi.net</a></p></li>
24<li><p>website: <a href="http://www.robertalessi.net/ekdosis" class="uri">http://www.robertalessi.net/ekdosis</a></p></li>
25<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>
26</ul>
27<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>
28<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>
29<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>
30<p>This release of icite consists of the following source files:</p>
31<ul>
32<li><p><code>ekdosis.dtx</code></p></li>
33<li><p><code>ekdosis.ins</code></p></li>
34<li><p><code>Makefile</code></p></li>
35</ul>
36<h2 id="license-applicable-to-the-documentation">License applicable to the documentation</h2>
37<p>Copyright ⓒ 2020 Robert Alessi</p>
38<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>
39<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>
40<h1 id="installation">Installation</h1>
41<ol style="list-style-type: decimal">
42<li><p>Run <code>'latex ekdosis.ins'</code> to produce the <code>ekdosis.sty</code> and <code>ekdosis.lua</code> files.</p></li>
43<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>
44</ol>
45<h1 id="development-git-repository">Development, Git Repository</h1>
46<h2 id="browse-the-code">Browse the code</h2>
47<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>
48<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>
49<h2 id="comments-feature-requests-bug-reports">Comments, Feature requests, Bug Reports</h2>
50<p><a href="https://gitlab.com/ralessi/ekdosis/issues" class="uri">https://gitlab.com/ralessi/ekdosis/issues</a></p>
51<h2 id="download-the-repository">Download the repository</h2>
52<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>
53<p>Use this command to download the repository</p>
54<pre><code>git clone http://git.robertalessi.net/ekdosis</code></pre>
55<p>A new directory named icite will have been created, containing <code>ekdosis</code>.</p>
56<h2 id="git-hosting">Git hosting</h2>
57<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>
58</body>
59</html>
diff --git a/ekdosis.dtx b/ekdosis.dtx
index bc2695b..908162d 100644
--- a/ekdosis.dtx
+++ b/ekdosis.dtx
@@ -23,19 +23,6 @@
23%<*internal> 23%<*internal>
24\iffalse 24\iffalse
25%</internal> 25%</internal>
26%<*readme>
27|
28-------:| -----------------------------------------------------------------
29ekdosis:| Typesetting TEI xml compliant critical editions
30 Author:| Robert Alessi
31 E-mail:| alessi@robertalessi.net
32License:| Released under the GNU General Public License v3 or later
33 See:| http://www.gnu.org/licenses/
34
35
36Short description:
37Some text about the package: probably the same as the abstract.
38%</readme>
39%<*luapre> 26%<*luapre>
40--[[ 27--[[
41This file is part of the `ekdosis' package 28This file is part of the `ekdosis' package
diff --git a/ekdosis.ins b/ekdosis.ins
index 4085554..f1558f2 100644
--- a/ekdosis.ins
+++ b/ekdosis.ins
@@ -58,8 +58,4 @@ Running "make install" installs the files in the local TeX tree.
58% \from{\jobname.dtx}{examples} 58% \from{\jobname.dtx}{examples}
59% } 59% }
60% } 60% }
61\usedir{doc/lualatex/ekdosis}
62\generate{
63 \file{README.txt}{\from{\jobname.dtx}{readme}}
64}
65\endbatchfile 61\endbatchfile