tdiary-blogkit 5.0.1 → 5.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fed7a8e5927f142c15c0f08a67a9abfb24e22e6
-  data.tar.gz: 31305cc43ec4ab1da945dd9d3946cf50de633115
+  metadata.gz: 576eb10416dfe7ab894d6a755bb09a4581cb48b3
+  data.tar.gz: 7930fa8fa513af7ecf9bf7a2db4b1b4fffec5f77
 SHA512:
-  metadata.gz: e052c7286aead737e98d49aa5c1a8e0d757ca20230e8001ad251a49a6db3adcd9f1d75fecd75d4694e09cbc433cabe7221e846b87e9af36aa66696a59f24db84
-  data.tar.gz: 8624f9131606ac7eb3889b2fd99b7fdd3d3d58d9f5ba89bb962604f7aa7e585e959b8c7f09c5c5298f0789f2c03e28477c5332f2b72f40a8fd112b69081ca032
+  metadata.gz: 59c36612af3dc5cf5e8771a7d948be2704154a54a909c7c6bf116c5a328a0d0ea42f9d6638ae8169b60809bd61e17e33c89b67a5142e50242f52636076055316
+  data.tar.gz: b5c7dfe231f488a68c05ddf346819042b15aedb75ada1b33faf18f881d5fc08c603e9a7502f0454c969d970f7e5ade8c2cdd5787afd5604eb0fabcb408b31a40

data/ChangeLog

@@ -1,3 +1,6 @@
+2016-09-29 TADA Tadashi <t@tdtds.jp>
+	* release 5.0.2
+
 2016-06-29 TADA Tadashi <t@tdtds.jp>
 	* release 5.0.1
 

data/README.en.md

@@ -12,19 +12,21 @@ tDiary BlogKit modifies tDiary. This modification enables tDiary to manage artic
 
 You can setup BlogKit without changing tDiary. It is only plugged-in.
 
-## how to install
+## how to install (Running as CGI)
+
+See "how to install (use gem)" section if you want to run tDiary + BlogKit with gem.
 
 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 `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
+### 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.
+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
 
@@ -50,6 +52,20 @@ This option can have some pathes of plugins, 1st path is tDiary plugin collectio
 
 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.
 
+## how to install (use gem)
+
+If you installed tDiary by gem, exec `tdiary new` command to make your diary, and move current directory to the diary. If you did not use tDiary gem, also make your diary and move current directory to it.
+
+Edit `Gemfile.local` on the current directory, add a line below:
+
+    gem 'tdiary-blogkit'
+
+(If you want to use any web server, you can specify into the same file.)
+
+So, edit `tdiary.conf` file and change `@style` variable to 'Blog', 'BlogWiki' or 'BlogRD'.
+
+Then exec tDiary: `tdiary server` command or your specified web server.
+
 ## About Plugins
 
 See each plugin file if you want more information.

data/README.md

@@ -12,22 +12,25 @@ tDiary BlogKitは、tDiaryをblogのように日単位でなく記事単位で
 
 tDiary BlogKitは、tDiaryには影響を与えずに、すべてファイル追加のみで導入できます。
 
-## インストール
+## インストール (CGIとして運用する場合)
+
+このセクションでは、tDiary + BlogKitをCGIとして運用する場合のインストール方法を解説します。gemとしてインストールして独立したWebアプリケーションとして運用する場合は次の「インストール (gemを使う場合)」を参照してください。
 
 すでに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のインストールディレクトリにtdiary.confとしてコピーします。そして、`@data_path`をデータの保存場所に書き換えます。詳しくはtDiaryのドキュメントを参照してください。付属のサンプルには、ヘッダやフッタなどにblog風のレイアウト指定が施されています。これらのカスタマイズは、運用開始後に設定画面から行ってください。
 
-tdiary.conf.sample_jaは日本語向けのサンプルです。英語向けにはtdiary.conf.sampleを使ってください。
+`tdiary.conf.sample_ja`は日本語向けのサンプルです。英語向けには`tdiary.conf.sample`を使ってください。
 
 ### スタイルをコピー
 
-tdiary/style/blog.rbを、tDiaryインストールディレクトリのtdiary/styleの下にコピーします。このファイルは、BlogKit向けのさまざまな機能拡張を含んでいるので、他のスタイルを使う場合にもかならずコピーする必要があります。
+`tdiary/style/blog.rb`を、tDiaryインストールディレクトリの`tdiary/style`の下にコピーします。このファイルは、BlogKit向けのさまざまな機能拡張を含んでいるので、他のスタイルを使う場合にもかならずコピーする必要があります。
 
 tDiaryではさまざまな記法を使えます(スタイル機能)。BlogKitでは、すでに提供されているスタイルをベースに、blog向けにカスタマイズした専用のスタイルをいくつか提供しています。以下の3種類が提供されているので、好みの応じて使うようにして下さい。
 
-なお、必要のないスタイルファイル(style/*.rb)をインストールすると、エラーの原因になりますので、以下の説明をよく読んで、不要なファイルを入れないように注意してください。ただし、先に書いたように、style/blog.rbはかならずコピーしてください。これを忘れると、記事の自動採番機能が効かなくなります。
+なお、必要のないスタイルファイル(`style/*.rb`)をインストールすると、エラーの原因になりますので、以下の説明をよく読んで、不要なファイルを入れないように注意してください。ただし、先に書いたように、style/blog.rbはかならずコピーしてください。これを忘れると、記事の自動採番機能が効かなくなります。
 
 #### tDiaryスタイルを使う場合
 
@@ -61,60 +64,80 @@ tDiary 2.0.1からは、プラグイン選択が設定画面からできるよ
 
 まず最初に、設定画面に入って、必要なプラグインを選択しましょう。
 
+## インストール (gemを使う場合)
+
+tDiary本体もgemを使って導入している場合は`tdiary new`コマンドを使って日記を作成済みとします。この場合は作成した日記のディレクトリをカレントディレクトリにしてください。tDiary gemを使っていない場合も、すでに運用可能な日記のあるディレクトリに移動しておきます。
+
+カレントディレクトリに`Gemfile.local`というファイルがあるので、そこに以下の1行を追加します:
+
+    gem 'tdiary-blogkit'
+
+(その他、`thin`や`puma`などでお好きなWebサーバも指定できます)
+
+`Gemfile.local`ファイルを保存後、`bundle install`コマンドを実行し、現在の環境にBlogKitを組み込みます。
+
+続いて、`tdiaty.conf`を編集します。BlogKitに付属のものを使っても良いですし、既存の`tdiary.conf`の`@style`を書き換えるだけでも良いです。`@style`には`Blog～`で始まるものだけが利用できます。具体的には以下の3つからお好きなスタイルを選びます:
+
+    @style = 'Blog'
+    @style = 'BlogWiki'
+    @style = 'BlogRD'
+
+あとはtDiaryを動かすだけです。`tdiary server`ないし指定したWebサーバを動かすコマンドを実行してください。
+
 ## プラグイン解説
 
 ここでは各プラグインの概要のみ解説します。指定方法などは個々のプラグインファイルを見てください。
 
-### archive.rb
+### `archive.rb`
 
-#### archiveプラグイン
+#### `archive`プラグイン
 
 過去記事一覧を表示します。サイドバーにデフォルトで配置されています。記事はグループ化されており(ようするに月単位ですが、BlogKitでは日付に意味がないので00001からの連番です)、新しい順に表示します。
 
-#### archive\_dropdownプラグイン
+#### `archive_dropdown`プラグイン
 
 archiveと同様の一覧を、ドロップダウンリストで表示します。
 
-### blog-style.rb
+### `blog-style.rb`
 
 tDiaryとはやや異なった用語を使うblogツールに合わせて、各所の文字列を置き換えるプラグインです。また、タイトルの表現を変えるなど、1ページに1トピックというblog風体裁を整えるためには導入必須のプラグインだと考えてください。
 
-### lm.rb
+### `lm.rb`
 
 Last-Modifiedを表示するプラグインです。タイトル下か、記事最下部のどちらに表示するか、tdiary.confで選択可能です。
 
-### recent-entry.rb
+### `recent-entry.rb`
 
 最新の記事一覧を、新しい順に表示します。
 
-### title-navi.rb
+### `title-navi.rb`
 
 tDiaryでは「前日」「翌日」になっていたナビゲーションボタンを、記事のタイトルで置き換えます。ただし、月をまたぐ場合には、「Prev」「Next」という表記になります。
 
-### whatsnew-list.rb
+### `whatsnew-list.rb`
 
 記事が更新された順に一覧表示を行います。recent-entryと違い、過去の記事を更新しても上位に入れ替わります。secureモードでは動きません。また、設定画面からの指定によって、RDFファイルを生成することが可能です。
 
-### blog-category.rb
+### `blog-category.rb`
 
 カテゴリ機能を追加します。タイトル中の [ ] で囲んだ文字列がカテゴリ名として認識されます。カテゴリ名をクリックするとそのカテゴリの記事のみを表示する画面に移ります。設定画面からカテゴリインデックスの初期化を行う必要があります。
 
-#### blog\_category\_entryプラグイン
+#### `blog_category_entry`プラグイン
 
 カテゴリ別画面に表示しきれなかった記事のタイトルを新しい順に表示します。
 
-#### blog\_category\_formプラグイン
+#### `blog_category_form`プラグイン
 
 表示するカテゴリを選択できるドロップダウンリストを表示します。
 
-### title-link.rb
+### `title-link.rb`
 
 記事のタイトル全体をPermalinkへのリンクにします。従来のアンカー文字よりもPermalinkであることがよりわかりやすくなります。ただし、タイトル中にリンクを含めることができなくなりますので、運用に照らし合わせて使ってください。
 
 ## ライセンス
 
-GPLの元で改造、配布が可能です。
+GPL v2ないしそれ以降のライセンスで改造、配布が可能です。
 
-作者はただただし<sho@spc.gr.jp>です。
+作者はただただし<t@tdtds.jp>です。
 
 BlogKitに関する最新情報は、http://www.tdiary.org/ で得られます。

data/lib/tdiary/blogkit/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tdiary-blogkit
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.0.2
 platform: ruby
 authors:
 - tDiary contributors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-29 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hikidoc
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: tDiary blogkit package.