tdiary-blogkit 5.0.1

data/README.en.md

@@ -0,0 +1,107 @@
+# tDiary BlogKit: How to run tDiary like blog. --
+
+## What's BlogKit?
+
+tDiary BlogKit modifies tDiary. This modification enables tDiary to manage articles by topics, not daily. tDiary with BlogKit is different from original one:
+
+ * Date has no meaning. It looks like 'serial number'.
+ * Each topic have last-modified.
+ * Top page has the 1st section of each topic(like summary).
+ * tDiary with BlogKit makes new topic number automatically when update.
+ * BlogKit adds new features: 'Recent Entries' and 'What's New'.
+
+You can setup BlogKit without changing tDiary. It is only plugged-in.
+
+## how to install
+
+First, you need tDiary that is installed. You must use tDiary version 2.1.3 or later. Here, it is assumed that you install tDiary under $INSTALL anew. 
+
+### Creating tdiary.conf
+
+Copy tdiary.conf.sample in BlogKit to $INSTALL/tdiary.conf. And, rewrite @data\_path in the tdiary.conf to your data saving directory. Read README of tDiary about @data_path. 
+
+### Copy blog_style.rb
+
+#### To use tDiary style
+
+Copy tdiary/blog_style.rb of BlogKit under $INSTALL/tdiary. You have to confirm there is "@style= 'Blog'" in your tdiary.conf.
+
+#### To use Wiki style
+
+If you want to write by Wiki style, install Wiki style of tDiary original and copy tdiary/blogwiki_style.rb into $INSTALL/tdiary. And specify "@style = 'BlogWiki'" in your tdiary.conf.
+
+#### To use RD style
+
+Also if you want to write by RD style, install RD style of tDiary original and copy tdiary/blogrd_style.rb into $INSTALL/tdiary. And specify "@style = 'BlogRD'" in your tdiary.conf.
+
+### Copy theme
+
+A sample theme for BlogKit available in tdiary-theme package named by "blog'. This is one kind of tDiary themes, but it has some settings to enable sidebar etc.
+
+### Copy Plugins
+
+After tDiary 2.0.1, you can select plugin in preference page. Add the path of BlogKit plugins into tdiary.conf:
+
+    @options['sp.path'] = ['misc/plugin', 'blogkit/plugin']
+
+This option can have some pathes of plugins, 1st path is tDiary plugin collection. 2nd path is BlogKit's. Modify path name with your environment.
+
+### and run tDiary as CGI
+
+When you want to add a new topic, click 'Update' link at the bottom of the page. If you want to edit existing page, open the topic and click 'Edit' link at the bottom of the page.
+
+## About Plugins
+
+See each plugin file if you want more information.
+
+### archive.rb
+
+#### archive plugin
+
+Shows all the topics in group sorted by topic number. By default, this plugin shows the topics in the sidebar.
+
+#### archive\_dropdown plugin
+
+Like archive plugin, this plugin shows all the topics in group. The topics are shown in dropdown list.
+
+### blog-style.rb
+
+Changes 'Diary like' labels to 'Blog like' and adjust title style. You should enable this plugin for using BlogKit.
+
+### lm.rb
+
+Shows last-modified in each topic. You can choose position of the last-modified, under topic title or bottom of article. You can use this plugin only by copying this plugin to plugin directory.
+
+### recent-entry.rb
+
+Shows the list of the recent topics. You have to choose this plugin or recent-entry2.
+
+### title-navi.rb
+
+Shows a topic title as navigation label. You can use this plugin only by copying this plugin to plugin directory.
+
+### whatsnew-list.rb
+
+Shows a list of updated topics like "What's new". This plugin cannot be used on secure mode. And it can generate RDF file when option setting in tdiary.conf.
+
+### blog-category.rb
+
+Add category feature.  A word surrounded by '[' and ']' is treated as a name of category.  By clicking this category name, you can move to the page which displays articles of the category. You should initialize the index of category in the config page of tDiary.
+
+#### blog\_category\_entry plugin
+
+Show the list of titles which can't be shown in the category specific page.
+
+#### blog\_category\_form plugin
+
+Shows all categories in dropdown list.  You can select a category to be shown.
+
+### title-link.rb
+
+Make whole title to link to Permalink.
+
+## License
+
+Copyright (C) by TADA Tadashi <sho@spc.gr.jp>.
+
+You can distribute or modify this under GPL.

data/README.md

@@ -0,0 +1,120 @@
+# tDiary BlogKit: tDiaryをblog風に運用する
+
+## はじめに
+
+tDiary BlogKitは、tDiaryをblogのように日単位でなく記事単位で管理するシステムに改造するキットです。BlogKitを全面的に適用したtDiaryは、日記システムとしてのtDiaryに対して、以下のような違いを持ちます。
+
+ * 日付が意味を持たなくなる(記事番号扱いになる)
+ * 記事に「最終更新時刻(Last-Modified)」が付くようになる
+ * 最新表示時には、記事の最初のセクションだけが表示される(似非サマリ)
+ * 「更新」を選ぶと、自動的に空いている記事番号を割り当ててくれる
+ * Recent EntoriesやWhat's Newで更新情報が公開される
+
+tDiary BlogKitは、tDiaryには影響を与えずに、すべてファイル追加のみで導入できます。
+
+## インストール
+
+すでにtDiaryはインストール済みだとします。tDiaryは2.1.3もしくはそれ以降のできるだけ新しいものを推奨します。すでに運用中の日記ではなく、新たにblog系サイトを作るという前提で説明します。すでに運用中の日記に適用する場合には、tdiary.confのマージ作業などが必要になります(ただし日記とは管理単位が異なるので、すでにある日記にBlogKitを適用するのはオススメできません)。
+### tdiary.confを作成
+
+付属のtdiary.conf.sample\_jaを、tDiaryのインストールディレクトリにtdiary.confとしてコピーします。そして、@data\_pathをデータの保存場所に書き換えます。詳しくはtDiaryのドキュメントを参照してください。付属のサンプルには、ヘッダやフッタなどにblog風のレイアウト指定が施されています。これらのカスタマイズは、運用開始後に設定画面から行ってください。
+
+tdiary.conf.sample_jaは日本語向けのサンプルです。英語向けにはtdiary.conf.sampleを使ってください。
+
+### スタイルをコピー
+
+tdiary/style/blog.rbを、tDiaryインストールディレクトリのtdiary/styleの下にコピーします。このファイルは、BlogKit向けのさまざまな機能拡張を含んでいるので、他のスタイルを使う場合にもかならずコピーする必要があります。
+
+tDiaryではさまざまな記法を使えます(スタイル機能)。BlogKitでは、すでに提供されているスタイルをベースに、blog向けにカスタマイズした専用のスタイルをいくつか提供しています。以下の3種類が提供されているので、好みの応じて使うようにして下さい。
+
+なお、必要のないスタイルファイル(style/*.rb)をインストールすると、エラーの原因になりますので、以下の説明をよく読んで、不要なファイルを入れないように注意してください。ただし、先に書いたように、style/blog.rbはかならずコピーしてください。これを忘れると、記事の自動採番機能が効かなくなります。
+
+#### tDiaryスタイルを使う場合
+
+必要なファイル(tdiary/style/blog.rb)のコピーは済んでいると思います。スタイルの指定も、先に作成したのtdiary.confに「@style = 'Blog'」の指定がすでにあるはずなので、確認してください。
+
+#### Wikiスタイルを使う場合
+
+style/blogwiki.rbをtdiary/style下にコピーし、@styleには'BlogWiki'を指定します。Wikiスタイルを使用しない場合には、この作業は行わないで下さい。
+
+#### RDスタイルを使う場合
+
+まずRDスタイルを導入して下さい(tdiary-style-rd gemをインストールします)。その上で、style/blogrd.rbをtdiary下にコピーし、@styleには'BlogRD'を指定します。RDスタイルを使用しない場合には、この作業は行わないで下さい。
+
+### テーマをコピー
+
+サンプルとしてBlogKit向けのテーマがあります。この「blog」テーマはtdiary-themeパッケージに含まれているので、そちらを利用してください。このテーマはtDiaryの標準的テーマですが、サイドバーを使ったレイアウトのための設定や、blog用プラグインのための設定が追加されています。もちろん、通常のtDiary向けテーマも使えますが、微調整が必要かもしれません。
+
+### プラグインの設定
+
+tDiary 2.0.1からは、プラグイン選択が設定画面からできるようになっています。BlogKit専用のプラグインも、ここから選択できるようにします。プラグイン選択がBlogKitを展開したディレクトリを参照できるように、tdiary.confにある以下の設定を修正してください。
+
+    @options['sp.path'] = ['misc/plugin', 'blogkit/plugin']
+
+このオプションは複数のパスを指定できます。ひとつ目はtDiaryのプラグイン集のパスを指定してあるので、ふたつ目をBlogKitで配布されているプラグインのパスにしてあります。
+
+もちろん、tDiaryのpluginディレクトリに、必要なプラグインをコピーする従来のインストール方法でもかまいません。
+
+### あとはtDiary同様に動かすだけ
+
+記事を追加するときには、画面下の「更新」をクリックします。日付は最新のものが自動的に入るので、「更新」時には常に新しい記事の追加になります。また、既存の記事の編集は、その記事を開いてから画面下の「編集」をクリックすることで行えます。
+
+まず最初に、設定画面に入って、必要なプラグインを選択しましょう。
+
+## プラグイン解説
+
+ここでは各プラグインの概要のみ解説します。指定方法などは個々のプラグインファイルを見てください。
+
+### archive.rb
+
+#### archiveプラグイン
+
+過去記事一覧を表示します。サイドバーにデフォルトで配置されています。記事はグループ化されており(ようするに月単位ですが、BlogKitでは日付に意味がないので00001からの連番です)、新しい順に表示します。
+
+#### archive\_dropdownプラグイン
+
+archiveと同様の一覧を、ドロップダウンリストで表示します。
+
+### blog-style.rb
+
+tDiaryとはやや異なった用語を使うblogツールに合わせて、各所の文字列を置き換えるプラグインです。また、タイトルの表現を変えるなど、1ページに1トピックというblog風体裁を整えるためには導入必須のプラグインだと考えてください。
+
+### lm.rb
+
+Last-Modifiedを表示するプラグインです。タイトル下か、記事最下部のどちらに表示するか、tdiary.confで選択可能です。
+
+### recent-entry.rb
+
+最新の記事一覧を、新しい順に表示します。
+
+### title-navi.rb
+
+tDiaryでは「前日」「翌日」になっていたナビゲーションボタンを、記事のタイトルで置き換えます。ただし、月をまたぐ場合には、「Prev」「Next」という表記になります。
+
+### whatsnew-list.rb
+
+記事が更新された順に一覧表示を行います。recent-entryと違い、過去の記事を更新しても上位に入れ替わります。secureモードでは動きません。また、設定画面からの指定によって、RDFファイルを生成することが可能です。
+
+### blog-category.rb
+
+カテゴリ機能を追加します。タイトル中の [ ] で囲んだ文字列がカテゴリ名として認識されます。カテゴリ名をクリックするとそのカテゴリの記事のみを表示する画面に移ります。設定画面からカテゴリインデックスの初期化を行う必要があります。
+
+#### blog\_category\_entryプラグイン
+
+カテゴリ別画面に表示しきれなかった記事のタイトルを新しい順に表示します。
+
+#### blog\_category\_formプラグイン
+
+表示するカテゴリを選択できるドロップダウンリストを表示します。
+
+### title-link.rb
+
+記事のタイトル全体をPermalinkへのリンクにします。従来のアンカー文字よりもPermalinkであることがよりわかりやすくなります。ただし、タイトル中にリンクを含めることができなくなりますので、運用に照らし合わせて使ってください。
+
+## ライセンス
+
+GPLの元で改造、配布が可能です。
+
+作者はただただし<sho@spc.gr.jp>です。
+
+BlogKitに関する最新情報は、http://www.tdiary.org/ で得られます。

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/UPDATE.en.md

@@ -0,0 +1,24 @@
+# How to update from Blogkit 1.5.2 or before.
+
+New blogkit support 'style'. If you have sites using old Blogkit, you have to change below:
+
+1. Remove blogio.rb in $INSTALL/tdiary. And copy new file blog_style.rb to same directory.
+2. Open tdiary.conf by textaeditor, and remove "require 'tdiary/blogio'" and add "@style = 'Blog'".
+
+And convert data files:
+
+3. Find *.td2 files in your @data_path.
+4. Open these files by text editor, and replace all of "Format: tDiary" to "Format: Blog".
+5. Save all changes, and remove @data_path/cache/*.parser and @data_path/cache/*.rb.
+
+If you cannot do above, one more method in compatible.
+
+3. Open blog_style.rb in text file, and find a line below.
+
+      # TDiary::DefaultIO::add_style( 'tDiary', self )
+
+4. Change this line to below (remove '#').
+
+      TDiary::DefaultIO::add_style( 'tDiary', self )
+
+5. Save the file, and remove *.parser and *.rb in @data_path/cache.

data/UPDATE.md

@@ -0,0 +1,26 @@
+# 1.5.2以前のBlogkitからのアップデートについて
+
+新しいBlogkitは、最新のtDiaryからサポートされた「スタイル」に対応しました。この結果、旧Blogkitを使っていた場合には、以下の手順で設定を変更してください:
+
+1. 従来のblogio.rbを削除し、新しいblog_style.rbを同じ場所にコピーします。
+2. tdiary.confの「require 'tdiary/blogio'」を削除し、代わりに「@style = 'Blog'」を追加します。
+
+さらに非互換吸収のために、データのコンバートが必要になりました:
+
+3. @data_pathにある*.td2というファイルをすべて見つけてください
+4. 見つけたファイルをテキストエディタで開き、すべての「Format: tDiary」を「Format: Blog」に置換します。
+5. ファイルを保存後、@data_path/cacheディレクトリにある*.parserファイルと*.rbファイルを削除してください。
+
+もし、上記の方法が実施できないのであれば、以下の方法を代わりに実施してもよいです。
+
+3. blog_style.rbを開いて、以下の行を見つけます。
+
+      # TDiary::DefaultIO::add_style( 'tDiary', self )
+
+4. この行を以下のように書き換えます(「#」を削除するだけ)。
+
+      TDiary::DefaultIO::add_style( 'tDiary', self )
+
+5. ファイルを保存し、@data_path/cacheにある*.parserと*.rbを削除します。
+
+あとの方法は互換性維持のための逃げ手なので、できれば先の方法をお勧めします。

data/lib/tdiary-blogkit.rb

@@ -0,0 +1,4 @@
+require 'tdiary/blogkit'
+require 'tdiary/style/blog'
+require 'tdiary/style/blogrd'
+require 'tdiary/style/blogwiki'

data/lib/tdiary/blogkit.rb

@@ -0,0 +1,9 @@
+require 'tdiary/extensions/blogkit'
+
+module TDiary
+	class Blogkit
+		def self.root
+			File.expand_path('../../..', __FILE__)
+		end
+	end
+end

data/lib/tdiary/blogkit/version.rb

@@ -0,0 +1,5 @@
+module TDiary
+  class Blogkit
+    VERSION = "5.0.1"
+  end
+end

data/lib/tdiary/extensions/blogkit.rb

@@ -0,0 +1,13 @@
+module TDiary
+	module Extensions
+		class Blogkit
+			def self.sp_path
+				File.join(TDiary::Blogkit.root, 'plugin')
+			end
+
+			def self.assets_path
+				File.join(TDiary::Blogkit.root, 'js')
+			end
+		end
+	end
+end

data/lib/tdiary/style/blog.rb

@@ -0,0 +1,123 @@
+# -*- coding: utf-8; -*-
+#
+# blog_style.rb: tDiary blog kit's style $Revision: 1.5 $
+#
+# if you want to use this style, add @style into tdiary.conf below:
+#
+#    @style = 'Blog'
+#
+# Copyright (C) 2003, TADA Tadashi <sho@spc.gr.jp>
+# You can distribute this under GPL.
+#
+begin
+	# require each classes extended by this file (TDiaryBase, TDiaryForm, TDiaryAppend)
+	# because 'tdiary.rb' have not loaded at this point
+	require 'tdiary/view_helper'
+	require 'tdiary/base'
+	require 'tdiary/author_only_base'
+	require 'tdiary/admin'
+	require 'tdiary/style/tdiary'
+rescue LoadError
+	require 'tdiary/tdiary_style'
+end
+
+module TDiary
+	module Style
+		class BlogDiary < TdiaryDiary
+			def style
+				'Blog'
+			end
+
+			def to_html4( opt )
+				section_id = 0
+				r = %Q[<div class="section">\n]
+				each_section do |section|
+					if section_id > 0 and not opt['anchor'] then
+						r << %Q|<p class="readmore"><a href="#{opt['index']}<%=anchor "#{date.strftime( '%Y%m%d' )}"%>">Read more...</a></p>\n|
+						break
+					end
+					if section.subtitle then
+						r << %Q[<h3>#{section.subtitle}</h3>\n]
+					end
+					if /^</ =~ section.body then
+						r << %Q[#{section.body}\n]
+					else
+						r << %Q[<p>#{section.body.lines.collect{|l|l.chomp.sub( /^[ 　]/u, '' )}.join( "</p>\n<p>" )}</p>\n]
+					end
+					section_id += 1
+				end
+				r << %Q[</div>]
+			end
+
+			def to_chtml( opt )
+				r = ''
+				each_section do |section|
+					if section.subtitle then
+						r << %Q[<H3>#{section.subtitle}</H3>]
+					end
+					if /^</ =~ section.body then
+						r << section.body
+					else
+						r << %Q[<P>#{section.body.lines.collect{|l|l.chomp.sub( /^[ 　]/u, '' )}.join( "</P>\n<P>" )}</P>]
+					end
+				end
+				r
+			end
+		end
+	end
+
+	class TDiaryBase
+	protected
+		def blog_newdate( date )
+			calendar
+			year = @years.keys.sort[-1]
+			if year then
+				month = @years[year].sort[-1]
+				if month then
+					@io.transaction( Time::local( year.to_i, month.to_i ) ) do |diaries|
+						recent = diaries.keys.sort[-1]
+						if date.strftime( '%Y%m%d' ) <= recent then
+							yield( recent )
+						end
+						DIRTY_NONE
+					end
+				end
+			end
+		end
+	end
+
+	class TDiaryForm
+		alias eval_rhtml_blogkit eval_rhtml
+		def eval_rhtml( prefix = '' )
+			if /^blog/i =~ @conf.style then
+				blog_newdate( @date ) do |recent|
+					@date = Time::local( *recent.scan( /(\d{4})(\d\d)(\d\d)/ )[0] ) + 24*60*60
+					@diary = @io.diary_factory( @date, '', '' )
+				end
+			end
+			eval_rhtml_blogkit( prefix )
+		end
+	end
+
+	class TDiaryAppend
+	protected
+		alias newdate_blogkit newdate
+		def newdate
+			date = nil
+			if /^blog/i =~ @conf.style then
+				blog_newdate( newdate_blogkit ) do |recent|
+					date = Time::local( *recent.scan( /(\d{4})(\d\d)(\d\d)/ )[0] ) + 24*60*60
+				end
+			end
+			date = newdate_blogkit unless date
+			date
+		end
+	end
+end
+
+# Local Variables:
+# mode: ruby
+# indent-tabs-mode: t
+# tab-width: 3
+# ruby-indent-level: 3
+# End: