Skip to content

Commit 418ed37

Browse files
committed
Correcting problems in translated configuration files
Correcting some problems in the different translated configuration files based on running the translated configuration files through doxygen as if they were part of the documentation. As the header / footer part has not yet been translated a dummy header / footer is added during the conversion of and "xml" to a "dox" (like: `python configgen.py -doc config_de.xml > config_de.dox`)
1 parent dd91164 commit 418ed37

9 files changed

Lines changed: 1106 additions & 989 deletions

File tree

src/configgen.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
from xml.dom import Node
2020
import io
2121
import glob
22+
import os
2223

2324
messages = {}
2425

@@ -1108,9 +1109,14 @@ def main():
11081109
print(" * python configgen.py -doc %s to regenerate this file!" % configFile)
11091110
print(" */")
11101111
# process header
1112+
foundHeader = False
1113+
foundFooter = False
11111114
for n in elem.childNodes:
11121115
if n.nodeType == Node.ELEMENT_NODE and n.nodeName == "header":
1116+
foundHeader = True
11131117
parseHeaderDoc(n, mode)
1118+
if not foundHeader:
1119+
print("/*! \\page %s"%re.sub(".xml",'',os.path.basename(configFile)))
11141120
# generate list with all commands
11151121
commandsList = ()
11161122
for n in elem.childNodes:
@@ -1127,7 +1133,10 @@ def main():
11271133
# process footers
11281134
for n in elem.childNodes:
11291135
if n.nodeType == Node.ELEMENT_NODE and n.nodeName == "footer":
1136+
foundFooter = True
11301137
parseFooterDoc(n, mode)
1138+
if not foundFooter:
1139+
print("*/")
11311140
elif sys.argv[1] == "-maph":
11321141
print("/* WARNING: This file is generated!")
11331142
print(" * Do not edit this file, but edit %s instead and run" % configFile)

src/i18n/config_de.xml

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@
199199
</option>
200200
<option type="list" id="ALIASES" format="string">
201201
<docs>
202-
<![CDATA[Dieses Tag kann verwendet werden, um eine Reihe von Aliasnamen anzugeben, die als Befehle in der Dokumentation fungieren. Ein Alias hat die Form: \verbatim name=wert\endverbatim Zum Beispiel wurde das Hinzufügen von \verbatim "sideeffect=@par Nebeneffekte:^^"\endverbatim es Ihnen ermöglichen, den Befehl \c \sideeffect (oder \c \@sideeffect) in der Dokumentation zu platzieren, was einen benutzerdefinierten Absatz mit der Überschrift "Nebeneffekte:" erzeugt. Beachten Sie, dass Sie im Werteteil eines Alias kein \ref cmdn "\n" einfügen können, um einen Zeilenumbruch einzufügen (in der resultierenden Ausgabe). Sie können `^^` im Werteteil eines Alias einfügen, um einen Zeilenumbruch einzufügen, als ob ein physikalischer Zeilenumbruch in der Originaldatei vorhanden wäre.]]>
202+
<![CDATA[Dieses Tag kann verwendet werden, um eine Reihe von Aliasnamen anzugeben, die als Befehle in der Dokumentation fungieren. Ein Alias hat die Form: \verbatim name=wert\endverbatim Zum Beispiel wurde das Hinzufügen von \verbatim "sideeffect=@par Nebeneffekte:^^"\endverbatim es Ihnen ermöglichen, den Befehl \c \\sideeffect (oder \c \@sideeffect) in der Dokumentation zu platzieren, was einen benutzerdefinierten Absatz mit der Überschrift "Nebeneffekte:" erzeugt. Beachten Sie, dass Sie im Werteteil eines Alias kein \ref cmdn "\\n" einfügen können, um einen Zeilenumbruch einzufügen (in der resultierenden Ausgabe). Sie können `^^` im Werteteil eines Alias einfügen, um einen Zeilenumbruch einzufügen, als ob ein physikalischer Zeilenumbruch in der Originaldatei vorhanden wäre.]]>
203203
</docs>
204204
<docs>
205205
<![CDATA[
@@ -832,7 +832,12 @@ eine doppelte Maskierung (\c \\\\{ und \c \\\\}) zu verwenden.]]>
832832
</option>
833833
<option type="bool" id="USE_HTAGS" defval="0" depends="SOURCE_BROWSER">
834834
<docs>
835-
<![CDATA[Wenn das \c USE_HTAGS-Tag auf \c YES gesetzt ist, verweisen die Referenzen auf den Quellcode auf das vom \c htags(1)-Tool generierte HTML anstelle des integrierten Quellcode-Browsers von Doxygen. Das \c htags-Tool ist Teil des globalen Quellcode-Tagging-Systems von GNU (siehe https://www.gnu.org/software/global/global.html). Sie benötigen Version 4.8.6 oder höher. <br>Um es zu verwenden, tun Sie Folgendes: -# Installieren Sie die neueste Version von \c global -# Aktivieren Sie \ref cfg_source_browser "SOURCE_BROWSER" und \c USE_HTAGS in der Konfigurationsdatei -# Stellen Sie sicher, dass \ref cfg_input "INPUT" auf die Wurzel des Quellbaums zeigt -# Führen Sie \c doxygen wie gewohnt aus <br>Doxygen ruft \c htags auf (und das wiederum ruft \c gtags auf), daher müssen diese Tools über die Befehlszeile verfügbar sein (d.h. im Suchpfad). <br>Das Ergebnis: Anstelle des von Doxygen generierten Quellcode-Browsers zeigen die Links zum Quellcode jetzt auf die Ausgabe von \c htags.]]>
835+
<![CDATA[Wenn das \c USE_HTAGS-Tag auf \c YES gesetzt ist, verweisen die Referenzen auf den Quellcode auf das vom \c htags(1)-Tool generierte HTML anstelle des integrierten Quellcode-Browsers von Doxygen. Das \c htags-Tool ist Teil des globalen Quellcode-Tagging-Systems von GNU (siehe https://www.gnu.org/software/global/global.html). Sie benötigen Version 4.8.6 oder höher. <br>Um es zu verwenden, tun Sie Folgendes:
836+
-# Installieren Sie die neueste Version von \c global
837+
-# Aktivieren Sie \ref cfg_source_browser "SOURCE_BROWSER" und \c USE_HTAGS in der Konfigurationsdatei
838+
-# Stellen Sie sicher, dass \ref cfg_input "INPUT" auf die Wurzel des Quellbaums zeigt
839+
-# Führen Sie \c doxygen wie gewohnt aus
840+
<br>Doxygen ruft \c htags auf (und das wiederum ruft \c gtags auf), daher müssen diese Tools über die Befehlszeile verfügbar sein (d.h. im Suchpfad). <br>Das Ergebnis: Anstelle des von Doxygen generierten Quellcode-Browsers zeigen die Links zum Quellcode jetzt auf die Ausgabe von \c htags.]]>
836841
</docs>
837842
</option>
838843
<option type="bool" id="VERBATIM_HEADERS" defval="1">
@@ -1210,7 +1215,10 @@ eine doppelte Maskierung (\c \\\\{ und \c \\\\}) zu verwenden.]]>
12101215
</option>
12111216
<option type="string" id="MATHJAX_CODEFILE" format="string" depends="USE_MATHJAX">
12121217
<docs>
1213-
<![CDATA[Das \c MATHJAX_CODEFILE-Tag kann verwendet werden, um eine Datei mit JavaScript-Code-Stucken anzugeben, die beim Start des MathJax-Codes verwendet werden. Siehe die MathJax-Website für weitere Details: - <a href="https://docs.mathjax.org/en/v2.7/">MathJax version 2</a> - <a href="https://docs.mathjax.org/en/v3.2/">MathJax version 3</a> - <a href="https://docs.mathjax.org/en/v4.0/">MathJax version 4</a>]]>
1218+
<![CDATA[Das \c MATHJAX_CODEFILE-Tag kann verwendet werden, um eine Datei mit JavaScript-Code-Stucken anzugeben, die beim Start des MathJax-Codes verwendet werden. Siehe die MathJax-Website für weitere Details:
1219+
- <a href="https://docs.mathjax.org/en/v2.7/">MathJax version 2</a>
1220+
- <a href="https://docs.mathjax.org/en/v3.2/">MathJax version 3</a>
1221+
- <a href="https://docs.mathjax.org/en/v4.0/">MathJax version 4</a>]]>
12141222
</docs>
12151223
<docs filter="doxyfile,doxywizard">
12161224
<![CDATA[
@@ -1817,7 +1825,14 @@ eine doppelte Maskierung (\c \\\\{ und \c \\\\}) zu verwenden.]]>
18171825
</option>
18181826
<option type="string" id="MERMAID_JS_URL" format="string" defval="https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs">
18191827
<docs>
1820-
<![CDATA[Das \c MERMAID_JS_URL-Tag gibt die URL an, von der \c mermaid.js geladen werden soll, wenn clientseitiges Rendering verwendet wird (\c MERMAID_RENDER_MODE ist \c CLIENT_SIDE oder \c AUTO). Der Standardwert verweist auf die neueste Mermaid v11-Version auf dem jsDelivr CDN. \par Beispiele: - Neueste v11 (Standard): <code>https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs</code> - Angeheftete Version: <code>https://cdn.jsdelivr.net/npm/mermaid@11.3.0/dist/mermaid.esm.min.mjs</code> - Lokale Kopie: <code>./mermaid.esm.min.mjs</code> (Benutzer muss Datei im HTML-Ausgabeverzeichnis platzieren) \par Die Standard-CDN-URL erfordert Internetzugang beim Anzeigen der generierten Dokumentation. Für die Offline-Verwendung laden Sie \c mermaid.esm.min.mjs herunter und setzen Sie dies auf einen relativen Pfad, oder verwenden Sie \c MERMAID_RENDER_MODE=CLI, um stattdessen Bilder vorab zu generieren.]]>
1828+
<![CDATA[Das \c MERMAID_JS_URL-Tag gibt die URL an, von der \c mermaid.js geladen werden soll, wenn clientseitiges Rendering verwendet wird (\c MERMAID_RENDER_MODE ist \c CLIENT_SIDE oder \c AUTO). Der Standardwert verweist auf die neueste Mermaid v11-Version auf dem jsDelivr CDN.
1829+
<br>
1830+
Die Standard-CDN-URL erfordert Internetzugang beim Anzeigen der generierten Dokumentation. Für die Offline-Verwendung laden Sie \c mermaid.esm.min.mjs herunter und setzen Sie dies auf einen relativen Pfad, oder verwenden Sie \c MERMAID_RENDER_MODE=CLI, um stattdessen Bilder vorab zu generieren.
1831+
\par Beispiele:
1832+
- Neueste v11 (Standard): <code>https://cdn.jsdelivr.net/npm/mermaid@11/dist/mermaid.esm.min.mjs</code>
1833+
- Angeheftete Version: <code>https://cdn.jsdelivr.net/npm/mermaid@11.3.0/dist/mermaid.esm.min.mjs</code>
1834+
- Lokale Kopie: <code>./mermaid.esm.min.mjs</code> (Benutzer muss Datei im HTML-Ausgabeverzeichnis platzieren)
1835+
]]>
18211836
</docs>
18221837
</option>
18231838
<option type="list" id="MERMAIDFILE_DIRS" format="dir">

0 commit comments

Comments
 (0)