diff options
author | Robert Alessi <alessi@robertalessi.net> | 2020-08-14 10:52:56 +0200 |
---|---|---|
committer | Robert Alessi <alessi@robertalessi.net> | 2020-08-14 10:52:56 +0200 |
commit | 4b05238fee9c43acb8d05b98779e7c559e651c9d (patch) | |
tree | 301b0ac76bcd80285cb536d0661702c63f7fa93c | |
parent | 70d00b9ff02d4e91e8925fc55fcab4658b6ebe37 (diff) | |
download | ekdosis-4b05238fee9c43acb8d05b98779e7c559e651c9d.tar.gz |
adapted makefiles. a few additions in the documentation. this is v1.0
-rw-r--r-- | Makefile | 12 | ||||
-rw-r--r-- | README.md | 10 | ||||
-rw-r--r-- | about.html | 2 | ||||
-rw-r--r-- | ekdosis.dtx | 27 | ||||
-rw-r--r-- | samples/Makefile | 8 |
5 files changed, 28 insertions, 31 deletions
@@ -13,10 +13,15 @@ findopts := $(foreach ext,$(exts),-or -iname "*.$(ext)") | |||
13 | 13 | ||
14 | all: sty $(NAME).pdf | 14 | all: sty $(NAME).pdf |
15 | 15 | ||
16 | testsamples: | ||
17 | if [ ! -d $(SAMPLES) ] ; \ | ||
18 | then echo "$(SAMPLES)/ directory is needed. Aborting." && exit 1 ; \ | ||
19 | fi | ||
20 | |||
16 | sty: clean | 21 | sty: clean |
17 | $(CMP) $(NAME).ins >/dev/null | 22 | $(CMP) $(NAME).ins >/dev/null |
18 | 23 | ||
19 | $(NAME).pdf: $(NAME).dtx | 24 | $(NAME).pdf: testsamples $(NAME).dtx |
20 | @ echo "Making the sample files first..." | 25 | @ echo "Making the sample files first..." |
21 | $(MAKE) --directory=$(SAMPLES) | 26 | $(MAKE) --directory=$(SAMPLES) |
22 | @ echo "Building the documentation of $(NAME)..." | 27 | @ echo "Building the documentation of $(NAME)..." |
@@ -33,7 +38,7 @@ $(NAME).pdf: $(NAME).dtx | |||
33 | samples: clean sty | 38 | samples: clean sty |
34 | $(MAKE) --directory=$(SAMPLES) | 39 | $(MAKE) --directory=$(SAMPLES) |
35 | 40 | ||
36 | clean: | 41 | clean: testsamples |
37 | rm -rf auto | 42 | rm -rf auto |
38 | rm -f $(NAME).bib $(PWD)/TMP/*.bib | 43 | rm -f $(NAME).bib $(PWD)/TMP/*.bib |
39 | rm -rf .backup | 44 | rm -rf .backup |
@@ -93,4 +98,5 @@ package: distclean all | |||
93 | tar czf $(NAME)-$(VERS).tar.gz $(NAME).tds.zip $(NAME)/ | 98 | tar czf $(NAME)-$(VERS).tar.gz $(NAME).tds.zip $(NAME)/ |
94 | rm -rf $(NAME)/ | 99 | rm -rf $(NAME)/ |
95 | 100 | ||
96 | .PHONY: all clean distclean inst local uninst install uninstall zip package samples | 101 | .SILENT: testsamples |
102 | .PHONY: all clean distclean inst local uninst install uninstall zip package samples testsamples | ||
@@ -19,16 +19,6 @@ readings, translations or annotated borrowings between texts. It is | |||
19 | published under the terms of the GNU General Public License (GPL) | 19 | published under the terms of the GNU General Public License (GPL) |
20 | version 3. | 20 | version 3. |
21 | 21 | ||
22 | Notice to the Gentle Reader | ||
23 | =========================== | ||
24 | The current state of this documentation covers the basics of | ||
25 | `ekdosis`, namely what should be enough to start a new document and | ||
26 | see how it works. v1.0 with a full documentation should be out by the | ||
27 | end 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 | ||
29 | subscribe to and a section entitled “Literature” where one will find | ||
30 | some slides and a paper submitted to a journal. | ||
31 | |||
32 | License and Disclamer | 22 | License and Disclamer |
33 | ===================== | 23 | ===================== |
34 | ekdosis – Typesetting TEI xml Compliant Critical Editions | 24 | ekdosis – Typesetting TEI xml Compliant Critical Editions |
@@ -15,8 +15,6 @@ | |||
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="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> | 18 | <h1 id="license-and-disclamer">License and Disclamer</h1> |
21 | <p>ekdosis – Typesetting TEI xml Compliant Critical Editions</p> | 19 | <p>ekdosis – Typesetting TEI xml Compliant Critical Editions</p> |
22 | <p>Copyright ⓒ 2020 Robert Alessi</p> | 20 | <p>Copyright ⓒ 2020 Robert Alessi</p> |
diff --git a/ekdosis.dtx b/ekdosis.dtx index ebbd2ee..5eb4844 100644 --- a/ekdosis.dtx +++ b/ekdosis.dtx | |||
@@ -582,20 +582,6 @@ along with this program. If not, see | |||
582 | % \metapick[print]{titletext} | 582 | % \metapick[print]{titletext} |
583 | % \end{tcolorbox} | 583 | % \end{tcolorbox} |
584 | % | 584 | % |
585 | % \begin{comment} | ||
586 | % \begin{tcolorbox}[title=Notice to the Gentle Reader] | ||
587 | % The current state of this documentation covers the basics of | ||
588 | % \pkg{ekdosis}, namely what should be enough to start a new | ||
589 | % document and see how it works. v1.0 with a full documentation | ||
590 | % should be out by the end of July. Until then, there is a web | ||
591 | % page that can be accessed,\footnote{% | ||
592 | % \url{http://www.robertalessi.net/ekdosis}} with a mailing list | ||
593 | % that one can subscribe to and a section entitled | ||
594 | % \enquote{Literature} where one will find some slides and a paper | ||
595 | % submitted to a journal. | ||
596 | % \end{tcolorbox} | ||
597 | % \end{comment} | ||
598 | % | ||
599 | % \tableofcontents | 585 | % \tableofcontents |
600 | % \listoflistings | 586 | % \listoflistings |
601 | % | 587 | % |
@@ -2608,6 +2594,15 @@ argument of the | |||
2608 | % can be used to enable modulo line numbering as described above.\\ | 2594 | % can be used to enable modulo line numbering as described above.\\ |
2609 | % \DescribeMacro{\resetlinenumber} \cs{resetlinenumber}\oarg{n} resets | 2595 | % \DescribeMacro{\resetlinenumber} \cs{resetlinenumber}\oarg{n} resets |
2610 | % the line number to one or to \emph{n} if specified.\\ | 2596 | % the line number to one or to \emph{n} if specified.\\ |
2597 | % \DescribeMacro{\linenumberfont} | ||
2598 | % \cs{renewcommand}|{\linenumberfont}|\marg{commands} can be used to | ||
2599 | % set the font used for the line numbers that are printed in the | ||
2600 | % margins. By default, the definition is | ||
2601 | % \cs{normalfont}\cs{footnotesize}.\\ | ||
2602 | % \DescribeMacro{\linenumbersep} \cs{linenumbersep} is the distance | ||
2603 | % between the numbers and the margin. By default, this distance is set | ||
2604 | % to \unit[10]{pt}. It can be redefined like so: | ||
2605 | % \cs{setlength}\cs{linenumbersep}\marg{length}.\\ | ||
2611 | % \DescribeMacro{\linelabel} \DescribeMacro{\lineref} | 2606 | % \DescribeMacro{\linelabel} \DescribeMacro{\lineref} |
2612 | % \cs{linelabel}\marg{label} sets a line label that can be referred to | 2607 | % \cs{linelabel}\marg{label} sets a line label that can be referred to |
2613 | % with \cs{lineref}\marg{label}. | 2608 | % with \cs{lineref}\marg{label}. |
@@ -3463,6 +3458,7 @@ subtype="arabtex">'inna 'abI kAna mina | |||
3463 | % issue warnings if such labels contain invalid strings. | 3458 | % issue warnings if such labels contain invalid strings. |
3464 | % | 3459 | % |
3465 | % \paragraph{\texttt{TEI xml} Export Settings} | 3460 | % \paragraph{\texttt{TEI xml} Export Settings} |
3461 | % \label{ref:setteixmlexport} | ||
3466 | % \DescribeMacro{\SetTEIxmlExport} \cs{SetTEIxmlExport}\marg{csv list | 3462 | % \DescribeMacro{\SetTEIxmlExport} \cs{SetTEIxmlExport}\marg{csv list |
3467 | % of options} can be used in the preamble or at any point of the | 3463 | % of options} can be used in the preamble or at any point of the |
3468 | % document, except inside environments set to receive an apparatus | 3464 | % document, except inside environments set to receive an apparatus |
@@ -3811,7 +3807,8 @@ Sample text with a \textcolor{red}{word} in red. | |||
3811 | % speech.\footnote{See | 3807 | % speech.\footnote{See |
3812 | % \url{https://tei-c.org/release/doc/tei-p5-doc/en/html/TS.html}.} The | 3808 | % \url{https://tei-c.org/release/doc/tei-p5-doc/en/html/TS.html}.} The |
3813 | % technique applied below uses \cs{EnvtoTEI} conjointly with | 3809 | % technique applied below uses \cs{EnvtoTEI} conjointly with |
3814 | % \cs{SetTEIxmlExport}|{autopar=|\allowbreak|false}|:--- | 3810 | % \cs{SetTEIxmlExport}|{autopar=|\allowbreak|false}| described above |
3811 | % \vpageref{ref:setteixmlexport}:--- | ||
3815 | % | 3812 | % |
3816 | % \iffalse | 3813 | % \iffalse |
3817 | %<*example> | 3814 | %<*example> |
diff --git a/samples/Makefile b/samples/Makefile index 49bb11b..8cb7a98 100644 --- a/samples/Makefile +++ b/samples/Makefile | |||
@@ -13,7 +13,7 @@ define dosamples | |||
13 | $(CMP) --shell-escape $1 >/dev/null | 13 | $(CMP) --shell-escape $1 >/dev/null |
14 | endef | 14 | endef |
15 | 15 | ||
16 | all: | 16 | all: test |
17 | cp ../ekdosis.{lua,sty} . | 17 | cp ../ekdosis.{lua,sty} . |
18 | $(foreach file,$(texsamples), $(call dosamples, $(file))) | 18 | $(foreach file,$(texsamples), $(call dosamples, $(file))) |
19 | rm -rf auto | 19 | rm -rf auto |
@@ -24,4 +24,10 @@ all: | |||
24 | cp -p -r .backup/* . | 24 | cp -p -r .backup/* . |
25 | rm -rf .backup | 25 | rm -rf .backup |
26 | 26 | ||
27 | test: | ||
28 | if [ ! -e ../ekdosis.sty ] || [ ! -e ../ekdosis.lua ] ;\ | ||
29 | then echo "This Makefile cannot be invoked but recursively. Aborting." && exit 1 ;\ | ||
30 | fi | ||
31 | |||
32 | .SILENT: test | ||
27 | .PHONY: all | 33 | .PHONY: all |