Styling readme.html в плагине?

Я делаю файл readme.html для плагина с подробной инструкцией по установке, которая должна включать скриншоты.

В качестве остальной части пользовательского интерфейса я хочу, чтобы он соответствовал стилю WordPress, поэтому я посмотрел на свой собственный readme.html .

Он включает таблицу стилей с относительным путем:

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

Поэтому для файла плагина я могу использовать:

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

Но это хороший способ включить стиль? Есть много способов сделать это:

  • ссылка на install.css ;
  • пакетная копия install.css с плагином;
  • связать собственный файл CSS с плагином;
  • стиль в readme.html .

Я не знаю никаких рекомендаций по предоставлению документации HTML с помощью плагинов.

Если бы вы включили HTML-документацию с плагинами (или темами, что угодно)? Какой метод вы выбрали для его стилизации и в чем вы его рассуждали?

Solutions Collecting From Web of "Styling readme.html в плагине?"

Было бы лучше включить ваш собственный файл CSS так, как вы можете:

  • Используйте относительный путь к вашему CSS.
  • Избегайте проблем с получением пути к директории wp-admin . Не все люди помещают WordPress в корневую директорию, поэтому ваш пример выше будет ломаться для них.
  • Возможно избыточность путем повторного использования CSS на ваших страницах HTML и admin для вашего плагина.

Я предлагаю вам взглянуть на плагин Justin Tadlock's Get the Image . Он включает readme.html, readme.txt и readme.css.

Что касается пути к вашему файлу css, то то, что вы разместили, не имеет смысла (я не думаю). Я бы предложил что-то вроде

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

и просто поместите readme.css в тот же каталог, что и ваш файл readme.html.

Я не могу понять, почему вы собираете таблицу стилей вместе с readme, она просматривается независимо от чего-либо еще, поэтому почему бы просто не поместить тот же CSS в файл HTML (так как вам все равно придется его поддерживать).

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

Использование встроенных стилей:

Pros

  • Еще один запрос HTTP
  • Нет дополнительных файлов для управления
  • Не нужно беспокоиться о каких-либо проблемах с дорогой

Cons

  • Нет прилагаемой таблицы стилей (вам нужно будет поддерживать встроенный CSS с WP install.css)
  • Все стили необходимо будет управлять (и поддерживать) внутри документа readme * ¹

* ¹ – Не очень большое дело, CSS будет правильным в верхней части файла.


То, что я на самом деле делаю, это просто использовать внешний источник, который будет обновлять встроенный WordPress, и вы избежите любых проблем с переходом (поскольку внешний путь всегда должен быть действительным).

Может быть, использовать WordPress.com в качестве источника?

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

Где% NUM% будет числовым значением (например, 1 или 5 и т. Д.), Чтобы представить, с какого сервера вы хотите извлечь CSS. Я тестировал upto s20.wp.com , не уверен, насколько они высоки.

Таким образом, вы, по крайней мере, знаете, что некоторые пользователи уже будут кэшировать его.

Вы также можете использовать WordPress.org svn или любое количество других мест, которые обслуживают WordPress CSS, я просто понял, что блоги WordPress.com популярны и, скорее всего, будут кэшироваться.