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