From 1fbd4becbd764809ea7f31ca85f26ec3c20af9e9 Mon Sep 17 00:00:00 2001 From: Robert Alessi Date: Wed, 8 Jul 2020 18:22:28 +0200 Subject: final adjustments. this is v0.99a --- README.md | 32 +++++++++++++++++--------------- about.html | 14 ++++++++------ ekdosis.dtx | 2 +- ekdosis.ins | 7 ++++--- 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 published under the terms of the GNU General Public License (GPL) version 3. - -License and disclamer +Notice to the Gentle Reader +=========================== +The current state of this documentation covers the basics of +`ekdosis`, 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, +, 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. + +License and Disclamer ===================== - ekdosis – Typesetting TEI xml Compliant Critical Editions Copyright ⓒ 2020 Robert Alessi @@ -60,9 +68,8 @@ This release of icite consists of the following source files: - `Makefile` -License applicable to the documentation +License Applicable to the Documentation --------------------------------------- - Copyright ⓒ 2020 Robert Alessi The documentation file `ekdosis.pdf` that is generated from the @@ -78,7 +85,6 @@ Permission is granted to copy, distribute and/or modify this document Installation ============ - 1. Run `'latex ekdosis.ins'` to produce the `ekdosis.sty` and `ekdosis.lua` files. @@ -90,23 +96,21 @@ Installation Development, Git Repository =========================== -Browse the code +Browse the Code --------------- - You can browse icite repository on the web: From this page, you can download all the releases of `ekdosis`. For instructions on how to install `ekdosis`, please see above. -Comments, Feature requests, Bug Reports +Comments, Feature Requests, Bug Reports --------------------------------------- - -Download the repository ------------------------ +Download the Repository +----------------------- `ekdosis` 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). @@ -118,11 +122,9 @@ Use this command to download the repository A new directory named icite will have been created, containing `ekdosis`. -Git hosting +Git Hosting ----------- - Make an account on and navigate (while logged in) to . Click *Fork* and you will have in your account your own repository of `ekdosis` where you will be able to make whatever changes you like to. - diff --git a/about.html b/about.html index 80f474f..895b884 100644 --- a/about.html +++ b/about.html @@ -15,7 +15,9 @@

Overview

ekdosis 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, ekdosis can convert .tex source files so as to produce TEI xml 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.

-

License and disclamer

+

Notice to the Gentle Reader

+

The current state of this documentation covers the basics of ekdosis, 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, http://www.robertalessi.net/ekdosis, 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.

+

License and Disclamer

ekdosis – Typesetting TEI xml Compliant Critical Editions

Copyright ⓒ 2020 Robert Alessi

Please send error reports and suggestions for improvements to Robert Alessi:

@@ -34,7 +36,7 @@

  • ekdosis.el

  • Makefile

    • -

    License applicable to the documentation

    +

    License Applicable to the Documentation

    Copyright ⓒ 2020 Robert Alessi

    The documentation file ekdosis.pdf that is generated from the ekdosis.dtx source file is licensed under the GNU Free Documentation License, as follows:---

    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”.

    @@ -44,17 +46,17 @@

  • To finish the installation you have to move the ekdosis.sty and ekdosis.lua files into a directory where LaTeX can find it. See the FAQ on texfaq.org at https://texfaq.org/FAQ-inst-wlcf for more on this.

    • Development, Git Repository

    -

    Browse the code

    +

    Browse the Code

    You can browse icite repository on the web: http://git.robertalessi.net/ekdosis

    From this page, you can download all the releases of ekdosis. For instructions on how to install ekdosis, please see above.

    -

    Comments, Feature requests, Bug Reports

    +

    Comments, Feature Requests, Bug Reports

    https://gitlab.com/ralessi/ekdosis/issues

    -

    Download the repository

    +

    Download the Repository

    ekdosis 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).

    Use this command to download the repository

    git clone http://git.robertalessi.net/ekdosis

    A new directory named icite will have been created, containing ekdosis.

    -

    Git hosting

    +

    Git Hosting

    Make an account on https://gitlab.com and navigate (while logged in) to https://gitlab.com/ralessi/ekdosis. Click Fork and you will have in your account your own repository of ekdosis where you will be able to make whatever changes you like to.

    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}{;}+ % any point of the document to set or to modify alignment settings. % % \section{To Be Continued...} -% v1.0 of \pkg{ekdosis} which should be available by the end of July +% v1.0 of \pkg{ekdosis}, which should be available by the end of July % 2020, will include a full documentation. At the time of writing, the % author is working on this part of the package. % 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 along with this program. If not, see . -This work consists of the file ekdosis.dtx and a Makefile. -Running "make" generates the derived files README, ekdosis.pdf and ekdosis.sty. +This work consists of the files ekdosis.dtx, ekdosis.el, this file and +a Makefile. +Running "make" generates the derived files README, ekdosis.pdf and +ekdosis.sty. Running "make inst" installs the files in the user's TeX tree. -Running "make install" installs the files in the local TeX tree. \endpreamble \usedir{tex/lualatex/ekdosis} -- cgit v1.2.3