From e7ed5fbe56b982e0b7d753d5407dea6bca63c970 Mon Sep 17 00:00:00 2001
From: Frank Steinberg <steinberg@ibr.cs.tu-bs.de>
Date: Fri, 4 Oct 2019 19:33:25 +0200
Subject: [PATCH] Better step-by-step explanation. Other updates.
---
.gitignore | 2 ++
README.md | 26 +++++++++++++++++++++-----
2 files changed, 23 insertions(+), 5 deletions(-)
diff --git a/.gitignore b/.gitignore
index f65375c..a67826d 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,6 @@
bjcp-2015-styleguide-de.xml
bjcp-2015-styleguide-orig.xml
+bjcp-2015-styleguide-de.html
+bjcp-2015-styleguide-orig.html
cache/
orig/
diff --git a/README.md b/README.md
index 19448dc..3296bb5 100644
--- a/README.md
+++ b/README.md
@@ -23,17 +23,32 @@ This is a new approach to achieve two goals:
apt install make curl libxml2-utils xsltproc
```
(Sorry, I have no clue what to do on Windows systems.)
-- Download and unarchive this project and enter its directory.
-- Simply run
+- Download and unarchive this project:
+ ```
+ git clone https://gitlab.ibr.cs.tu-bs.de/steinb/bjcp-2015-styleguide.git
+ ```
+ [TBD: move to a real public repo server.]
+- ```
+ cd bjcp-2015-styleguide
+ ```
+- Now, in order to fetch the original BJCP document and build various derived and translated variants, simply run
```
make
```
- Don't care about lots of warning about missing external entities (files). These are the missing translation snippets that we have to supply step by step.
- You will now find:
- The original complete styleguide in XML representation: `bjcp-2015-styleguide-orig.xml`
- The broken-down original content as category, subcategory, and "subsubcategory" snippets in the directory: `orig`
- A (partially) translated XML styleguide: `bjcp-2015-styleguide-de.xml`
-- Now, you can gradually add and update translated content in the directory `de`. The structure should match `orig`. XML elements not present in the translated files will be copied from the `orig` data, when the translated styleguide will be generated. You will probably want to make use of this for the lists of "Commercial Examples", which are plain names of beer brands. Never modify XML element names or the XML structure, just edit the texts within the XML elements. Never change `id` attributes, never add `tags` or `specs` ("Vital Statistics") to the translated files, they will always be taken from the original data.
+ - An HTML form of the original styleguide: `bjcp-2015-styleguide-orig.html`
+ - An HTML form of the translated styleguide: `bjcp-2015-styleguide-de.html`
+- Now, you can gradually add and update translated content:
+ - Do this only in the directory `de`.
+ - The structure should match `orig`.
+ - XML elements not present in the translated files will be copied from the `orig` data, when the translated styleguide will be generated. You will probably want to make use of this for the lists of "Commercial Examples", which are plain names of beer brands.
+ - Never modify XML element names or the XML structure, just edit the texts within the XML elements.
+ - Never change `id` attributes.
+ - Never add `tags` or `specs` ("Vital Statistics") to the translated files, they will always be taken from the original data.
+- To supply your work back upstream to the repository, ...[TBD]
- To see the results of your translation work, you can re-run `make` at any time.
## Contact
@@ -50,4 +65,5 @@ Contact:
- Care about copyright questions. Add LICENSE file.
- Add Acknowledgements to all contributors.
- Implement links.
-
+- Move to real public repo server und update text above.
+- "make status" to display potentially missing translation snippets.
--
GitLab