エントリー書き出しプラグイン
このプラグインについて
エントリーのデータをHTMLファイルに書き出します。
広告
ダウンロード
以下のリンクからプラグインをダウンロードできます。(GitHubに遷移します。)
GitHubの緑ボタン「Code」内にある「Download ZIP」からすべてのプラグインをダウンロードできるので、解凍後に作成されるフォルダの中から entry_output
フォルダを入手してください。
導入方法
準備
あらかじめ管理者ページにログインしておきます。
ファイルのアップロード
entry_output/
内の configs/
と files/
と libs/
と templates/
を、freo設置ディレクトリ内にアスキーモードで上書きアップロードします。
パーミッションの設定
ブラウザソフトで freo/index.php/setup
にアクセスすると、必要なパーミッションが自動設定されます。
ただし、設置時に「ご利用のサーバーは、PHPから直接パーミッションを設定することができない環境のようです。」と表示された環境の場合は自動設定されないので、FTPソフトで以下のファイルのパーミッションを設定してください。
対象 | パーミッション |
---|---|
configs/plugins/entry_output.ini |
606 に設定 |
files/plugins/entry_output.html |
606 に設定 |
完了
管理画面からエントリーを登録し、エラーが表示されなければ完了です。エントリーは files/plugins/entry_output.html
に書き出されます。
管理者ページにログイン後、管理メニューから「システム」→「設定管理」→「プラグインの設定」→「エントリー書き出し」を選択すると、各種設定を行えます。
書き出した内容をJavaScriptで任意のページに表示
書き出したHTMLファイルの内容を、JavaScriptで任意のページに表示することができます。
一例ですが、jQueryを利用すれば
$(document).ready(function() {
$('div#entry').load('./~entry_output.htmlへのパス~/entry_output.html');
});
このようなコードを書けば、同じページの
<div id="entry"></div>
この部分に表示することができます。具体的には以下のようなコードでHTMLファイルの内容を表示できます。JavaScriptやjQueryの文法については、別途解説書などを参考にしてください。
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<script type="text/javascript" src="../js/jquery.js"></script>
<script type="text/javascript">
$(document).ready(function() {
$('div#entry').load('./~entry_output.htmlへのパス~/entry_output.html');
});
</script>
<title>テスト</title>
</head>
<body>
<h1>テスト</h1>
<p>↓ここにテキストが読み込まれます↓</p>
<div id="entry">JavaScriptをONにすると、エントリーが読み込まれます。</div>
<p>↑ここにテキストが読み込まれます↑</p>
</body>
</html>
書き出した内容をPHPで任意のページに表示
書き出したHTMLファイルの内容を、PHPで任意のページに表示することができます。
一例ですが
<?php echo file_get_contents('./~entry_output.htmlへのパス~/entry_output.html') ?>
このようなコードを書けば、その場所に entry.html
の内容を表示することができます。具体的には以下のようなコードでHTMLファイルの内容を表示できます。
<?php echo '<?xml version="1.0" encoding="utf-8"?>' . "\n" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>テスト</title>
</head>
<body>
<h1>テスト</h1>
<p>↓ここにテキストが読み込まれます↓</p>
<?php echo file_get_contents('./~entry_output.htmlへのパス~/entry_output.html') ?>
<p>↑ここにテキストが読み込まれます↑</p>
</body>
</html>
以下はPHPファイルを作成する際の注意点です。
- PHPプログラムの拡張子は、大抵の場合は
php
です。なので、info.php
のようなファイル名にする必要があります。 - 大抵の環境では、PHPファイル内に
<?xml version="1.0" encoding="utf-8"?>
というXML宣言があるとエラーになります。これは、上のサンプルコードのように<?php echo '<?xml version="1.0" encoding="utf-8"?>' . "\n" ?>
と書けば回避できます。
機能解説
目次
書き出し先の変更
管理メニューから「システム」→「設定管理」→「プラグインの設定」→「エントリー書き出し」を選択すると各種設定を行えますが、「書き出し先」でファイルの書き出し先を変更することができます。
例えば entry.html
と設定すると、index.php
と同じ場所の entry.html
というファイルに書き出されるようになります。この場合、entry.html
はあらかじめ作成してパーミッションを 606
に設定しておいてください。
書き出し内容の絞り込み
管理メニューから「システム」→「設定管理」→「プラグインの設定」→「エントリー書き出し」を選択すると各種設定を行えますが、「書き出し先」のファイル名の直後に、半角コンマに続けて条件を指定することができます。これにより、特定のカテゴリのエントリーのみを書き出したりすることができます。
files/plugins/entry_output.html
- 普通に一覧表示します。
files/plugins/entry_output.html,category=カテゴリーID
- カテゴリーIDで絞り込みます。(例:
files/plugins/entry_output.html,category=diary
) files/plugins/entry_output.html,word=検索キーワード
- 検索キーワードで絞り込みます。(例:
files/plugins/entry_output.html,word=テスト
) files/plugins/entry_output.html,user=ユーザー名
- ユーザー名で絞り込みます。(例:
files/plugins/entry_output.html,user=freo
) files/plugins/entry_output.html,tag=タグ
- タグで絞り込みます。(例:
files/plugins/entry_output.html,tag=テスト
) files/plugins/entry_output.html,date=日付
- 日付で絞り込みます。(例:
files/plugins/entry_output.html,date=2010
、files/plugins/entry_output.html,date=201004
、files/plugins/entry_output.html,date=20100401
)
また、条件は &
で区切って複数指定できます。例えば
files/plugins/entry_output.html,category=diary&tag=テスト
このようにすると、カテゴリーIDとタグの両方で絞り込むことができます。
複数ファイルの書き出し
管理メニューから「システム」→「設定管理」→「プラグインの設定」→「エントリー書き出し」を選択すると各種設定を行えますが、「書き出し先」のファイル名を改行区切りで複数指定することができます。例えば
files/plugins/entry_output1.html
files/plugins/entry_output2.html,category=diary
files/plugins/entry_output3.html,category=diary&tag=プログラム
このようにすると、files/plugins/entry_output1.html
と files/plugins/entry_output2.html
と files/plugins/entry_output3.html
のそれぞれに書き出すことができます。書き出し先のファイルはあらかじめサーバー上に作成し、パーミッションを 606
に設定しておいてください。
なお、jQueryを利用する場合は以下のようなコードで複数のファイルを表示することができます。
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="ja" lang="ja" dir="ltr">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<script type="text/javascript" src="../js/jquery.js"></script>
<script type="text/javascript">
$(document).ready(function() {
$('div#entry1').load('./~entry_output1.htmlへのパス~/entry_output1.html');
$('div#entry2').load('./~entry_output2.htmlへのパス~/entry_output2.html');
$('div#entry3').load('./~entry_output3.htmlへのパス~/entry_output3.html');
});
</script>
<title>テスト</title>
</head>
<body>
<h1>テスト</h1>
<p>↓ここに entry_output1.html が読み込まれます↓</p>
<div id="entry1">JavaScriptをONにすると、エントリーが読み込まれます。</div>
<p>↑ここに entry_output1.html が読み込まれます↑</p>
<p>↓ここに entry_output2.html が読み込まれます↓</p>
<div id="entry2">JavaScriptをONにすると、エントリーが読み込まれます。</div>
<p>↑ここに entry_output2.html が読み込まれます↑</p>
<p>↓ここに entry_output3.html が読み込まれます↓</p>
<div id="entry3">JavaScriptをONにすると、エントリーが読み込まれます。</div>
<p>↑ここに entry_output3.html が読み込まれます↑</p>
</body>
</html>
削除方法
このプラグインは、以下の手順で削除できます。
ファイルの編集
entry_output.html
を読み込むコードを追加したファイルから、コードを削除します。
ファイルの削除
以下のファイルを削除します。
configs/plugins/entry_output.ini
files/plugins/entry_output.html
libs/freo/plugins/config.entry_output.php
libs/freo/plugins/end.entry_output.php
templates/plugins/entry_output/
(ディレクトリごと削除)
更新履歴
- 最新版との差分ファイルを一覧表示できます。
- 使用しているエントリー書き出しプラグインのバージョンを入力してください。
- 更新内容の詳細は、以下の更新履歴を確認してください。
- 2013/01/03 Ver 1.3.0
-
- freo Ver 1.15.0 に合わせて、閲覧制限対象の記事を記事一覧に表示するか否かの選択が反映されるように調整。
バージョンアップは、以下のファイルを最新版付属のものに差し替えてください。
- 2012/11/06 Ver 1.2.1
-
- データの書き出し先の初期値を変更。
バージョンアップは、以下のファイルを最新版付属のものに差し替えてください。
書き出し先の初期値を変更したのみなので、バージョンアップしなくても動作に支障はありません。
- 2012/07/23 Ver 1.2.0
-
- freo Ver 1.9.0 に合わせて、オプションを表示するか否かの選択が反映されるように調整。
バージョンアップは、以下のファイルを最新版付属のものに差し替えてください。
- 2011/01/28 Ver 1.1.1
-
- 認証が必要な記事でも、オプション項目以外の情報は参照できるように調整。
バージョンアップは、以下のファイルを最新版付属のものに差し替えてください。
- 2010/10/20 Ver 1.1.0
-
バージョンアップは、以下のファイルを最新版付属のものに差し替えてください。
- 2010/10/08 Ver 1.0.1
-
- SQLite2使用時、エントリーを分類で検索できない不具合を修正。
バージョンアップは、以下のファイルを最新版付属のものに差し替えてください。
- 2010/09/01 Ver 1.0.0
-
正式版を公開しました。最終ベータ版から大きな変更はありませんが、プログラム内部のバージョン情報と更新日はすべて変更しています。ですので今後混乱の無いように、拡張子が
php
のファイルはすべて正式版付属のものに変更することをお勧めします。