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