OriginalSeite bei-ekke / HTML Tidy in Deutsch / Häufig gestellte Fragen (=FAQ)

freie Übersetzung!!    Durch den Autor ergänzter Text.   


HTML Tidy - Häufig gestellte Fragen (=FAQ)

Überblick

Es kommen immer wieder Fragen zu Tidy von den Benutzern auf. Wir haben einige häufige aus den Zusendungen nach html-tidy@w3.org und tidy-develop@lists.sourceforge.net hier gleich beantwortet. Wenn Sie Ihre Frage hier nicht beantwortet bekommen, dann sehen Sie unten bei Woher bekommt man Unterstützung? nach.


Was ist das?

Wenn plötzlich ein Fenster aufgeht mit dem Text:

HTML Tidy for Windows <vers 1st August 2002; built on Aug 8 2002, at 15:41:13>
Parsing Console input <stdin>

und Sie nichts damit anfangen können, dann lesen Sie weiter.

Einfach Strg+C drücken, dann geht das Fenster wieder zu, höchstwahrscheinlich haben Sie dann nicht das gewünschte Ergebnis. ... Tidy wartet auf Ihre HTML-Eingaben, um sie dann zu analysieren. Tidy ist ein Basis-Werkzeug, daß HTML liest, es bereinigt und wieder "hinaus"-schreibt. Es wurde als Kommandozeilen-Programm entwickelt, aber es gibt viele graphische Programm-Oberflächen (=GUI's) dazu, z.B. HTML-Kit, Phase 5, usw. .

Unter Windows müssen Sie die tidyde.tgz Datei erst entpacken und dann die tidy.exe in dem Verzeichnis plazieren, wo auch das Programm steht, mit der Sie das "plötzliche Fenster" erhalten haben; oder Sie nehmen ein Verzeichnis was in der Umgebungsvariable PATH steht (C:\tidy.exe geht immer). An die gleiche Stelle muß auch die evtl. vorhandene KonfigurationsDatei. Von der Kommandozeile (auch "DOS-Box" genannt) können Sie Tidy beispielsweise starten mit:

C:> tidy -m meineSeite.html

In diesem Fall weist die Option -m Tidy an, das bereiniget AnalyseErgebnis direkt in die eingelesene Datei zurück zu schreiben, die Datei(meineSeite.html) wird also überschrieben. Tidy schlüsselt Ihnen dann auf, was es für "Unreinheiten"(Probleme) gefunden hat und nach welcher HTML-Version diese Datei-Formatierung aussieht.

Siehe auch Dave Raggett's Säuberung von Web-Seiten mit HTML TIDY.

Wenn Sie es nicht sehr komfortabel finden mit der DOS-Kommandozeile, dann versuchen Sie es doch mit einer graphischen Version (=GUI) von:

Windows

Woher bekommt man Unterstützung?

Im Allgemeinen ist die HTML Tidy Unterstützung auf der original eMail-Liste html-tidy@w3.org noch am Besten. Immer sind dort die Entwickler mit ihrem Wisssen präsent. In dieser Liste findet man auch Antworten zu den Java- und C-Versionen, den verschiedenen Optionen zu den GUI Front End's und zu der Perl- sowie Python- Integration usw. . Wenn Sie keine Anwort in dieser Liste finden, oder Sie eine Fehlerbenachrichtigung (mit evtl. Korrektur-Vorschlag) haben, dann gehen Sie über die Entwickler-Liste tidy-develop@lists.sourceforge.net. Das ist nicht Vorschrift, aber die allgemeine Vereinbarung.

Wie sendet man einen Fehlerbericht?

Haben Sie nur Mut, einen in Tidy gefundenen Fehler an die Entwickler-Gruppe zu schicken. Die Qualität von Tidy hängt auch von Ihrer Aktivität ab. Sie können entweder die Datei mit Ihrem Fehlerbericht an den Sourceforge Fehler-" Erfasser " senden, oder schicken diesen als eMail an html-tidy@w3.org . Sie brauchen dazu keinen Sourceforge-Account bei html-tidy@w3.org, um einen Fehlerbericht zu zusenden und kein Abonnomierung von html-tidy@w3.org um dahin eine eMail senden zu können.

Prüfen Sie bitte unbedingt vorher, ob dieser Fehler nicht schon von jemand anderem gemeldet wurde, oder bereits bekannt ist. Wenn Sie sich nicht sicher sind, dann fragen Sie erst nach. Sind Sie sich sicher, daß es ein neuer Fehler ist, dann vergewissern Sie sich, daß Ihr Fehlerbericht folgende mindest-Informationen enthält:

Dies benötigen wir alles, um Ihren Fehler nachvollziehen zu können, ansonsten können wir Ihnen nicht helfen. Zusätzliche Informationen und evtl. Patches (zu deren Behebung) sind uns sehr willkommen!

Bitte senden Sie immer nur einen Fehler je Bericht. Berichte mit mehreren Fehlern lassen sich schlecht nachvollziehen und einige könnten übersehen werden.

Beachten Sie, daß alles in englischer Sprache sein muß! Vorschlag: Schreiben Sie alles erste in einfachem(kurze Sätze) Deutsch und lassen Sie es dann von diversen Übersetzungsprogrammen oder Online-Übersetzungs-Diensten erst von Ihrem Deutsch nach Englisch und dann wieder nach Deutsch übersetzen. Wenn der letzte Deutsche Text inhaltlich mit Ihrem "Original" übereinstimmt, dann schicken Sie die englische Version ab.

Zur Vorbereitung für einen Fehlerbericht einige Angaben/Tips: Im For Projekt: HTML Tidy müssen Sie sich für eine Categorie: von None | Documentation | HTML/XML/XHTML Parser | Pretty Printer und für eine Group: von None | 04 Aug 00-Mac OS specific | 04 Aug 00-Other platforms | 04 Aug 00-UN*X specific | 04 Aug 00-Win32 specific | 04 Aug 00-all platforms | Future-all platforms | TidyLib-based (all platforms) entscheiden. Ihr evtl. vorgefasster eMail-Text darf nicht breiter als 52 Zeichen sein, sonst wird er verstümmelt und der Fehler erst spät behoben. Zeilenumbrüche sind möglich, ansonsten werden Leerzeichen und Tabulatoren nicht dargestellt. Es muß reiner ASCII-Text sein, also nicht HTML! Wenn es darauf ankommt bereiten Sie eher eine Datei für den Upload vor, was bei dem Fehler-Erfasser möglich ist. Dort können Sie auch nach Bug's suchen oder einfach nur nachsehen welche am meisten gemeldet werden.

Wie sendet man eine zukünftig Merkmals-Anforderung?

Wenn Sie wollen, daß Tidy etwas Neues tut (oder zukünftig unterläßt), dann ist dies wahrscheinlich eine zukünftige Merkmals-Anforderung.

Das Vorgehen für das Versenden einer zukünftig Merkmals-Anforderung ist das Gleiche wie bei "Wie sendet man einen Fehlerbericht?". Einziger Unterschied ist der " Erfasser ", der eine andere "Betreff"-Zeile bei SourceForge notiert.

Wie beim Fehler, sehen Sie bitte erst nach, ob es diese zukünftig Merkmals-Anforderung nicht schon gibt. Wenn es diese schon gibt, können Sie Ihre Konmmentare/Wünsche dazu an den zukünftig-Merkmals-Anforderung-" Erfasser " oder eine eMail an html-tidy@w3.org senden. Gibt es Ihre zukünftig Merkmals-Anforderung noch nicht, dann senden Sie diese wie "Wie sendet man einen Fehlerbericht?", aber mit spezieller Betonung auf die gewünschte Ausgabe von der mitgelieferten Eingabe, den gewünschten Optionen usw. Bitte Erklären Sie, wenn möglich, was genau Tidy für Sie tun soll.

Wie kann die Formatierung des Ergebnisses kontrolliert werden?

Es gibt drei primäre Optionen um die Ausgabe-Formatierung zu steuern:

Am Besten probieren Sie ein wenig, um das von Ihnen gewünschte Format zu erzielen. Vermeiden Sie dabei indent yes,da einige Browser Bugs in der Darstellung produzieren.

Für eine Tidy Classic --indent auto Formatierung verwende die folgenden Optionen:

indent: auto
indent-attributes: no
vertical-space: yes

Weiteres finden Sie bei den Formatierungs Optionen.

Welche Version von Tidy kann ich verwenden?

Es wird empfohlen die aktuellen Source Forge Ausgaben, die auf http://tidy.sourceforge.net zu finden sind, zu verwenden. Die Leute berichteten immer wieder mal über Beispiele in denen Tidy verunstaltetes HTML nicht korrigierte, oder schlimmer, daß es verunstaltetes HTML erzeugte. Diese Fälle nehmen bezeichenderweise ab. Was besagt, daß Tidy mit repräsentativen Dateien Ihrer Betriebssystem-Umgebung getestet wird.

Für die Entwicklungs-Arbeit verwenden Sie bitte das CVS direkt aus Ihrem Entwicklungs-System. Informationen, wie Sie sich die Tidy Quellen holen, finden Sie unter http://sourceforge.net/cvs/ bzw. unter "'TidyLib' mit Batch-Datei downloaden". Auf diese Weise können Sie alle Änderungs-Stände aufheben und Konflikte schnell ausfindig machen.

Für die Erstellung eines Front End's (d.h. eine GUI oder eine Perl Umgebung) ist es am einfachsten eine Shell (=Hülle/Umgebung) für das Kommando-Zeilen-Werkzeug und seine analysierte Ausgabe zu schreiben. Auf diese Weise können die Benutzer Ihres Front End's einfach die neuste Version von Tidy laden ohne, daß Sie es neu in Ihr Front End einbinden müssen.

Ein anderer Ansatz ist die main() Funktion von Tidy durch eine auf Tidy-Quellen beruhende Bibliothek zu erstetzen. Dieser Ansatz ist zwar aufwendiger in der Synchronisation mit den Tidy-Änderungen, aber dennoch flexlibler in der Entwicklung.

Weiteres finden Sie bei der Einführung zu TidyLib.

Wie überprüfe ich das korrekte Funkionieren von Tidy? (Regression Test)

Sicher fragen Sie sich: "Warum soll ich einen Funktions-Test ausführen?"
Als Tidy-Anwender wollen Sie Ihre aktuelle Version mit der neuen Tidy-Version vergleichen, was bei Tidy-Beifügungen zu Ihren Anwendungen zu empfehlen ist!
Als Entwickler wollen Sie prüfen, ob Ihre Fehler-Behebungen oder Erweiterungen nicht neue Fehler produzieren!

Neue Fehler müssen durch Sie nicht unbedingt gleich erkannt werden, da einige nur unter bestimmten Bedingungs-Kombinationen auftreten können, oder nur im Browser zu sehen sind (oder in ausgewählten Browsern, die Sie gerade nicht haben). Durch den hier beschiebenen Funktions-Test können Sie die meisten Abstürze und Formatierungs-Probleme bemerken (und dann hoffentlich auch beheben).

Das gundlegende Vorgehen ist einfach: Der Funktions-Test ist vor und nach Ihren Änderungen auszuführen und
die "gut formatierte Quelltextauszeichnung" sowie Meldungen miteinander zu vergleichen. Die Ausgaben der Test-Scripte von alltest.cmd für WinNT/2K/XP und testall.sh für Linux/Unix erfolgen nach tidy/test/tmp. Wenn Sie es versäumt haben, vor Ihren Änderungen den Funktions-Test auszuführen, dann laden Sie sich die ausführbare Tidy-Version von der
Projekt-Seite herunter. Sind Sie kein TidyLib-Entwickler, dann können Sie sich die http://tidy.sourceforge.net/test/tidy_test.tgz = Testdateien direkt herunterladen.

Nun die einzelnen Schritte zur Überprüfung der TidyLib-Änderungen:

Für Windows (Win2k)

Um D:\Tidy\tidy\test>alltest.cmd unter Win2k im Folgenden ausführen zu können:

  1. http://tidy.sourceforge.net/test/tidy_test.tgz = = Testdateien = tidy_test.tgz herunterladen
    Besser D:\Tidy\tidy\test\*.* aus dem CVS herunterladen,
    da dann alle Dateien die nötigen DOS-Zeilen-Umbrüche haben.
    In http://tidy.sourceforge.net/test/tidy_test.tgz = tidy_test.tgz sind es alles Unix-Zeilen-Umbrüche.
  2. tidy_test.tgz/tidy/*.* entpacken z.B. nach D:\Tidy\tidy\test\*.*
    Alle Dateien stehen somit unter D:\Tidy\tidy\test\*.*
  3. Verzeichnis anlegen D:\Tidy\tidy\test\bin\*.*
  4. In das Verzeichnis D:\Tidy\tidy\test\bin\*.* die zu testende tidy.exe kopieren!
    ( z.B. tidytestwin2k.tgz/tidy.exe = "HTML Tidy for Windows released on 1st November 2003"
    oder aus tidyde.tgz/tidy.exe )
    Es gibt dann also die Datei D:\Tidy\tidy\test\bin\tidy.exe
  5. Ersparren Sie sich die nachfolgenden Schritte von 6. bis 11. indem Sie
    herunterladen und abspeichern/überschreiben in
    D:\Tidy\tidy\test\alltest.cmd aus tidytestwin2k.tgz/alltest.cmd
    D:\Tidy\tidy\test\onetest.cmd aus tidytestwin2k.tgz/onetest.cmd
    Setzen Sie bei 12. fort!
  6. Herunterladen von tab2space.exe aus tab2space.tgz
  7. tab2space.tgz/tab2space.exe enpacken/kopieren nach D:\Tidy\tidy\test\tab2space.exe
  8. Die Datei D:\Tidy\tidy\test\tab2space.bat erstellen mit dem Inhalt:
    tab2space.exe -crlf -date alltest.cmd
    tab2space.exe -crlf -date onetest.cmd
    tab2space.exe -crlf -date xmltest.cmd
    
    tab2space.exe -crlf -date testcases.txt
    tab2space.exe -crlf -date xmlcases.txt
  9. In D:\Tidy\tidy\test\*.* einmalig die D:\Tidy\tidy\test\tab2space.bat starten
  10. In D:\Tidy\tidy\test\alltest.cmd am Dateiende ergänzen:
    1.Von:
          for /F "tokens=1*" %%i in (testcases.txt) do call onetest.cmd %%i %%j
    1.Nach (ändern):
          for /F "tokens=1*" %%i in (testcases.txt) do call onetest.cmd %%i %%j
          echo.
          echo ALLE TEST DURCHLAUFEN!
          echo.
          pause
  11. In D:\Tidy\tidy\test\onetest.cmd ändern:
    2.Von:
          echo Testing %1
    2.Nach (ändern):
          echo Teste: onetest.cmd %1 %2
    3.Von:
          set TIDY=..\bin\tidy
    3.Nach (ändern):
          set TIDY=.\bin\tidy
    4.Von:
          REM Remove any pre-exising test outputs
          if exist %MSGFILE% rm %MSGFILE%
          if exist %TIDYFILE% rm %TIDYFILE%

    4.Nach (ändern):
          REM Remove any pre-exising test outputs
          if exist %MSGFILE% del %MSGFILE%
          if exist %TIDYFILE% del %TIDYFILE%

    5.Von:
          if %STATUS% EQU %EXPECTED% goto done
          cat %MSGFILE%

          :done

    5.Nach (ändern):
          if %STATUS% EQU %EXPECTED% goto done
          rem type %MSGFILE%
         
          SET SATTXT=
          if %STATUS% EQU 0   SET SATTXT=Fehler-u.Warnungsfrei
          if %EXPECTED% EQU 0 SET EXPTXT=Fehler-u.Warnungsfrei
          if %STATUS% EQU 1   SET SATTXT=         Warnung-en
          if %EXPECTED% EQU 1 SET EXPTXT=         Warnung-en
          if %STATUS% EQU 2   SET SATTXT=Fehler u.Warnung-en
          if %EXPECTED% EQU 2 SET EXPTXT=Fehler u.Warnung-en
          if "%SATTXT%"=="" SET SATTXT=Schwerwiegender ProgrammFehler
         
          echo.
          echo Bug bei : onetest.cmd %1 %2
          echo Rueckgabe= %STATUS% (%SATTXT%)
          echo Soll = %EXPECTED% (%EXPTXT%)
          echo.
          :done
  12. D:\Tidy\tidy\test\alltest.cmd   starten bzw. Doppelklick darauf!
    Nun sieht man alle wichtigen Daten, wenn tidy.exe Probleme verursacht.
    Diese können mit
    DOS-Box bzw. CMD-Box oben links anklicken
    -> Bearbeiten -> "Markieren" bzw. "Alles Markieren" -> UND Enter
    in die Zwischenablage kopiert und weiter verarbeitet/ausgewertet werden.

    D:\Tidy\tidy\test\xmltest.cmd   starten (aus tidytestwin2k.tgz/xmltest.cmd) und selbiges Vorgehen wie bei alltest.cmd !
     
  13. Es ist bei Weitem nicht so, daß der Funktions-Test OHNE Bug's abläuft.
    Es sollten eben nur nicht mehr werden!!
  14. Noch interessanter wird es, wenn man die 38 "unterschlagenen" Bugs ansieht
    (testcases.txt in testcases.org.txt umbennen und statt dessen diese tidytestwin2k.tgz/testcases.txt setzen).
    Einfach nur mit der Nummer über das Verzeichnis D:\Tidy\tidy\test\*.* suchen und
    die entsprechenden cfg_*.txt , in_*.*ml , out_*.*ml und msg_*.txt ansehen.
    Meistens ist der Bug in in_*.*ml näher beschrieben.
    (die 0 , 1 oder 2 hinter der BugNo in tidytestwin2k.tgz/testcases.txt sind vom Autor nicht weiter geprüft worden)

    z.B. Trifft Bug [ 450389 ] Color attval check allows only black/# noch voll zu!
            Nur soll er angeblich schon behoben (fixed) sein und wurde am 12.08.2001 geschlossen.
     

Vor den Änderungen:

D:\Tidy\tidy\test>alltest.cmd
D:\Tidy\tidy\test>ren tmp baseline

Nach den Änderungen und der Erstellung von Tidy:

D:\Tidy\tidy\test>alltest.cmd
D:\Tidy\tidy\test>fc /L /N /T .\tmp\*.* .\baseline\*.* >diff.txt

Für Linux/Unix

Vor den Änderungen:

~/tidy/test$ ./testall.sh
~/tidy/test$ mv tmp baseline

Nach den Änderungen und der Erstellung von Tidy:

~/tidy/test$ ./testall.sh
~/tidy/test$ diff -u tmp baseline > diff.txt

Der Autor distanziert sich ausdrücklich vom Inhalt aller externen Links und Verweise.
Er übernimmt keine Gewähr oder Haftung für
Vollständigkeit, Richtigkeit, Aktualität oder etwaige Schäden.