aboutsummaryrefslogtreecommitdiff
path: root/about.html
diff options
context:
space:
mode:
authorRobert Alessi <alessi@robertalessi.net>2022-07-11 18:27:52 +0200
committerRobert Alessi <alessi@robertalessi.net>2022-07-11 18:27:52 +0200
commit960f38689ef9a194696f236441af480e827ba045 (patch)
tree3bbdcb481e65a300568da2e95092e86a977f0502 /about.html
parentd528a97fc33191ebdd24b5b03a4619b4f686e59a (diff)
downloadekdosis-960f38689ef9a194696f236441af480e827ba045.tar.gz
updated README with instructions for using sourcehut
Diffstat (limited to 'about.html')
-rw-r--r--about.html244
1 files changed, 223 insertions, 21 deletions
diff --git a/about.html b/about.html
index 45d25aa..cfa85f6 100644
--- a/about.html
+++ b/about.html
@@ -7,13 +7,157 @@
7 <meta name="author" content="Robert Alessi" /> 7 <meta name="author" content="Robert Alessi" />
8 <title>The ekdosis package – README file</title> 8 <title>The ekdosis package – README file</title>
9 <style> 9 <style>
10 html {
11 line-height: 1.5;
12 font-family: Georgia, serif;
13 font-size: 20px;
14 color: #1a1a1a;
15 background-color: #fdfdfd;
16 }
17 body {
18 margin: 0 auto;
19 max-width: 36em;
20 padding-left: 50px;
21 padding-right: 50px;
22 padding-top: 50px;
23 padding-bottom: 50px;
24 hyphens: auto;
25 overflow-wrap: break-word;
26 text-rendering: optimizeLegibility;
27 font-kerning: normal;
28 }
29 @media (max-width: 600px) {
30 body {
31 font-size: 0.9em;
32 padding: 1em;
33 }
34 h1 {
35 font-size: 1.8em;
36 }
37 }
38 @media print {
39 body {
40 background-color: transparent;
41 color: black;
42 font-size: 12pt;
43 }
44 p, h2, h3 {
45 orphans: 3;
46 widows: 3;
47 }
48 h2, h3, h4 {
49 page-break-after: avoid;
50 }
51 }
52 p {
53 margin: 1em 0;
54 }
55 a {
56 color: #1a1a1a;
57 }
58 a:visited {
59 color: #1a1a1a;
60 }
61 img {
62 max-width: 100%;
63 }
64 h1, h2, h3, h4, h5, h6 {
65 margin-top: 1.4em;
66 }
67 h5, h6 {
68 font-size: 1em;
69 font-style: italic;
70 }
71 h6 {
72 font-weight: normal;
73 }
74 ol, ul {
75 padding-left: 1.7em;
76 margin-top: 1em;
77 }
78 li > ol, li > ul {
79 margin-top: 0;
80 }
81 blockquote {
82 margin: 1em 0 1em 1.7em;
83 padding-left: 1em;
84 border-left: 2px solid #e6e6e6;
85 color: #606060;
86 }
87 code {
88 font-family: Menlo, Monaco, 'Lucida Console', Consolas, monospace;
89 font-size: 85%;
90 margin: 0;
91 }
92 pre {
93 margin: 1em 0;
94 overflow: auto;
95 }
96 pre code {
97 padding: 0;
98 overflow: visible;
99 overflow-wrap: normal;
100 }
101 .sourceCode {
102 background-color: transparent;
103 overflow: visible;
104 }
105 hr {
106 background-color: #1a1a1a;
107 border: none;
108 height: 1px;
109 margin: 1em 0;
110 }
111 table {
112 margin: 1em 0;
113 border-collapse: collapse;
114 width: 100%;
115 overflow-x: auto;
116 display: block;
117 font-variant-numeric: lining-nums tabular-nums;
118 }
119 table caption {
120 margin-bottom: 0.75em;
121 }
122 tbody {
123 margin-top: 0.5em;
124 border-top: 1px solid #1a1a1a;
125 border-bottom: 1px solid #1a1a1a;
126 }
127 th {
128 border-top: 1px solid #1a1a1a;
129 padding: 0.25em 0.5em 0.25em 0.5em;
130 }
131 td {
132 padding: 0.125em 0.5em 0.25em 0.5em;
133 }
134 header {
135 margin-bottom: 4em;
136 text-align: center;
137 }
138 #TOC li {
139 list-style: none;
140 }
141 #TOC ul {
142 padding-left: 1.3em;
143 }
144 #TOC > ul {
145 padding-left: 0;
146 }
147 #TOC a:not(:hover) {
148 text-decoration: none;
149 }
10 code{white-space: pre-wrap;} 150 code{white-space: pre-wrap;}
11 span.smallcaps{font-variant: small-caps;} 151 span.smallcaps{font-variant: small-caps;}
12 span.underline{text-decoration: underline;} 152 span.underline{text-decoration: underline;}
13 div.column{display: inline-block; vertical-align: top; width: 50%;} 153 div.column{display: inline-block; vertical-align: top; width: 50%;}
14 div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;} 154 div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
15 ul.task-list{list-style: none;} 155 ul.task-list{list-style: none;}
156 .display.math{display: block; text-align: center; margin: 0.5rem auto;}
16 </style> 157 </style>
158 <!--[if lt IE 9]>
159 <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
160 <![endif]-->
17</head> 161</head>
18<body> 162<body>
19<header id="title-block-header"> 163<header id="title-block-header">
@@ -21,20 +165,49 @@
21<p class="author">Robert Alessi</p> 165<p class="author">Robert Alessi</p>
22</header> 166</header>
23<h1 id="overview">Overview</h1> 167<h1 id="overview">Overview</h1>
24<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> 168<p><code>ekdosis</code> is a LuaLaTeX package designed for multilingual
169critical editions. It can be used to typeset texts and different layers
170of critical notes in any direction accepted by LuaTeX. Texts can be
171arranged in running paragraphs or on facing pages, in any number of
172columns which in turn can be synchronized or not. In addition to printed
173texts, <code>ekdosis</code> can convert <code>.tex</code> source files
174so as to produce <code>TEI xml</code>-compliant critical editions.
175Database-driven encoding under LaTeX then allows extraction of texts
176entered segment by segment according to various criteria: main edited
177text, variant readings, translations or annotated borrowings between
178texts. It is published under the terms of the GNU General Public License
179(GPL) version 3.</p>
25<h1 id="license-and-disclamer">License and Disclamer</h1> 180<h1 id="license-and-disclamer">License and Disclamer</h1>
26<p>ekdosis – Typesetting TEI xml-Compliant Critical Editions</p> 181<p>ekdosis – Typesetting TEI xml-Compliant Critical Editions</p>
27<p>Copyright ⓒ 2020–2022 Robert Alessi</p> 182<p>Copyright ⓒ 2020–2022 Robert Alessi</p>
28<p>Please send error reports and suggestions for improvements to Robert Alessi:</p> 183<p>Please send error reports and suggestions for improvements to Robert
184Alessi:</p>
29<ul> 185<ul>
30<li><p>email: <a href="mailto:alessi@robertalessi.net" class="email">alessi@robertalessi.net</a></p></li> 186<li><p>email: <a href="mailto:alessi@robertalessi.net"
31<li><p>website: <a href="http://www.ekdosis.org" class="uri">http://www.ekdosis.org</a></p></li> 187class="email">alessi@robertalessi.net</a></p></li>
32<li><p>comments, feature requests, bug reports: <a href="http://www.ekdosis.org/issues" class="uri">http://www.ekdosis.org/issues</a></p></li> 188<li><p>website: <a href="http://www.ekdosis.org"
33<li><p>mailing list, support: <a href="http://www.ekdosis.org/mailman/listinfo/ekdosis" class="uri">http://www.ekdosis.org/mailman/listinfo/ekdosis</a> [<a href="http://www.ekdosis.org/pipermail/ekdosis/">mailing list archives</a>]</p></li> 189class="uri">http://www.ekdosis.org</a></p></li>
190<li><p>comments, feature requests, bug reports: <a
191href="http://www.ekdosis.org/issues"
192class="uri">http://www.ekdosis.org/issues</a></p></li>
193<li><p>mailing list, support: <a
194href="http://www.ekdosis.org/mailman/listinfo/ekdosis"
195class="uri">http://www.ekdosis.org/mailman/listinfo/ekdosis</a> [<a
196href="http://www.ekdosis.org/pipermail/ekdosis/">mailing list
197archives</a>]</p></li>
34</ul> 198</ul>
35<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> 199<p>This program is free software: you can redistribute it and/or modify
36<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> 200it under the terms of the GNU General Public License as published by the
37<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> 201Free Software Foundation, either version 3 of the License, or (at your
202option) any later version.</p>
203<p>This program is distributed in the hope that it will be useful, but
204WITHOUT ANY WARRANTY; without even the implied warranty of
205MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
206Public License for more details.</p>
207<p>You should have received a copy of the GNU General Public License
208along with this program. If not, see <a
209href="http://www.gnu.org/licenses/"
210class="uri">http://www.gnu.org/licenses/</a>.</p>
38<p>This release of ekdosis consists of the following source files:</p> 211<p>This release of ekdosis consists of the following source files:</p>
39<ul> 212<ul>
40<li><p><code>ekdosis.dtx</code></p></li> 213<li><p><code>ekdosis.dtx</code></p></li>
@@ -42,27 +215,56 @@
42<li><p><code>ekdosis.el</code></p></li> 215<li><p><code>ekdosis.el</code></p></li>
43<li><p><code>Makefile</code></p></li> 216<li><p><code>Makefile</code></p></li>
44</ul> 217</ul>
45<h2 id="license-applicable-to-the-documentation">License Applicable to the Documentation</h2> 218<h2 id="license-applicable-to-the-documentation">License Applicable to
219the Documentation</h2>
46<p>Copyright ⓒ 2020–2022 Robert Alessi</p> 220<p>Copyright ⓒ 2020–2022 Robert Alessi</p>
47<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> 221<p>The documentation file <code>ekdosis.pdf</code> that is generated
48<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> 222from the <code>ekdosis.dtx</code> source file is licensed under the GNU
223Free Documentation License, as follows:—</p>
224<p>Permission is granted to copy, distribute and/or modify this document
225under the terms of the GNU Free Documentation License, Version 1.3 or
226any later version published by the Free Software Foundation; with no
227Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
228copy of the license is included in the section entitled “GNU Free
229Documentation License”.</p>
49<h1 id="installation">Installation</h1> 230<h1 id="installation">Installation</h1>
50<ol type="1"> 231<ol type="1">
51<li><p>Run <code>'latex ekdosis.ins'</code> to produce the <code>ekdosis.sty</code> and <code>ekdosis.lua</code> files.</p></li> 232<li><p>Run <code>'latex ekdosis.ins'</code> to produce the
52<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> 233<code>ekdosis.sty</code> and <code>ekdosis.lua</code> files.</p></li>
234<li><p>To finish the installation you have to move the
235<code>ekdosis.sty</code> and <code>ekdosis.lua</code> files into a
236directory where LaTeX can find them. See the FAQ on
237<code>texfaq.org</code> at <a href="https://texfaq.org/FAQ-inst-wlcf"
238class="uri">https://texfaq.org/FAQ-inst-wlcf</a> for more on
239this.</p></li>
53</ol> 240</ol>
54<h1 id="development-git-repository">Development, Git Repository</h1> 241<h1 id="development-git-repository">Development, Git Repository</h1>
55<h2 id="browse-the-code">Browse the Code</h2> 242<h2 id="browse-the-code">Browse the Code</h2>
56<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> 243<p>You can browse ekdosis repository on the web: <a
57<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> 244href="http://git.robertalessi.net/ekdosis"
58<h2 id="comments-feature-requests-bug-reports">Comments, Feature Requests, Bug Reports</h2> 245class="uri">http://git.robertalessi.net/ekdosis</a></p>
59<p><a href="http://www.ekdosis.org/issues" class="uri">http://www.ekdosis.org/issues</a></p> 246<p>From this page, you can download all the releases of
247<code>ekdosis</code>. For instructions on how to install
248<code>ekdosis</code>, please see above.</p>
249<h2 id="comments-feature-requests-bug-reports">Comments, Feature
250Requests, Bug Reports</h2>
251<p><a href="http://www.ekdosis.org/issues"
252class="uri">http://www.ekdosis.org/issues</a></p>
60<h2 id="download-the-repository">Download the Repository</h2> 253<h2 id="download-the-repository">Download the Repository</h2>
61<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> 254<p><code>ekdosis</code> development is facilitated by git, a distributed
255version control system. You will need to install git (most GNU/Linux
256distributions package it in their repositories).</p>
62<p>Use this command to download the repository</p> 257<p>Use this command to download the repository</p>
63<pre><code>git clone http://git.robertalessi.net/ekdosis</code></pre> 258<pre><code>git clone http://git.robertalessi.net/ekdosis</code></pre>
64<p>A new directory named ekdosis will have been created, containing <code>ekdosis</code>.</p> 259<p>A new directory named ekdosis will have been created, containing
260<code>ekdosis</code>.</p>
65<h2 id="git-hosting">Git Hosting</h2> 261<h2 id="git-hosting">Git Hosting</h2>
66<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> 262<p>Make an account on <a href="https://sr.ht"
263class="uri">https://sr.ht</a> and navigate (while logged in) to <a
264href="https://git.sr.ht/~ralessi/ekdosis"
265class="uri">https://git.sr.ht/~ralessi/ekdosis</a>. Click <em>Clone repo
266to your account</em> and you will have in your account your own
267repository of <code>ekdosis</code> where you will be able to make
268whatever changes you like to.</p>
67</body> 269</body>
68</html> 270</html>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-24 15:14:52 +0000