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.2
  10         Copyright
  11           2001-2018 PukiWiki Developement 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.osdn.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 Development 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        https://osdn.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              wiki          777               707
  71           File
  72              attach/*      666               606
  73              backup/*      666               606
  74              cache/*       666               606
  75              diff/*        666               606
  76              face/*        644               604
  77              image/*       644               604
  78              plugin/*      644               604
  79              skin/*        644               604
  80              wiki/*        666               606
  81              *.php         644               604
  82              *.lng         644               604
  83              *.txt         644               604
  84
  85     5.  Now you are ready to access the site !
  86          Please point your browser to:
  87            http://[your domain]/[pukiwiki dir]/pukiwiki.php
  88
  89 HOW TO MAKE A BACKUP OF DATA
  90
  91     The document data is stored in the "wiki" directory. (default setting)
  92     Please make a backup of your "wiki" directory.
  93     And, if necessary, also make backups of the other directories - namely,
  94     "attach" , "backup", "counter", "cache", and "diff" with default setting.
  95
  96 HOW TO CREATE PAGE
  97
  98     1.  Click on ''New'' menu ( at the top of a page) or ''new icon '' (at the
  99         bottom of a page), then a page displaying an input box will  open.
 100         Please input whatever name you like for the new page and push the
 101         button, then the new page will be created in edit mode.
 102     2.  Every time you write a WikiName, which includes at least two capitalized
 103         letters in a word, or BracketName enclosing on a page, the question
 104         mark, "?", appears at the tail of the written word. If you click the
 105         mark, a new page with an editable textfield is displayed, and you can
 106         modify the page as you usually edit a page.
 107
 108 RULES FOR TEXT FORMATTING
 109
 110     Refer to [[Text Formatting Rule]] page.
 111
 112 INTERWIKI
 113
 114     The InterWiki feature is supported from version 1.11 on.
 115     InterWiki originally meant the function that established links among Wiki Sites.
 116     The present InterWiki can connect any web site to strings. This expanded feature
 117     is very convenient even though it is now a conceptually different function.
 118     This function is ported nearly completely from Tiki.
 119
 120     Please refer to [[InterWikiTechnical]] page for details.
 121
 122 RDF/RSS
 123
 124     Since version 1.2.1, the function to create RDF/RSS from RecentChanges
 125     has been supported.
 126     Since version 1.4.5, RSS 2.0 has been supported.
 127
 128     * Output example:
 129       RSS 0.91 http://path/to/pukiwiki/index.php?plugin=rss
 130       RSS 1.0  http://path/to/pukiwiki/index.php?plugin=rss&ver=1.0
 131       RSS 2.0  http://path/to/pukiwiki/index.php?plugin=rss&ver=2.0
 132
 133 TODO
 134
 135     http://pukiwiki.osdn.jp/dev/?BugTrack
 136
 137 AUTHOR
 138
 139     PukiWiki Development Team http://pukiwiki.osdn.jp/dev/
 140     Based on "PukiWiki" 1.3 by yu-ji
 141
 142     Please send questions, opinions and bug reports to
 143     http://pukiwiki.osdn.jp/dev/
 144
 145 LICENCE
 146
 147     PukiWiki is distributed under GNU GPL/2 (GNU General Public License) .
 148      (http://www.gnu.org)
 149
 150 ACKNOWLEDGEMENT
 151
 152     First of all, thanks so much to the users of PukiWiki and the members of
 153     PukiWiki Development Team.
 154     Special thanks to Mr. yu-ji(aka sng) who developed the first PukiWiki.
 155     And also thanks to Mr. Hiroshi Yuki who was willing to accept our cloning
 156     YukiWiki and
 157     Cunningham & Cunningham, Inc. who created the original WikiWikiWeb.
 158
 159 REFERENCE
 160
 161     * PukiWiki Web Site         http://pukiwiki.osdn.jp/
 162     * PukiWiki Developers' Site http://pukiwiki.osdn.jp/dev/
 163     * yu-ji's Web Site          http://factage.com/yu-ji/
 164     * Hiroshi Yuki 's Web Site  http://www.hyuki.com/
 165     * YukiWiki                  http://www.hyuki.com/yukiwiki/
 166     * Tiki                      http://todo.org/cgi-bin/jp/tiki.cgi
 167     * Original WikiWikiWeb      http://c2.com/cgi/wiki?WikiWikiWeb
 168     * Author of WikiWikiWeb(Cunningham & Cunningham, Inc.) http://c2.com/