ニュースプラグイン

hiki_news

ニュースプラグインはHiki上でニュースページの生成・表示を簡単に行うようにするプラグインです。 元々はRuby-GNOME2 Project Website用に作ったのでニュースプラグインと名付けましたが、ページ生成部分を(Rubyを知っていれば)簡単に変更することができますので、その辺をうまくカスタマイズすれば簡単なblogや日記機能として使うことができると思います。

なお、このプラグインは2007-08-12にkskeilさんにメンテナンスを引き継いでいただきました。最新の情報はこちらを参照してください。

(このページのプラグインではHiki-0.8.5以降で動作しません。)

ソース

news.rb - newsプラグイン本体

news_wikistyle.rb - Wikiスタイル(デフォルトのスタイル)を使う場合はnews.rbプラグインと一緒にpluginディレクトリに置いてください。

news_en.rb - 英語用リソースファイル。必要な場合はplugin/en/配下に置いてください。

利用方法

登録用入力ページを作る

まずは、登録用入力ページを作ります。ページID等は適当なモノで良いです。 で、そのページ内に以下の一行を書きます。

{{news_entry_box}}

ニュースを生成するときには上記ページを使ってください。 なお、news_entry_boxの仕様は以下の通りです。列と行の数を指定できますのでお好みでどうぞ。

news_entry_box(cols = 70, rows = 10)
列と行を指定してニュース登録用ページを生成する。
  • cols: 列数
  • rows: 行数

実際にページを作成する際は以下のようにしてください。

  • 通常のページのようにWikiスタイルであればWikiスタイルを、RD+スタイルであればRD+スタイルで記述できます
  • 最初の空行以前がヘッドラインとして後述するnewsプラグインで表示されます。
  • 各ページは1つずつ別ページになります。一度登録した情報を修正したい場合はそれぞれのページを他の普通のページのように編集してください。

表示用のページを作る

newsのヘッドライン一覧を登録された日時の降順で表示します。 新規でニュース用のページを作るか、あるいはお好みの場所に以下の一行を書きます。

{{news}}

デフォルトで20件表示されます。

newsの仕様は以下の通りです。

news(n = 10, depth = 0)
newsの一覧を登録された日時の降順で表示する。
  • n: 表示する最大数。
  • depth: 見出し部分の深さ。表示する場所によって変更した方が良い場合があるかも。

カスタマイズ

Newsプラグインは表示内容を自分の好みに書き換えることができます。若干Rubyの知識が必要ですが、これをマスターすればHiki上で書く日記などにも応用できるでしょう。

news_read_more(name)
「もっと読む」の表示箇所を返すようにします。
  • name: ページ名
def news_read_more(name)
  "\n\n[[もっと読む|#{name}]]\n\n"
end
news_title(date, num)
ニュースのタイトル部分に表示する箇所を返すようにします。
  • date: そのニュースの日付(Date型)
  • num: その日付の何番目のニュースか
def news_title(date, num)
  date.strftime("News (%Y-%m-%d No.#{num})")
end
news_content(subject, name, date, msg)
ニュースの内容を返すようにします。
  • subject: タイトル
  • name: ページ名
  • date: そのニュースの日付
  • msg: ニュースの本文
news_a_news(news, name, lines, depth = 0)
ニュースの一覧表示で表示する1件の内容を返すようにします。 ちょっと複雑ですので詳細は略します。ソースコードを直接参照してください。すでにあるものをちょこちょこいじるだけで好みの表示を作ることができると思います。

その他

ニュースがrecentプラグインで表示されるとちょっとかっこわるいので、その場合はrecent_omittableプラグインを使ってください。

 ライセンスについて

Copyright (C) 2003 Masao Mutoh <mutoh@highwhay.ne.jp>

本ソフトウェアはGNU General Public License Version 2(GNU一般公有使用許諾書バージョン2)に基づいてリリースされるフリーソフトウェアです。 また、本プログラムは無保証です。本プログラムの利用により何らかのトラブルが生じても、当方は一切責任を負いません。

更新日時:2007/08/12 21:06:17
キーワード:
参照:[Hiki] [recentプラグイン(omittable)] [News (2003-10-25 No.1)]