LOCALE::PO4A::VIMHELP.3PM(1)

NAME
Locale::Po4a::VimHelp - konvertiert Vim-Hilfedateien von/in PO-Dateien

BESCHREIBUNG
Das Projektziel von Po4a (PO für alles) ist es, die Übersetzung (und interessanter, die Wartung der Übersetzung) zu vereinfachen, indem die Gettext-Werkzeuge auch für Gebiete verwendet werden, wo diese nicht erwartet werden, wie Dokumentation.

"Locale::Po4a::VimHelp" ist ein Modul, das bei der Übersetzung einer Vim-Hilfedatei hilft. Siehe auch Writing help files <https://vimhelp.org/helphelp.txt.html#help-writing> für deren Syntax.

STATUS DIESES MODULS
Dieses Modul befindet sich in einem frühen Entwicklungsstadium. Es wurde erfolgreich mit einfachen Dateien wie "helphelp.txt" getestet. Allerdings wurde es noch nicht mit vollständigen Hilfedateien getestet und die Art, wie es diese auswertet, kann sich für Fehlerkorrekturen und Verbeserungen noch ändern, insbesondere beim Absatzumbruch.

ENTWICKLUNG
Die Auswertung von Vim-Hilfedateien ist schwierig. Im folgenden werden einige Hindernisse bei diesem Modul beschrieben. Falls Sie eine bessere Idee haben, können Sie diese gerne mit einem Patch einreichen (mit zusätzlichen Testfällen).

"1. foo" sieht nach einer sortierten Liste aus
    Nicht notwendigerweise. Betrachten Sie den folgenden Absatz:

     There are 2 wandering tanukis, not
     1. He's using his cloning technique.

    Aus dem gleichen Grund kann etwas, das nach einer Überschrift (z.B. "1.1 bar") oder einer unsortierten Liste (z.B. "o baz") aussieht, nicht erkannt werden.

Rechts ausgerichtete Markierungen sollten vom Übersetzungsziel ausgeschlossen werden
    Dieses Thema ist auch schwierig, da es sich auf Sprachunterschiede in der Lokalisierung bezieht.

    Betrachten Sie das folgende Beispiel:

     Such a common and short concept in some languages *tags*

    Was wie folgt übersetzt werden könnte:

     They are unfamiliar, there are no corresponding concepts and *tags*
     it takes a longer sentence to express them in this language

    Wenn dies passiert, müssen Sie entscheiden, an welcher Stelle sie eine Markierung schön ergänzen können. Das sollte nicht leicht sein. Die Vim-Hilfe-Datei ist in einem hart umgebrochenen Format, selbst für Teile, die keine Code-Blöcke sind.

    Das gleiche gilt für Markierungsreferenzen wie "|ref|".

Nutzen von "--wrapcol", um die Textbreite zu überwachen.
    Es scheint ein vernünftiger Ansatz zu sein, die Option "--wrapcol" zu verwenden, um Warnungen auszugeben, wenn die Textbreite die festgelegten Grenzen überschreitet. Die offizielle Vim-Hilfedatei enthält eine Moduszeile, wie "vim:tw=78:ts=8:noet:ft=help:norl:", wie das in "runtime/doc/if_perl.txt" <https://github.com/vim/vim/blob/04cc8975930b7b2c5d6753d3eddf57dab2816518/runtime/doc/if_perl.txt#L307> gesehen werden kann. Allerdings sind ein paar Herausforderungen zu meistern:

    Dateiauswertverhalten
        Wenn diese Option implementiert ist, wäre es ideal, die gesamte Datei zuerst einzulesen, zu ermitteln, ob eine Moduszeile existiert, und dann zu bestimmen, welche Abschnitte betroffen sind. Unglücklicherweise wird der fortschreitende Auswertmechanismus in diesem Fall nicht eingesetzt.

    Standard kontra angepasste Werte
        Der generische Standardwert von "--wrapcol" ist 76, während VIM-Hilfedateien typischerweise 78 verwenden. In den meisten Fällen ist der Wert, der in den Optionen an dieses Modul übergeben wird, standardmäßig 76, aber es ist nicht klar, ob dieser Wert explizit gesetzt oder implizit angewandt wurde.

SIEHE AUCH
Locale::Po4a::TransTractor(3pm), po4a(7)

AUTOREN
 gemmaro <gemmaro.dev@gmail.com>

URHEBERRECHT UND LIZENZ
 Copyright © 2024, 2025 gemmaro.

Dieses Programm ist freie Software; Sie können es unter den Bedingungen der GPL v2.0 oder neuer (siehe die Datei COPYING) vertreiben und/oder verändern.