## 訳注：このドキュメントは、wikieditishプラグインのreadmeを一部翻訳したものです。
## readmeは、wikieditishプラグイン中にスクリプトの一部として記述されています。
## blosxom start kitを使っている場合、ここに登場する設定値のいくつかはconfig.cgiで設定します(多分)。

## 2005-04-10

NAME

Blosxom Plug-in: wikieditish

概要

ブラウザの中から、Wikiスタイルでブログを編集できる。

クイックスタート

このwikieditish plug-inファイルをplug-inディレクトリに保存する。
(blosxom.cgiの$plugin_dirで設定した場所になる)

あなたがパスワードをセットするかパスワード設定をオフにするまで、Wikieditishは何もしない（行儀が良いプラグインなのです）。
($require_password = 0 にセットします)

この配布ファイルに含まれるflavoursフォルダのコンテンツをblosxomのデータディレクトリに移動する。
(blosxom.cgiの$datadirで設定した場所になる)

フォルダ自体を移動しないこと！ フォルダ内のファイルだけを移動する。
もしもサンプルflavourが手元にない場合は、次からダウンロードできる。

http://www.raelity.org/apps/blosxom/downloads/plugins/wikieditish.zip
##訳注：オリジナルのWikieditishを展開すると、*.wikieditishというflavourファイルが展開される。bloxsom start kitには、これがentriesディテクトリに展開されている。

あなたのブラウザで、Blosxomのエントリのどれかをwikieditish flavourを使って表示させる。
(例, http://localhost/cgi-bin/blosxom.cgi/path/to/a/post.wikieditish)

エントリを編集し、パスワードを入力する(デフォルトでは必要)。それから、Saveボタンをクリックして変更を保存する。

パスやファイル名を指定するだけで、新しいエントリを簡単に作ることができる(例 http://localhost/cgi-bin/blosxom.cgi/foo/bar.wikieditish)。エントリーページにタイトル(title)と本文(body)を入力し、パスワードを設定して(デフォルトで要)、Saveボタンをクリックする。wikieditish plug-inは、指定されたパスとファイル名でエントリーを生成する。
##訳注：fooフォルダにbarファイルが作られる

Enjoy!

サンプル FLAVOUR テンプレート

あなたの学習を手助けするよう、サンプルFLAVOUR テンプレートを用意してある。
次のHTMLファイルを参照して欲しい。

• head.wikieditish、 基本headテンプレート -- 特別なところはない
• story.wikieditish、基本storyテンプレート -- 特別なところはない
• foot.wikieditish、基本footテンプレートは、他と少しだけ違っている。
  一番の違いは、エントリーを編集したり新しいエントリーを作成するための"edit this blog"フォームを持っていること

NOTE: wikieditish plug-inには、valueに"wikieditish"をセットした、pluginフォームが必要になる。これは、ほかのプラグインからデータを送信(POSTing)するときのハンドルになる。

WIKIEDITISHのFLAVOURについて

あなたの必要とする機能が、テンプレートファイルやサンプルのfoot.wikieditishになくて自分で作る場合は、次の機能を入れておくこと。

「$wikieditish::title」と「$wikieditish::body」を、 エントリーファイルに含める。あなたがcookie plug-inをインストールして動作させている場合には、「$wikieditish::password」で、パスワードの入力欄を表示し、その値を'wikieditish' cookieに保存する。

みんなで書くには

wikieditish plug-inは、2つも役割を持っている。1つは、あなたのblogでブラウザベースのエディタを使えるようにすること。もう一つは、パスワードを共有して(あるいはパスワードなしで、本当にwikiっぽく)wikiスタイルのコミュニティblogを提供すること。

みんなに記事を書いてもらうには、各エントリーに、次のタグで"Edit"ボタンを追加する。

<a href="$url$path/$fn.wikieditish">edit this blog</a>

インストール

plug-inディレクトリに、wikieditishファイルをコピーする
($blosxom::plugin_dir)

設定

エントリーの最終変更日時を記録するには

wikieditish plug-inは、あなたがエントリーを最後に編集した日時を記録できる。この機能を使うと、編集したエントリーをblogのトップに表示できることになる。この機能を使うには(デフォルトではオフ)、$preserve_lastmodified の設定値を1につする。

パスワードによる制限

By default, the wikieditish plug-in requires a password. You'll need to set one before being able to edit anything. Set the $blog_password configuration variable to anything you wish (e.g. my $blog_password = 'abc123';). Just be sure to use something you'll remember and other's won't guess.

You can disable password-protection if you wish, allowing passers-by to contribute to your blog, Wiki-style. Be sure this is something you want to do. It has some possible security implications, anyone being able to write to your server's hard drive, post to your public-facing blog, and edit (read: alter, spindle, contort) any blog postings. Those warning's out of the way, to turn off password-protection, set $require_password to 0.

IPによる制限

You can alternatively decide to restrict editing to a particular IP address or addresses -- those in your office, for example, or the machine actually running Blosxom (127.0.0.1).

To do so, set $restrict_by_ip to 1 (it's off, or 0, by default), and populate the @ips array with a list of approved IP addresses. By default, this is set to "this machine", the machine running Blosxom; shorthand for "this machine" in IP-speak is 127.0.0.1. The following example restricts editing to those coming from three IPs, including 127.0.0.1:

# Should editing this blog be restricted to a particular set of IPs?
# 0 = no (default), 1 = yes
$restrict_by_ip = 1;

# To what IPs should editing this blog be restricted?
@ips = qw/ 127.0.0.1 10.0.0.3 140.101.22.10/;

Of course, you can use a combination of password-protection and IP restriction if you so wish.

VERSION

2003-05-29
Version number is the date on which this version of the plug-in was created.

AUTHOR

Rael Dornfest , http://www.raelity.org/

その他

The wikieditish plug-in plays nicely with the wikiwordish plug-in [http://www.raelity.org/apps/blosxom/plugins/text/wikiwordish.individual] for wiki-style linking action. And for wiki-style markup, be sure to try the textile [http://www.raelity.org/apps/blosxom/plugins/text/textile.individual] or tiki [http://www.raelity.org/apps/blosxom/plugins/text/tiki.individual] plug-ins.

Blosxom Home/Docs/Licensing: http://www.raelity.org/apps/blosxom/

Blosxom Plugin Docs: http://www.raelity.org/apps/blosxom/plugin.shtml

バグ

Address bug reports and comments to the Blosxom mailing list [http://www.yahoogroups.com/group/blosxom].

LICENSE

Blosxom and this Blosxom Plug-in
Copyright 2003, Rael Dornfest

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.