Basic dita documentation

README.md

@@ -49,7 +49,7 @@ This bash script runs the post correction using a pre-trained
 OCRs should be used, models for these OCR steps are required and must
 be configured in an according configuration file (see ocrd-tool.json).
 
-Arguments:
+This tool accepts the following Arguments:
  * `--parameter` path to configuration file
  * `--input-file-grp` name of the master-OCR file group
  * `--output-file-grp` name of the post-correction file group
@@ -62,7 +62,7 @@ This tool is used to align the master OCR with any additional support
 OCRs.  It accepts a comma-separated list of input file groups, which
 it aligns in order.
 
-Arguments:
+This tool accepts the following Arguments:
  * `--parameter` path to configuration file
  * `--input-file-grp` comma seperated list of the input file groups;
    first input file group is the master OCR
@@ -72,8 +72,10 @@ Arguments:
 
 ### ocrd-cis-train.sh
 Script to train a model from a list of ground-truth archives (see
-ocrd-tool.json) for the post correction.  The tool somewhat mimics the
-behaviour of other ocrd tools:
+ocrd-tool.json) for the post correction.
+
+The tool somewhat mimics the behaviour of other ocrd tools and accepts
+the following Arguments:
  * `--mets` for the workspace
  * `--log-level` is passed to other tools
  * `--parameter` is used as configuration
@@ -85,10 +87,12 @@ Helper tool to get the path of the installed data files. Usage:
 path to th default 3-grams language model file.
 
 ### ocrd-cis-wer
-Helper tool to calculate the word error rate aligned ocr files.  It
-writes a simple JSON-formated stats file to the given output file group.
+Helper tool to calculate the word error rate of aligned ocr files.  It
+writes a simple JSON-formated stats file to the given output file
+group.
 
-Arguments:
+This tool accepts the following Arguments:
+ * `--parameter` set configuration file
  * `--input-file-grp` input file group of aligned ocr results with
    their respective ground truth.
  * `--output-file-grp` name of the file group for the stats file

data/docs/ocrd-cis-align/authors.md

@@ -0,0 +1,5 @@
+# Authors
+1. Christoph Weber
+2. Florian Fink
+3. Robert Sachunsky
+4. Tobias Englmeier

data/docs/ocrd-cis-align/copyright.md

@@ -0,0 +1,22 @@
+# License
+MIT License
+
+Copyright (c) 2018 2018 Centrum für Informations- und Sprachverarbeitung (CIS)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/docs/ocrd-cis-align/description.md

@@ -0,0 +1,5 @@
+# Description of ocrd-cis-align {#description .concept}
+Aligns tokens of multiple input file groups to one output file group.
+This tool is used to align the master OCR with any additional support
+OCRs.  It accepts a comma-separated list of input file groups, which
+it aligns in order.

data/docs/ocrd-cis-align/glossary.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE glossgroup
+PUBLIC "-//OASIS//DTD DITA Glossary Group//EN" "glossgroup.dtd">
+<glossgroup id="Glossar">
+    <title>Glossar</title>
+	<!--
+    <glossentry id="txtline">
+        <glossterm>Textline</glossterm>
+        <glossdef>A TextLine is a block of text without line break.
+        </glossdef>
+    </glossentry>
+    <glossentry id="gt">
+        <glossterm>Ground Truth</glossterm>
+        <glossdef>Ground truth (GT) in the context of OCR-D are
+        transcriptions, specific structure descriptions and word lists.
+        These are essentially available in PAGE XML format in
+        combination with the original image. Essential parts of
+        the GT were created manually.
+    </glossdef>
+    -->
+</glossgroup>
+<!--
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE glossgroup
+PUBLIC "-//OASIS//DTD DITA Glossary Group//EN" "glossgroup.dtd">
+<glossgroup id="Glossar">
+    <title>Glossar</title>
+    <glossentry id="txtline">
+        <glossterm>Textline</glossterm>
+        <glossdef>A TextLine is a block of text without line break.
+        </glossdef>
+    </glossentry>
+    <glossentry id="gt">
+        <glossterm>Ground Truth</glossterm>
+        <glossdef>Ground truth (GT) in the context of OCR-D are
+        transcriptions, specific structure descriptions and word lists.
+        These are essentially available in PAGE XML format in
+        combination with the original image. Essential parts of
+        the GT were created manually.
+        </glossdef>
+</glossgroup>
+-->

data/docs/ocrd-cis-align/inputFormatDescription.md

@@ -0,0 +1 @@
+# Input format {#inputFormatDescription .reference}

data/docs/ocrd-cis-align/installation.md

@@ -0,0 +1,4 @@
+# Installation of ocrd-cis-align {#installation .task}
+1. Initialize virtualenv: `python3 -m venv path/to/dir` (optional)
+2. Install ocrd_cis: `make install`
+3. Test the installation: `make test` (optional)

data/docs/ocrd-cis-align/name.md

@@ -0,0 +1 @@
+# ocrd-cis-align

data/docs/ocrd-cis-align/option.md

@@ -0,0 +1,8 @@
+# Options for ocrd-cis-align {#option .reference}
+This tool accepts the following Arguments:
+* `--parameter` path to configuration file
+* `--input-file-grp` comma seperated list of the input file groups;
+first input file group is the master OCR
+* `--output-file-grp` name of the file group for the aligned result
+* `--log-level` set log level
+* `--mets` path to METS file in workspace

data/docs/ocrd-cis-align/outputFormatDescription.md

@@ -0,0 +1 @@
+# Output format {#outputFormatDescription .reference}

data/docs/ocrd-cis-align/parameters.md

@@ -0,0 +1,5 @@
+# Parameters {#parameters .reference}
+The tool ocrd-cis-align accepts the following configuration parameters:
+```json
+{}
+```

data/docs/ocrd-cis-align/release_notes.md

@@ -0,0 +1 @@
+# Release notes

data/docs/ocrd-cis-align/reporting.md

@@ -0,0 +1,2 @@
+# Reporting
+Reports any bugs/problems at the [issues page](https://github.com/cisocrgroup/ocrd_cis/issues)

data/docs/ocrd-cis-align/tool.md

@@ -0,0 +1,2 @@
+# Tool ocrd-cis-align {#Tool .concept}
+Align multiple OCRs and/or GTs

data/docs/ocrd-cis-align/topicmap.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
+<map>
+  <topicref href="name.md" format="markdown"/>
+  <topicref href="release_notes.md" format="markdown"/>
+  <topicref href="installation.md" format="markdown"/>
+  <topicref href="tool.md" format="markdown"/>
+  <topicref href="description.md" format="markdown"/>
+  <topicref href="option.md" format="markdown"/>
+  <topicref href="inputFormatDescription.md" format="markdown"/>
+  <topicref href="parameters.md" format="markdown"/>
+  <topicref href="outputFormatDescription.md" format="markdown"/>
+  <topicref href="troubleshooting.xml"/>
+  <topicref href="glossary.xml"/>
+  <topicref href="authors.md" format="markdown"/>
+  <topicref href="reporting.md" format="markdown"/>
+  <topicref href="copyright.md" format="markdown"/>
+</map>

data/docs/ocrd-cis-align/troubleshooting.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE troubleshooting
+PUBLIC "-//OASIS//DTD DITA 1.3 Troubleshooting//EN" "troubleshooting.dtd">
+<troubleshooting id="Troubleshooting">
+    <title>Troubleshooting</title>
+	<!--
+    <troublebody>
+        <condition>
+            <title>Condition</title>
+            <p></p>
+        </condition>
+        <troubleSolution>
+            <cause>
+                <title>Cause</title>
+                <p></p>
+            </cause>
+            <remedy>
+                <title>Remedy</title>
+                <responsibleParty></responsibleParty>
+                <steps>
+                    <step>
+                        <cmd></cmd>
+                    </step>
+                </steps>
+            </remedy>
+        </troubleSolution>
+    </troublebody>
+	-->
+</troubleshooting>

data/docs/ocrd-cis-post-correct.sh/authors.md

@@ -0,0 +1,5 @@
+# Authors
+1. Christoph Weber
+2. Florian Fink
+3. Robert Sachunsky
+4. Tobias Englmeier

data/docs/ocrd-cis-post-correct.sh/copyright.md

@@ -0,0 +1,22 @@
+# License
+MIT License
+
+Copyright (c) 2018 2018 Centrum für Informations- und Sprachverarbeitung (CIS)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/docs/ocrd-cis-post-correct.sh/description.md

@@ -0,0 +1,5 @@
+# Description of ocrd-cis-post-correct.sh {#description .concept}
+This bash script runs the post correction using a pre-trained
+[model](http://cis.lmu.de/~finkf/model.zip).  If additional support
+OCRs should be used, models for these OCR steps are required and must
+be configured in an according configuration file (see ocrd-tool.json).

data/docs/ocrd-cis-post-correct.sh/glossary.xml

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE glossgroup
+PUBLIC "-//OASIS//DTD DITA Glossary Group//EN" "glossgroup.dtd">
+<glossgroup id="Glossar">
+    <title>Glossar</title>
+	<!--
+    <glossentry id="txtline">
+        <glossterm>Textline</glossterm>
+        <glossdef>A TextLine is a block of text without line break.
+        </glossdef>
+    </glossentry>
+    <glossentry id="gt">
+        <glossterm>Ground Truth</glossterm>
+        <glossdef>Ground truth (GT) in the context of OCR-D are
+        transcriptions, specific structure descriptions and word lists.
+        These are essentially available in PAGE XML format in
+        combination with the original image. Essential parts of
+        the GT were created manually.
+    </glossdef>
+    -->
+</glossgroup>
+<!--
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE glossgroup
+PUBLIC "-//OASIS//DTD DITA Glossary Group//EN" "glossgroup.dtd">
+<glossgroup id="Glossar">
+    <title>Glossar</title>
+    <glossentry id="txtline">
+        <glossterm>Textline</glossterm>
+        <glossdef>A TextLine is a block of text without line break.
+        </glossdef>
+    </glossentry>
+    <glossentry id="gt">
+        <glossterm>Ground Truth</glossterm>
+        <glossdef>Ground truth (GT) in the context of OCR-D are
+        transcriptions, specific structure descriptions and word lists.
+        These are essentially available in PAGE XML format in
+        combination with the original image. Essential parts of
+        the GT were created manually.
+        </glossdef>
+</glossgroup>
+-->

data/docs/ocrd-cis-post-correct.sh/inputFormatDescription.md

@@ -0,0 +1 @@
+# Input format {#inputFormatDescription .reference}

data/docs/ocrd-cis-post-correct.sh/installation.md

@@ -0,0 +1,4 @@
+# Installation of ocrd-cis-post-correct.sh {#installation .task}
+1. Initialize virtualenv: `python3 -m venv path/to/dir` (optional)
+2. Install ocrd_cis: `make install`
+3. Test the installation: `make test` (optional)

data/docs/ocrd-cis-post-correct.sh/name.md

@@ -0,0 +1 @@
+# ocrd-cis-post-correct.sh

data/docs/ocrd-cis-post-correct.sh/option.md

@@ -0,0 +1,7 @@
+# Options for ocrd-cis-post-correct.sh {#option .reference}
+This tool accepts the following Arguments:
+* `--parameter` path to configuration file
+* `--input-file-grp` name of the master-OCR file group
+* `--output-file-grp` name of the post-correction file group
+* `--log-level` set log level
+* `--mets` path to METS file in workspace

data/docs/ocrd-cis-post-correct.sh/outputFormatDescription.md

@@ -0,0 +1 @@
+# Output format {#outputFormatDescription .reference}

data/docs/ocrd-cis-post-correct.sh/parameters.md

@@ -0,0 +1,5 @@
+# Parameters {#parameters .reference}
+The tool ocrd-cis-post-correct.sh accepts the following configuration parameters:
+```json
+null
+```

data/docs/ocrd-cis-post-correct.sh/release_notes.md

@@ -0,0 +1 @@
+# Release notes

data/docs/ocrd-cis-post-correct.sh/reporting.md

@@ -0,0 +1,2 @@
+# Reporting
+Reports any bugs/problems at the [issues page](https://github.com/cisocrgroup/ocrd_cis/issues)

data/docs/ocrd-cis-post-correct.sh/tool.md

@@ -0,0 +1,2 @@
+# Tool ocrd-cis-post-correct.sh {#Tool .concept}
+null

data/docs/ocrd-cis-post-correct.sh/topicmap.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
+<map>
+  <topicref href="name.md" format="markdown"/>
+  <topicref href="release_notes.md" format="markdown"/>
+  <topicref href="installation.md" format="markdown"/>
+  <topicref href="tool.md" format="markdown"/>
+  <topicref href="description.md" format="markdown"/>
+  <topicref href="option.md" format="markdown"/>
+  <topicref href="inputFormatDescription.md" format="markdown"/>
+  <topicref href="parameters.md" format="markdown"/>
+  <topicref href="outputFormatDescription.md" format="markdown"/>
+  <topicref href="troubleshooting.xml"/>
+  <topicref href="glossary.xml"/>
+  <topicref href="authors.md" format="markdown"/>
+  <topicref href="reporting.md" format="markdown"/>
+  <topicref href="copyright.md" format="markdown"/>
+</map>

data/docs/ocrd-cis-post-correct.sh/troubleshooting.xml

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE troubleshooting
+PUBLIC "-//OASIS//DTD DITA 1.3 Troubleshooting//EN" "troubleshooting.dtd">
+<troubleshooting id="Troubleshooting">
+    <title>Troubleshooting</title>
+	<!--
+    <troublebody>
+        <condition>
+            <title>Condition</title>
+            <p></p>
+        </condition>
+        <troubleSolution>
+            <cause>
+                <title>Cause</title>
+                <p></p>
+            </cause>
+            <remedy>
+                <title>Remedy</title>
+                <responsibleParty></responsibleParty>
+                <steps>
+                    <step>
+                        <cmd></cmd>
+                    </step>
+                </steps>
+            </remedy>
+        </troubleSolution>
+    </troublebody>
+	-->
+</troubleshooting>

data/docs/ocrd-cis-train.sh/authors.md

@@ -0,0 +1,5 @@
+# Authors
+1. Christoph Weber
+2. Florian Fink
+3. Robert Sachunsky
+4. Tobias Englmeier

data/docs/ocrd-cis-train.sh/copyright.md

@@ -0,0 +1,22 @@
+# License
+MIT License
+
+Copyright (c) 2018 2018 Centrum für Informations- und Sprachverarbeitung (CIS)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.