RRZE-Webteam / FAU-Einrichtungen

WordPress-Theme für zentrale Einrichtungen der Friedrich-Alexander-Universität Erlangen-Nürnberg
GNU General Public License v3.0
18 stars 11 forks source link

Doku: Benennung der Bereiche #310

Closed xwolfde closed 6 years ago

xwolfde commented 7 years ago

In der Doku zum Theme müssen unbedingt die Bereiche des Themes/der Webseite klar benannt werden. Es ist sehr irritierend, wenn die Namen der Bereiche falsch verwendet werden. (header, meta, hero, footer, sidebar, navbar, ...)

xwolfde commented 7 years ago

Header = Gesamter Bereich oben. Dieser enthält:

Die Meta-Nav enthält die Bereiche

Der Hero-Bereich enthält optional:

Content: Bereiche unterhalb Header

Enthält:

Footer Unterhalb Content

Enthält:

AstridSemm commented 6 years ago

So, jetzt wird's lustig. Im Customizer heißt "Branding" nämlich einerseits Website-Informationen, andererseits Header-Bild. Der Hero-Bereich für die Fakultäten heißt seit Ewigkeiten "Bühne", für die Lehrstühle "Banner", was die Startseiten anbelangt. Für die Unterseiten gab's da noch nie eine Bezeichnung. "Subnav" war schon immer die Navigation auf den Unterseiten mit Navi, Sidebar Inline Optional war auch schon immer einfach die Sidebar. Main Content Bereich versteht auch keine Sau, das ist der Inhaltsbereich (schon immer gewesen, aber im Handbuch nicht weiter beschrieben, richtig). Sidebar rechts optional bei Startseite und Blogroll war auch schon immer die Sidebar, die Portalmenüs sind so bezeichnet, den Logoslider kennt auch keine Sau, das sind die Bildlinks, Werbebanner nutzt keine Sau (kann ich aber dokumentieren; nur: warum Leute auf blöde Ideen bringen?), Social Media Leiste heißt seit Ewigkeiten Social Media Footer, der Footer ist der Einfachheit halber mit Metanavigation unten bezeichnet, kann ich auch noch ändern, wenn's sein muss. Ich bin sehr dafür, Dokumentationen grundsätzlich "für Dummies" zu schreiben und mit möglichst wenig Spezialzeugs um mich zu werfen. Insofern konkret die Frage: Was soll ich ändern/neu machen? Oder kann das warten, bis die Theme Options im Customizer sind, damit ich das in einer Rutsche neu machen kann?

xwolfde commented 6 years ago

Dieser Teil ist aber für Entwickler gedacht. Die Bezeichnungen kommen aus dem Classnames. Für normale Autoren reicht es, wenn wir die 4 bereiche "Kopfteil, Fußteil, Hauptteil und Sidebar" bezeichnen. Von Entwicklern oder Designern, die an der Entwicklung aktiv teilhaben wollen, erwarte und fordere ich die notwendigen Grundkenntnisse die Bereiche aus den Classnamen auszulesen und richtig einzuordnen.

AstridSemm commented 6 years ago

Gut, soweit verstanden. Aber: Die Doku (also wordpress.rrze.fau.de) richtet sich ja ausschließlich an Anwender. Soll das wirklich dort rein oder ist es nicht vernünftiger, für Entwickler was eigenes zu haben?

xwolfde commented 6 years ago

Ich wollte für Entwickler einen Teil unter beta.wordpress. machen (Im Menü unter Dev)

AstridSemm commented 6 years ago

Ach, das bedeutet, dass ich gar nicht gemeint war! gnaaaaah Heute ist definitiv nicht mein Tag.

xwolfde commented 6 years ago

Dafür hast du einen netten neuen Avatar. Das ist doch auch was :)

xwolfde commented 6 years ago

Ausgelagert auf Entwicklerungswebauftritt