web-dev-qa-db-ja.com

プラグインでreadme.htmlをスタイリングする？

私はスクリーンショットを含める必要があるいくつかの詳細なセットアップ手順とプラグインのためのreadme.htmlファイルを作っています。

UIの残りの部分として、私はそれが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ドキュメントをプラグイン（またはテーマなど）に含めましたか？あなたはそれをスタイルするためにどんな方法を選びましたか、そしてあなたはそれを推論していましたか？

pluginscssdocumentationreadme
2
Rarst

次のような方法で独自のCSSファイルを含めることをお勧めします。

  • CSSへの相対パスを使用してください。
  • wp-adminディレクトリへのパスを正しく取得する際の問題を回避します。すべての人がWordPressをルートディレクトリに置くわけではないので、上記の例ではうまくいきません。
  • あなたのプラグインのためにあなたのHTMLと管理者ページのCSSを再利用することによっておそらく冗長性。
1
Manzabar

Justin Tadlockの Get the Imageプラグイン をご覧ください。彼にはreadme.html、readme.txt、およびreadme.cssが含まれています。

あなたのcssファイルへのパスに関して、あなたが投稿したものは意味がありません（私は考えていません）。私は何かを提案したい

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

そしてreadme.cssをあなたのreadme.htmlファイルと同じディレクトリに置くだけです。

1
Travis Northcutt

なぜあなたはスタイルシートをreadmeと一緒にバンドルしなければならないのでしょうか、それは他のものからは独立して見られるので、なぜ同じHTMLをHTMLファイルに入れてはいけないのですか。

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

インラインスタイルを使う：

長所

  • 1つ少ないHTTPリクエスト
  • 管理する追加のファイルはありません
  • パスの問題を心配する必要はありません

短所

  • スタイルシートは含まれていません（WP install.cssを使用してCSSをインラインで維持する必要があります）。
  • すべてのスタイル設定はreadmeドキュメント内で管理（および維持）する必要があります*¹

*¹ - 大したことはありませんが、CSSはファイルの先頭近くに表示されます。

私が実際にやるべきことはただWordPressとインラインで更新される外部のソースを使うことです、そしてあなたはどんなパスの問題も避けるでしょう（外部のパスは常に有効であるべきですから）。

たぶんソースとしてWordPress.comを使っていますか？

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

ここで、％NUM％は、どのサーバーからCSSを取得したいかを表す数値（1または5など）です。私はs20.wp.comまでテストしましたが、それらがどれほど高くなるかはわかりません。

そうすれば、少なくとも少数のusersがすでにキャッシュしていることになるでしょう。

また、 WordPress.org svn やその他のWordPress CSSを提供する場所を使用することもできます。私はWordPress.comのブログが人気であることを考え出しました。キャッシュされる可能性があります。

1
t31os