Diff: PhpWikiAdministration

Note: You are viewing an old revision of this page. View the current version.

Differences between version 4 and previous revision of PhpWikiAdministration.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 4 Last edited on 25 September 2005 4:15 by The PhpWiki programming team Revert
Older page: version 3 Last edited on 22 May 2014 3:01 by harold Revert
@@ -1,145 +1,222 @@
-**// Note:// ** // Most of the actions on this page require administrative privileges.//  
+_ *Note:*_ _ Most of the actions on this page require administrative  
+ privileges. They will not work unless you have set an admin username and  
+password in the PhpWiki config file._  
  
-<< CreateToc jshide||=0 with_toclink||=1 position=right with_counter=1>
+<?plugin CreateToc jshide||=1 with_toclink||=1 ?
  
-== Page Explorer ==  
+----  
+!!! Page Explorer 
  
 First select pages and then define the action: 
  
 <?plugin-form WikiAdminSelect s="*" ?> 
  
 or call the available ~WikiAdmin actions directly: 
  
-| [[/Chown]] | [[/Purge]] | [ [/Remove] ] | [ [/Rename] ] | [ [/SearchReplace] ] | [ [/SetAcl] ] | [ [/SetAclSimple] ] | [ [/DeleteAcl]
+[/Remove] |  
+ [/Rename] |  
+ [/Replace ] |  
+ [/SetAcl] |  
+ [/Chmod ] |  
+ [/Chown
  
-== Global Access Rights ==  
+----  
+!!! User Management  
  
-These action pages will allow you to set the default access rights for wiki pages.  
-Pages without individual access rights will use these default access rights .  
-* [[SetGlobalAccessRightsSimple]]  
-* [[SetGlobalAccessRights]]  
+PhpWiki:EmailVerification is currently non-strict, leaving some possible holes, which can be  
+administrated below
  
-== User Management ==  
+ This button will show a list of all users with registered emails and buttons to set the  
+ verification status manually.  
  
-=== Reset a users password ===  
+ <?plugin WikiAdminUtils  
+ action =email-verification  
+ label ="Email Verification"  
+ ?>  
  
-<?plugin -form PasswordReset textinput= user method=post ?>  
+To prevent from robots eating all possible ressources in a short time, blocking from certain IPs  
+or not -well-behaving user agents can be defined below. See PhpWiki:HowToBlockRobots and  
+MeatBall:SurgeProtector. _Note: Not yet enabled._  
  
-=== Email Verification ===  
+ <?plugin WikiAdminUtils  
+ action =access-restrictions  
+ label ="Access Restrictions"  
+ ?>  
  
-This is currently non -strict, leaving some possible holes in not being able to  
-connect to certain mail hosts, which can be overridden below. See [[PhpWiki:EmailVerification]].  
-  
-This button will show a list of all users with registered emails and buttons to set the verification status manually.  
-  
-<<WikiAdminUtils action=email -verification label="Email Verification">>  
-  
-== Cleanup ==  
+----  
+!!! Cleanup 
  
 A Wiki SandBox is very easy to clean. Here you can restore it to 
 pristine condition by loading the default from pgsrc. 
  
-**[ [phpwiki:?action=loadfile&overwrite=1 &source=pgsrc/SandBox|Rake the SandBox] ]**  
+ [Rake the SandBox| phpwiki:?action=loadfile&source=pgsrc/SandBox].  
  
-== Making Snapshots or Backups ==  
+----------  
  
-=== ZIP files of database ===  
+!!! Making Snapshots or Backups  
+  
+!! ZIP files of database 
  
 These links lead to zip files, generated on the fly, which contain all 
 the pages in your Wiki. The zip file will be downloaded to your local 
 computer. 
  
-This * *[[ phpwiki:?action=zip|ZIP Snapshot ]]* * contains only the  
-latest versions of each page, while this * *[[ phpwiki:?action=zip&include=all|ZIP Dump ]]* * contains all archived versions. 
+ This *[ZIP Snapshot | phpwiki:?action=zip]* contains only the  
+ latest versions of each page, while this *[ZIP Dump |  
+ phpwiki:?action=zip&include=all]* contains all archived versions. 
  
-(If the ~ PhpWiki is configured to allow it, anyone can download a zip file.) 
+ (If the PhpWiki is configured to allow it, anyone can download a zip  
+ file.) 
  
-If your php has // zlib// support, the files in the archive will be compressed, otherwise they will just be stored. 
+If your php has _ zlib_ support, the files in the archive will be  
+ compressed, otherwise they will just be stored. 
  
-=== Dump to directory ===  
+!! Dump to directory 
  
 Here you can dump pages of your Wiki into a directory of your choice. 
  
-<< WikiForm action=dumpserial>
+ <?plugin WikiForm action=dumpserial?
  
-The most recent version of each page will written out to the directory, one page per file. Your server must have write permissions to the directory! 
+The most recent version of each page will written out to the  
+ directory, one page per file. Your server must have write permissions  
+ to the directory! 
  
-== Restoring ==  
+-----------  
+!!! Restoring 
  
-If you have dumped a set of pages from ~ PhpWiki, you can reload them 
+If you have dumped a set of pages from PhpWiki, you can reload them 
 here. Note that pages in your database will be overwritten; thus, if 
 you dumped your HomePage when you load it from this form it will 
 overwrite the one in your database now. If you want to be selective 
 just delete the pages from the directory (or zip file) which you don't 
 want to load. 
  
-=== Upload File ===  
+!! Upload File 
  
 Here you can upload ZIP archives, or individual files from your 
 (client) machine. 
  
-<< WikiForm action=upload>>  
-<<WikiForm action=upload buttontext="Upload & Overwrite" overwrite=1>
+ <?plugin WikiForm action=upload?
  
-=== Load File ===  
+!! Load File 
  
 Here you can load ZIP archives, individual files or entire 
 directories. The file or directory must be local to the http 
 server. You can also use this form to load from an http: or ftp: URL. 
  
-<< WikiForm action=loadfile> >  
-<< WikiForm action=loadfile buttontext="Load & Overwrite" overwrite=1>
+ <?plugin WikiForm action=loadfile? >  
+ <?plugin WikiForm action=loadfile buttontext="Load & Overwrite" overwrite=1?
  
-=== Upgrade ===  
+!! Upgrade 
  
 Do some verification checks and upgrade changes automatically, after having installed a 
 new phpwiki engine update: 
 * Upgrade new or changed page revisions from pgsrc, 
-* Upgrade the database schema (mysql // page.id auto_increment// , ADD // session.sess_ip// ), 
+* Upgrade the database schema (mysql _ page.id auto_increment_ , ADD _ session.sess_ip_ ), 
  
-You can force overwrite or not :  
-* ** [[phpwiki:HomePage?action=upgrade |Upgrade]]**  
-* **[[ phpwiki:HomePage?action=upgrade&overwrite=1|Upgrade & Overwrite] ]**  
+; :[ Upgrade | phpwiki:HomePage?action=upgrade ] 
  
-== Format of the files ==  
+-----------  
  
-=== Current Format ===  
+!!! Format of the files  
  
 Currently the pages are stored, one per file, as MIME (RFC:2045) 
-e-mail (RFC:822) messages. The content-type // application/x-phpwiki//  
+e-mail (RFC:822) messages. The content-type _ application/x-phpwiki_  
 is used, and page meta-data is encoded in the content-type 
 parameters. (If the file contains several versions of a page, it will 
-have type // multipart/mixed// , and contain several sub-parts, each  
-with type // application/x-phpwiki// .) The message body contains the 
+have type _ multipart/mixed_ , and contain several sub-parts, each  
+with type _ application/x-phpwiki_ .) The message body contains the 
 page text. 
  
-=== Old Formats ===  
+!! Old Formats 
  
-==== Serialized Files ====  
+* Serialized Files*  
  
-The dump to directory command used to dump the pages as PHP  
-// serialized()// strings. For humans, this made the files very hard  
-to read, and nearly impossible to edit. 
+ The dump to directory command used to dump the pages as PHP  
+ _ serialized()_ strings. For humans, this made the files very hard  
+ to read, and nearly impossible to edit. 
  
-==== Plain Files ====  
+* Plain Files*  
  
-Before that the page text was just dumped to a file--this means that  
-all page meta-data was lost. Note that when loading // plain files// ,  
-the page name is deduced from the file name. 
+ Before that the page text was just dumped to a file--this means that  
+ all page meta-data was lost. Note that when loading _ plain files_ ,  
+ the page name is deduced from the file name. 
  
 The upload and load functions will automatically recognize each of 
 these three types of files, and handle them accordingly. 
  
-== Dump pages as XHTML ==  
+----  
  
-<< WikiForm action=dumphtml>
+!!! Dump pages as XHTML  
+  
+ <?plugin WikiForm action=dumphtml?
  
 This will generate a directory of static pages suitable for 
 distribution on disk where no web server is available. The various 
 links for page editing functions and navigation are removed from the 
 pages. 
  
-The XHTML file collection can also be downloaded as an **[ [phpwiki:?action=ziphtml|XHTML ZIP Snapshot] ]**. 
+ The XHTML file collection can also be downloaded as an  
+ *[XHTML ZIP Snapshot | phpwiki:?action=ziphtml]*.  
+  
+----  
+  
+!!! Phpwiki Internals  
+  
+These are here mostly for debugging purposes (at least, that is the  
+hope.)  
+  
+In normal use, you should not need to use these, though, then again,  
+they should not really do any harm.  
+  
+!! Purge Markup Cache  
+  
+(If your wiki is so configured,) the transformed (almost-HTML) content  
+of the most recent version of each page is cached. This speeds up page  
+rendering since parsing of the wiki-text takes a fair amount of juice.  
+  
+ Hitting this button will delete all cached transformed  
+ content. (Each pages content will be transformed and re-cached next  
+ time someone views it.)  
+  
+ <?plugin WikiAdminUtils  
+ action=purge-cache  
+ label="Purge Cache"  
+ ?>  
+  
+!! Clean WikiDB of Illegal Filenames  
+  
+Page names beginning with the subpage-separator, usually a slash  
+(=/=), are not allowed. Sometimes though an errant plugin or something  
+might create one....  
+  
+ This button will delete any pages with illegal page names, without possibility to restore.  
+  
+ <?plugin WikiAdminUtils  
+ action=purge-bad-pagenames  
+ label="Purge bad pagenames"  
+ ?>  
+  
+!! Clean WikiDB of empty and unreferenced pages  
+  
+ *Warning!* This button will delete every empty and unreferenced page, without any possibility to restore them again .  
+ This will disable the possibility to revert or get back any deleted page.  
+  
+ <?plugin WikiAdminUtils  
+ action=purge-empty-pages  
+ label="Purge all empty unreferenced pages"  
+ ?>  
+  
+!! Convert cached_html to new SQL column  
+  
+ This is only needed on SQL or ADODB if you didn't do action=upgrade, but created the  
+ new page.cached_html field seperately, and now you want to move this data from  
+ page.pagedata over to page.cached_html.  
+  
+ <?plugin WikiAdminUtils  
+ action=convert-cached-html  
+ label="Convert cached_html"  
+ ?>  
  
 ---- 
-[[CategoryActionPage]]  
+PhpWikiDocumentation  

version 4

Note: Most of the actions on this page require administrative privileges. They will not work unless you have set an admin username and password in the PhpWiki config file.


Page Explorer

First select pages and then define the action:

or call the available WikiAdmin actions directly:

/Remove /Rename /Replace /SetAcl /Chmod /Chown

User Management

PhpWiki:EmailVerification is currently non-strict, leaving some possible holes, which can be administrated below.

This button will show a list of all users with registered emails and buttons to set the verification status manually.

Plugin WikiAdminUtils disabled. Plugin not run: not in browse mode
<?plugin WikiAdminUtils
         action=email-verification
         label="Email Verification"
 ?>

To prevent from robots eating all possible ressources in a short time, blocking from certain IPs or not-well-behaving user agents can be defined below. See PhpWiki:HowToBlockRobots and MeatBall:SurgeProtector. Note: Not yet enabled.

Bad action requested: access-restrictions

Cleanup

A Wiki SandBox is very easy to clean. Here you can restore it to pristine condition by loading the default from pgsrc.

Rake the SandBox.


Making Snapshots or Backups

ZIP files of database

These links lead to zip files, generated on the fly, which contain all the pages in your Wiki. The zip file will be downloaded to your local computer.

This ZIP Snapshot contains only the latest versions of each page, while this ZIP Dump contains all archived versions.

(If the PhpWiki is configured to allow it, anyone can download a zip file.)

If your php has zlib support, the files in the archive will be compressed, otherwise they will just be stored.

Dump to directory

Here you can dump pages of your Wiki into a directory of your choice.

The most recent version of each page will written out to the directory, one page per file. Your server must have write permissions to the directory!


Restoring

If you have dumped a set of pages from PhpWiki, you can reload them here. Note that pages in your database will be overwritten; thus, if you dumped your HomePage when you load it from this form it will overwrite the one in your database now. If you want to be selective just delete the pages from the directory (or zip file) which you don't want to load.

Upload File

Here you can upload ZIP archives, or individual files from your (client) machine.

Load File

Here you can load ZIP archives, individual files or entire directories. The file or directory must be local to the http server. You can also use this form to load from an http: or ftp: URL.

Upgrade

Do some verification checks and upgrade changes automatically, after having installed a new phpwiki engine update:

  • Upgrade new or changed page revisions from pgsrc,
  • Upgrade the database schema (mysql page.id auto_increment, ADD session.sess_ip),
Upgrade

Format of the files

Currently the pages are stored, one per file, as MIME (RFC:2045) e-mail (RFC:822) messages. The content-type application/x-phpwiki is used, and page meta-data is encoded in the content-type parameters. (If the file contains several versions of a page, it will have type multipart/mixed, and contain several sub-parts, each with type application/x-phpwiki.) The message body contains the page text.

Old Formats

Serialized Files

The dump to directory command used to dump the pages as PHP serialized() strings. For humans, this made the files very hard to read, and nearly impossible to edit.

Plain Files

Before that the page text was just dumped to a file--this means that all page meta-data was lost. Note that when loading plain files, the page name is deduced from the file name.

The upload and load functions will automatically recognize each of these three types of files, and handle them accordingly.


Dump pages as XHTML

This will generate a directory of static pages suitable for distribution on disk where no web server is available. The various links for page editing functions and navigation are removed from the pages.

The XHTML file collection can also be downloaded as an XHTML ZIP Snapshot.


Phpwiki Internals

These are here mostly for debugging purposes (at least, that is the hope.)

In normal use, you should not need to use these, though, then again, they should not really do any harm.

Purge Markup Cache

(If your wiki is so configured,) the transformed (almost-HTML) content of the most recent version of each page is cached. This speeds up page rendering since parsing of the wiki-text takes a fair amount of juice.

Hitting this button will delete all cached transformed content. (Each pages content will be transformed and re-cached next time someone views it.)

Plugin WikiAdminUtils disabled. Plugin not run: not in browse mode
<?plugin WikiAdminUtils
         action=purge-cache
         label="Purge Cache"
 ?>

Clean WikiDB of Illegal Filenames

Page names beginning with the subpage-separator, usually a slash (/), are not allowed. Sometimes though an errant plugin or something might create one....

This button will delete any pages with illegal page names, without possibility to restore.

Plugin WikiAdminUtils disabled. Plugin not run: not in browse mode
<?plugin WikiAdminUtils
         action=purge-bad-pagenames
         label="Purge bad pagenames"
 ?>

Clean WikiDB of empty and unreferenced pages

Warning! This button will delete every empty and unreferenced page, without any possibility to restore them again. This will disable the possibility to revert or get back any deleted page.

Plugin WikiAdminUtils disabled. Plugin not run: not in browse mode
<?plugin WikiAdminUtils
         action=purge-empty-pages
         label="Purge all empty unreferenced pages"
 ?>

Convert cached_html to new SQL column

This is only needed on SQL or ADODB if you didn't do action=upgrade, but created the new page.cached_html field seperately, and now you want to move this data from page.pagedata over to page.cached_html.

Bad action requested: convert-cached-html

PhpWikiDocumentation