add readme

Author: pitolick

README.md

@@ -1 +1,64 @@
-# JavaScript-Content-Message
+# JavaScript-Content-Message
+投稿・固定ページの投稿日もしくは最終更新日が一定期間過ぎている場合、メッセージを表示させます。
+
+# 特徴
+Shifterのようなサーバレス環境での動作を想定しているためJavaScriptを使用してメッセージの表示を制御しています。
+
+# インストール
+zipでこのプラグインをダウンロードし、WordPressの管理画面にアップロードしてください。
+
+# 使い方
+プラグインを有効にすると、`設定 > 投稿設定` 内に `JavaScript-Content-Message` というセクションが追加されます。
+
+## 適用ページ
+メッセージを表示させる投稿タイプを選択します。  
+選択された投稿タイプをもつページが表示されているとき、 `the_content()` の一番最初にメッセージ表示に必要なDOMが挿入されます。
+
+| 選択項目 | 投稿タイプ | 表示条件 |
+----|----|----
+| 投稿 | `post` | `is_single()` |
+| 固定ページ | `page` | `is_page()` |
+
+デフォルトでは投稿・固定ページ両方に出力されます。
+
+## 比較基準日
+### 基準日の設定
+表示されている記事の投稿日もしくは最終更新日のどちらを基準日にするかを設定します。
+
+| 選択項目 | 日付取得関数 |
+----|----
+| 投稿日 | `get_the_date('Y/m/d')` |
+| 最終更新日 | `get_the_modified_date('Y/m/d')` |
+
+デフォルトでは投稿日が基準日として設定されます。
+
+### 基準日からの経過時間の設定
+基準日からどれだけ経過した場合にメッセージを表示するか設定します。  
+デフォルトでは1年以上経過した場合にメッセージを表示します。
+
+## 表示メッセージ
+表示させたいメッセージを設定します。  
+HTMLを使用した場合、そのまま出力されるように構築されているため、自由なDOM構造を作成することができます。  
+また、以下の特殊文字をメッセージ中に埋め込むことで正規表現を使用し、対応した文字に置換を行います。
+
+| 特殊文字 | 説明 |
+----|----
+| `%year%` | 基準日と現在の年差 |
+| `%monthnum%` | 基準日と現在の月差（1ヶ月あたり30日で計算のため多少ブレあり） |
+| `%day%` | 基準日と現在の日差 |
+
+## CSS設定
+表示されるメッセージに適用するCSSを設定します。  
+`オリジナルCSSを使う` を選択すると、CSSを記述するためのフィールドが表示されます。  
+表示されるメッセージは `表示メッセージ` で設定する内容とは関係なく `<div id="jcm_content_message">` にラップされた状態のDOMを出力するので、 `#jcm_content_message` をセレクタとすることでCSSを適用することができます。  
+オリジナルCSSを記述したあとで `プラグイン付属のCSSを使う` を選択しても記述された内容は保存されています。
+
+# 依存関係
+JavaScriptを使用して記述しているため、jQueryが無い環境でも動作します。  
+閲覧に使用するブラウザがJavaScriptをサポートしていれば動作します。
+
+# 注意
+- サーバーレス環境での動作を想定してJavaScriptで構築されているため、読み込み時に一瞬チラついて見えることがあります。
+- カスタム投稿への対応はしていません。
+- `the_content()` にフックする以外の出力方法は備えていません。
+- 特殊文字の `%monthnum%` は比較した差分の日数を30日で割った結果を月として出力しているため、正確な月ではありません。

index.php

@@ -51,7 +51,7 @@ function jcm_load_scripts() {
 function jcm_add_content($content) {
 	// 比較基準タイプ設定
 	if (get_option('jcm_option_reference') === 'modified_date') {
-		$content_time = get_the_modified_date('Y/m/d'); // 更新日
+		$content_time = get_the_modified_date('Y/m/d'); // 最終更新日
 	} else {
 		$content_time = get_the_date('Y/m/d'); // 投稿日
 	}
@@ -128,7 +128,7 @@ function jcm_option_reference() {
 	?>
 	<fieldset>
 		<label><input name="jcm_option_reference" type="radio" value="posted_date" <?php echo get_option( 'jcm_option_reference' ) === false ? 'checked="checked"' : checked( 'posted_date', get_option( 'jcm_option_reference' ) ); ?> />投稿日</label>
-		<label><input name="jcm_option_reference" type="radio" value="modified_date" <?php checked( 'modified_date', get_option( 'jcm_option_reference' ) ); ?> />更新日</label><br>
+		<label><input name="jcm_option_reference" type="radio" value="modified_date" <?php checked( 'modified_date', get_option( 'jcm_option_reference' ) ); ?> />最終更新日</label><br>
 		<input type="number" name="jcm_reference_date" min="0" max="9999" value="<?php echo get_option( 'jcm_reference_date' ) === false ? '1' : get_option( 'jcm_reference_date' ); ?>">
 		<select name="jcm_reference_type">
 			<option value="year" <?php echo get_option( 'jcm_reference_type' ) === false ? 'selected' : selected( 'year', get_option( 'jcm_reference_type' ) ); ?>>年</option>