tdiary 3.2.2.20130507

data/doc/INSTALL.md

@@ -0,0 +1,160 @@
+インストールマニュアル
+===========
+
+tDiaryのインストールと設定
+----------------
+
+一般的なCGIの実行を許可しているISPやレンタルサーバ上で利用する場合を想定し、以下のような環境を例に説明します。
+
+  - WWWサーバ: Apache 1.3.x
+  - ユーザ名: foo
+  - 日記のURL: http://www.hoge.example.org/~foo/diary/
+  - 上記URLのパス: /home/foo/public\_html/diary
+
+### CGIスクリプトの設定
+
+配布アーカイブを展開し、中身をすべて/home/foo/public\_html/diaryにコピーします。以下の2つのファイルがCGIスクリプト本体なので、WWWサーバの権限で実行可能なようにパーミッションを設定してください。
+
+  - index.rb
+  - update.rb
+
+また、/usr/bin/envを使った起動ができない環境では、各ファイルの先頭を、rubyのパスに書き換える必要があるでしょう。ISPのホームディレクトリにこっそりRubyを入れたような場合を除き、通常はあまり気にしなくても良いはずです。
+
+### .htaccessの作成
+
+続いて、CGIの実行環境を整えます。dot.htaccessを.htaccessにリネームして、環境に合わせて書き換えます。添付のサンプルは以下のようになっています。
+
+```
+Options +ExecCGI
+AddHandler cgi-script .rb
+DirectoryIndex index.rb
+
+<Files "*.rhtml">
+   deny from all
+</Files>
+
+<Files "tdiary.*">
+   deny from all
+</Files>
+
+<Files update.rb>
+AuthName      tDiary
+AuthType      Basic
+AuthUserFile  /home/foo/.htpasswd
+Require user  foo
+</Files>
+```
+
+ここでは、
+
+  - CGIの実行を可能にし、
+  - サフィックス「.rb」のファイルをCGIと認識させ、
+  - index.rbをデフォルトのファイルに設定し、
+  - *.rhtmlとtdiary.*のファイルの参照を禁止して、
+  - update.rbへのアクセスにはユーザ認証が必要
+
+という設定になっています。とりあえず書き換えが必要なのは、AuthUserFileとRequire userでしょう。意味はWebででも調べて下さい。AuthUseFileは、あらかじめhtpasswdコマンドで作成しておく必要があります(これもWebで調べればわかります)。
+
+また、利用するWWWサーバの設定が、CGIの実行ファイルのサフィックスを固定(例:.cgi)にしている場合があります。この場合、AddHandlerやDirectoryIndexも変更する必要があるでしょう。これに応じて、index.rbやupdate.rbのファイル名も変更する必要があります。
+
+### tdiary.confの作成
+
+次に、tDiaryの設定ファイルであるtdiary.confを作ります。
+
+初めてtDiaryをインストールする人には、付属のtdiary.conf.beginnerを使うのがオススメです。最初に使えるようにしておくと良いプラグインがあらかじめONになっていたり、spamフィルタにある程度の設定がされているなど、インストールしてすぐに使いやすい状態になっています。
+
+tdiary.conf.beginnerをtdiary.confにリネームして、内容を書き換えます。tDiaryの設定はほとんどWebブラウザ経由で行えます。ただし、@data\_pathは必要に応じて最初に書き換えてください。
+
+```
+@data_path = 'data'
+```
+
+@data\_pathは、日記のデータを保存するディレクトリです。ほとんどのレンタルサーバで使われているApache HTTPサーバ向けには、このディレクトリをWWWサーバ経由で参照されないように.htaccessファイルによるアクセス制御を設定済みです。他のWebサーバを使用する場合には、WWWサーバ経由でアクセスできない(public\_html配下でない)ディレクトリを指定するか、アクセス制御を設定してください。また、このディレクトリはWWWサーバの権限で書き込めるパーミッションにしておく必要があります。
+
+tdiary.confには、他にもいろいろな設定項目を記述できます。これらの項目には以下の3つの種類があります。
+
+#### CGIで設定できない項目
+
+@data\_pathのように、CGIでは設定できない項目です。これらの項目は、tdiary.confファイルを直接編集して変更しなければいけません。
+
+#### CGIで設定できる項目
+
+変更画面のメニューにある「設定」を開くと、ブラウザからtDiaryの設定を変更できます。ほとんどの項目はここから設定できるので、わざわざtdiary.confを手で書き換える必要はありません。
+
+#### CGIで追加設定できるが、標準設定を記述できる項目
+
+tdiary.confに記述しておくことで、CGIの設定画面からは編集できないが追加はできるといった設定をできる項目があります(リンク元記録除外や、リンク元変換表)。あらかじめtdiary.confに記述しておくことで、複数の人が同一サーバ上でtDiaryを使うような場合に手間を省くことができます。
+
+各々の項目については、tdiary.conf.sampleの説明を読んでください。一般的な使用では、@data\_pathだけを正しく設定すれば、あとはブラウザから変更が可能です。
+
+また、サフィックス.rbのファイルをCGIスクリプトとして指定できない環境では、index.rbやupdate.rbのファイル名を変更する必要がありますが、この変更をtDiaryに教えるために、@indexや@updateという変数が用意されています。環境によってはこれも指定する必要があるでしょう。
+
+tdiary.confの設定が終わったら、http://www.hoge.example.org/~foo/diary/にアクセスしてみましょう。からっぽの日記ページが出れば設定は正しいです。不幸にして「Internal Server Error」が出てしまったら、Apacheのエラーログを参照して間違った設定を修正してください。
+
+### セキュリティ
+
+tdiary.confには、tDiaryの設定をCGIから行う場合のセキュリティレベルを調整する変数があります。自分が管理するWebサーバで、自分だけが使う場合にはあまり気にしなくても良いですが、知人に貸したり、tDiaryを使った日記サービスを提供するような場合には、ユーザにできることを制限したい場合が少なくありません。
+
+そこで、tdiary.conf中でセキュリティの設定を行います。通常、tdiary.confの末尾には以下の2行が書かれています。
+
+```
+@secure = false
+load_cgi_conf
+```
+
+@secureは、セキュリティ設定を指定する変数です。この値がfalseの場合、セキュリティチェックはいっさいかかりません。ユーザはCGI設定で好き放題ができます。それでは危険という状況下でtDiaryを運営する場合には、@secureの値をtrueにします。そうすると、CGI設定中における危険な変数操作やファイル操作が禁止されます。
+
+また、@secureの値は、日記の表示時に後述するプラグインを実行する場合にも影響を及ぼします。これにより、@secureがtrueの場合には、いくつかのプラグインが利用できなくなります。
+
+load\_cgi\_confはその位置でCGIによる設定を読み込む指令です。つまり、@secureでセキュリティレベルを設定したあとでファイルを読み込むようになっています。
+
+なお、両者の指定位置は独立しているので、両者の位置を組み合わせることで様々な設定を行うことが可能です。また、@secureを指定しない場合のデフォルト値はtrueです。
+
+tDiaryの実行
+---------
+
+### 日記の更新
+
+ページの先頭には、「トップ」「更新」の2つのリンクがあります。「トップ」は@index\_pageで指定した表紙へ、「更新」は日記を更新するフォームへ移動します。もし「更新」をクリックした時、認証ダイアログが出なかったら、.htaccessの記述が正しくない可能性があります。
+
+更新ページの先頭にもメニューがあります。一番右端に「設定」が増えているでしょう。ここをクリックすると、設定用のページが開きます。詳しくはを参照してください。
+
+更新ページには、日記の日付とその日のタイトル、本文を入力するフォームがあります。日付、タイトル、本文を入力して「追加」ボタンを押すと、その日の日記に追加されます。タイトルと本文はどちらも省略可能です。追加なので、一日に何度も日記を書く場合に、わざわざ以前のデータを呼び出す必要はありません。また、すでにタイトルが指定されている場合、タイトルを入力しなければ以前指定したものが使われます。
+
+フォームで日付を入力して「この日付の日記を編集」ボタンを押すと、(その日の日記がすでに存在すれば)タイトルと本文に過去の日記のデータが読み込まれます。この時、フォームの最後のボタンは「登録」になります(つまり、追加ではありません)。
+
+日記本文には日記向けに少し特殊化したHTMLを使います。多少癖があって人によってはなかなか馴染めないことがあるようなので、[日記の書き方](HOWTO-write-tDiary.html)には必ず目を通して下さい。
+
+### 日記の設定
+
+更新画面で「設定」をクリックすると、設定画面になります。ここではtDiaryのさまざまな設定項目をブラウザから設定できます。各項目の説明は画面中に記述してありますから、それを参考にいろいろと設定を変えてみてください。また、ページ中には利用しやすくするために「OK」ボタンがたくさん置いてありますが、すべて同じものです。つまり、どの「OK」を押してもすべての項目が保存されます。
+
+なお、この設定画面で行った変更は、@data\_pathで指定したディレクトリに別のtdiary.confとして保存されます(初期設定時に手動で書き換えたtdiary.confではありません)。このファイルは、元のtdiary.confのあとに読み込まれるので、設定の内容はブラウザから指定したものが優先されます(ただし、元のtdiary.conf中の設定を変えることで、読み込むタイミングは変更できます)。
+
+### 日記の参照
+
+日記の参照には、最新、月別、日別の3種類のモードがあります。デフォルトページは最新です。月別は、ページの最初の方に出るカレンダーをクリックすると参照できます。また、日別は日付をクリックすると参照できます。
+
+最新・月別と日別には、表示される内容に違いがあります。最新・月別では「本日のツッコミ」「本日のリンク元」が省略されて表示されるのに対し、日別ではすべて表示されます。また、日別にはツッコミ用のフォームがあります。ツッコミをしてもらいたかったら、読者を日別ページに誘導するように、ヘッダ(@header)を工夫する必要があるかも知れません。
+
+月、日、セクション、ツッコミには、それぞれアンカーがあり、他の場所からリンクできるようになっています。それぞれのアンカーはリンクにもなっているので、そこにポインタを合わせることで、そのURLを知ることができます。
+
+携帯端末からの参照ではデータ量に制限があるため、上記の機能はほとんど使えません。最新は最新日付の日記だけが表示され、前日・翌日へ移動できるだけです。ただし、すべてのページにツッコミ用フォームが付いているので、ツッコミを入れることは可能です。
+
+### プラグインによるカスタマイズ
+
+tDiaryにはプラグインと呼ばれる機能があります。プラグインを追加することで、tDiaryの機能を増やしたり、変更したりすることが可能です。プラグインについての詳しい説明は、[HOWTO-use-plugin.html](HOWTO-use-plugin.html)(使い方)・[HOWTO-make-plugin.html](HOWTO-make-plugin.html)(作り方)を参照してください。
+
+### あとは……
+
+日記をつけ続けるだけです(これが一番難しい:-)。Have fun!!
+
+著作権、サポートなど
+----------
+
+tDiary本体は、原作者であるただただし(t@tdtds.jp)が、GPL2の元で配布、改変を許可するフリーソフトウェアです。
+
+また、tDiaryフルセットに付属するテーマ、プラグインはすべて、それぞれの原作者が著作権を有します。ライセンス等に関しては個々のファイルを参照してください。
+
+tDiaryは[tDiary.org](http://www.tdiary.org/)でサポートを行っています。ご意見・ご要望はこちらへどうぞ。パッチ歓迎です。
+

data/doc/README.en.md

@@ -0,0 +1,174 @@
+tDiary -- a TSUKKOMI-able Web-log
+=================================
+
+tDiary is so called Weblog. tDiary has these features.
+
+features
+--------
+
+### You can change your configuration with browser.
+
+You can not only read diary, but also write diary. Also, it is possible to change your configuration with browser. With tDiary, you can easily use and maintain Web-log system. So, you continue to write diary for a long time.
+
+### TSUKKOMI
+
+'TSUKKOMI' means a short, smart and heartfelt comment in Japanese. It is possible for diary readers to add a TSUKKOMI to your diary. In other words, tDiary is equipped with BBS. With this BBS, you can communicate with your diary readers. tDiary can inform the author of a new TSUKKOMI by e-mail.
+
+### Today's Link (Referer)
+
+When people links their diary to your diary, tDiary shows their URL by analysis of the referer header. This feature is supported in many Japanese web-log systems. In tDiary, this feature is more user-friendly.
+
+### small devices -- PDA or mobile phone
+
+You can read your diary with PDA or mobile phone, for example, i-mode, Palm, Zaurus(SHARP's PDA) and so on. When you access the same URL as usual, tDiary creates a page for PDA or mobile phone. The page for small devices are small and suitable for reading with them.
+
+### theme -- CSS
+
+You can change the look of the diary by CSS. In tDiary, this feature is called 'theme'. tDiary package has some themes. Of course, you can create a new theme. You can change your theme with browser.
+
+### Plugin
+
+By plugins, you can add new features to tDiary, and change the existing feature of tDiary.
+
+### Selectable Style and IO
+
+You can choice a grammar of writing your diary by 'Style' feature. Some style files are in misc/style. And you can choice data saving format (IO) also. Seee HOWTO-make-io.rd for more information about Style or IO.
+
+### Written in Ruby
+
+Important :-). tDiary requires Ruby-1.8.2 or later.
+
+### Others
+
+tDiary also supports these features.
+
+  - Section anchor
+  - Read past diaries
+
+Installation and Configuration
+------------------------------
+
+In this manual, we presume this environment as one example.
+
+  - WWW server: Apache 1.3.x
+  - User: foo
+  - Diary URL: http://www.bar.example.org/~foo/diary/
+  - Diary Path: /home/foo/public\_html/diary/
+
+### CGI script configuration
+
+Unpack archive, and copy all the files to "/home/foo/public\_html/diary/". You must change permission of two files, which are executed as CGI script.
+
+  - index.rb
+  - update.rb
+
+If you use tDiary in an environment where the command "/usr/bin/env" can't be used, you need to edit these files and change their front line so that it stands for the Ruby executable. Except the case when you install Ruby under your home directory, you may be not careful about this thing.
+
+### .htaccess
+
+Next, you arrange CGI environment. You copy "dot.htaccess" as ".htaccess". And, edit it. The file, "dot.htaccess", is like this;
+
+```
+Options ExecCGI AddHandler cgi-script .rb DirectoryIndex index.rb  deny from all  deny from all  AuthName tDiary AuthType Basic AuthUserFile /home/foo/.htpasswd Require user foo
+```
+"dot.htaccess" configures these things.
+
+  - makes it possible to use CGI.
+  - makes files whose suffix is ".rb" recognized as CGI script.
+  - sets "index.rb" to the default file.
+  - prohibits accesses to "*.rhtml" and "tdiary.*"
+  - When you access "update.rb", authentification is needed.
+
+At least, you must change the "AuthUserFile" and "Require User" items. In Addition to it, you must create the the file named as "AuthUserFile" by "htpasswd" command before you access your diary. If you don't know "AuthUserFile" and "Require users", please examine these words.
+
+If your WWW server doesn't allow you to change the suffix of CGI scripts, you need to change the "AddHandeler" or "DirectoryIndex" items. In this case, you may need to change the filenames of "index.rb" and "update.rb".
+
+### creation of tdiary.conf
+
+You copy "misc/i18n/tdiary.conf.sample-en" as "tdiary.conf" and edit "tdiary.conf". _Notice! "tdiary.conf.sample" in INSTALLDIR is Japanese version_. "tdiary.conf.sample" only supports Japanese.
+
+"tdiary.conf" is loaded as Ruby script by the CGI scripts, for example, "index.rb" and "update.rb". With tDiary, you can do configuration with browser. If necessary, you may change "@data\_path" parameter at first. "@data\_path" is appeared at the beginning of "tdiary.conf".
+
+```
+@data_path = "data"
+```
+In "@data\_path", you specify the directory where your diary data are stored. This item is usually set to the directory which can not be accessed through WWW. In addition to it, you must set permission of this directory so that the WWW server can access it.
+
+In "tdiary.conf", you can configure many items. They are divided into three categories.
+
+The items which you can't set with browserLike "@data\_path", these are the items which you can't change with browser. These items are configured only by editing "tdiary.conf" directly.
+
+The items which you can set with browserWhen you click the menu, "preferences", you can change your configuration with browser. Almost all the items are changed with browser. You don't have to edit "tdiary.conf" directly.
+
+The items to which you can add values with browser"tdiary.conf" has some items to which values are added with browser, for example, the ignored links and the rules which convert a URL. By editing these items of "tdiary.conf", you can set the default values(This is meaningful if you use multi-user mode).
+
+### Configuration
+
+The meaning of each item is explained in "tdiary.conf.sample". Generally speaking, you can change your configuration with browser after you configure @data\_path. If you want to receive a new TSUKKOMI by e-mail, you configure the @smtp\_host and @smtp\_port.
+
+If you run tDiary in the environment where you can't use the suffix, ".rb", as CGI script, you change the filenames of "index.rb" and "update.rb". In this case, you must configure @index and @update.
+
+After you finish configuration, access "http://www.hoge.example.org/~foo/diary/". If you can see an empty page, tDiary works well. Unfortunately, if you encounter "Internal Server Error", you must change configuration. The error-log of Apache is useful in order to investigate the cause.
+
+Security
+--------
+
+"tdiary.conf" has the item which change the security level. If you use tDiary on your own server, you may not care about security. But, if you lend tDiary or provide the service of web-log, you need restriction.
+
+In these cases, you set the security level in "tdiary.conf". Normally, these two lines exists at the end of "tdiary.conf".
+
+```
+@secure = false load_cgi_conf
+```
+By changing @secure, you set the security level. If this is false, no security check is carried out. If no security check is executed, users can change tDiary indulgently. When you run tDiary under the dangerous circumstance, you set @secure to true. If you do it, the dangerous operation, for example, file operation or variable assignment, is prohibited when "tdiary.conf" is loaded. The "@secure" affects plugins. If security check is carried out, you can't use some plugins.
+
+"load\_cgi\_conf" is the function which loads the tDiary's configuration file of CGI. In this example, the CGI configuration file is loaded after the security level is configured.
+
+Because you can change the positions of "load\_cgi\_conf" and @secure independently, you can do detailed configuration. If you omit @secure, @secure is set to the default value, true.
+
+run tDiary
+----------
+
+### update the diary
+
+At the beginning of the diary page, there are two links, "Top" and "Update". When you click "Top", you move to the page which is specified by "@index\_page". When you click "Update", you move to the page which has the form to update your diary. If the authentification dialog doesn't appear in clicking "Update", there is possibility that your ".htaccess" is wrong.
+
+The "Update" page also has the menu in its beginning. In "Update" page, "Preferences" is added in the right of the menu. When you click it, the "Preferences" page is opened. The detail about the "Preferences" page is explained in the below.
+
+The "Update" page has the form where you can input the date, title, and body of diary. Write your diary and put the "Add" button. By this procedure, the diary is added. Because this procedure is "Add", you don't have to show all the diary data if you write diary many times a day. Once you set the title of the diary, tDiary uses it.
+
+If you set date and click the "Edit this day" button, the title and body of the date are loaded(If the data is empty, these data are not loaded). In this case, the last button of the form is "Register"(Be careful. It is not "Add").
+
+In tDiary, You use a bit specialized HTML in order to describe your diary. It is a little characteristic and it takes considerable time for some people to get accustomed to writing diary in this format. Please read HOWTO-write-diary.
+
+### Configuration with browser
+
+When you click the "Preferences" button in the "Update" page, the "Preferences" page is shown. Here, you can configure many items with browser. In the "Preferences" page, each item has explanation. When you change a item, it is good to refer to explanation. Though the "Preferences" page has many "OK" buttons, their role is the same. When any "OK" button is clicked, all the items are stored to the configuration file. These buttons are located for the purpose of convenience.
+
+The configuration which is done with browser is stored as "tdiary.conf", which is located in the "@data\_path" directory. This "tdiary.conf" is not the "tdiary.conf" which you edit manually. This file is normally loaded after the original "tdiary.conf" is loaded, so the values of the CGI "tdiary.conf" has priority over the values of the original "tdiary.conf". (If you edit the original "tdiary.conf", you can change the timing of loading the cgi "tdiary.conf")
+
+### Read Diary
+
+When you read your diary, tDiary provides the three kind of the pages, "Latest", "Monthly", and "Daily". In default, tDiary shows "Latest" page. You can read the "Monthly" page if you click the link of the calendar located at the beginning of the page. And you can read the "Daily" page if you click the date.
+
+There is difference between "Latest"/"Monthly" and "Daily" page. In "Latest"/"Monthly" page, today's TSUKKOMIs and today's links are partly omitted. On the other hand, "Daily" page shows all the TSUKKOMIs and links. And, "Daily" page has the form for TSUKKOMI.
+
+Every month, day, section, and TSUKKOMI has an anchor, and diary readers can link other place to it. Because each anchor is also a link, you can know the URL of it if you move pointer to it.
+
+With small devices, for instance, mobile phone, Zaurus and Palm, you can't use some of the features above because of restriction on data amount. When you access the diary with small devices, the "Latest" page shows the page which contains only one latest diary. You can move from this page to previous day page or next day page.
+
+### And ...
+
+Now, All you have to do is that you write diary ( But, it is the most difficult to continue to write diary:-) ). Have fun.!!
+
+License
+-------
+
+tDiary is free software created by TADA Tadashi(sho@spc.gr.jp). tDiary is licensed under the terms of GPL2. You can distribute and modify it under the terms of GPL2.
+
+But, all the files that are in "erb/" directory is ERb library created by Seki-san. You can know the detail about the license of these files at http://www2a.biglobe.ne.jp/~seki/ruby/.
+
+And, authors of all the plugins and themes have its copyright. All the plugins can be distributed and modified under the terms of GPL2. Most themes are also under GPL2, but some have original license. See each theme file.
+
+tDiary is developed on https://sourceforge.net/projects/tdiary/.
+

data/doc/README.md

@@ -0,0 +1,56 @@
+ツッコミのできるWeb日記システム
+=================
+
+tDiaryでできること
+------------
+
+tDiaryは、いわゆるWeb日記を支援するシステムです。tDiaryには以下の特徴があります。
+
+### 更新や設定までブラウザからできる
+
+日記の参照だけでなく、日記の更新、設定までもWebブラウザから実行できます。ブラウザさえあれば面倒なメンテナンスは不要。手軽に使えて、長く続けられます。
+
+### 「ツッコミ」が入れられる
+
+日記の読者が、日記に「ツッコミ」を入れられます。ようするに、日付ごとに掲示板がついています。これを通じて、読者とのコミュニケーションが生まれます。 ツッコミがあったことを著者にメールで知らせる機能もあります。
+
+### 「本日のリンク元」(Referer)機能
+
+他の日記等からリンクされると、Refererヘッダを見てそのURLを表示します。どこかで自分の日記が話題にされていることがすぐにわかるように、従来のWeb日記コミュニケーションで使われている手法をわかりやすくサポートしています。
+
+### 携帯端末対応
+
+iモードに限らず、ほとんどの携帯電話やPalm・ザウルスなどの携帯端末からも日記を参照できます。専用の特別なURLは必要なく、自動認識して最適なページを生成します。通信料金のシビアな端末向けには無駄を省いた小さなページを送るようになっています。
+
+### CSSを使ったテーマ機能
+
+スタイルシートを使って見た目をがらりを変えることができます。これは「テーマ」と呼ばれ、別パッケージとして配布されているテーマ集には、100を越えるテーマが収録されています。もちろん自分で作ることも可能です。テーマは設定画面で簡単に切り替えることができます。
+
+### プラグインによる機能追加
+
+プラグインというモジュールを追加することで、日記の機能を増やしたり変更したりすることが可能です。詳しくは[HOWTO-use-plugin.html](HOWTO-use-plugin.html)(使い方)・[HOWTO-make-plugin.html](HOWTO-make-plugin.html)(作り方)を参照してください。
+
+### 記述形式や保存形式を変更できる
+
+日記を記述する形式(スタイル機能)や、データの保存形式(IO機能)が選択可能です。スタイルはmisc/styleの下に複数収められています。IOは現在、1.4系までの旧tDiary互換のPStoreIOと、2.0系以降の新しいテキスト形式であるDefaultIOがあります。詳しくは[HOWTO-make-io.rd](HOWTO-make-io.rd)を参照してください。
+
+### Rubyで書かれている
+
+重要なポイントでしょう:-)??実行にはruby 1.9.1-p378またはruby 1.8.7-p249以上が必要です。
+
+セクション(段落)アンカーや過去の日記の参照など、一般的なWeb日記システムの持つ機能は基本的にサポートしています。
+
+tDiaryのインストールと設定
+----------------
+
+[INSTALL.html](INSTALL.html)を参照してください。
+
+著作権、サポートなど
+----------
+
+tDiary本体は、原作者であるただただし(t@tdtds.jp)が、GPL2の元で配布、改変を許可するフリーソフトウェアです。
+
+また、tDiaryフルセットに付属するテーマ、プラグインはすべて、それぞれの原作者が著作権を有します。ライセンス等に関しては個々のファイルを参照してください。
+
+tDiaryは[http://www.tdiary.org/](http://www.tdiary.org/)でサポートを行っています。ご意見・ご要望はこちらへどうぞ。パッチ歓迎です。
+

data/doc/UPGRADE.md

@@ -0,0 +1,164 @@
+アップグレードガイド
+=========
+
+このドキュメントについて
+--
+
+tDiaryは、バージョン番号の2桁目が偶数のもの(1.0.x、1.2.x...)がリリースバージョン、奇数のもの(0.9.xx、1.1.x...)が開発バージョンとなっています。このドキュメントでは、リリースバージョン間の変更点について解説します。開発バージョンを使っている場合は、ChangeLogファイルを参照してください。
+
+2.2と3.0の違い
+-----
+
+2.2系から3.0への最大の変更点は、「UTF-8化」と「ruby 1.9対応」です。いずれも大きな変更になりますので、以下の注意をよく読んでからアップデートを行って下さい。すでに2.3系で運用している場合は特に大きな問題はでないでしょう。
+
+### アップデートに関する注意点■
+
+#### 文字コードのUTF-8化
+
+tDiary 3.0では日記データのファイルのエンコードをEUC-JPからUTF-8へと変更しています。この変更により複数の言語で日記を書けるようになりました。
+
+tDiary 3.0にバージョンアップすることで、自動的に新しく書いた日記はエンコーディングがUTF-8で作成され、過去の日記データも表示する際にEUC-JPからUTF-8に自動的に変換されます。
+
+いちどUTF-8に変換された日記データは、基本的にはEUC-JPへは戻せません。かならずバックアップをとってからアップデート作業をしてください。
+
+#### ruby 1.9.2 への対応
+
+tDiary 3.0ではrubyを1.9.2にバージョンアップするだけで移行できるようになっていますが、 tDiaryが生成するキャッシュファイルは互換性の問題でまれにエラーになることがあります。
+
+エラーになった場合のもっとも簡単な対処は、データディレクトリにあるcacheディレクトリを丸ごと削除する方法です。ただし、counter.rbの情報が消えるとカウンタが巻き戻ってしまうので、初期値を控えておくなどの対処が必要です。また makerss.rbやrecent_comment.rbが生成するキャッシュが消えるため、しばらくは寂しい状況になるかも知れませんが、これらは時間が解決してくれます:-) すべてのキャッシュを削除するのが困難な場合は、個別のファイルごとに対処してください。
+
+また、カテゴリに関する情報も、同様な理由でエラーを起こすことがあります。この場合は、categoryプラグインの設定画面で「カテゴリインデックスの作成」を実行してください。
+
+いちどruby 1.9.2上で動作させた日記データは、基本的には1.8へは戻せません。かならずバックアップをとってからアップデート作業をしてください。
+
+#### tDiary 3.0とruby 1.9.2を同時にアップデートしない
+
+ruby 1.8.* で動かしているtDiary 2.2系をtDiary 3.0とruby 1.9.2の環境へ同時にアップデートすることは避けるべきでしょう。日記データが壊れることはないはずですが、キャッシュデータが壊れてしまう可能性があります。
+
+どうしてもtDiaryとrubyの両方をバージョンアップしたい場合は以下の手順でバージョンアップして下さい。
+
+ 1. tDiaryをまず3.0にバージョンアップし、ruby 1.8の状態でブラウザから日記を表示します。この際に日記データと利用しているプラグインのキャッシュデータがUTF-8へと変換されます。
+ 2. 利用しているプラグインの動作を全て確認後にruby 1.9.2へとアップデートします。
+ 3. 利用しているプラグインによっては、上記の手順で完全に変換が実行されない可能性もあります。
+
+不安な場合は<tdiary-devel@sourceforge.net>まで相談してください。
+
+2.0と2.2の違い
+-----
+
+### 2.0から2.2移行時の注意
+
+#### いくつかのファイル名が変更になっています。
+
+ - plugin/01sp.rb → plugin/50sp.rb
+ - plugin/ja/01sp.rb → plugin/ja/50sp.rb
+ - plugin/en/01sp.rb → plugin/en/50sp.rb
+ - plugin/zh/01sp.rb → plugin/zh/50sp.rb
+
+2.2へのアップデートをする前に、上記のファイルをあらかじめ削除しておいてください。残っていると誤動作する場合があります。
+
+#### リンク元の記録方法が変更になっています。
+
+リンク元は従来、月単位に記録していましたが、2.2からは日単位の記録になっています。このため、データディレクトリには自動的にYYYYMMDD.tdrというファイルが生成され、元のYYYYMM.tdrはYYYYMM.tdr~にリネームされて残されます。ディスク容量に余裕がない場合には、古いファイルは削除してかまいません。
+
+#### 2.0から2.2への主な変更点
+
+[tDiary.orgのリリース](http://www.tdiary.org/20071216.html)を参照してください。
+
+プラグインの中にも廃止・統合されたファイルがあります。
+
+1.4と2.0の違い
+-----
+
+### 1.4から2.0移行時の注意
+
+#### データ形式が変更になっています。
+
+1.4系ではバイナリ形式でしたが、2.0からは標準でテキスト形式になっています。保存形式は差し替え可能になっていますが、テキスト形式に変換することをお勧めします。詳しくは[tDiary.orgのページ](http://www.tdiary.org/20021121.html)を参照してください。
+
+#### プラグインのインストール方法が変わっています。
+
+tDiaryインストールディレクトリのmisc/pluginにプラグインファイルを入れておくと、設定画面から有効にするプラグインを選択できます。従来の方法でもインストールできますが、プラグインファイルが本体と言語リソースに分離されたこともあり、今後はこちらを推奨します。
+
+#### ツッコミのメール通知を、本体内蔵からプラグインにしました。
+
+comment_mail-smtp.rb 他のプラグインを使うようにしてください。
+
+### 1.4から2.0への主な変更点
+
+ 1. 「長年日記」機能
+ 2. カテゴリ機能追加(http://www.tdiary.org/20030224.html)
+ 3. スタイル機能で記述形式を選択可能に(http://www.tdiary.org/20030225.html)
+ 4. 更新前に内容を確認できるプレビュー機能
+ 5. 設定画面の大幅機能拡張で絵日記などが可能に
+ 6. ツッコミやリンク元を制限できるフィルタ機能
+ 7. 更新画面に機能を追加できるプラグイン拡張
+ 8. 国際化機能。標準でja(日本語)、en(英語)、zh(中国語繁字体)に対応
+ 9. 各種ウェブログ機能(TrackBack、ping、RSS)対応(プラグイン併用)
+
+1.2と1.4の違い
+----
+
+### 1.2から1.4移行時の注意
+
+#### *.rhtml、*.rconf、*.rtxtが、ディレクトリskelに移動しています。
+
+これら以前のファイルは削除してかまいません。
+
+#### ページ最上部に出ていたナビゲーションボタンが、プラグインとして独立し、自由な場所に配置できるようになりました。
+
+この副作用で、ヘッダ(@header)に「<%=navi%>」という文字列を含めないとナビゲーションボタンが出てきません。移行後にブラウザからupdate.rbを開いて、ヘッダを変更してください。
+
+### 1.2から1.4への主な変更点
+
+ 1. プラグインによる拡張機能
+ 2. 最新表示で月をまたいだ表示
+ 3. キャッシュによる高速化
+ 4. 複数日記の運用が簡単に
+ 5. 検索インデックス作成用squeeze.rbによる静的HTML生成
+ 6. モバイルモード対象機種を充実
+ 7. 特定の日付を隠せるようになった
+
+1.0と1.2の違い
+-----
+
+### 1.0から1.2移行時の注意
+
+#### CSSがthemeディレクトリへ移動になっています。
+
+ここに*.cssを入れておくと、設定画面から対話式にテーマを切り替えることができます。従来のデフォルトCSSは、default.cssとしてthemeディレクトリに再録されています。
+
+#### tdiary.confのフォーマットが少し変更になっています。
+
+1.1以前のtDiaryから移行する場合には、以下の2行をtdiary.confの末尾に追加する必要があります。これを加えないと後述する対話式の設定変更機能が使えません。
+
+```
+@secure = false 
+load_cgi_conf 
+```
+
+#### ヘッダやフッタにeRuby書式を許可したのに伴い、カレンダーの挿入位置を自由にできるようにしました。
+
+このため、デフォルトではカレンダーは表示されません。従来のヘッダ(@header)、もしくはフッタ(@footer)に、「<%=calendar%>」という文字列を挿入して下さい。
+
+#### CGIによる対話式設定が可能になりました。
+
+従来tdiary.confで設定していた変数の多くはCGI経由で設定できます。しかし、いくつかの変数を除いて、一度CGI上で設定を変更してしまうと旧来のtdiary.confよりも優先されてしまいます。tdiary.conf.sampleにそのあたりの説明があるので、良く読んでください。
+
+### 1.0から1.2への主な変更点
+
+  1. CSSを使ったテーマに対応
+  2. ヘッダ(@header)とフッタ(@footer)にeRuby書式の記述が可能になった
+  3. カレンダーの挿入位置をヘッダとフッタ内で自由に指定可能になった
+  4. @multi_userで簡易マルチユーザモードを設定可能になった
+  5. @date_formatで、日付の表示形式をカスタマイズ可能になった
+  6. ブラウザ上で設定の変更ができるようになった
+  7. 用語の変更(Referer→リンク元、段落→セクション) 
+  8. 新しいツッコミを入れやすいようにリンクを追加
+  9. 設定以上のツッコミがある場合に「More...」を表示
+ 10. mod_ruby対応
+ 11. 携帯端末の対応を拡充(各社携帯電話、ザウルス、Windows CE機) 
+ 12. *.rbをCGIとして設定できないサーバ上への設置に対応(@index、@update)
+ 13. 任意のツッコミを非表示にできるようになった
+ 14. ドキュメントの充実
+ 15. 多数のバグFIX