web-dev-qa-db-fra.com

Styling readme.html dans le plugin?

Je crée un fichier readme.html pour un plug-in avec des instructions de configuration détaillées qui doivent inclure des captures d'écran.

En tant que reste de l'interface utilisateur, je veux que ce soit cohérent avec le style WordPress et j'ai donc examiné son propre readme.html.

Il comprend une feuille de style avec un chemin relatif:

<link rel="stylesheet" href="wp-admin/css/install.css?ver=20100228" type="text/css" />

Donc, pour un fichier de plugin, je pourrais aller avec:

<link rel="stylesheet" href="/wp-admin/css/install.css" type="text/css" />

Mais c’est un bon moyen d’inclure le style? Il y a vraiment beaucoup de façons de le faire:

  • lien vers install.css;
  • copie groupée de install.css avec plugin;
  • regrouper son propre fichier CSS avec le plugin;
  • style intégré dans readme.html.

Je ne suis au courant d'aucune recommandation concernant la fourniture de documentation HTML avec des plugins.

Aviez-vous inclus la documentation HTML avec des plugins (ou des thèmes, peu importe)? Quelle méthode aviez-vous choisie pour le nommer et quel raisonnement suiviez-vous?

pluginscssdocumentationreadme
2
Rarst

Il serait préférable d’inclure votre propre fichier CSS pour pouvoir:

  • Utilisez un chemin relatif à votre CSS.
  • Évitez les problèmes pour obtenir le chemin d'accès direct au répertoire wp-admin. Tous les utilisateurs ne mettent pas WordPress dans le répertoire racine. Votre exemple ci-dessus se briserait pour eux.
  • Peut-être une redondance en réutilisant le CSS dans vos pages HTML et d'administration pour votre plugin.
1
Manzabar

Je vous suggère de jeter un coup d'œil à celui de Justin Tadlock Téléchargez le plugin Image . Il inclut les fichiers readme.html, readme.txt et readme.css.

En ce qui concerne le chemin d'accès à votre fichier CSS, ce que vous avez publié n'aurait aucun sens (je ne pense pas). Je suggère quelque chose comme

<link rel="stylesheet" href="readme.css" type="text/css />

et placez simplement readme.css dans le même répertoire que votre fichier readme.html.

1
Travis Northcutt

Je ne vois pas pourquoi vous associeriez une feuille de style à un fichier Lisez-moi, elle est considérée indépendamment de toute autre chose, alors pourquoi ne pas simplement mettre le même CSS dans le fichier HTML (étant donné que vous devrez le conserver de toute façon).

<style type="text/css">
/* 
.example { }
*/
</style>

Utilisation de styles en ligne:

Avantages

  • Une demande HTTP de moins
  • Aucun fichier supplémentaire à gérer
  • Pas besoin de s'inquiéter des problèmes de chemin

Les inconvénients

  • Aucune feuille de style incluse (vous devrez maintenir votre CSS en ligne avec le WP install.css)
  • Tout le style devra être géré (et maintenu) dans le document readme * ¹

* ¹ - Pas vraiment grave, le code CSS sera tout près du haut du fichier.

Ce que j’aimerais faire, c’est utiliser une source externe, qui se mettra à jour en ligne avec WordPress, et vous éviterez les problèmes de cheminement (car le chemin externe doit toujours être valide).

Peut-être utiliser WordPress.com comme source?

<link rel="stylesheet" type="text/css" href="http://s%NUM%.wp.com/wp-admin/css/install.css" />

Où% NUM% serait une valeur numérique (par exemple, 1 ou 5, etc.) pour représenter le serveur à partir duquel vous voulez extraire le CSS. J'ai testé jusqu'à s20.wp.com, pas sûr à quelle hauteur ils vont.

Ainsi, vous saurez au moins que quelques utilisateurs l'auront déjà mis en cache.

Vous pouvez également utiliser le WordPress.org svn ou un nombre quelconque d’autres lieux qui servent WordPress CSS, j’ai juste pensé que les blogs WordPress.com sont populaires et plus susceptible d'être mis en cache.

1
t31os