Add translations of api, data, development and faq
Change-Id: I286c3e1ce1e698128a2119b2bc8c78cd039ad61e
diff --git a/templates/de/doc/annotation.html.ep b/templates/de/doc/annotation.html.ep
new file mode 100644
index 0000000..e1bb832
--- /dev/null
+++ b/templates/de/doc/annotation.html.ep
@@ -0,0 +1,20 @@
+% layout 'main', title => 'Annotationen';
+
+%= page_title
+
+<p>KorAP unterstützt eine beliebige Anzahl von <%= embedded_link_to 'doc', 'Annotationen', 'data', 'annotation' %> aus unterschiedlichen (<em>Foundries</em> genannten) Quellen mit unterschiedlichen <em>Annotationsebenen</em>.</p>
+
+<dl>
+ <p>Folgende Arten von Annotationen werden unterstützt:</p>
+ <dt>Tokens</dt>
+ <dd>Annotationen, die mit einzelnen Tokens (z.B. Wörtern oder Zahlen) assoziiert sind</dd>
+
+ <dt>Spans</dt>
+ <dd>Annotationen einer Sequenz von Wörtern oder Knoten (z.B. Sätze, Phrasen, Konstituenzannotationen)</dd>
+
+ <dt>Relationen</dt>
+ <dd>Annotationen von Relationen zwischen Tokens oder Spans (z.B. Dependenzannotationen)</dd>
+
+ <dt>Attribute</dt>
+ <dd>Attributinformationen zu Tokens, Spans oder Relationen (z.B. Attribute von HTML-Elementen)</dd>
+</dl>
diff --git a/templates/de/doc/api.html.ep b/templates/de/doc/api.html.ep
new file mode 100644
index 0000000..1e5312b
--- /dev/null
+++ b/templates/de/doc/api.html.ep
@@ -0,0 +1,24 @@
+% layout 'main', title => 'KorAP: Application Programming Interface';
+
+%= page_title
+
+<p>Die Kommunikation zwischen KorAP-Komponenten wird intern über das KoralQuery-Protokoll geregelt. Die Spezifikation für KoralQuery ist auf <%= ext_link_to 'GitHub', "http://korap.github.io/Koral" %> verfügbar. Alle API-Endpunkte nutzen entweder KoralQuery oder sind (mehr oder weniger) RESTful-Web-APIs.</p>
+
+<p>Alle (teilweise experimentellen) öffentlich verfügbaren API-Endpunkte inklusive ihrer Anfragen und Antworten sind im <%= ext_link_to 'GitHub-Wiki', "https://github.com/KorAP/Kustvakt/wiki" %> von <%= embedded_link_to 'doc', 'Kustvakt', 'korap', 'kustvakt' %> beschrieben.</p>
+
+% my $api_url = $c->url_for('proxy' => (apiv => $Kalamar::API_VERSION))->to_abs->scheme('https');
+% $api_url->path->trailing_slash(1);
+
+%if ($c->app->config('Kalamar')->{openapi}) {
+<p id="openapi">
+% my $openapi= $api_url->to_abs;
+% $openapi->path->merge($c->app->config('Kalamar')->{openapi})->trailing_slash(1);
+Die OpenAI-Dokumentation befindet sich <%= ext_link_to 'hier', $openapi %>.
+</p>
+% }
+
+<p>Der Root-Service ist unter <code id="api-service-uri"><%= $api_url %></code> zu finden.</p>
+
+<h2>Client-Bibliotheken</h2>
+
+<p>Client-Bibliotheken sind für R auf <%= ext_link_to 'CRAN', 'https://cran.r-project.org/package=RKorAPClient' %> (Quellcode und weitere Informationen auf <%= ext_link_to 'GitHub', 'https://github.com/KorAP/RKorAPClient' %>) und für Python auf <%= ext_link_to 'PyPI', 'https://pypi.org/project/KorAPClient/' %> (Quellcode auf <%= ext_link_to 'GitHub', 'https://github.com/KorAP/PythonKorAPClient' %>) verfügbar.</p>
diff --git a/templates/de/doc/development.html.ep b/templates/de/doc/development.html.ep
new file mode 100644
index 0000000..4dfcf95
--- /dev/null
+++ b/templates/de/doc/development.html.ep
@@ -0,0 +1,68 @@
+% layout 'main', title => 'KorAP: Architektur & Entwicklung';
+
+%= page_title
+
+%= korap_overview 'development'
+
+<p>Das KorAP-Projekt wurde 2011 am <%= ext_link_to 'Leibniz-Institut für Deutsche Sprache (IDS)', "https://www.ids-mannheim.de/" %> in Mannheim ins Leben gerufen. KorAP ist eine Korpusanalyseplattform mit einer erweiterbaren und skalierbaren Architektur. Sie besteht aus mehreren Komponenten, die dank wohldefinierter APIs austauschbar sind.</p>
+
+<dl>
+ <dt><%= embedded_link_to('doc', 'Kalamar', 'development', 'kalamar') %></dt>
+ <dd>Kalamar ist das Benutzer-Frontend. Die meisten Nutzenden werden über dieses Frontend auf die Such- und Analysemöglichkeiten, die KorAP bietet, zugreifen. Dies geschieht durch die Formulierung von Anfragen in einer der unterstützten Anfragesprachen, die an Kustvakt weitergereicht werden.</dd>
+
+ <dt><%= embedded_link_to('doc', 'API', 'api') %></dt>
+ <dd>Als Alternative zum Benutzer-Frontend können Anfragen auch über eine direkte REST-Webschnittstelle zu Kustvakt initiiert werden.</dd>
+
+ <dt><%= embedded_link_to('doc', 'Kustvakt', 'development', 'kustvakt') %></dt>
+ <dd>Kustvakt ist der zentrale Dienst für Benutzer- und Rechteverwaltung. Er nimmt Anfragen an und formuliert sie so um, dass sich die Suche auf Dokumente beschränkt, auf die der oder die Nutzende Zugriff hat. Darüber hinaus können weitere benutzerdefinierte Parameter wie zum Beispiel bevorzugte Annotationsebenen in die Anfragen eingebunden werden. Um eine Anfrage, die in einer bestimmten Anfragesprache geschrieben wurde, in das interne allgemeine Anfrageprotokoll <%= ext_link_to 'KoralQuery', "https://korap.github.io/Koral/" %> zu überführen, verwendet Kustvakt <%= embedded_link_to('doc', 'Koral', 'development', 'koral') %>.</dd>
+
+ <dt><%= embedded_link_to('doc', 'Koral', 'development', 'koral') %></dt>
+ <dd>Koral ist eine Bibliothek, die Anfragen, die in einer von mehreren implementierten Anfragesprachen geschrieben wurden, in ein allgemeines Anfrageprotokoll namens <%= ext_link_to 'KoralQuery', "https://korap.github.io/Koral/" %> überführt.</dd>
+
+ <dt><%= embedded_link_to('doc', 'Krill', 'development', 'krill') %></dt>
+ <dd>Krill ist eine Lucene-basierte Backend-Engine, die große Korpora nach Vorkommen von in <%= ext_link_to 'KoralQuery', "https://korap.github.io/Koral/" %> formulierten Suchmustern durchsuchen kann.</dd>
+
+ <dt><%= embedded_link_to('doc', 'Karang', 'development', 'karang') %></dt>
+ <dd>Karang ist eine Neo4j-basierte Backend-Engine, die in Graphform repräsentierte Korpora durchlaufen kann.</dd>
+</dl>
+
+<h3>Team</h3>
+
+<dl>
+ <dt>Leitung</dt>
+ <dd>
+ <%= ext_link_to 'Marc Kupietz', "https://www.ids-mannheim.de/digspra/personal/kupietz/" %>,
+ <%= ext_link_to 'Andreas Witt', "https://www.ids-mannheim.de/digspra/personal/witt/" %>
+ </dd>
+
+ <dt>Wissenschaftliche Mitarbeit</dt>
+ <dd>
+ <%= ext_link_to 'Franck Bodmer', "https://perso.ids-mannheim.de/seiten/bodmer.html" %>,
+ <%= ext_link_to 'Nils Diewald', "https://www.nils-diewald.de/" %>,
+ <%= ext_link_to 'Peter Harders', "https://perso.ids-mannheim.de/seiten/harders.html" %>,
+ <%= ext_link_to 'Eliza Margaretha', "https://perso.ids-mannheim.de/seiten/margaretha.html" %>,
+ <%= ext_link_to 'Helge Stallkamp', "https://perso.ids-mannheim.de/seiten/krause.html" %>,
+ <%= ext_link_to 'Rameela Yaddehige',"https://perso.ids-mannheim.de/seiten/yaddehige.html" %>
+ </dd>
+
+ <dt>Übersetzungen</dt>
+ <dd>
+ <%= ext_link_to 'Susanne Feix', "https://www.ids-mannheim.de/digspra/personal/bergmann/" %>
+ </dd>
+
+ <dt>Ehemalige Projektmitglieder</dt>
+ <dd>
+ <%= ext_link_to 'Piotr Bański', "https://www.ids-mannheim.de/gra/personal/banski/" %>,
+ Joachim Bingel,
+ <%= ext_link_to 'Elena Frick', "https://www.ids-mannheim.de/prag/personal/frick/" %>,
+ Michael Hanl,
+ Carsten Schnober
+ </dd>
+
+ <dt>Beratung</dt>
+ <dd>
+ <%= ext_link_to 'Cyril Belica', "https://www.ids-mannheim.de/digspra/kl/misc/tlk-cb/" %>,
+ Piotr Pęzik,
+ <%= ext_link_to 'Oliver Schonefeld', "https://www.ids-mannheim.de/zentrale-bereiche/informationstechnik/personal/schonefeld/" %>
+ </dd>
+</dl>
diff --git a/templates/de/doc/faq.html.ep b/templates/de/doc/faq.html.ep
new file mode 100644
index 0000000..151cfed
--- /dev/null
+++ b/templates/de/doc/faq.html.ep
@@ -0,0 +1,23 @@
+% layout 'main', title => 'KorAP: Frequently Asked Questions';
+
+%= page_title
+
+<p>Dieses Dokument bietet eine Zusammenstellung von häufig gestellten Fragen und bereits aufgefallenen Problemen. Gerne können Sie per <%= mail_to_chiffre join('@', 'korap', 'ids-mannheim.de'), subject => 'Question via Kalamar', begin %>E-Mail<% end %> weitere Fragen stellen.
+
+<section>
+ <h3>Wo befindet sich der Quellcode?</h3>
+ <p>Der Quellcode von KorAP ist auf <%= ext_link_to 'GitHub', 'https://github.com/KorAP' %> verfügbar.</p>
+</section>
+
+<section>
+ <h3>Warum brauchen manche Anfragen so lange oder liefern am Ende keine Ergebnisse?</h3>
+ <p>In der Alpha-Phase ist es Teil unserer Aufgaben, das System zu optimieren. Am Anfang ist davon auszugehen, dass manche Aktionen unverhältnismäßig viel Zeit brauchen werden, aber das wird mit der Zeit besser und besser. Wenn Sie in einem bestimmten Fall einen wiederkehrenden Fehler bemerken, seien Sie bitte so freundlich und <%= mail_to_chiffre join('@', 'korap', 'ids-mannheim.de'), subject => 'I found a bug in the query system', begin %>lassen Sie es uns wissen<% end %>.</p>
+</section
+
+<section>
+ <h3>Ich möchte ein Problem melden - wie mache ich das?</h3>
+ <p>Bitte nutzen Sie unser öffentliches Ticketsystem <%= ext_link_to 'für das Frontend auf GitHub', 'https://github.com/KorAP/Kalamar/issues' %>, um Probleme zu melden. Falls Sie kein GitHub-Konto haben, senden Sie uns bitte eine <%= mail_to_chiffre join('@', 'korap', 'ids-mannheim.de'), subject => 'I found an issue', begin %>E-Mail<% end %>.</p>
+ %# Diese Option ist uns lieber, da hiermit wichtige Versionierungsdaten gesammelt werden können (in Zukunft noch mehr als jetzt)
+</section>
+
+%= content_block 'faq'
diff --git a/templates/doc/annotation.html.ep b/templates/doc/annotation.html.ep
index 18cdad9..7c839c0 100644
--- a/templates/doc/annotation.html.ep
+++ b/templates/doc/annotation.html.ep
@@ -2,7 +2,7 @@
%= page_title
-<p>KorAP supports an arbitrary number of <%= embedded_link_to 'doc', 'Annotations', 'data', 'annotation' %> from different sources (called <em>foundries</em>) with different <em>layers</em>.</p>
+<p>KorAP also supports an arbitrary number of <%= embedded_link_to 'doc', 'annotations', 'data', 'annotation' %> from different sources (called <em>foundries</em>) with different <em>layers</em>.</p>
<dl>
<p>Annotations of the following kind are supported:</p>
diff --git a/templates/doc/api.html.ep b/templates/doc/api.html.ep
index 411a876..1be1fe1 100644
--- a/templates/doc/api.html.ep
+++ b/templates/doc/api.html.ep
@@ -4,7 +4,7 @@
<p>Internally the communication between KorAP components is done using the KoralQuery protocol.
The specification for KoralQuery is available on <%= ext_link_to 'GitHub', "http://korap.github.io/Koral" %>.
- All API endpoints either use KoralQuery or are (more or lest) REST-ful web APIs.</p>
+ All API endpoints either use KoralQuery or are (more or less) REST-ful web APIs.</p>
<p>All publicly available API endpoints (partially experimental) including their requests and responses are described in the <%= ext_link_to 'GitHub Wiki', "https://github.com/KorAP/Kustvakt/wiki" %> of <%= embedded_link_to 'doc', 'Kustvakt', 'korap', 'kustvakt' %>.</p>
diff --git a/templates/doc/development.html.ep b/templates/doc/development.html.ep
index 1a041dd..69788c2 100644
--- a/templates/doc/development.html.ep
+++ b/templates/doc/development.html.ep
@@ -4,7 +4,7 @@
%= korap_overview 'development'
-<p>The KorAP project was launched in 2011 at the <%= ext_link_to 'Leibniz Institute for the German Language (IDS)', "https://www.ids-mannheim.de/" %> in Mannheim, Germany. KorAP is a Corpus Analysis Platform, with an extensible and scalable architecture. It consists of multiple components, that are exchangable due to well defined APIs.</p>
+<p>The KorAP project was launched in 2011 at the <%= ext_link_to 'Leibniz Institute for the German Language (IDS)', "https://www.ids-mannheim.de/" %> in Mannheim, Germany. KorAP is a corpus analysis platform with an extensible and scalable architecture. It consists of multiple components that are exchangable due to well defined APIs.</p>
<dl>
<dt><%= embedded_link_to('doc', 'Kalamar', 'development', 'kalamar') %></dt>
@@ -14,16 +14,16 @@
<dd>As an alternative to the user frontend, queries can be initiated using a REST web interface directly with Kustvakt.</dd>
<dt><%= embedded_link_to('doc', 'Kustvakt', 'development', 'kustvakt') %></dt>
- <dd>Kustvakt is the central user and policy management service. It takes a query and rewrites it to restrict the scope of a search to documents the user is allowed to. It may also inject further properties the user has set up, like preferred annotation layers. To transfer a query written in a certain query language to the internal general query protocol <%= embedded_link_to('doc', 'KoralQuery', 'api', 'koralquery') %>, Kustvakt uses <%= embedded_link_to('doc', 'Koral', 'development', 'koral') %>.</dd>
+ <dd>Kustvakt is the central user and policy management service. It takes a query and rewrites it to restrict the scope of a search to documents the user is allowed to access. It may also inject further properties the user has set up, like preferred annotation layers. To transfer a query written in a certain query language to the internal general query protocol <%= ext_link_to 'KoralQuery', "https://korap.github.io/Koral/" %>, Kustvakt uses <%= embedded_link_to('doc', 'Koral', 'development', 'koral') %>.</dd>
<dt><%= embedded_link_to('doc', 'Koral', 'development', 'koral') %></dt>
- <dd>Koral is a library that translates queries written in one of several implemented query languages into a general query protocol, called <%= embedded_link_to('doc', 'KoralQuery', 'api', 'koralquery') %>.</dd>
+ <dd>Koral is a library that translates queries written in one of several implemented query languages into a general query protocol, called <%= ext_link_to 'KoralQuery', "https://korap.github.io/Koral/" %>.</dd>
<dt><%= embedded_link_to('doc', 'Krill', 'development', 'krill') %></dt>
- <dd>Krill is a Lucene based backend engine that can search large corpora for occurrences of search patterns formulated in <%= embedded_link_to('doc', 'KoralQuery', 'api', 'koralquery') %>.</dd>
+ <dd>Krill is a Lucene-based backend engine that can search large corpora for occurrences of search patterns formulated in <%= ext_link_to 'KoralQuery', "https://korap.github.io/Koral/" %>.</dd>
<dt><%= embedded_link_to('doc', 'Karang', 'development', 'karang') %></dt>
- <dd>Karang is a Neo4j based backend engine that can traverse large corpora represented as graphs.</dd>
+ <dd>Karang is a Neo4j-based backend engine that can traverse large corpora represented as graphs.</dd>
</dl>
<h3>Team</h3>
diff --git a/templates/doc/faq.html.ep b/templates/doc/faq.html.ep
index 648402e..f5fce71 100644
--- a/templates/doc/faq.html.ep
+++ b/templates/doc/faq.html.ep
@@ -16,7 +16,7 @@
<section>
<h3>I want to report an issue, how do I do it?</h3>
- <p>Please refer to our public ticketing system <%= ext_link_to 'for the frontend at GitHub', 'https://github.com/KorAP/Kalamar/issues' %>, to report on any issues. If you don't have a GitHub account, please send us an <%= mail_to_chiffre join('@', 'korap', 'ids-mannheim.de'), subject => 'I found an issue', begin %>e-mail<% end %>.</p>
+ <p>Please refer to our public ticketing system <%= ext_link_to 'for the frontend at GitHub', 'https://github.com/KorAP/Kalamar/issues' %> to report on any issues. If you don't have a GitHub account, please send us an <%= mail_to_chiffre join('@', 'korap', 'ids-mannheim.de'), subject => 'I found an issue', begin %>e-mail<% end %>.</p>
%# This option is the preferred one because it gathers some (and will in time gather more) important versioning data.
</section>