First working note added, dcoumented Bible factory related stuff.

Author: mzattera

README.md

@@ -2,6 +2,8 @@
 
 This is a Java library i created to experiment with the [Voynich manuscript](https://en.wikipedia.org/wiki/Voynich_manuscript).
 
+The outcomes of my experiments are tracked on the [project pages](https://mzattera.github.io/v4j/).
+
 The folder `eclipse` contains an eclipse workspace. The (Maven) project `io.github.mattera.v4j` holds the actual code for the Java library.
 The library content is described below. The (Maven) project `io.github.mattera.v4j-apps` contains classes I created to experiment with the 
 Voynich manuscript; here you cna find examples about how to use the library.
@@ -56,6 +58,7 @@ This class also provides means to get the text alphabet, split text in words, co
 (think of a book made of chapters made or paragraphs). `filterElements()` and `splitElements()` can be used to select parts of text,
 or cut the text into parts, based on rules.
 
+<a id="ivtff">
 ### Getting the Voynich Text - `io.github.mattera.v4j.text.ivtff`
 
 The main class in this package is `IvtffText` that represents a text in IVTFF (Intermediate Voynich Transliteration File Format) format,
@@ -99,6 +102,15 @@ can be used to create IVTFF documents by filtering and/or splitting content of a
 IvtffText doc = VoynichFactory.getDocument(TranscriptionType.MAJORITY);
 doc = doc.filterPages(new PageFilter.Builder().illustrationType("B").build());
 ```
+### Other (Regular) Texts - `io.github.mattera.v4j.text.txt`
+
+`TextString` represent a Java string as a `Text` document, whilst `TextFile` represents a text files 
+composed by numbered `TextLine`s. These classes allow processing regular (e.g. contemporary plain English)
+texts within the vj4 library.
+
+Sometimes it is useful to compare Voynich statistics with those from a known text. For this reason
+`BibleFactory` provide methods to return the text of the Bible in different languages as `TextFile`
+instances.
 
 ### Testing (under src/test/java) - `io.github.mattera.v4j.test
 

docs/001/index.md

@@ -1,37 +1,30 @@
-## Welcome to GitHub Pages
+## Note 001 - The Text
 
-You can use the [editor on GitHub](https://github.com/mzattera/v4j/edit/master/docs/index.md) to maintain and preview the content for your website in Markdown files.
+_Last updated Sep. 6th, 2021._
 
-Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.
+_This note refers to release XXXX of v4j. Some of the content might not apply to more recent versions of the library._
 
-### Markdown
+### The Voynich Text
 
-Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
+As explained in the [v4j README](https://github.com/mzattera/v4j#ivtff), the library provides factory methods to 
+obtain an `IvtffText` instance with the Voynich text. At present the library provides means to obtain the
+Landini-Stolfi Interlinear file (**LSI**) and an augmented version of it, containing concordance and majority versions of the text.
 
-```markdown
-Syntax highlighted code block
+The corresponding IVTFF files (which are read by the factory) can be found in the [resource folder]() of the library.
 
-# Header 1
-## Header 2
-### Header 3
+The "augmented" version is created using class [`BuildConcordanceVersion`](); the input for the class
+is a slightly modified version of LSI that can be found in the [v4j-apps resource folder]().
+In this version, minor changes are done, that do not change the text content, in order to make sure
+all the different versions of the lines align properly, as required by `BuildConcordanceVersion` code.
 
-- Bulleted
-- List
+### The Bible Text
 
-1. Numbered
-2. List
+Similarly, class [`BuildBibleTranscription`]() is used to produce tex version if the Bible from 
+XML files that can be found in the v4j-apps resource folder]().
 
-**Bold** and _Italic_ and `Code` text
+The corresponding IVTFF files (which are read by the factory) can be found in the [resource folder]() of the library.
 
-[Link](url) and ![Image](src)
-```
 
-For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
 
-### Jekyll Themes
 
-Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/mzattera/v4j/settings/pages). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
 
-### Support or Contact
-
-Having trouble with Pages? Check out our [documentation](https://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and we’ll help you sort it out.

docs/index.md

@@ -1,7 +1,8 @@
 ## Welcome to GitHub Pages
 
-Hi, in these pages I store thoughts, working notes, rants and frustrations about the [Voynich manuscript](https://en.wikipedia.org/wiki/Voynich_manuscript).
+Hi, in these pages I store thoughts, working notes, rants and frustrations about the [Voynich manuscript](https://en.wikipedia.org/wiki/Voynich_manuscript)
+as resulting from my work with the [v4j library](https://github.com/mzattera/v4j).
 
 ### Working Notes
 
-[Note 001](./001)
+[Note 001 - The Text](./001)

eclipse/io.github.mattera.v4j/src/main/java/io/github/mattera/v4j/support/BuildBibleTranscription.java

@@ -3,16 +3,15 @@
  */
 package io.github.mattera.v4j.text.txt;
 
-import java.io.File;
 import java.io.IOException;
 import java.net.URISyntaxException;
-import java.net.URL;
 
 import io.github.mattera.v4j.text.alphabet.Alphabet;
+import io.github.mattera.v4j.util.FileUtil;
 
 /**
- * Factory class to read different language versions of the Bible. The
- * documents are read from TXT files in resource folder.
+ * Factory class to read different language versions of the Bible. The documents
+ * are read from TXT files in resource folder.
  * 
  * @author Massimiliano "Maxi" Zattera
  *
@@ -22,22 +21,23 @@ public class BibleFactory {
 	/**
 	 * Languages in which the bible is available.
 	 */
-	public static final String[] LANGUAGES = {"Italian", "Latin", "German", "French"};
-	
+	public static final String[] LANGUAGES = { "Italian", "Latin", "German", "French" };
+
 	/**
-	 * Name of folder with transcriptions (inside resource folder)
+	 * Name of folder with transcriptions (inside resource folder), including
+	 * trailing separator
 	 */
-	public static final String TRANSCRIPTION_FOLDER = "Transcriptions\\Bible";
+	public static final String TRANSCRIPTION_FOLDER = "Transcriptions/Bible/";
 
 	/**
 	 * Returns a version of the Bible in given language.
 	 * 
 	 * @return given transcription type for the MZ transcription
-	 * @throws IOException 
-	 * @throws URISyntaxException 
+	 * @throws IOException
+	 * @throws URISyntaxException
 	 */
 	public static TextFile getDocument(String language) throws IOException, URISyntaxException {
-		URL url = ClassLoader.getSystemResource(TRANSCRIPTION_FOLDER + "/" + language+".txt");
-		return new TextFile(new File(url.toURI()), Alphabet.UTF_16, "UTF-8");
+		return new TextFile(FileUtil.getResourceFile(TRANSCRIPTION_FOLDER + language + ".txt"), Alphabet.UTF_16,
+				"UTF-8");
 	}
 }

eclipse/io.github.mattera.v4j/src/main/java/io/github/mattera/v4j/text/txt/BibleFactory.java

@@ -0,0 +1,66 @@
+/**
+ * 
+ */
+package io.github.mattera.v4j.applications;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+import io.github.mattera.v4j.util.FileUtil;
+
+/**
+ * This class takes the XML files for the Bible transcription in different
+ * languages and transforms them in .TXT files.
+ * 
+ * Source files are taken from: http://christos-c.com/bible/
+ * 
+ * @author Massimiliano "Maxi" Zattera
+ *
+ */
+public final class BuildBibleTranscription {
+
+
+	/// MAKE SURE THIS IS CORRECT BUT DO NOT USE RESOURCE FOLDER AS IT IS READ
+	/// ONLY
+	private final static String OUTPUT_FOLDER = "D:\\";
+
+	private final static Pattern VERSE_PATTERN = Pattern
+			.compile("<seg id=[\"'][^'\"]*[\"'] type=[\"']verse[\"']>([^<]+)</seg>");
+
+	/**
+	 * @param args
+	 */
+	public static void main(String[] args) {
+		try {
+			convert(FileUtil.getResourceFile("Transcriptions/Bible/French.xml"));
+		} catch (Exception e) {
+			e.printStackTrace();
+		} finally {
+			System.out.println("Completed.");
+		}
+	}
+
+	private static void convert(File f) throws IOException {
+
+		// read the text in the file
+		List<String> lines = FileUtil.read(f, "UTF-8");
+		String xml = String.join("\n", lines);
+
+		// find verses in the XML
+		Matcher m = VERSE_PATTERN.matcher(xml);
+		List<String> txt = new ArrayList<>();
+		while (m.find()) {
+			String s = m.group(1).trim();
+			if (s.length() > 0)
+				txt.add(s);
+		}
+
+		// write the result as a simple file
+		File out = new File (OUTPUT_FOLDER, f.getName().replace(".xml", ".txt"));
+		FileUtil.write(txt, out.getCanonicalPath(), "UTF-8");
+	}
+}

eclipse/io.github.mzattera.v4j-apps/src/main/java/io/github/mattera/v4j/applications/BuildBibleTranscription.java

@@ -19,15 +19,16 @@
 import io.github.mattera.v4j.util.FileUtil;
 
 /**
- * Processes an interlinear transcription to create concordance and majority versions of it (added as new "artificial" transcribers).
+ * Processes an interlinear transcription to create concordance and majority
+ * versions of it (added as new "artificial" transcribers).
  * 
  * STATUS: Working & with (some) test harness.
  * 
  * @author Massimiliano "Maxi" Zattera
  */
-public class BuildConcordanceVersion {
+public final class BuildConcordanceVersion {
 
-	/// MAKE SURE THIS IS CORRECT BUT DO NOT USE RESOURCE FILES; AS THEY ARE READ
+	/// MAKE SURE THIS IS CORRECT BUT DO NOT USE RESOURCE FOLDER AS IT IS READ
 	/// ONLY
 	private final static String OUTPUT_FOLDER = "D:\\";