From 0e2ee1feda80f4ed80ebaa8681ddd38493741dbc Mon Sep 17 00:00:00 2001 From: Frank Steinberg <steinberg@ibr.cs.tu-bs.de> Date: Fri, 4 Oct 2019 17:41:43 +0200 Subject: [PATCH] README cleanup. Makefile workflow streamlined. --- Makefile | 6 +++--- README.md | 11 +++++------ 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/Makefile b/Makefile index 75a04f5..d031efa 100644 --- a/Makefile +++ b/Makefile @@ -3,20 +3,20 @@ default: bjcp-2015-styleguide-orig.xml orig bjcp-2015-styleguide-de.xml bjcp-201 cache/2015_Guidelines_Beer.docx: if [ ! -d cache ] ; then mkdir cache ; fi - curl https://www.bjcp.org/docs/2015_Guidelines_Beer.docx -o cache/2015_Guidelines_Beer.docx + curl -s https://www.bjcp.org/docs/2015_Guidelines_Beer.docx -o cache/2015_Guidelines_Beer.docx cache/bjcp-2015-styleguide-word.xml: cache/2015_Guidelines_Beer.docx unzip -p cache/2015_Guidelines_Beer.docx word/document.xml | xmllint --format - > cache/bjcp-2015-styleguide-word.xml bjcp-2015-styleguide-orig.xml: fix cache/bjcp-2015-styleguide-word.xml xsl/bjcp-2015-styleguide-doc-to-xml.xsl - xsltproc xsl/bjcp-2015-styleguide-doc-to-xml.xsl cache/bjcp-2015-styleguide-word.xml > bjcp-2015-styleguide-orig.xml + -xsltproc --output bjcp-2015-styleguide-orig.xml xsl/bjcp-2015-styleguide-doc-to-xml.xsl cache/bjcp-2015-styleguide-word.xml 2>&1 | grep -v "failed to load external entity" orig: bjcp-2015-styleguide-orig.xml xsl/bjcp-2015-styleguide-split.xsl if [ ! -d orig ] ; then mkdir orig ; fi xsltproc xsl/bjcp-2015-styleguide-split.xsl bjcp-2015-styleguide-orig.xml bjcp-2015-styleguide-de.xml: orig de xsl/bjcp-2015-styleguide-translate.xsl - xsltproc --stringparam lang de xsl/bjcp-2015-styleguide-translate.xsl bjcp-2015-styleguide-orig.xml > bjcp-2015-styleguide-de.xml + -xsltproc --stringparam lang de --output bjcp-2015-styleguide-de.xml xsl/bjcp-2015-styleguide-translate.xsl bjcp-2015-styleguide-orig.xml 2>&1 | grep -v "failed to load external entity" bjcp-2015-styleguide-orig.html: xsl/bjcp-2015-styleguide-html.xsl xsltproc xsl/bjcp-2015-styleguide-html.xsl bjcp-2015-styleguide-orig.xml > bjcp-2015-styleguide-orig.html diff --git a/README.md b/README.md index b6cbf8a..54b951c 100644 --- a/README.md +++ b/README.md @@ -4,22 +4,21 @@ This is a new approach to achieve two goals: -- tranlating BJCP documents (primarily the beer styleguide 2015) to the German language (in a way that easily allows to add further languages), +- tranlating BJCP documents (so far, we care only about the 2015 beer styleguide) to the German language (in a way that easily allows to add further languages), - establishing an XML form of the styleguide in order to support a flexible transformation architecture for a variety of destination formats. ## Concept & Roadmap -- Create a consistent XML representation from the original BJCP styleguide docx document. -- Double-check its consitency, which is not implcit, because of potential typos and inconsistencies in the manually crafted original Word document. -- Continuously add and update translated content in the German "de" folder. +- Create a consistent XML representation from the original BJCP styleguide docx document. This will require some hacks, since the original document is hand-crafted and thus shows some inconsistencies. +- Continuously add and update translated content. - Develop a XSL tranformation to rebuild a (partially) translated XML styleguide. - Develop XSL / XSL-FO (maybe LaTeX) backends to create PDF, HTML and potentially other destination documents. ## Procedure -- If you are just curious about the current state of this project's results, you make take a look at the so called "[artifacts](https://gitlab.ibr.cs.tu-bs.de/steinb/bjcp-2015-styleguide/-/jobs/artifacts/master/download?job=build)" at the GitLab repository at which are automatically rebuilt after each commit. +- If you are just curious about the current state of this project's results, you may take a look at the so called "[artifacts](https://gitlab.ibr.cs.tu-bs.de/steinb/bjcp-2015-styleguide/-/jobs/artifacts/master/download?job=build)" of the GitLab repository which get automatically rebuilt after each commit. -- MacOS systems should have the required tools. On Linux you should install some packages, e.g. on Ubuntu: +- MacOS systems should have the required tools when the XCode App is installed. On Linux you should install some packages, e.g. on Ubuntu: ``` apt install make curl libxml2-utils xsltproc ``` -- GitLab