Dev:XHTML

Aus YaCyWiki
Wechseln zu: Navigation, Suche

Der XHTML-Code ist bereits im SVN, Änderungen bitte dort direkt einchecken oder einen patch (svn diff) an einen developer schicken!

Jede(r) ist herzlich eingeladen, mitzuarbeiten!

Konventionen

  • Der Anfang der Datei sieht folgendermaßen aus:

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

  • JavaScript wird mit <script type="text/javascript"> eingebunden, das Attribut language="JavaScript" kann weggelassen werden und ist auch nicht valid. Probleme mit älteren Browsern gibt es anscheinend keine.
  • Standard-Einrückung: 2 Leerzeichen bei Block-Level Elementen, bei kurzen Inhalten der Elemente kann aber auch alles in eine Zeile geschrieben werden.
  • Formatierung hat nichts im XHTML-Code verloren, dafür bitte CSS benutzen.
  • Um individuelle Formatierungen für einzelne Seiten vornehmen zu können den Dateinamen als Body-ID eintragen (siehe bereits geänderte Dateien)
  • Tabellen werden nur verwendet, wenn es semantisch Sinn macht, es also um tabellenartigen Inhalt geht.
  • Zweispaltige Tabellen für Formulare sollten durch Definitionslisten ersetzt werden - siehe http://www.clagnut.com/blog/241, wo möglich sollte <label> verwendet werden.
  • Die Namen für Klassen sollten semantisch sinnvoll sein, d.h. z.B. <p class="error"> statt <p class="red"> verwenden. class="small"> entfällt!
  • Natürlich sollte alles XHTML 1.0 strict valid sein und in gängigen Browsern funktionieren und in allen Browsern benutzbar sein. Beim Arbeiten in Firefox hilft das Web Developer-Plugin.

Arbeitsablauf

Im Moment werden alle Dateien grob bearbeitet, d.h. nach den obigen Konventionen angepasst. Parser (z.B. für das Wiki) werden noch nicht geändert und Java-Dateien werden auch noch nicht in größerem Umfang bearbeitet.

In einem zweiten Durchlauf wird dann der Java-Code wo nötig verändert und die Klassennamen werden noch einmal überarbeitet. Dabei sollten z.B. die Klassen TableCellLight und TableCellDark durch odd und even ersetzt werden. Auch die Klasse TableHeader kann durch <th> für einzelne Elemente bzw. <thead> für den Header und <tfoot> für den Fuß sowie <tbody> für den Inhalt ersetzt werden (siehe SelfHTML).

Immer wieder sollte das CSS bearbeitet und bereinigt werden. Das Ergebnis sollte möglichst klar und einfach sein. Eine gute Struktur wären zwei CSS-Dateien von denen eine grundlegendes CSS für das Layout enthält und die andere dann die Farben enthält, also der Skin ist. Dies würde die Erstellung von Skins sehr vereinfachen, da nur einige Farben eingetragen werden müssten. Ein durchkommentierter Prototyp eines Skins sollte ebenfalls erstellt werden. In Skins kann darüber hinaus natürlich auch das Layout verändert werden, der Skin sollten deshalb als letztes in die HTML-Datei eingebunden werden.

Erfolgreich validierte Dateien

In /htroot

  • Blacklist_p.html - leeres <select> bei leerer Blacklist entfernt, valid --Kane 14:22, 24. Dez 2006 (CET)
  • Bookmarks.html - Probleme mit nicht escapeten URLs beseitigt, valid --Kane 14:22, 24. Dez 2006 (CET)
  • CacheAdmin_p.html - Benötigt Umstellung auf YaCy CSS und weg von den ursprünglichen Tabellen / Probleme mit nicht escapetem Text aus .java beseitigt, valid --Kane 14:22, 24. Dez 2006 (CET)
  • CacheResource_p.html - enthält kein HTML, nur Bilder; aufgerufen von CacheAdmin_p.html --Kane 02:18, 20. Dez 2006 (CET)
  • ConfigAdvanced_p.html - ungültige ID's aus dem Java gefixt --Kane 16:37, 22. Dez 2006 (CET)
  • ConfigBasic.html - valid und auch semantisch ok
  • ConfigLanguage_p.html - valid, Tabellenlayout entfernt --Kane 14:43, 25. Dez 2006 (CET)
  • ConfigProfile_p.html - valid und fertig --Michitux 20:26, 26. Aug 2006 (CEST)
  • ConfigSkins_p.html - valid, Tabellenlayout entfernt --Kane 14:43, 25. Dez 2006 (CET)
  • Config_p.html - das selbe wie ConfigAdvanced_p.html (selber code nur kein subMenu) --Kane 14:43, 25. Dez 2006 (CET)
  • Connections_p.html - valid und ok
  • CookieMonitorIncoming_p.html - valid und ok
  • CookieMonitorOutgoing_p.html - valid und ok
  • CookieTest.html - valid und ok
  • DetailedSearch.html - removed JS => valid --Kane 20:02, 5. Jan 2007 (CET)
  • PerformanceMemory_p.html - Probleme mit <br> aus der Java-Datei beseitigt, valid --Kane 16:37, 22. Dez 2006 (CET)
  • PerformanceQueues_p.html - valid
  • PerformanceSearch_p.html - valid
  • Settings_Crawler.inc - valid --NetBude 15:44, 23. Jan 2007 (CET)
  • Settings_p.html - --Kane 16:37, 22. Dez 2006 (CET)
  • Settings_Http.inc - --Kane 16:37, 22. Dez 2006 (CET)
  • Settings_MessageForwarding.inc - --Kane 16:37, 22. Dez 2006 (CET)
  • Settings_Parser.inc - --Kane 16:37, 22. Dez 2006 (CET)
  • Settings_PortForwarding.inc - --Kane 16:37, 22. Dez 2006 (CET)
  • Settings_Proxy.inc - --Kane 16:37, 22. Dez 2006 (CET)
  • Settings_ProxyAccess.inc - --Kane 16:37, 22. Dez 2006 (CET)
  • Settings_Seed.inc - --Kane 16:37, 22. Dez 2006 (CET)
  • Settings_Seed_UploadFile.inc - --Kane 16:37, 22. Dez 2006 (CET)
  • Settings_Seed_UploadFtp.inc - --Kane 16:37, 22. Dez 2006 (CET)
  • Settings_Seed_UploadScp.inc - --Kane 16:37, 22. Dez 2006 (CET)
  • Status.html - valid, von unnötigem styling bereinigt
  • Status_p.inc - valid, von unnötigem styling bereinigt (Fortschrittsbalken enthalten Hack wegen Darstellungsfehler -> Ursache?), doppeltes </tr> entfernt, wieder valid --Kane 16:37, 22. Dez 2006 (CET)
  • WatchCrawler.html - valid --NetBude 15:30, 23. Jan 2007 (CET)

bereits bearbeitete Dateien

in /htroot

  • Blog.html - bis auf den Post-Inhalt valid
  • Gettext_p.html - vermutlich valid --Kane 02:18, 20. Dez 2006 (CET)
  • Help.html - fertig
  • index.html - valid, neues Template für Formulare könnte noch verwendet werden
  • IndexCleaner_p.html - valid
  • IndexControl_p.html - Schlechter Code aus der Java-Datei, u.a. kein checked="checked" möglich, leeres <select>, checked="checked" sollte jetzt überall drin sein --Kane 00:02, 20. Dez 2006 (CET)
  • IndexCreateIndexingQueue_p.html - valid
  • IndexCreateLoaderQueue_p.html - valid
  • IndexCreateWWWGlobalQueue_p.html - valid
  • IndexCreateWWWLocalQueue_p.html - müsste valid sein
  • IndexCreate_p.html - valid
  • IndexImport_p.html - valid
  • IndexMonitor.html - Probleme mit nicht-escapten URLs aus der Java-Datei
  • IndexShare_p.html - Seite noch kaum bearbeitet, Sinn der Tabelle aber unklar, deshalb Bearbeitung sehr schwierig --Michitux 18:30, 12. Aug 2006 (CEST)
  • IndexTransfer_p.html - valid
  • Log_p.html - wird nicht mehr benötigt, wird durch die neue ViewLog_p.html ersetzt --Michitux 18:01, 9. Aug 2006 (CEST)
  • MessageSend_p.html - fertig
  • Messages_p.html - valid, aber nicht vollständig getestet
  • Network.html - valid
  • News.html - valid
  • ProxyIndexingMonitor_p.html - valid, jetzt mit <label> --Kane 00:02, 20. Dez 2006 (CET)
  • QuickCrawlLink_p.html - valid
  • SettingsAck_p.html - sollte valid sein --Michitux 22:53, 9. Sep 2006 (CEST)
  • User.html - vermutlich valid; table noch zu ersetzen --Kane 02:18, 20. Dez 2006 (CET)
  • User_p.html - vermutlich valid; tables noch zu ersetzen --Kane 02:18, 20. Dez 2006 (CET)
  • ViewLog_p.html - fertig, aber Probleme mit dem Internet Explorer (width:100%)
  • ViewProfile.html - valid, fertig (bis auf WikiParser) --Michitux 13:28, 26. Aug 2006 (CEST)
  • Wiki.html - Bis auf den Seiteninhalt valid, Code könnte an manchen Stellen besser sein
  • yacysearch.html - Noch Probleme mit dem Form und nicht escpate URLs aus der Java-Datei
  • env/templates/header.template - fertig
  • env/templates/footer.template - fertig
  • env/templates/metas.template - fertig
  • env/templates/simpleheader.template - valid, aber nicht ganz sauber (style-informationen im content)
  • env/templates/simplefooter.template - fertig
  • submenuConfig.template - valid, könnte aber noch einmal nur mit ul und li überarbeitet werden (statt div)
  • submenuCookie.template - valid, könnte aber noch einmal nur mit ul und li überarbeitet werden (statt div)
  • submenuIndexControl.template - valid, könnte aber noch einmal nur mit ul und li überarbeitet werden (statt div)
  • submenuIndexCreate.template - valid, könnte aber noch einmal nur mit ul und li überarbeitet werden (statt div)
  • submenuPerformance.template - valid, könnte aber noch einmal nur mit ul und li überarbeitet werden (statt div)

in /doc

reservierte Dateien

bei Bearbeitung einer der untenstehenden Dateien bitte Datei in diese Liste schieben und Signatur dahinter setzen (--~~~~).

in /htroot

  • Statistics.html HerrLich
  • Lab.html HerrLich
  • env/Page.html HerrLich

in /doc

noch nicht bearbeitete Dateien

in /htroot

  • Settings_ServerAccess.inc
  • sharedBlacklist_p.html
  • Steering.html
  • ViewFile.html
  • WikiHelp.html
  • YaCySearchPluginFF.html
  • YPStats_p.html
  • www/welcome.html
  • htdocsdefault/dir.html
  • proxymsg/authfail.inc
  • proxymsg/error.html
  • proxymsg/proxylimits.inc - muss vermutlich nicht bearbeitet werden
  • proxymsg/unknownHost.inc

in /doc

Hinweis: bitte erst alles in /htroot bearbeiten, erst dann mit /doc anfangen!

  • Contact.html
  • Demo.html
  • Details.html
  • Download.html
  • Download.html.up (?)
  • FAQ.html
  • Impressum.html
  • index.html
  • Installation.html
  • License.html
  • Links.html
  • Material.html
  • News.html
  • Platforms.htm
  • Technology.html
  • Volunteers.html

Und natürlich CSS- und JavaScript-Dateien soweit notwendig!