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