cfw.ftcommunity.de: Weitere Inhalte / Navigation

Community-Firmware (cfw), Selbstbaucontroller (TX-Pi, ftduino, usw.), usw.
Forumsregeln
Bitte beachte die Forumsregeln!
Benutzeravatar
ski7777
Beiträge: 870
Registriert: 22 Feb 2014, 14:18
Wohnort: Saarwellingen

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von ski7777 » 02 Apr 2017, 19:58

Merge it!

richard.kunze
Administrator
Beiträge: 583
Registriert: 26 Dez 2015, 23:49
Wohnort: Rhein-Main-Gebiet

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von richard.kunze » 02 Apr 2017, 20:41

MasterOfGizmo hat geschrieben:Gefällt mir auch sehr gut. Beim Mobilmenü würde ich erwarten, dass es sich wieder schließt, wenn man außerhalb des offenen Menüs klickt. Aber das ist kein Showstopper und kann auch gerne so wie's ist übernommen werden.
PHabermehl hat geschrieben:Ich stimme auch für übernahme!
ski7777 hat geschrieben:Merge it!
OK, mach ich. Ich will vorher aber noch eine passende Behandlung für fehlende Übersetzungen einbauen (das gibt aktuell noch einen 404-Fehler beim Versuch die fehlende Sprachversion aufzurufen), die englische Installationsanleitung integrieren und ein paar Sätze auf den Seiten "Einstieg", "Programmierung" und "Programmierung/Python" schreiben (da darf mir aber auch gerne jemand zuvorkommen, wäre eine prima Gelegenheit auch mal den Edit-PullRequest-Prozess direkt auf Github durchzuspielen).

Das Mobilmenü beim Klick irgendwohin wieder zuzumachen sollte eigentlich auch gehen, da weiß ich nur aktuell nicht wo ich den passenden Klick-Handler am besten anklemmen soll. Wenn jemand eine Idee hat: Das Javascript für das Mobilmenü liegt direkt in docs/_layouts/default.html. Sonst schau ich es mir mal an wenn der Rest erledigt und die Sachen auf cfw.ftcommunity.de sind.

Benutzeravatar
MasterOfGizmo
Beiträge: 2720
Registriert: 30 Nov 2014, 07:44

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von MasterOfGizmo » 02 Apr 2017, 22:16

Die Brickly-Doku ist ja Wahnsinn! Wow, sehr toll. Danke!
Arduino für fischertechnik: ftDuino http://ftduino.de, ftDuino32 http://ftduino.de/32

richard.kunze
Administrator
Beiträge: 583
Registriert: 26 Dez 2015, 23:49
Wohnort: Rhein-Main-Gebiet

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von richard.kunze » 02 Apr 2017, 22:22

MasterOfGizmo hat geschrieben:Die Brickly-Doku ist ja Wahnsinn! Wow, sehr toll. Danke!
Der Dank gebührt Esther - ich hab da nur https://github.com/EstherMi/ft-brickly-userguide eingebunden...

... wobei mich das gerade an was erinnert: Die Edit-Links für die Brickly-Doku tun noch nicht, weil das aus einem anderen Repository kommt. Muss ich auch nochmal gradeziehen...

nq30
Beiträge: 144
Registriert: 25 Feb 2017, 07:44

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von nq30 » 03 Apr 2017, 20:35

Ich habe noch eine (einfache) Idee:
Wenn man (in der Mobil ausprobiert) af das Icon der Cfw clickt, würde (bei Amazon) ja (hast du aber nicht eingebaut) die Startseite kommen. Könntest du das einbauen?
Mit freundlichen Grüssen
nq30

ft:cool :)

Benutzeravatar
ski7777
Beiträge: 870
Registriert: 22 Feb 2014, 14:18
Wohnort: Saarwellingen

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von ski7777 » 03 Apr 2017, 20:44

nq30 hat geschrieben:Ich habe noch eine (einfache) Idee:
Wenn man (in der Mobil ausprobiert) af das Icon der Cfw clickt, würde (bei Amazon) ja (hast du aber nicht eingebaut) die Startseite kommen. Könntest du das einbauen?
Das gibts sogar hier im Forum und die Idee ist gut!

Raphael

sven
Beiträge: 2750
Registriert: 18 Okt 2010, 18:13
Wohnort: Rahden
Kontaktdaten:

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von sven » 03 Apr 2017, 21:43

Hallo!

Warum macht Ihr Euch denn so viel Arbeit und erstellt so eine Seite auf github?
Das ist meiner Ansicht nach irgendwie von hinten durch die Brust ins Auge.

Hier bietet sich ein CMS wie z.B. Joomla an.
Damit hat man so eine Seite relativ schnell umgesetzt.
Das Rad muss man nicht neu erfinden.

Gruß
Sven
Dieses Posting gibt ganz allein meine persönliche Meinung wieder!

richard.kunze
Administrator
Beiträge: 583
Registriert: 26 Dez 2015, 23:49
Wohnort: Rhein-Main-Gebiet

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von richard.kunze » 03 Apr 2017, 22:10

nq30 hat geschrieben:Wenn man (in der Mobil ausprobiert) af das Icon der Cfw clickt, würde (bei Amazon) ja (hast du aber nicht eingebaut) die Startseite kommen. Könntest du das einbauen?
ski7777 hat geschrieben:Das gibts sogar hier im Forum und die Idee ist gut!
Gute Idee. Den Links zur Startseite gibts zwar auch schon in der Navigation (als ersten Eintrag, "Home"/"Startseite"), aber schaden kann das nichts das im Seitenkopf auch nochmal zu verlinken.

Mag das einer von Euch versuchen und als PR einreichen (die Änderung gehört hier rein)? Wenn nicht bau ich das bei Gelegenheit ein.

Benutzeravatar
MasterOfGizmo
Beiträge: 2720
Registriert: 30 Nov 2014, 07:44

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von MasterOfGizmo » 03 Apr 2017, 22:32

sven hat geschrieben: Warum macht Ihr Euch denn so viel Arbeit und erstellt so eine Seite auf github?
Das ist meiner Ansicht nach irgendwie von hinten durch die Brust ins Auge.
Jekyll oder Joomla? Weil Jekyll schön in github integriert werden kann. Ist ja nicht so, dass Richard das Rad da neu erfindet. Seine Arbeit geht primär in die recht extravaganten Features wie die von jedem User anlegbaren Übersetzungen etc.

Ich find's cool ...
Arduino für fischertechnik: ftDuino http://ftduino.de, ftDuino32 http://ftduino.de/32

richard.kunze
Administrator
Beiträge: 583
Registriert: 26 Dez 2015, 23:49
Wohnort: Rhein-Main-Gebiet

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von richard.kunze » 03 Apr 2017, 22:43

sven hat geschrieben: Warum macht Ihr Euch denn so viel Arbeit und erstellt so eine Seite auf github?
Weil wir auch den Quellcode der CFW auf GitHub veröffentliche, es sinnvoll ist Quellcode und Dokumentation gemeinsam zu verwalten und zu versionieren, und GitHub mit "GitHub Pages" eine simple, elegante und kostenlose Möglichkeit bietet die Dokumentation auch gleich mit zu hosten.
sven hat geschrieben: Das ist meiner Ansicht nach irgendwie von hinten durch die Brust ins Auge.
Warum?
sven hat geschrieben: Hier bietet sich ein CMS wie z.B. Joomla an.
Nicht wirklich. Ein typisches, dynamisches CMS ist für so eine simple, statische Seite kompletter Overkill, man muss sich dafür einen eigenen Hoster suchen (und in der Regel auch bezahlen), man muss es administrieren (CMS-Systeme - vor allem solche auf Basis von PHP - sind notorisch anfällig für Sicherheitsprobleme, sowas längere Zeit ungepatcht im Web stehen zu lassen ist sträflicher Leichtsinn), und Inhalte editieren ist damit auch nicht einfacher als z.B. mit einem Wiki oder dem Online-Editor von GitHub.
sven hat geschrieben: Damit hat man so eine Seite relativ schnell umgesetzt.
Man hat sich schnell ein Grundgerüst zusammengeklickt. Zumindest solange man mit dem zufrieden ist, was das CMS einem als Vorlagen anbietet - wenn man da was anpassen will (oder muss, weil die Vorlage nichts taugt), wird es sehr schnell sehr eklig.

Und die Inhalte - also das, worauf es wirklich ankommt - erstellen sich auch mit einem CMS nicht von selbst.
sven hat geschrieben: Das Rad muss man nicht neu erfinden.
Machen wir ja auch nicht. Wir nutzen Git für die Versionierung (und das bietet da Möglichkeiten, die einem typischen CMS um Lichtjahre voraus sind), GitHub für den Redaktionsprozess (komplett mit komfortablem Online-Editor zum Inhalte editieren, einem sauberen Review über Pull-Requests und Diskussionen dazu, Authentifizierung/Identifikation der einzelnen Mitautoren über ihren GitHub-Login, und absolut exakter Dokumentation wer wann was warum geändert hat), Jekyll um bequem und automatisch die publizierten Inhalte als fertig layoutetes HTML zu rendern, und wir hosten den Kram ebenfalls auf GitHub (übrigens kostenlos).

Und im Endeffekt haben wir damit eine Lösung, die für unsere Zwecke deutlich besser geeignet ist als jedes CMS.

richard.kunze
Administrator
Beiträge: 583
Registriert: 26 Dez 2015, 23:49
Wohnort: Rhein-Main-Gebiet

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von richard.kunze » 04 Apr 2017, 00:09

richard.kunze hat geschrieben:Der Dank gebührt Esther - ich hab da nur https://github.com/EstherMi/ft-brickly-userguide eingebunden...
... wobei mich das gerade an was erinnert: Die Edit-Links für die Brickly-Doku tun noch nicht, weil das aus einem anderen Repository kommt. Muss ich auch nochmal gradeziehen...
Das tut jetzt auch. Zwar nicht ganz so schön mit automagischer Anpassung an den jeweiligen Fork wie die "normalen" Edit-Links, aber damit dass man die URL in _config.yaml jedesmal anpassen muss wenn die Brickly-Doku aus einem anderen Repository eingebunden wird können wir denke ich leben :-)

Benutzeravatar
ski7777
Beiträge: 870
Registriert: 22 Feb 2014, 14:18
Wohnort: Saarwellingen

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von ski7777 » 04 Apr 2017, 06:28

richard.kunze hat geschrieben:
nq30 hat geschrieben:Wenn man (in der Mobil ausprobiert) af das Icon der Cfw clickt, würde (bei Amazon) ja (hast du aber nicht eingebaut) die Startseite kommen. Könntest du das einbauen?
ski7777 hat geschrieben:Das gibts sogar hier im Forum und die Idee ist gut!
Gute Idee. Den Links zur Startseite gibts zwar auch schon in der Navigation (als ersten Eintrag, "Home"/"Startseite"), aber schaden kann das nichts das im Seitenkopf auch nochmal zu verlinken.

Mag das einer von Euch versuchen und als PR einreichen (die Änderung gehört hier rein)? Wenn nicht bau ich das bei Gelegenheit ein.
Wenn ich mir den Code angeguckt habe, sollte ich <a href> da rein kriegen. ;)

Raphael

Benutzeravatar
ski7777
Beiträge: 870
Registriert: 22 Feb 2014, 14:18
Wohnort: Saarwellingen

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von ski7777 » 04 Apr 2017, 21:41

Feature ist gemerged in Richards Repository! :D

Raphael

nq30
Beiträge: 144
Registriert: 25 Feb 2017, 07:44

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von nq30 » 05 Apr 2017, 05:32

@ski7777
Funtioniert sogar ;) ;) ;)
Mit freundlichen Grüssen
nq30

ft:cool :)

Benutzeravatar
EstherM
Beiträge: 1466
Registriert: 11 Dez 2011, 21:24

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von EstherM » 06 Apr 2017, 21:30

richard.kunze hat geschrieben: @Esther: Ich schick Dir für die Änderungen gleich noch einen Pull-Request, dann kannst Du schauen ob du das übernehmen willst.
Super! Erledigt. Danke. Ich habe die Links in Github irgendwie für komplizierter gehalten als sie sind.
Wegen des wunderbaren Wetters war ich jetzt ein paar Tage offline. Demnächst kommen aber noch ein paar Aktualisierungen und vor allem Bilder für die letzten beiden Abschnitte.
Gruß
Esther

Benutzeravatar
EstherM
Beiträge: 1466
Registriert: 11 Dez 2011, 21:24

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von EstherM » 11 Apr 2017, 09:48

Ich bin jetzt komplett durch mit der Brickly-Anleitung. Bei den Abbildungen ist das Layout auf der fertigen Seite gelegentlich verrutscht gegenüber der Darstellung des Markdowns. Ich habe jetzt versucht, an den entsprechenden Stellen noch Zeilenumbrüche und Leerzeichen einzufügen. Ob es geholfen hat, werden wir sehen.
Was wäre denn die nächste wichtige Schreibaufgabe? Brickly auf Englisch? Oder lieber erst Python aktualisieren und auf Deutsch übertragen?
Es macht einfach Spaß, an diesem Projekt mitzuarbeiten! Vor allem, wenn man sieht, dass die eigenen Beiträge genutzt werden und anderen weiterhelfen.
Gruß
Esther

richard.kunze
Administrator
Beiträge: 583
Registriert: 26 Dez 2015, 23:49
Wohnort: Rhein-Main-Gebiet

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von richard.kunze » 18 Apr 2017, 22:46

Hallo Esther,
EstherM hat geschrieben:Ich bin jetzt komplett durch mit der Brickly-Anleitung.
... und auf https://rkunze.github.io/ftcommunity-TXT/ ist jetzt auch die aktuelle Version eingebunden.
EstherM hat geschrieben:Bei den Abbildungen ist das Layout auf der fertigen Seite gelegentlich verrutscht gegenüber der Darstellung des Markdowns. Ich habe jetzt versucht, an den entsprechenden Stellen noch Zeilenumbrüche und Leerzeichen einzufügen
Ja, die Abbildungen werden auf der Website etwas anders dargestellt als in der Markdown-Ansicht auf Github - das ist prinzipiell auch Absicht, und da steckt ein System dahinter:

Bilder, die allein auf einer Zeile stehen (also mindestens eine Leerzeile davor und danach) werden im HTML horizontal zentriert dargestellt und dürfen den kompletten verfügbaren Platz beanspruchen. Falls das Bild einen Titel hat (siehe Beispiel), dann wird dieser Titel in einer Bildunterschrift unter dem Bild ebenfalls zentriert angezeigt. Beispiel:

Code: Alles auswählen

Dieser Text steht vor dem Bild.

![Beispiel-Bild](http://bei.spiel/bild.png "Ich bin ein großes, zentriertes, einzeln stehendes Bild mit Titel")

Dieser Absatz kommt nach dem Bild
Bilder, die innerhalb eines Absatzes stehen, werden an den rechten Rand des Artikelbreichs geschoben, auf maximal ein Drittel der Breite des Artikels skaliert, und der Text (je nach Größe des Bildes auch nachfolgende Abschnitte) fließt um das Bild herum. Ein eventueller Titel landet im "title"-Attribut des Bildes und wird von den meisten Browsern als Popup angezeigt, wenn man mit dem Mauszeiger auf das Bild fährt. Beispiel:

Code: Alles auswählen

![Beispiel-Bild](http://bei.spiel/bild.png "Bild im Text")
Dieser Text fliesst um das Bild herum.

Der nächste Absatz auch noch

## Unterabschnitt

Und sogar dieser komplette Unterabschnitt.

# Neues Kapitel

Erst ein neues Kapitel mit einer Überschrift auf dem höchsten Level fließt auch dann nicht mehr um das Bild, wenn dadurch links vom Bild dann Leerraum verbleibt.
Die "Inline"-Bilder habe ich absichtlich nach rechts statt nach links geschoben, weil - zumindest auf einem großen Bildschirm - links schon das Menü angezeigt wird, und ich in den Text eingebettete Illustrationen (und später dann auch sowas wie Randnotizen bzw. "Erklärkästen", wenn mir dafür noch was einfällt wie man das in Markdown-Syntax vernüftig eingeben kann) nicht auf derselben Seite wie das Menü haben wollte.

Was man eventuell noch feiner abstimmen sollte ist die maximale Breite der eingebetten Bilder - da wäre etwas mehr als 30% der Textbreite eventuell besser (50% sind aber - gerade auf schmalen Bildschirmen wie z.B. Smartphone im Hochformat - schon wieder zuviel). Das geht aber einfach per CSS, d.h. da können wir problemlos noch später dran schrauben ohne an den Inhalten etwas ändern zu müssen.
EstherM hat geschrieben:Was wäre denn die nächste wichtige Schreibaufgabe? Brickly auf Englisch? Oder lieber erst Python aktualisieren und auf Deutsch übertragen?
Meine Prioritäten sind:
  • Die bisher leeren "Zwischenseiten" ("Einstieg", "Programmierung", "Programmierung -> Python", ...) mit Inhalt füllen (Deutsch und English). Viel muss da nicht hin, aber die komplett leeren Seiten sind gerade in der Darstellung für Mobilgeräte (mit eingeklapptem Menü) etwas irritierend.
  • Aktualisierte Anleitung für Python und Übersetzung auf Deutsch.
  • Brickly auf Englisch.
Wobei wir denke ich schon nach den ersten beiden Punkten - oder vielleicht auch schon nach dem ersten - die neuen Inhalte auch auf cfw.ftcommunity.de spielen können.

Inhalte auf Deutsch haben übrigens deshalb für mich aktuell eine etwas höhere Priorität, weil laut Traffic-Statistik für das CFW-Repository auf Github (siehe https://github.com/ftCommunity/ftcommun ... hs/traffic, um das zu sehen braucht man allerdings Commit-Rechte auf dem Repository) gut dreiviertel der Klicks auf das "Fork me on Github"-Banner auf cfw.ftcommunity.de von der deutschen Version kommen und nur knapp ein Viertel von der englischen Version - d.h. vermutlich wird die deutsche Version von cfw.ftcommunity.de auch deutlich öfter gelesen als die englische...

Liebe Grüße,

Richard

Benutzeravatar
EstherM
Beiträge: 1466
Registriert: 11 Dez 2011, 21:24

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von EstherM » 19 Apr 2017, 16:36

richard.kunze hat geschrieben: Die "Inline"-Bilder habe ich absichtlich nach rechts statt nach links geschoben, weil - zumindest auf einem großen Bildschirm - links schon das Menü angezeigt wird, und ich in den Text eingebettete Illustrationen (und später dann auch sowas wie Randnotizen bzw. "Erklärkästen", wenn mir dafür noch was einfällt wie man das in Markdown-Syntax vernüftig eingeben kann) nicht auf derselben Seite wie das Menü haben wollte.
Danke für deine ausführliche Erklärung. Die Idee, zumindest einige Bilder rechts im Text zu haben, finde ich gar nicht schlecht. Wenn der Text um das Bild herum fließt, dann sollte das allerdings der Text sein, der zu dem Bild gehört und nicht der nächstfolgende Abschnitt. An den meisten Stellen habe ich geplant, dass zuerst der Text kommt, und dann das Bild, das das Ergebnis zeigt. Ich werde bei Gelegenheit versuchen, das Layout entsprechend anzupassen. Die Bilder sollen halt die richtige Größe haben, nicht unnötig groß, aber so, dass man sie noch gut lesen kann.
richard.kunze hat geschrieben: Meine Prioritäten sind:
  • Die bisher leeren "Zwischenseiten" ("Einstieg", "Programmierung", "Programmierung -> Python", ...) mit Inhalt füllen (Deutsch und English). Viel muss da nicht hin, aber die komplett leeren Seiten sind gerade in der Darstellung für Mobilgeräte (mit eingeklapptem Menü) etwas irritierend.
  • Aktualisierte Anleitung für Python und Übersetzung auf Deutsch.
  • Brickly auf Englisch.
Ich habe mir schon mal Gedanken gemacht zu den Zwischentexten und werde versuchen, bald einen Fork anzulegen und den Text da einzugeben.
Gruß
Esther

Benutzeravatar
EstherM
Beiträge: 1466
Registriert: 11 Dez 2011, 21:24

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von EstherM » 25 Apr 2017, 17:35

EstherM hat geschrieben: Ich habe mir schon mal Gedanken gemacht zu den Zwischentexten und werde versuchen, bald einen Fork anzulegen und den Text da einzugeben.
Wenn ich jetzt einen kompletten Fork habe, kann ich dann auch daraus probeweise eine selbst eine Seite erzeugen? Dann könnte ich prüfen, ob das mit dem Layout so passt, bevor ich die geänderten Texte committe. Würde das gehen? Was müsste ich dafür machen?
Danke für die Unterstützung.
Gruß
Esther

richard.kunze
Administrator
Beiträge: 583
Registriert: 26 Dez 2015, 23:49
Wohnort: Rhein-Main-Gebiet

Re: cfw.ftcommunity.de: Weitere Inhalte / Navigation

Beitrag von richard.kunze » 25 Apr 2017, 20:43

Hallo Esther,
EstherM hat geschrieben:Wenn ich jetzt einen kompletten Fork habe, kann ich dann auch daraus probeweise eine selbst eine Seite erzeugen?
Ja - da gibt es sogar mehrere Möglichkeiten. Du kannst entweder in Deinem Fork auf GitHub "Github Pages" einschalten (Einfach unter "Settings" im Repository im passenden Abschnitt als Quelle "master branch docs/ folder" auswählen, die Seite findest Du dann unter https://esthermi.github.io/ftcommunity-TXT), oder Du kannst lokal auf Deinem Rechner Jekyll installieren (Eine Installationsanleitung findest Du z.B. unter https://jekyllrb.com/docs/installation/ und/oder https://jekyllrb.com/docs/windows/).

Beides hat Vor- und Nachteile: GitHub Pages ist schnell und simpel eingerichtet, aber Du musst Änderungen in Deinem Fork committen bevor Du sie sehen kannst, und die Seite auf GitHub ist öffentlich zugänglich. Ein lokales Jekyll ist etwas mehr Arbeit bei der Installation, aber dafür kannst Du Änderungen direkt ausprobieren (auch bevor Du sie committest) und musst nicht jedes Experiment gleich mit der ganzen Welt teilen.

Liebe Grüße,

Richard

Antworten