tei->eoatex: simpler installation and README

EditionOpenAccess · Nov 22, 2019 · 7e829b9 · 7e829b9
1 parent 0d003ab
commit 7e829b9
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 32 deletions.
diff --git a/README.md b/README.md
@@ -83,22 +83,8 @@ Compiling your documents involves following a workflow which can consist of seve
 
 ## The LaTeX workflow (eoatex -> pdf, django, epub)
 
-1. load environment variables (just for convenience):
-
-		$ source .env
-
-	This step will make available the environment variables from `.env`, such as `$INPUT_DIR`.
-
-1. copy your publication into the `$INPUT_DIR`
-
-		$ mkdir temp
-		$ cd temp
-		$ git clone 'https://github.molgen.mpg.de/EditionOpenAccess/eoa-publication-model.git'
-		$ cd eoa-publication-model
-		$ git checkout 8fc4ea49340e551ff52afe303abd624f1d44dd12
-		$ cd ../..
-		$ mkdir --parents $INPUT_DIR/example
-		$ cp -r --dereference "temp/eoa-publication-model/examples/eoatex" "$INPUT_DIR/example/eoatex"
+The following description uses the example publication in `input/example` (from the `eoa-publication-model` repository).
+In order to apply the workflow to any other publication copy it into the `input/` directory and adjust paths in the description accordingly.
 
 1. enter the docker container
 
@@ -115,22 +101,8 @@ Compiling your documents involves following a workflow which can consist of seve
 
 ## The DocX workflow (docx -> TEI -> pdf, django, epub)
 
-1. load environment variables (just for convenience):
-
-		$ source .env
-
-	This step will make available the environment variables from `.env`, such as `$INPUT_DIR`.
-
-1. copy your publication into the `$INPUT_DIR`
-
-		$ mkdir temp
-		$ cd temp
-		$ git clone 'https://github.molgen.mpg.de/EditionOpenAccess/eoa-publication-model.git'
-		$ cd eoa-publication-model
-		$ git checkout 8fc4ea49340e551ff52afe303abd624f1d44dd12
-		$ cd ../..
-		$ mkdir --parents $INPUT_DIR/example
-		$ cp -r --dereference "temp/eoa-publication-model/examples/tei" "$INPUT_DIR/example/tei"
+The following description uses the example publication in `input/example` (from the `eoa-publication-model` repository).
+In order to apply the workflow to any other publication copy it into the `input/` directory and adjust paths in the description accordingly.
 
 1. enter the docker container
 

diff --git a/scripts/init.py b/scripts/init.py
@@ -43,6 +43,10 @@ def create_dirs( config ):
     create_dir(
         BASE_DIR / config['OUTPUT_DIR']
     )
+    copy_dir(
+        BASE_DIR / config['DEPENDENCIES_DIR'] / 'eoa-publication-model/examples',
+        BASE_DIR / config['INPUT_DIR'] / 'example'
+    )
 
 def install_git_dep(
     repo_name,
@@ -107,6 +111,12 @@ def install_git_dep(
         repo_hash = "2a01be46ee82fce5eba6074359b3d18db2222e0c",
         force = args.force_deps,
     )
+    install_git_dep(
+        repo_name = "eoa-publication-model",
+        repo_uri = "https://github.molgen.mpg.de/EditionOpenAccess/eoa-publication-model.git",
+        repo_hash = "ea8a2eb99b22703f1ef92544352701f07c08d17e",
+        force = args.force_deps,
+    )
 
     # rebuild docker image:
     if args.build: