Styling readme.html im Plugin?

Ich mache readme.html Datei für ein Plugin mit einigen detaillierten Setup-statementen, die Screenshots enthalten müssen.

Als Rest der Benutzeroberfläche möchte ich es mit WordPress-Stil konsistent sein und so habe ich mir eine eigene readme.html .

Es enthält ein Stylesheet mit einem relativen Pfad:

  

Also für eine Plugin-Datei könnte ich gehen mit:

  

Aber es ist ein guter Weg, Styling zu integrieren? Es gibt wirklich viele Möglichkeiten, dies zu tun:

  • Link zu install.css ;
  • Bundle-Kopie von install.css mit Plugin;
  • eigene CSS-Datei mit Plugin bündeln;
  • Einbetten von Stil in readme.html .

Mir ist keine Empfehlung zur Bereitstellung von HTML-Dokumentation mit Plugins bekannt.

Hatten Sie HTML-Dokumentation mit Plugins (oder Themen, was auch immer) enthalten? Welche Methode hatten Sie gewählt, um es zu stylen und was haben Sie dafür gefolgert?

Solutions Collecting From Web of "Styling readme.html im Plugin?"

Es wäre besser, eine eigene CSS-Datei zu verwenden, damit Sie:

  • Verwenden Sie einen relativen Pfad zu Ihrem CSS.
  • Vermeiden Sie Probleme, den Pfad direkt in das Verzeichnis wp-admin . Nicht alle Leute haben WordPress in das Stammverzeichnis gestellt, also würde Ihr Beispiel oben für sie brechen.
  • Möglicherweise Redundanz durch Wiederverwendung des CSS in Ihren HTML- und Admin-Seiten für Ihr Plugin.

Ich schlage vor, dass Sie sich Justin Tadlocks Get the Image Plugin ansehen. Er enthält readme.html, readme.txt und readme.css.

In Bezug auf den Pfad zu deiner CSS-Datei würde das, was du gepostet hast, keinen Sinn ergeben (glaube ich nicht). Ich würde so etwas vorschlagen

 
		      	

Ich kann mir nicht vorstellen, warum Sie ein Stylesheet neben einer Readme-Datei bündeln, es wird unabhängig von etwas anderem betrachtet. Warum also nicht einfach dasselbe CSS in die HTML-Datei einfügen (da Sie es sowieso pflegen müssen).

  

Inline-Stile verwenden:

Pros

  • Eine weniger HTTP-Anfrage
  • Keine zusätzlichen Dateien zu verwalten
  • Sie müssen sich keine Gedanken über Pfadprobleme machen

Nachteile

  • Kein enthaltenes Stylesheet (Sie müssen Ihr CSS inline mit der WP install.css pflegen)
  • Das gesamte Styling muss innerhalb des Readme-Dokuments verwaltet werden *)

* ¹ – Nicht wirklich eine große Sache, das CSS wird in der Nähe der Spitze der Datei sein.


Was ich tatsächlich tun würde, ist nur eine externe Quelle zu verwenden, die inline mit WordPress aktualisiert wird, und Sie werden Pfadprobleme vermeiden (weil der externe Pfad immer gültig sein sollte).

Vielleicht WordPress.com als Quelle verwenden?

  

Wobei% NUM% ein numerischer Wert wäre (zB 1 oder 5 usw.), um darzustellen, von welchem ​​Server das CSS abgerufen werden soll. Ich testete bis s20.wp.com , nicht sicher, wie hoch sie gehen.

Auf diese Weise wissen Sie zumindest, dass einige Benutzer es bereits im Cache gespeichert haben.

Sie könnten auch die WordPress.org svn oder eine beliebige Anzahl anderer Orte benutzen, die WordPress CSS bedienen, ich dachte gerade, dass WordPress.com-Blogs populär sind und eher im Cache gespeichert werden.