Merge pull request #149 from LukasCBossert/dtx

Dtx integration

Makefile

@@ -0,0 +1,60 @@
+MAKE  = make
+NAME  = archaeologie
+NAMEtypeout = $(CYAN)*** $(NAME) ***$(NC)
+BIB   = $(NAME)
+PFX   = biblatex-
+SHELL = bash
+PWD   = $(shell pwd)
+TEMP := $(shell mktemp -d -t tmp.XXXXXXXXXX)
+TDIR  = $(TEMP)/$(NAME)
+VERS  = $(shell /bin/date "+%Y-%m-%d---%H-%M-%S")
+LOCAL = $(shell kpsewhich --var-value TEXMFLOCAL)
+# Colors
+RED   = \033[0;31m
+CYAN  = \033[0;36m
+NC    = \033[0m
+
+.PHONY:  all clean cleanall zip install uninstall
+# Just create the PDF
+all: $(NAME).pdf
+	@echo -e "$(NAMEtypeout)\n$(RED) * all up to date * $(NC)"
+	@exit 0
+
+# How to create the PDF
+$(NAME).pdf: $(NAME).dtx
+	latexmk  -lualatex -f $(NAME).dtx
+
+
+# clean all temporary files
+clean:
+	rm -f {$(NAME),$(BIB)}.{sectionbibs.aux,thm,bibexample,biographies.aux,xdv,aux,mw,bbl,bcf,blg,doc,fdb_latexmk,fls,glo,gls,hd,idx,ilg,ind,listing,log,nav,out,run.xml,snm,synctex.gz,toc,vrb}
+	rm -f $(NAME).markdown.{in,lua,out}
+	rm -f *.{log,aux}
+	rm -rf _markdown_*
+	@echo -e "$(NAMEtypeout) \n      $(RED)cleaned temp files $(NC)"
+
+# clean all files
+cleanbundle: clean
+	rm -f *.{{b,c,d,l}bx,ins,pdf,zip,bib}
+	@echo -e "$(NAMEtypeout) \n      $(RED)cleaned all files $(NC)"
+
+# zip files up for sending etc.
+ctan: all
+	rm -f $(NAME)*.zip
+	mkdir $(TDIR)
+	cp $(NAME).{dtx,pdf} README.md Makefile $(TDIR)
+	cd $(TEMP); zip -Drq $(PWD)/$(NAME)-$(VERS).zip $(NAME)
+	@echo -e "$(NAMEtypeout) \n      $(RED)files zipped $(NC)"
+
+# install in your local TEX folder
+install: all
+	sudo mkdir -p $(LOCAL)/{tex,source,doc}/latex/$(PFX)$(NAME)
+	sudo cp $(NAME).{dtx,ins} $(LOCAL)/source/latex/$(PFX)$(NAME)
+	sudo cp $(BIB).{b,c,d}bx {english,german,italian,french,spanish}-$(NAME).lbx $(LOCAL)/tex/latex/$(PFX)$(NAME)
+	sudo cp $(NAME).pdf $(NAME)-*.bib $(LOCAL)/doc/latex/$(PFX)$(NAME)
+	sudo mktexlsr
+	@echo -e "$(NAMEtypeout) \n      $(RED)all files installed$(NC)"
+
+uninstall:
+	sudo rm -r $(LOCAL)/{tex,source,doc}/latex/$(PFX)$(NAME)
+	sudo mktexlsr

README.md

@@ -1,13 +1,12 @@
-bibLaTeX-__archaeologie__    
+bibLaTeX-__archaeologie__ Bundle
 =======
 
 bibLaTeX-style for archaeologists, historians and philologists.
 ---
-_2018/XX/XX v2.3.8beta_
 
+Copyright (c) 2016-2018 Lukas C. Bossert
 
-
-Copyright (c) 2016-2018 Lukas C. Bossert | Johannes Friedl
+Copyright (c) 2015 Lukas C. Bossert | Johannes Friedl
 
 * Email: [[email protected]](mailto:[email protected])
 * Website: [www.biblatex-archaeologie.de](http://www.biblatex-archaeologie.de)
@@ -31,9 +30,7 @@ This style contains:
 documentation:
 
 - archaeologie.pdf
-- archaeologie.tex
-- archaeologie-ger.pdf (*short documentation*)
-- archaeologie-ger.tex
+- archaeologie.dtx
 
 mandatory:
 
@@ -58,54 +55,82 @@ additional lists and bibliographies:
 - archaeologie-bibcorpora.bib
 - archaeologie-bibancient.bib
 
+-----------------
+
+This work may be distributed and/or modified under the
+conditions of the LaTeX Project Public License, either version 1.3
+of this license or (at your option) any later version.
+The latest version of this license is in [http://www.latex-project.org/lppl.txt](http://www.latex-project.org/lppl.txt) and version 1.3 or later is part of all distributions of LaTeX
+version 2005/12/01 or later.
+
+---
+This work has the LPPL maintenance status _maintained_.
+The current maintainer of this work is [Lukas C. Bossert](https://github.com/LukasCBossert).
+
+## Installation of the bundle
+`archaeologie` is part of the distributions [MiKTeX](http://www.miktex.org)
+and [TeXLive](http://www.tug.org/texlive) -- thus, you
+can easily install it using the respective package manager.
+If you would like to
+install `archaeologie` into your local folder  manually, do the following:
+Go to your terminal, browse to the folder of this bundle and run
+
+`make install`
+
+If you are using macOS you will be asked for your user account password for the installation.
+
+Further options of this makefile are:
 
-# Changelog
+* `clean`:  deletes all unnecessary files
+* `cleanbundle`:  deletes all files except `.dtx`, `.pl`, `.md`. You will get the plain version of this bundle.
+This might be helpful if you send the bundle to someone else.
+* `ctan`:  this will create a zip file which can be used to send to CTAN.
+* `uninstall`: will erase the locally installed files.
 
-All notable changes to this project will be documented in this file.
+This bundle is constantly updated. For hints, errors or suggestions use the GitHub repository [https://github.com/LukasCBossert/biblatex-archaeologie](https://github.com/LukasCBossert/biblatex-archaeologie).
+
+## Changelog
+
+All notable changes to this project will be documented in the README.md.
 This project **does not** adhere to [Semantic Versioning](http://semver.org/).
 The markdown syntax is inspired by the conventions proposed by [keepachangelog.com](http://keepachangelog.com/).
-
-## v2.3.8 (2018-XX-XXX)
+## v2.4.0 (2018-09-25)
 
 ### *Fixed*
-* there was a bug if the field `eventdatelanguage` wasn’t defined [see #145](https://github.com/LukasCBossert/biblatex-archaeologie/issues/145)
+* there was a bug if the field `eventdatelanguage` wasn’t defined [see issue no. 145](https://github.com/LukasCBossert/biblatex-archaeologie/issues/145)
 * if the field `volume` doesn’t have an integer it won’t proceed with it as Roman numeral
 * somehow the field `edition` was missing for `references`, fixed it.
 * a mysterious space in the name part, got rid of it
 * missing space before `volumes`, added a space
 
 ### *Changed*
+* BIG change: all files are generated from the `.dtx` file. This is such a major change so we skipped some version numnbers and jumped directly to `2.4.0`.
 * the fields `postnote` and `multipostnote` are formatted with `\mknormrange`, that means you don’t have to type `--` to get an endash for page ranges.
 
-
 ## v2.3.7 (2018-04-08)
 
 ### *Added*
 * New data-field `arachne = {}` to reference to the database iDAI.objects arachne
 * Alias `matheseis` for `thesis` (for all Zotero-users) (`\DeclareBibliographyAlias{mathesis}{thesis}`)
 * field `eventdatelanguage`, you can get the date of the field `eventdate` in the chosen language, enable with `eventdatelanguage=true`
 
-
 ### *Changed*
 * `inreferences=true` is now called `inreferencesasfullcite=true` due to better understanding of the option. There is a fallback.
 *  `bibstrings` are defined in `archaeologie.bbx` now
 * `editortype` is now used as `parens`
 * `autolang=hyphen` now you can use `langid={}` to manage to language of an entry
 
-
 ### *Fixed*
 * better coding for the year delimiter (thanks to moewe!)
 
-
 ### *Deleted*
 *  Version `initials` has to be deleted since its incompatibility to `biber`-version `2.11` see [https://github.com/plk/biber/issues/215](https://github.com/plk/biber/issues/215)
 
-
 ## v2.3.6 (2018-02-20)
 
 ### *Added*
 * `citeauthorformat=firstinitialsthenfamily` as requested in
-[#138](https://github.com/LukasCBossert/biblatex-archaeologie/issues/138),
+[see issue no. 138](https://github.com/LukasCBossert/biblatex-archaeologie/issues/138),
 * `citeauthorformat=firstfullthenfamily`
 
 ### *Changed*
@@ -119,11 +144,10 @@ The markdown syntax is inspired by the conventions proposed by [keepachangelog.c
 * wrong entry with `\archaeologieoptions` deleted
 * labeldates now work correctly
 
-
 ## v2.3.5 (2018-02-13)
 
 ### *Fixed*
-* `\citereset` for author names (https://github.com/LukasCBossert/biblatex-archaeologie/issues/122)
+* `\citereset` for author names [see issue no. 122](https://github.com/LukasCBossert/biblatex-archaeologie/issues/122)
 * `\citetitle` will give the original title of a work which has the option `ancient`;
 `\citetitle*` instead will always give title without year.
 * no comma before `in:` if title is missing (got wrong in last version)
@@ -138,33 +162,31 @@ This update is also due to compatibility with `biblatex 3.8a`/`biber 2.8`.
 
 ### *Fixed*
 * Arrangement of multiple authors with `\textcites`; see
-[#115](https://github.com/LukasCBossert/biblatex-archaeologie/issues/115), solved with [https://tex.stackexchange.com/a/387162/98739](https://tex.stackexchange.com/a/387162/98739)
+[see issue no. 115](https://github.com/LukasCBossert/biblatex-archaeologie/issues/115), solved with [https://tex.stackexchange.com/a/387162/98739](https://tex.stackexchange.com/a/387162/98739)
 * Delimiter of `subtitle` and `titleaddon`, it is now a comma instead of fullstop.
 * Remodelled the bibmacro `volume` and fixed a bug of a duplicate `volume`.
 * `in:` is now always with minor `I` it doesn’t matter if follows a dot.
 
-
 #### *added*
-* `@MvBook` and its children can be listed in the bibliography together; see [#118](https://github.com/LukasCBossert/biblatex-archaeologie/issues/118)
+* `@MvBook` and its children can be listed in the bibliography together [see issue no. 118](https://github.com/LukasCBossert/biblatex-archaeologie/issues/118)
 
 * `\citetitle*` for showing the publication title without year of publication.
 
 * You can use the namefield `bookauthor` now, then no *(ed.)* will be printed.
 
-
 ## v2.3.3 (2017-08-10)
 
 #### *fixed*
 * typo in documentation
 
 #### *added*
-* if there is no `translator` `\citetranslator` will fall back to the `bibstring` "owntranslation" which can be modified; see [#112](https://github.com/LukasCBossert/biblatex-archaeologie/issues/112) and [tex.stackexchange.com/q/385719/98739](https://tex.stackexchange.com/q/385719/98739) thanks to [moewe](https://tex.stackexchange.com/users/35864/moewe)
+* if there is no `translator` `\citetranslator` will fall back to the `bibstring` "owntranslation" which can be modified; see [112](https://github.com/LukasCBossert/biblatex-archaeologie/issues/112) and [tex.stackexchange.com/q/385719/98739](https://tex.stackexchange.com/q/385719/98739) thanks to [moewe](https://tex.stackexchange.com/users/35864/moewe)
 
 ## v2.3.2 (2017-07-19)
 
 #### *fixed*
 * wrong code-example in documentation
-* issue [#111](https://github.com/LukasCBossert/biblatex-archaeologie/issues/111) (regarding option `inreferences`) solved, thanks to [moewe](https://tex.stackexchange.com/users/35864/moewe)
+* issue [see issue no. 111](https://github.com/LukasCBossert/biblatex-archaeologie/issues/111) (regarding option `inreferences`) solved, thanks to [moewe](https://tex.stackexchange.com/users/35864/moewe)
 
 ## v2.31 (2017-05-29)
 
@@ -190,19 +212,5 @@ This update is also due to compatibility with `biblatex 3.8a`/`biber 2.8`.
 * *added* <br> `uniqueme` for variant translations of ancient works.
 * *added* <br> bibliography-file `archaeologie-examples.bib` included
 
-
 [current release]: http://www.biblatex-archaeologie.de
 [unreleased]: http://github.com/LukasCBossert/biblatex-archaeologie
-
-
-______________________
-
-This work may be distributed and/or modified under the
-conditions of the LaTeX Project Public License, either version 1.3
-of this license or (at your option) any later version.
-The latest version of this license is in [http://www.latex-project.org/lppl.txt](http://www.latex-project.org/lppl.txt) and version 1.3 or later is part of all distributions of LaTeX
-version 2005/12/01 or later.
-
----
-This work has the LPPL maintenance status _maintained_.
-The current maintainer of this work is [Lukas C. Bossert](https://github.com/LukasCBossert).