pgsrc/PhpWikiAdministration

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