pgsrc/PhpWikiAdministration

   1 Date: Tue, 20 Aug 2002 11:04:00 -0500
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.3)
   3 X-Rcs-Id: $Id: PhpWikiAdministration,v 1.21 2003-02-21 04:14:15 dairiki Exp $
   4 Content-Type: application/x-phpwiki;
   5   pagename=PhpWikiAdministration;
   6   flags=PAGE_LOCKED;
   7   pgsrc_version="4 $Revision: 1.21 $";
   8   markup=2;
   9   charset=iso-8859-1
  10 Content-Transfer-Encoding: binary
  11
  12 __Note__: Most of the actions on this page require administrative
  13 privileges.  They won't work unless you have set an admin username and
  14 password in the PhpWiki config file.
  15
  16 ----------
  17
  18 !! Cleanup
  19
  20 A Wiki SandBox is very easy to clean. Here you can restore it to
  21 pristine condition by loading the default from pgsrc:
  22
  23 [ Rake the SandBox | phpwiki:?action=loadfile&source=pgsrc/SandBox ].
  24
  25 [/Remove] multiple pages.
  26
  27 ----------
  28
  29 !! Making Snapshots or Backups
  30
  31 ! ZIP files of database
  32
  33 These links lead to zip files, generated on the fly, which contain all
  34 the pages in your Wiki.  The zip file will be downloaded to your local
  35 computer.
  36
  37 This __[ZIP Snapshot | phpwiki:?action=zip]__ contains only the latest
  38 versions of each page, while this
  39 __[ZIP Dump | phpwiki:?action=zip&include=all]__ contains all archived
  40 versions.
  41
  42 (If the PhpWiki is configured to allow it,) anyone can download a zip
  43 file.
  44
  45 If your php has ''zlib'' support, the files in the archive will be
  46 compressed, otherwise they will just be stored.
  47
  48 ! Dump to directory
  49
  50 Here you can dump pages of your Wiki into a directory of your choice.
  51
  52 <?plugin WikiForm action=dumpserial?>
  53
  54 The most recent version of each page will written out to the
  55 directory, one page per file.  Your server must have write permissions
  56 to the directory!
  57
  58 -----------
  59 !! Restoring
  60
  61 If you have dumped a set of pages from PhpWiki, you can reload them
  62 here.  Note that pages in your database will be overwritten; thus, if
  63 you dumped your HomePage when you load it from this form it will
  64 overwrite the one in your database now. If you want to be selective
  65 just delete the pages from the directory (or zip file) which you don't
  66 want to load.
  67
  68 ! Upload File
  69
  70 Here you can upload ZIP archives, or individual files from your
  71 (client) machine.
  72
  73 <?plugin WikiForm action=upload?>
  74
  75 ! Load File
  76
  77 Here you can load ZIP archives, individual files or entire
  78 directories.  The file or directory must be local to the http server.
  79 You can also use this form to load from an http: or ftp: URL.
  80
  81 <?plugin WikiForm action=loadfile?>
  82
  83 -----------
  84
  85 !! Format of the files
  86
  87 Currently the pages are stored, one per file, as MIME (RFC:2045)
  88 e-mail (RFC:822) messages.  The content-type ''application/x-phpwiki''
  89 is used, and page meta-data is encoded in the content-type parameters.
  90 (If the file contains several versions of a page, it will have type
  91 ''multipart/mixed'', and contain several sub-parts, each with type
  92 ''application/x-phpwiki''.)  The message body contains the page text.
  93
  94 ! Old Formats
  95
  96 __Serialized Files__
  97
  98 The dump to directory command used to dump the pages as PHP
  99 ''serialized()'' strings.  For humans, this made the files very hard
 100 to read, and nearly impossible to edit.
 101
 102 __Plain Files__
 103
 104 Before that the page text was just dumped to a file--this means that
 105 all page meta-data was lost. Note that when loading ''plain files'',
 106 the page name is deduced from the file name.
 107
 108 The upload and load functions will automatically recognize each of
 109 these three types of files, and handle them accordingly.
 110
 111 ----
 112
 113 !! Dump pages as XHTML
 114 <?plugin WikiForm action=dumphtml?>
 115
 116 This will generate a directory of static pages suitable for
 117 distribution on disk where no web server is available. The various
 118 links for page editing functions and navigation are removed from the
 119 pages.
 120
 121 The XHTML file collection can also be downloaded as an
 122 __[XHTML ZIP Snapshot | phpwiki:?action=ziphtml]__.
 123
 124 ----
 125
 126 !! PhpWiki Internals
 127
 128 These are here mostly for debugging purposes (at least, that's the hope.)
 129
 130 In normal use, you shouldn't need to use these, though, then again,
 131 they shouldn't really do any harm.
 132
 133 Purge Markup Cache |
 134   (If your wiki is so configured,) the transformed (almost-HTML) content
 135   of the most recent version of each page is cached.  This speeds up page
 136   rendering since parsing of the wiki-text takes a fair amount of juice.
 137
 138   Hitting this button will delete all cached transformed content.
 139   (Each pages content will be transformed and re-cached next time someone
 140   views it.)
 141
 142   <?plugin WikiAdminUtils action=purge-cache label="Purge Cache" ?>
 143
 144 Clean WikiDB of Illegal Filenames |
 145   Page names beginning with the subpage-separator --- usually a slash (=/=) ---
 146   are not allowed.  Sometimes though an errant plugin or something might
 147   create one...  This button will delete any pages with illegal page names.
 148
 149   <?plugin WikiAdminUtils action=purge-bad-pagenames label="Exorcise WikiDB" ?>
 150
 151 ----
 152
 153 PhpWikiDocumentation