README.en.txt

   1 NOTE: This document become old, needs help
   2 (2004-08-28)
   3 ----------------------------------------------
   4 NAME
   5
   6     PukiWiki - PHP scripts for Web pages which can be edited by anyone,
   7                at any time, from anywhere.
   8
   9         PukiWiki 1.4.6_alpha
  10         Copyright (C)
  11           2001-2005 PukiWiki Developers Team
  12           2001-2002 yu-ji (Based on PukiWiki 1.3 by yu-ji)
  13         License: GPL version 2 or (at your option) any later version
  14         http://pukiwiki.org/
  15
  16 SYNOPSIS
  17
  18         http://pukiwiki.org/
  19
  20 DESCRIPTION
  21
  22     PukiWiki consists of a series of PHP Scripts designed to build
  23     a collection of web pages which can be edited by anyone without any restriction.
  24     Pukiwiki is more flexible than moderate bulletinboards.
  25     Since it ,basically, enables everyone change the design and content of any
  26     page, while you can only leave messages in bulletinboards.
  27
  28     PukiWiki is a unique Wiki-Engine which is based on the YukiWiki specification
  29      created by Mr. Hiroshi Yuki.
  30     Mr. yu-ji continued its development until the release of PukiWiki 1.3, and
  31     PukiWiki Developers Team inherited the development from him after 1.3.1b.
  32
  33     PukiWiki is written in PHP, so it's relatively easy to install
  34     on a web server which supports PHP.
  35
  36     PukiWiki is distributed under GPL. Thus it is, so to speak, a  Free Software!
  37
  38 REQUIREMENTS
  39
  40     PukiWiki is only written in PHP, so it needs a PHP environment.
  41     PHP4.1 or later versions are recommended.
  42
  43     To use the multibyte features, PHP with multibyte extensions is needed.
  44
  45 HOW TO MAKE SITE
  46
  47     1. Download a PukiWiki package.
  48        The latest package can be obtained from http://pukiwiki.org/.
  49
  50     2. Extract the package on a local system or a target system.
  51         The default name for the root directory of the system is "pukiwiki".
  52         You may change it to another name if necessary.
  53
  54     3. Edit pukiwiki.ini.php to make it fit to your environment.
  55         Common setting                 : pukiwiki.ini.php
  56         Settings for each agent:
  57           I-MODE(NTT),AirH"(DDIPocket) : i_mode.ini.php
  58           J-PHONE                      : jphone.ini.php
  59           Default( any other above )   : default.ini.php
  60         String replace setting         : rules.ini.php
  61
  62     4. Change the file permission as follows
  63           Directory      Permission     (more secure (*1))
  64              attach        777               707
  65              backup        777               707
  66              cache         777               707
  67              counter       777               707
  68              diff          777               707
  69              face          755               705
  70              image         755               705
  71              plugin        755               705
  72              skin          755               705
  73              trackback     777               707
  74              wiki          777               707
  75           File
  76              attach/*      666               606
  77              backup/*      666               606
  78              cache/*       666               606
  79              diff/*        666               606
  80              face/*        644               604
  81              image/*       644               604
  82              plugin/*      644               604
  83              skin/*        644               604
  84              trackback/*   666               606
  85              wiki/*        666               606
  86              *.php         644               604
  87              *.lng         644               604
  88              *.txt         644               604
  89
  90     5.  Now you are ready to access the site !
  91          Please point your browser to:
  92            http://[your domain]/[pukiwiki dir]/pukiwiki.php
  93
  94 HOW TO MAKE A BACKUP OF DATA
  95
  96     The document data is stored in the "wiki" directory. (default setting)
  97     Please make a backup of your "wiki" directory.
  98     And, if necessary, also make backups of the other directories - namely,
  99     "attach" , "backup", "counter", "cache", "diff" and "trackback" with default setting.
 100
 101 HOW TO CREATE PAGE
 102
 103     1.  Click on ''New'' menu ( at the top of a page) or ''new icon '' (at the
 104         bottom of a page), then a page displaying an input box will  open.
 105         Please input whatever name you like for the new page and push the
 106         button, then the new page will be created in edit mode.
 107     2.  Every time you write a WikiName, which includes at least two capitalized
 108         letters in a word, or BracketName enclosing on a page, the question
 109         mark, "?", appears at the tail of the written word. If you click the
 110         mark, a new page with an editable textfield is displayed, and you can
 111         modify the page as you usually edit a page.
 112
 113 RULES FOR TEXT FORMATTING
 114
 115     Refer to [[Text Formatting Rule]] page.
 116
 117 INTERWIKI
 118
 119     The InterWiki feature is supported from version 1.11 on.
 120     InterWiki originally meant the function that established links among Wiki Sites.
 121     The present InterWiki can connect any web site to strings. This expanded feature
 122     is very convenient even though it is now a conceptually different function.
 123     This function is ported nearly completely from Tiki.
 124
 125     Please refer to [[InterWikiTechnical]] page for details.
 126
 127 RDF/RSS
 128
 129     Since version 1.2.1, the function to create RDF/RSS from RecentChanges
 130     has been supported.
 131     Since version 1.4.5, RSS 2.0 has been supported.
 132
 133     * Output example:
 134       RSS 0.91 http://path/to/pukiwiki/index.php?plugin=rss
 135       RSS 1.0  http://path/to/pukiwiki/index.php?plugin=rss&ver=1.0
 136       RSS 2.0  http://path/to/pukiwiki/index.php?plugin=rss&ver=2.0
 137
 138 TODO
 139
 140     http://pukiwiki.sourceforge.jp/dev/?BugTrack
 141
 142 AUTHOR
 143
 144     PukiWiki Developers Team http://pukiwiki.sourceforge.jp/dev/
 145     Based on "PukiWiki" 1.3 by yu-ji
 146
 147     Please send questions, opinions and bug reports to http://pukiwiki.org/
 148
 149 LICENCE
 150
 151     PukiWiki is distributed under GNU GPL/2 (GNU General Public License) .
 152      (http://www.gnu.org)
 153
 154 ACKNOWLEDGEMENT
 155
 156     First of all, thanks so much to the users of PukiWiki and the members of
 157     PukiWiki Developers Team.
 158     Special thanks to Mr. yu-ji(aka sng) who developed the first PukiWiki.
 159     And also thanks to Mr. Hiroshi Yuki who was willing to accept our cloning
 160     YukiWiki and
 161     Cunningham & Cunningham, Inc. who created the original WikiWikiWeb.
 162
 163 REFERENCE
 164
 165     * PukiWiki Web Site         http://pukiwiki.org/
 166     * PukiWiki Developer's Site http://pukiwiki.sourceforge.jp/dev/
 167     * yu-ji's Web Site          http://factage.com/yu-ji/
 168     * Hiroshi Yuki 's Web Site  http://www.hyuki.com/
 169     * YukiWiki                  http://www.hyuki.com/yukiwiki/
 170     * Tiki                      http://todo.org/cgi-bin/jp/tiki.cgi
 171     * Original WikiWikiWeb      http://c2.com/cgi/wiki?WikiWikiWeb
 172     * Author of WikiWikiWeb(Cunningham & Cunningham, Inc.) http://c2.com/