pgsrc/PhpWikiAdministration

   1 Date: Mon, 16 Jun 2008 14:15:24 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=PhpWikiAdministration;
   6   flags=PAGE_LOCKED;
   7   markup=2;
   8   charset=iso-8859-1
   9 Content-Transfer-Encoding: binary
  10
  11 _*Note:*_  _Most of the actions on this page require administrative
  12 privileges. They will not work unless you have set an admin username and
  13 password in the [PhpWiki|PhpWiki:PhpWiki] config file._
  14
  15 <?plugin CreateToc jshide||=0 with_toclink||=1 liststyle=ul?>
  16
  17 ----
  18 !!! Page Explorer
  19
  20 First select pages and then define the action:
  21
  22 <?plugin-form WikiAdminSelect s="*" ?>
  23
  24 or call the available ~WikiAdmin actions directly:
  25
  26 [/Remove] |
  27   [/Rename] |
  28     [/Replace] |
  29       [/SetAcl] |
  30         [/Chmod] |
  31           [/Chown]
  32
  33 ----
  34 !!! User Management
  35
  36 Reset a users password:
  37
  38   <?plugin-form PasswordReset textinput=user method=post ?>
  39
  40 Email Verification:
  41
  42   This is currently non-strict, leaving some possible holes in not being able to
  43   connect to certain mail hosts, which can be overridden below. See PhpWiki:EmailVerification
  44
  45   This button will show a list of all users with registered emails and buttons to set the
  46   verification status manually.
  47
  48   <?plugin WikiAdminUtils
  49            action=email-verification
  50            label="Email Verification"
  51    ?>
  52
  53 Access Restrictions (disabled):
  54
  55   To prevent from robots eating all possible ressources in a short time, blocking from certain IPs
  56   or not-well-behaving user agents can be defined below. See PhpWiki:HowToBlockRobots and
  57   MeatBall:SurgeProtector. _Note: Not yet enabled._
  58
  59   <?plugin WikiAdminUtils
  60            action=access-restrictions
  61            label="Access Restrictions"
  62    ?>
  63
  64 ----
  65 !!! Cleanup
  66
  67 A Wiki SandBox is very easy to clean. Here you can restore it to
  68 pristine condition by loading the default from pgsrc.
  69
  70   [Rake the SandBox|phpwiki:?action=loadfile&source=pgsrc/SandBox].
  71
  72 ----------
  73
  74 !!! Making Snapshots or Backups
  75
  76 !! ZIP files of database
  77
  78 These links lead to zip files, generated on the fly, which contain all
  79 the pages in your Wiki. The zip file will be downloaded to your local
  80 computer.
  81
  82   This *[ZIP Snapshot | phpwiki:?action=zip]* contains only the
  83   latest versions of each page, while this *[ZIP Dump |
  84   phpwiki:?action=zip&include=all]* contains all archived versions.
  85
  86   (If the [PhpWiki|PhpWiki:PhpWiki] is configured to allow it, anyone can download a zip
  87   file.)
  88
  89 If your php has _zlib_ support, the files in the archive will be
  90 compressed, otherwise they will just be stored.
  91
  92 !! Dump to directory
  93
  94 Here you can dump pages of your Wiki into a directory of your choice.
  95
  96   <?plugin WikiForm action=dumpserial?>
  97
  98 The most recent version of each page will written out to the
  99 directory, one page per file. Your server must have write permissions
 100 to the directory!
 101
 102 -----------
 103 !!! Restoring
 104
 105 If you have dumped a set of pages from [PhpWiki|PhpWiki:PhpWiki], you can reload them
 106 here. Note that pages in your database will be overwritten; thus, if
 107 you dumped your HomePage when you load it from this form it will
 108 overwrite the one in your database now. If you want to be selective
 109 just delete the pages from the directory (or zip file) which you don't
 110 want to load.
 111
 112 !! Upload File
 113
 114 Here you can upload ZIP archives, or individual files from your
 115 (client) machine.
 116
 117   <?plugin WikiForm action=upload?>
 118
 119 !! Load File
 120
 121 Here you can load ZIP archives, individual files or entire
 122 directories. The file or directory must be local to the http
 123 server. You can also use this form to load from an http: or ftp: URL.
 124
 125   <?plugin WikiForm action=loadfile?>
 126   <?plugin WikiForm action=loadfile buttontext="Load & Overwrite" overwrite=1?>
 127
 128 !! Upgrade
 129
 130 Do some verification checks and upgrade changes automatically, after having installed a
 131 new phpwiki engine update:
 132 * Upgrade new or changed page revisions from pgsrc,
 133 * Upgrade the database schema (mysql _page.id auto_increment_, ADD _session.sess_ip_),
 134
 135 ;:[ Upgrade | phpwiki:HomePage?action=upgrade ]
 136
 137 -----------
 138
 139 !!! Format of the files
 140
 141 Currently the pages are stored, one per file, as MIME (RFC:2045)
 142 e-mail (RFC:822) messages. The content-type _application/x-phpwiki_
 143 is used, and page meta-data is encoded in the content-type
 144 parameters. (If the file contains several versions of a page, it will
 145 have type _multipart/mixed_, and contain several sub-parts, each
 146 with type _application/x-phpwiki_.)  The message body contains the
 147 page text.
 148
 149 !! Old Formats
 150
 151 *Serialized Files*
 152
 153   The dump to directory command used to dump the pages as PHP
 154   _serialized()_ strings. For humans, this made the files very hard
 155   to read, and nearly impossible to edit.
 156
 157 *Plain Files*
 158
 159   Before that the page text was just dumped to a file--this means that
 160   all page meta-data was lost. Note that when loading _plain files_,
 161   the page name is deduced from the file name.
 162
 163 The upload and load functions will automatically recognize each of
 164 these three types of files, and handle them accordingly.
 165
 166 ----
 167
 168 !!! Dump pages as XHTML
 169
 170   <?plugin WikiForm action=dumphtml?>
 171
 172 This will generate a directory of static pages suitable for
 173 distribution on disk where no web server is available. The various
 174 links for page editing functions and navigation are removed from the
 175 pages.
 176
 177   The XHTML file collection can also be downloaded as an
 178   *[XHTML ZIP Snapshot | phpwiki:?action=ziphtml]*.
 179
 180 ----
 181
 182 !!! Phpwiki Internals
 183
 184 These are here mostly for debugging purposes (at least, that is the
 185 hope.)
 186
 187 In normal use, you should not need to use these, though, then again,
 188 they should not really do any harm.
 189
 190 Purge Markup Cache:
 191
 192 (If your wiki is so configured,) the transformed (almost-HTML) content
 193 of the most recent version of each page is cached. This speeds up page
 194 rendering since parsing of the wiki-text takes a fair amount of juice.
 195
 196   Hitting this button will delete all cached transformed
 197   content. (Each pages content will be transformed and re-cached next
 198   time someone views it.)
 199
 200   <?plugin WikiAdminUtils
 201            action=purge-cache
 202            label="Purge Markup Cache"
 203    ?>
 204
 205 Clean WikiDB of Illegal Filenames:
 206
 207 Page names beginning with the subpage-separator, usually a slash
 208 (=/=), are not allowed. Sometimes though an errant plugin or something
 209 might create one....
 210
 211   This button will delete any pages with illegal page names, without possibility to restore.
 212
 213   <?plugin WikiAdminUtils
 214            action=purge-bad-pagenames
 215            label="Purge bad pagenames"
 216    ?>
 217
 218 Clean WikiDB of empty and unreferenced pages:
 219
 220   *Warning!* This button will delete every empty and unreferenced page, without any possibility to restore them again.
 221   This will disable the possibility to revert or get back any deleted page.
 222
 223   <?plugin WikiAdminUtils
 224            action=purge-empty-pages
 225            label="Purge all empty unreferenced pages"
 226    ?>
 227
 228 Convert cached_html to new SQL column:
 229
 230   This is only needed on SQL or ADODB if you didn't do action=upgrade, but created the
 231   new page.cached_html field seperately, and now you want to move this data from
 232   page.pagedata over to page.cached_html.
 233
 234   <?plugin WikiAdminUtils
 235            action=convert-cached-html
 236            label="Convert cached_html"
 237    ?>
 238
 239
 240 Check WikiDB:
 241
 242   This button will check the Wiki page database for consistency. This can last several minutes.
 243
 244   <?plugin WikiAdminUtils
 245            action=db-check
 246            label="Check WikiDB"
 247    ?>
 248
 249 Rebuild WikiDB:
 250
 251   This will retransform all pages and rebuild the Wiki database on consistency errors or parser updates.
 252   This can last several minutes, eat a lot of memory and possibly times out!!
 253
 254   <?plugin WikiAdminUtils
 255            action=db-rebuild
 256            label="Rebuild WikiDB"
 257    ?>
 258
 259 ----
 260 [CategoryActionPage]