Aktion #144

WordPress-Plugin zum Exportieren von Blog-Posts nach Markdown erstellen

Added by Denis Kurz over 4 years ago. Updated over 4 years ago.

Status:RückfrageStart date:02/04/2015
Priority:NormalDue date:
Assignee:Denis Kurz% Done:

40%

Category:Infrastruktur - Blog
Target version:-
Assoziiert mit:Denis Kurz, Frederick Weiß, Nicolai Parlog, Till Schäfer

Description

Einige Blogposts werden nach der Veröffentlichung per E-Mail verschickt, z.B. an die Newsletter-Abonnenten. Gemäß unserer Kommunikationsrichtlinie für Newsletter muss dabei der Inhalt auch als Text (ohne HTML-Formatierungen) enthalten sein. Das manuelle Konvertieren der in HTML verfassten Blogposts in Text ist sowohl mühselig als auch zeitaufwendig.

Ein WordPress-Plugin dafür zu schreiben scheint mir nicht so furchtbar aufwendig zu sein, vor allem, weil ich die entsprechende Funktionalität in PHP sowieso schon fertig habe. Ich habe allerdings als Autor noch kein Wordpress verwendet und bin deswegen auf Feedback angewiesen.

Frage also an die Redaktion: Wie könnte ein solches Plugin in unseren Blog eingebunden werden? Wie könnte ein möglichst reibungsloser Zugriff auf den Markdown-Text in euren bestehenden Workflow eingebunden werden?

Ein bisschen Inspiration:
  • Nur für Redaktion: Wenn ein Post bearbeitet, wird unter der Vorschau eine zusätzliche Box angezeigt, die den Post als Markdown zum Rauskopieren enthält.
  • Für alle: Wenn an die URL eines Posts ein "?format=markdown" oder so angehängt wird, wird der Blogpost als text/plain zurückgegeben.

Mehr sinnvolle Möglichkeiten fallen mir nicht ein. Ideen? Wünsche?

History

#1 Updated by Nicolai Parlog over 4 years ago

  • Start date set to 02/04/2015
  • % Done changed from 0 to 20

Die Lösung mit ?format=markdown gefällt mir ganz ausgezeichnet.

Wenn das Kern-Feature implementiert ist, müssen wir noch über das Drumherum reden. Einige Fragen, die mir spontan in den Sinn kommen:
  • Wollen wir diese Möglichkeit publik machen, also z.B. neben "English" einen Menüpunkt "Markdown" erstellen?
  • Sollte der Knopf dann auf "HTML" wechseln, wenn er aktuell Markdown anzeigt?
  • Besteht die Möglichkeit, automatisch alle Links um den Parameter zu erweitern, so dass man sozusagen im "Markdown-Modus" bleiben kann?
  • Wollen wir diese Funktionalität sauber kapseln und ein Plugin erstellen?
  • Wollen wir das Konzept verallgemeinern, so dass beliebige "Übersetzungsskripte" eingebunden werden?
  • Welchen Namen verwenden wir statt Markdown, denn das ist es ja nicht 100%ig (wegen der Links)?

Diese Fragen sollten wir im Kontext der zur Verfügung stehenden Zeit und der vermutlich niedrigen Priorität dieser Nice-To-Haves besprechen. Außerdem ist "wir" ein ganz schlimmer Euphemismus für "Denis". ;)

@Denis: Hier ist ja schon ne Menge passiert, weswegen ich Beginn und Fortschritt geraten habe...

#2 Updated by Denis Kurz over 4 years ago

  • % Done changed from 20 to 40

Unsere Artikel erscheinen unter einer Freien Lizenz. Die werden natürlich erst richtig interessant, wenn man eine bequeme Möglichkeit hat, an die "Quellen" zu kommen. Man kann natürlich seinen Browser anweisen, sich den Quelltext unseres Blogs anzeigen zu lassen, aber bequem ist irgendwie anders. Die "Markdown"-Funktionalität allen zur Verfügung zu stellen halte ich deswegen für sehr sinnvoll.

Wenn wir so etwas wie einen "Markdown"-Modus implementieren würden, wäre ein prominent platzierter Button, mit dem man diesen Modus wieder verlassen kann, dringend notwendig. Kann ja gut sein, dass mal jemand aus Versehen oder Unwissenheit in diesen Modus wechselt. Welche Vorteile hätte denn ein solcher Modus? Dass weniger Bilder geladen werden? Wenn niemand noch einen anderen Nutzen sieht, ist m.M.n. der Aufwand zu hoch. Statt alle Links zu manipulieren, könnte man das ?format=markdown übrigens auch einfach in ein Cookie verlagern ;)

Das ganze ist schon in einem Plugin gekapselt.

Hast du Vorschläge, welche anderen "Übersetzungsskripte" sinnvoll sein könnten?

Wir könnten es weiterhin Markdown nennen und ich nehme kleine Änderungen an diesem Projekt vornehmen oder alternativ eins von diesen dreien nehmen. Markdown erlaubt durchaus Link-Referenzen, wie wir sie auch benutzen. Sie sehen nur etwas anders aus, z.B.:

Dies ist ein [Beispiellink][1], der auf unseren Blog führt.

[1]: http://blog.do-foss.de "title-Attribut des Links, optional" 

Ich behaupte mal, dass ein nach Markdown exportierter Blog-Artikel keiner unserer Kommunikationsrichtlinien entsprechen muss, so dass dieses Format ohne entsprechende Änderungen möglich sein sollte. Um es trotzdem mal direkt vergleichen zu können, hier unser aktueller Link-Stil z.B. für E-Mails:

Dies ist ein Beispiellink [1], der auf unseren Blog führt.

[1] http://blog.do-foss.de

Statusbericht: Wenn ich nichts übersehen hab, funktioniert im Moment nur das Filtern von Bildern nicht. Bei einem WordPress-Plugin kommt der "content" leider nicht als fertiges HTML an. Bild und Unterschrift scheinen lose zusammenzuhängen (indem sie in einer Zeile stehen) und ich möchte nicht aus Versehen zu viel rausfiltern.

#3 Updated by Denis Kurz over 4 years ago

Und jetzt fällt mir auch wieder ein, wofür wir einen html2text-Konvertierer eigentlich haben wollten, nämlich zum Rauskopieren für E-Mails. In denen sollten wir uns natürlich schon an die entsprechenden Kommunikationsrichtlinien halten :)

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 300 MB)