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