rNote では最初から RSS のフォードの生成機能が備わっている。そのバージョンは RSS1.0 だ。

これまでは特に問題を感じていなかったのだが、 KDE のフィードリーダ Akregator に当サイトのフィードを追加してみたところ、記事一覧の作者の表示がされなかった。

各記事に dc:creator を追加してみるなどいろいろやってみたのだがだめだったので、多分 RSS2.0 形式なら作者も表示されるだろうと推測し、 rNote に RSS2.0 のフィード生成機能を追加した。

プラグインとして実装できるかな、と思ったのだが、 RSS の生成時に RSS 用のスキンが使用され、 RSS 用スキンのための置換文字列の処理が rNote 本体に実装されているので、この部分をプラグイン化して外部に出さない限り無理だと分かった。なので、とりあえず rNote 本体に処理を追加する形で実現した。

追加したファイル:

rss2_body.skin, rss2_item.skin

修正したファイル:

rnote_config.php( FNAME_RSS2, MAX_DESCRIPTION_RSS2, FNAME_SKIN_RSS2 の3つの定数を追加した。)

rnote.php( CreateRSS2() を追加し、AdminMode() 内で CreateRSS() に続き CreateRSS2() を呼ぶようにした。 CreateHTML() 内に、スキン用のタグとして rss2_url を置換する処理を追加した。)

html_side.skin( RSS2 のフィードへのリンクを追加した。)

RSS2.0 の記述の仕方やフィードのファイル名の付け方については、「RSSのフォーマット・仕様・構造 - RSS1.0、RSS2.0、Content-Type」や「横着者のRSS 2.0 配信ページの作成方法」が参考になった。

試したところ、 Akregaror で問題なく作者が表示されるようになった。

この記事のリンク元 | 9 | 8 | 1 |

この記事のリンク用URL&トラックバックURL : https://red-souls.jp/ichounoki/rnote/works/software/20190818_160607538729.htm

キーワード: RSS2.0 rNote


管理画面の「動作設定」

管理画面の「動作設定」各項目について説明します。

キャッシュ関係の設定

  • If-Modified-Sinceに応答…ブラウザやプロキシのキャッシュ制御を行うかどうかの設定です。
  • ページキャッシュを生成…ページの生成結果をページキャッシュとしてサーバーに保存するかどうかの設定です。
  • キャッシュするページ数…ページキャッシュを生成する場合に、保存するページの最大数を設定します。

rNote-re での If-Modified-Since について

If-Modified-Since は、ブラウザからサーバに送るリクエストヘッダに付記される項目です。ブラウザのキャッシュが作られた日時を送信します。

この項目が設定されていた場合、サーバは、送られてきた日時以降にページの内容が更新されていた場合のみ、新しいページを送信します。(200を送信)

rNote-re では、更新されたページの内容が既にサーバにキャッシュとして存在している場合は、そのキャッシュを送ります。まだキャッシュが作られていない場合は新たにキャッシュを作りページを送信します。

送られてきた日時以降にページの内容が変わっていなかった場合は、新しいページは送信しません。(304を送信)

rNote-re では、この仕組みを使用することで、不要な場合はキャッシュの生成やデータの送信を省略することができ、サーバからの応答性を向上することができます。

その他の設定

  • 最近のコメント等のログ保存数…最近のコメント等のログの保存数の最大値を設定します。
  • 携帯用ページをテスト…現在使用しているブラウザでサイトにアクセスした時に、携帯用のページを表示することで、携帯用ページの表示テストを行うことができます。
  • コメントを承認制にする…コメントが送信された時に管理者の承認を待つか、承認を待たず即時公開するかの設定です。

設定状態の保存方法

「携帯用ページをテスト」の設定状態は、使用中のブラウザの動作を変更させるために cookie に保存されます。その他の設定状態は SITE_TOP/cache/config.ini に保存されます。


rNote-re のインストール

設定ファイルを編集し設定する

テキストディタで rnote_config.php を開き、下の項目を設定します。

  • SITE_TITLE…サイトのタイトルです。
  • SITE_AUTHOR…サイトのオーナーの名前です。
  • SITE_URL…サイトのURLです。
  • ADMIN_ID…管理者のIDです。
  • ADMIN_PASSWORD…管理者のパスワードです。
  • USE_MOD_REWRITE… apache の mod_rewrite を使用し rnote.php を隠蔽する場合は true にします。
  • EVAL_ENABLE…スキン内で php スプリクトを実行する場合は true にします。
  • DATETIME_FORMAT…日付時刻表示のフォーマットです。
  • $dir_access_enable[]…外部から書き込みを許可するディレクトリをこの配列の要素にに指定します。
  • $nodisp_at_toplv[]…トップレベルには表示したくないカテゴリのカテゴリキーをこの配列の要素に指定します。
  • $category_name[]…カテゴリキー・カテゴリ名の連想配列です。 $category_name['key']='name'; のように指定します。
  • $category_key[]…カテゴリキーの配列です。
  • $XR_USER… XML-RPC クライアントからログインできるユーザを指定します。 renote_config.php のサンプルを参考に指定してください。
  • XR_FTP_HOST… XML-RPC API でサーバ上のディレクトリ・ファイルを操作する際に FTP のアカウントで行う必要がある場合に設定します。
  • XR_FTP_USER… XML-RPC API でサーバ上のディレクトリ・ファイルを操作する際に FTP のアカウントで行う必要がある場合に設定します。
  • XR_FTP_PW… XML-RPC API でサーバ上のディレクトリ・ファイルを操作する際に FTP のアカウントで行う必要がある場合に設定します。
  • XR_FTP_ROOT_DIR… XML-RPC API でサーバ上のディレクトリ・ファイルを操作する際に FTP のアカウントで行う必要がある場合に設定します。
  • XR_FTP_DIR… XML-RPC API でサーバ上のディレクトリ・ファイルを操作する際に FTP のアカウントで行う必要がある場合に設定します。
  • XR_FTP_DUMMY_DIR… XML-RPC API でサーバ上のディレクトリ・ファイルを操作する際に FTP のアカウントで行う必要がある場合に設定します。

ディレクトリとファイルの配置

下のとおりにディレクトリ、ファイルを用意します。( SITE_HOME を rNote-re のトップディレクトリとします。)

ディレクトリ:

  • SITE_HOME/entries/ この下にディレクトリをきってカテゴリを表現し、記事を投稿します。スキン、コメントやトラックバック等のログもここです。
  • SITE_HOME/plugins/ プラグインのファイルはこのディレクトリの中に用意します。
  • SITE_HOME/rnoteadmin/ 管理者画面用のディレクトリです。
  • SITE_HOME/style/ style-sites.css など、サイトのデザインに関わるファイルが置かれるディレクトリです。
  • SITE_HOME/cache/ サイトのキャッシュが生成されるディレクトリです。

ファイル:

  • SITE_HOME/rnote.php ブログのプログラム本体です。
  • SITE_HOME/rnoteadmin.php 管理者画面用ツールです。
  • SITE_HOME/rnote_config.php rnote.php などから参照される初期設定ファイルです。
  • SITE_HOME/rn_xmlrpc.php XML-RPC クライアントから利用するファイルです。
  • SITE_HOME/rss.rdf RSSファイルです。(自動生成されます。)
  • SITE_HOME/rnoteadmin/config.php 管理画面の「動作設定」プラグインです。
  • SITE_HOME/rnoteadmin/rnotepad.php 管理画面の「エディタ」プラグインです。
  • SITE_HOME/rnoteadmin/wb_log.php 管理画面の「ログ表示」プラグインです。
  • SITE_HOME/rnoteadmin/tb_tool.php 管理画面の「トラバ」プラグインです。
  • SITE_HOME/rnoteadmin/entries_list.php 管理画面の「エントリ一覧」プラグインです。
  • SITE_HOME/rnoteadmin/cmntcnfm.php 管理画面の「コメント承認」プラグインです。
  • SITE_HOME/rnoteadmin/access_log.php 管理画面の「アクセスログ」プラグインです。

パーミッションの設定

  • entries/ と、その中の全ディレクトリ…(0777)
  • cache/ ディレクトリ…(0777)
  • rss.rdf…(0666)
  • rnote.php… CGI版PHP で動作させる場合実行権限をつけておく。
  • rnoteadmin.php… CGI版PHP で動作させる場合実行権限をつけておく。

初回起動時の操作

ディレクトリの作成、ファイルのアップロード、パーミッションの設定が済んだら、まず最初に再構築を行います。

ブラウザで、管理者ツール(rnoteadmin.php)を実行し、管理画面を表示してください。初回なので、管理者ツールにログインする際に、IDとパスワードを入力する必要があります。 rnote_config.php に設定した管理者IDとパスワードを入力してください。

無事起動したら、「再構築」ボタンを押します。特にワーニングなどが出ず、「キャッシュファイルの再構築とRSS生成を終了しました。」と表示されれば、インストールは無事完了です。「サイト表示」ボタンを押し、ブログが表示されることを確認してください。

初回起動後も、新規記事の追加、カテゴリ追加削除、スキンの変更等々、何か変更を加えたら必ず再構築を行ってください。これを行わないと、ブログを表示したときに変更した内容が反映されません。(再構築は管理者ツールからだけでなく、ブラウザから rnote.php?mode=admin と指定してサイトを表示しても行うことが出来ます。)

バックアップ

サーバーのトラブルに備えたバックアップの方法は、entries/ ディレクトリ以下を丸ごと保存しておくとよいでしょう。( SITE_HOME/cache/ ディレクトリの中身はバックアップする必要はありません。レストアしたときに改めて再構築すればOKです。)

バックアップしてあったファイルをサーバに戻したときは、記事のログファイル( xxx.log と xxx_ref.log)のパーミッションを (0666) にして書き込み権限を加えておいてください。忘れると当該記事にコメントや追記が出来ません。


rNote-re について

rNote-re は、 Woody-Rinn さん作 rNote を冬星がいろいろといじったものです。

主な特徴:

  • PHP のカレントバージョンである PHP8, PHP7 で動作するように修正(残念ながら rNote は PHP7 以上では動作しないのです。)。
  • オンラインでの記事書き込みツールを管理画面に用意。(とみらさんの rnotepad.php の修正版。)
  • XML-RPC を用いた記事の投稿が可能。画像ファイルを挿入した記事の投稿も可能。( Open Live Writer で動作確認済み。)対応 API は MovableType, Blogger, MetaWeblog 。
  • プラグインの種別を拡張し、 rNote 標準の「ナビゲーションツール系プラグイン」( body スキンで使用)、「管理画面プラグイン」( rnoteadmin.php から呼び出される)に加え、「コールバックプラグイン」を追加。
  • 投稿されたコメントを管理画面で承認して初めて公開されるように「コメントの承認制」を導入。

rNote-re は公開する予定は今のところありません。 rNote-re に関するページは、あくまで冬星が自分で確認・参照するために作成しています。


以前、「ブログにタグクラウドを追加してみた」に書いたとおり、 rNote にタグクラウドの処理を追加したが、そのときは、 rnote.php 本体に実装して実現した。

最近、コールバックプラグインの処理を実装したので、これを使ってタグクラウドの処理もプラグイン化することにした。

rnote.php の CreateHTML() が呼ばれるタイミングで起動されるコールバックプラグインを追加し、これを "createhtml" タイプとして追加した。

このコールバックプラグインが呼ばれると、グローバル変数 $g_keyslist を、タグと参照回数の連想配列として初期化する。

一方で、スキンから呼び出される(コールバックではない)プラグインが、 $g_keyslist の内容をもとにタグクラウドを生成し出力するようにした。

今回ちょっと面白いのは、上記2つのプラグイン(コールバックプラグインとコールバックではないプラグイン)を、1つのクラスとして実装し、1つの .php ファイルの中に記述したことだ。

つまり、1つのクラスで2つの種類のプラグインを表現している。こういうこともできるのだと我ながら感心した。

この記事のリンク元 | 9 | 8 |

この記事のリンク用URL&トラックバックURL : https://red-souls.jp/ichounoki/rnote/works/software/20190815_210316931286.htm