/[pub]/suikawiki/script/readme.txt
Suika

Contents of /suikawiki/script/readme.txt

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1.2 - (show annotations) (download)
Wed Jan 1 01:29:04 2003 UTC (21 years, 4 months ago) by w
Branch: MAIN
CVS Tags: HEAD
Changes since 1.1: +0 -0 lines
File MIME type: text/plain
FILE REMOVED
Obsoleted YukiWiki/WalWiki files are removed.

1 NAME
2 YukiWiki - 自由にページを追加・削除・編集できるWebページ構築CGI
3
4 Copyright (C) 2000,2001 by Hiroshi Yuki.
5 結城浩 <hyuki@hyuki.com>
6 http://www.hyuki.com/
7 http://www.hyuki.com/yukiwiki/
8
9 SYNOPSIS
10 http://www.hyuki.com/yukiwiki/yukiwiki.cgi
11
12 DESCRIPTION
13 YukiWiki(結城ウィキィ)は参加者が自由にページを追加・削除・編集できる
14 不思議なWebページ群を作るCGIです。
15 Webで動作する掲示板とちょっと似ていますが、
16 Web掲示板が単にメッセージを追加するだけなのに対して、
17 YukiWikiは、Webページ全体を自由に変更することができます。
18
19 YukiWikiは、Cunningham & CunninghamのWikiWikiWebの
20 仕様を参考にして独自に作られました。
21
22 YukiWikiはPerlで書かれたCGIスクリプトとして実現されていますので、
23 Perlが動作するWebサーバならば比較的容易に設置できます。
24
25 あとはdbmopenが使える環境ならば設置できます(Version
26 1.5.0以降ならdbmopenが使えなくても設置できます)。
27
28 YukiWikiはフリーソフトです。 ご自由にお使いください。
29
30 設置方法
31 入手
32
33 YukiWikiの最新版は、 http://www.hyuki.com/yukiwiki/ から入手できます。
34
35 ファイル一覧
36
37 readme.txt ドキュメント
38 yukiwiki.cgi YukiWiki本体
39 yukiwiki.gif ロゴ(カラー版)
40 yukimono.gif ロゴ(モノクロ版)
41 jcode.pl 漢字コードライブラリ
42
43 インストール
44
45 1. アーカイブを解く。
46
47 2. yukiwiki.cgiのはじめの方にある設定を確認します。
48 通常は何もしなくてよいが、
49 はじめは$touchfileを''にした方がよいでしょう。
50
51 3. yukiwiki.cgiとjcode.plを同じところに設置します。
52
53 4. サイズ0のyukiwiki.dbというファイルを設置します。
54 (Perlシステムによってはyukiwiki.pag, yukiwiki.dir)
55
56 5. yukiwiki.cgiにブラウザからアクセスします。
57
58 パーミッション
59
60 ファイル パーミッション 転送モード
61 yukiwiki.cgi 755 ASCII
62 yukiwiki.gif 644 BINARY
63 yukimono.gif 644 BINARY
64 jcode.pl 644 ASCII
65
66 $dbmopen = 1; にした場合:
67 yukiwiki.db 666 BINARY
68 (yukiwiki.pag, yukiwiki.dirの場合もあり)
69
70 $dbmopen = 0; にした場合: (カレントディレクトリを777にしておく)
71 . 777 (転送しない)
72
73 データのバックアップ方法
74 $dbmopen = 1;の場合は、 データはすべてyukiwiki.db(.dir, .pag)に入る。
75 これをバックアップすればよい。
76
77 $dbmopen = 0;の場合は、 yukiwikiというディレクトリができるので、
78 これ以下をバックアップすればよい。
79
80 新しいページの作り方
81 1. まず、適当なページ(例えばFrontPage)を選び、
82 ページの下にある「編集」リンクをたどります。
83
84 2. するとテキスト入力ができる状態になるので、 そこにNewPageのような単語
85 (大文字小文字混在している英文字列) を書いて「保存」します。
86
87 3. 保存すると、FrontPageのページが書き換わり、
88 あなたが書いたNewPageという文字列の後ろに ?
89 というリンクが表示されます。 この ?
90 はそのページがまだ存在しないことを示す印です。
91
92 4. その ? をクリックすると新しいページNewPageができますので、
93 あなたの好きな文章をその新しいページに書いて保存します。
94
95 5. NewPageページができるとFrontPageの ? は消えて、リンクとなります。
96
97 テキスト整形のルール
98 * 連続した複数行はフィルされて表示されます。
99
100 * 空行は段落`<p>'の区切りとなります。
101
102 * HTMLのタグは書けません。
103
104 * ''ボールド''のようにシングルクォート二つではさむと、
105 ボールド`<b>'になります。
106
107 * '''イタリック'''のようにシングルクォート三つではさむと、
108 イタリック`<i>'になります。
109
110 * ----のようにマイナス4つがあると、 水平線`<hr>'になります。
111
112 * 行を*ではじめると、 大見出し`<h2>'になります。
113
114 * 行を**ではじめると、 小見出し`<h3>'になります。
115
116 * 行をマイナス-ではじめると、 箇条書き`<ul>'になります。
117 マイナスの数が増えるとレベルが下がります(3レベルまで)
118
119 -項目1
120 --項目1-1
121 --項目1-2
122 -項目2
123 -項目3
124 --項目3-1
125 ---項目3-1-1
126 ---項目3-1-2
127 --項目3-2
128
129 * コロンを使うと、 用語と解説文のリスト`<dl>'が書けます。
130
131 :用語1:いろいろ書いた解説文1
132 :用語2:いろいろ書いた解説文2
133 :用語3:いろいろ書いた解説文3
134
135 * リンク
136
137 * LinkToSomePageやFrontPageのように、
138 英単語の最初の一文字を大文字にしたものが
139 二つ以上連続したものはYukiWikiのページ名となり、
140 それが文章中に含まれるとリンクになります。
141
142 * http://www.hyuki.com/ のようなURLは自動的にリンクになります。
143
144 * 二重の大かっこ[[ ]]でくくった文字列も、
145 YukiWikiのページ名になります。
146 大かっこの中にはスペースを含めてはいけません。
147 日本語も使えます。
148
149 * 行頭がスペースやタブで始まっていると、
150 それは整形済みの段落`<pre>'として扱われます。
151 プログラムの表示などに使うと便利です。
152
153 * 行を > ではじめると、 引用文`<blockquote>'が書けます。
154 >の数が多いとインデントが深くなります(3レベルまで)。
155
156 >文章
157 >文章
158 >>さらなる引用
159 >文章
160
161 更新履歴
162 * 2001年10月20日、Version 1.6.6。
163
164 更新の衝突対策。 元ページの簡単なチェックサムを取っておき、
165 更新前にチェックサムを比較する。
166 修正個所はdigestという文字列を検索すれば分かる。
167 本来はMD5などでちゃんとやった方がいいのだけれど。
168
169 衝突時に表示されるメッセージなどは「極悪」さんのページを参考にした。
170
171 * 2001年10月17日、Version 1.6.5。
172
173 プレビュー画面で、更新ボタンを押したときに送信される
174 メッセージの内容をinput要素のtype="hidden"を使って埋め込むのをやめる
175 。 代わりに、textarea要素を使う。
176 再プレビュー用にmyspecial_を導入。でもきれいな対策ではない。
177
178 * 2001年8月30日、Version 1.6.4。
179
180 URLでダイレクトにページ名を指定しても、
181 $WikiNameと$BracketName以外のページを作れないようにした。
182 (is_valid_nameとis_editable参照)。
183
184 * 2001年8月30日、Version 1.6.3。
185
186 RecentChangesを編集・再編集不可とした。
187 編集不可ページは@uneditableにページ名を入れる。
188
189 * 2001年2月25日、Version 1.6.1, 1.6.2。
190
191 差分機能のバグ修正。 do_previewで'>'が扱えないバグを修正
192 (ユーザからの指摘)。
193
194 * 2001年2月22日、Version 1.6.0。 差分機能を実装した。
195
196 * 2001年2月19日、Version 1.5.4。
197 画像ファイルへのリンクは画像にしてみた。
198
199 * 2001年2月19日、Version 1.5.3。
200 RecentChangesの中に削除したページがあるのをやめた。 use
201 strict;で引っかかる部分を少し整理(完全ではない)。
202
203 * 2001年2月16日、Version 1.5.2。
204 textareaに表示およびプレビューする前に < や > を &lt; や &gt;
205 に変換した (do_preview, editpage, print_preview_buttons)。
206
207 * 2000年12月27日、Version 1.5.1。 プレビュー画面を整理した。
208
209 * 2000年12月22日、Version 1.5.0。 全体的にずいぶん書き直した。
210 一覧を別途作成するようにした(do_list)。
211 書き込む前に確認画面を出すようにした(do_preview)。
212 テキストの書き方を編集画面に入れた(do_edit, do_reedit)。
213 WhatsNew→RecentChanges、TopPage→FrontPageに変更した。
214
215 * 2000年12月20日、Version 1.1.0。
216 tieを利用して、dbmopenが使えない場合でも動作するように修正。
217 利用者の1人である「極悪」さんから
218 送っていただいたコードを元にしています。
219
220 * 2000年9月5日、Version 1.0.2。 <body color=...> → <body bgcolor=...>
221 利用者からの指摘による。感謝。
222
223 * 2000年8月6日、Version 1.0.1を公開。 C
224 MAGAZINE(ソフトバンクパブリッシング)
225 2000年10月号連載記事向け公開版。 [[ ]]
226 の最後が「望」のようにシフトJISで 0x5Dになる場合の回避を行なった。
227
228 * 2000年8月5日、Version 1.0.0を公開。
229
230 * 2000年7月23日、Version 0.82を公開。 編集時のリンクミス。
231 <textarea>の属性変更。
232
233 * 2000年7月22日、Version 0.81を公開。 ロゴを組み込む。
234
235 * 2000年7月21日、Version 0.80を公開。 PODをCGI中に書き込む。
236
237 * 2000年7月19日、Version 0.70を公開。
238 '''イタリック'''や、--、---、>>、>>>などを実装。
239
240 * 2000年7月18日、Version 0.60を公開。 *太字*を''太字''に変更
241
242 * 2000年7月17日、Version 0.50を公開。
243
244 * 2000年7月17日、さらにいろいろ追加する。
245
246 * 2000年7月16日、いろいろ追加。
247
248 * 2000年7月15日、公開。
249
250 TODO
251 - テキスト表示モード
252 - Charsetを明示。
253 - textarea中の閉じタグ対応
254 - メニューの英語表記付記
255 - プレビューのボタンで、mymsgをinputのvalueに入れているが、改行をそのままvalueにいれてはいけないのではないか。
256 - 「再編集」の機能はブラウザの back で充分ではないか。プレビューはもっとシンプルに。
257 - ページタイトル(Wikiname)が検索にかかるようにする。
258 - InterWiki風の機能「URLを隠しつつ、リンクを張る」
259
260 作者
261 Copyright (C) 2000 by Hiroshi Yuki.
262 結城浩 <hyuki@hyuki.com>
263 http://www.hyuki.com/
264 http://www.hyuki.com/yukiwiki/
265
266 質問、意見、バグ報告は hyuki@hyuki.com にメールしてください。
267
268 配布条件
269 YukiWikiは、 GNU General Public Licenseにて公開します。
270
271 YukiWikiはフリーソフトです。 ご自由にお使いください。
272 自分好みのYukiWikiが作れるようにシンプルにしてあります。
273
274 謝辞
275 本家のWikiWikiを作ったCunningham & Cunningham, Inc.に 感謝します。
276
277 YukiWikiを楽しんで使ってくださる ネット上の方々に感謝します。
278
279 YukiWikiのロゴをデザインしてくださった橋本礼奈さん
280 http://city.hokkai.or.jp/~reina/ に感謝します。
281
282 tieを使った版の元になるコードを送ってくださった
283 「極悪」さんに感謝します。
284
285 参照リンク
286 * YukiWikiホームページ http://www.hyuki.com/yukiwiki/
287
288 * 本家のWikiWiki http://c2.com/cgi/wiki?WikiWikiWeb
289
290 * 本家のWikiWikiの作者(Cunningham & Cunningham, Inc.) http://c2.com/
291
292 * YukiWikiのロゴデザインをしてくださった橋本礼奈さんのページ
293 http://city.hokkai.or.jp/~reina/
294

admin@suikawiki.org
ViewVC Help
Powered by ViewVC 1.1.24