[phpwiki-checkins] CVS: phpwiki/pgsrc MagicPhpWikiURLs,NONE,1.1 PhpWikiAdministration,1.3,1.4 TextFormattingRules,1.10,1.11

[Geoffrey T. D. <da...@us...>]

Update of /cvsroot/phpwiki/phpwiki/pgsrc
In directory usw-pr-cvs1:/tmp/cvs-serv20420/pgsrc

Modified Files:
	PhpWikiAdministration TextFormattingRules 
Added Files:
	MagicPhpWikiURLs 
Log Message:
Jeff hacks again: LOT's of changes.  
Highlights:
  * Pagename in PATH_INFO support added.
  * Redid the user (admin)  authentication stuff.
    All access now through index.php.

See HISTORY for (a few) more details.


--- NEW FILE ---
!!! About phpwiki: URLs

A special type of URL is available for making links to perform
administrative and other special functions in PhpWiki.  Here is a
brief description of how they work.

The basic syntax of a phpwiki: URL is
  __phpwiki:__''pagename''__?__''query-args''

If ''pagename'' is omitted it defaults to the current page.

''Query-args'' should be a set of parameters in standard
HTTP GET format.

The "action=''x''" parameter should almost always be given.  It can be one of
__browse__, __info__, __diff__, __search__, __edit__,
__zip__, __dumpserial__, __loadserial__,
__remove__, __lock__, __unlock__,
__login__, __logout__, or __save__.
The default action is __browse__.

Some of the actions accept other parameters.

;__info__: Accepts __showpagesource__.
;__search__: Accepts __searchterm__, and __searchtype__.
;__edit__: Accepts __version__.
;__remove__: Accepts __verify__.
;__save__: Accepts __editversion__, __minor_edit__, and  __content__.


!! Writing Magic Links in Wiki Pages

A magic link looks like:

  __[[__ ''text'' __|__ ''phpwiki-url'' __]__

The "''text'' __|__" is optional but usually recommended. 
If given it will provide the label for the link.

The ''pagename'' part is optional, too.  If omitted, the link will
refer to the current wiki-page.

!Some examples

  [[ Edit the !SandBox | phpwiki:!SandBox?action=edit ] 
will generate a link which will take you directly to editing the SandBox, like so:
[ Edit the SandBox | phpwiki:SandBox?action=edit ].

Other possibilites:
* [ Diff the SandBox | phpwiki:SandBox?action=diff ],
* [ Lock the FrontPage | phpwiki:FrontPage?action=lock ],
* [ Get a Full Zip Dump | phpwiki:?action=zip&include=all ],
* [ Page titles containing 'wiki' | phpwiki:?action=search&searchterm=wiki ],

!! Writing Magic Forms in Wiki Pages

If one of the ''query-args'' has a value like
  ''arg''__=__''opt-width''__(__''opt-dflt-val''__)__
the link will be rendered as a form, rather than as an anchor.

''Opt-width'', if given specifies the size of the input area, while
''opt-dflt-val'' specifies the default value for the input.
If ''text'' is given in the link, then a submit-button with that
label will be included in the form, otherwise the submit button
will be omitted.

Examples:

  [[ Full Search | phpwiki:?action=search&searchtype=full&searchterm=() ] 
gives
[ Full Search | phpwiki:?action=search&searchtype=full&searchterm=() ] 

While
  [[ phpwiki:?action=search&searchterm=12() ]
yields
[ phpwiki:?action=search&searchterm=12() ]

Other examples:
[ Browse Page | phpwiki:?action=browse&pagename=() ]


Index: PhpWikiAdministration
===================================================================
RCS file: /cvsroot/phpwiki/phpwiki/pgsrc/PhpWikiAdministration,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** PhpWikiAdministration	2001/02/08 01:28:16	1.3
--- PhpWikiAdministration	2001/02/10 22:15:08	1.4
***************
*** 1,11 ****
! !!! This works only if you are logged in as ADMIN
  
  -----------
  
  ! ZIP files of database
  
!  __[ZIP Snapshot | phpwiki:?zip=snapshot]__ : contains only the latest versions
  
!  __[ZIP Dump | phpwiki:?zip=all]__ : contains all archived versions
  
  These links lead to zip files, generated on the fly, which contain the most
--- 1,21 ----
! __Note__: The actions on this page require administrative privileges.
! They won't work unless you have set an admin username and password in the PhpWiki config file.
  
  -----------
+ ! Log In
  
+  __[Log In | phpwiki:?action=login]__
+ 
+ This allows you to login.
+ While you are logged in you will be able to ''lock'', ''unlock'' and ''delete'' pages.
+ You will also be able edit ''locked'' pages.
+ 
+ ----------
+ 
  ! ZIP files of database
  
!  __[ZIP Snapshot | phpwiki:?action=zip]__ : contains only the latest versions
  
!  __[ZIP Dump | phpwiki:?action=zip&include=all]__ : contains all archived versions
  
  These links lead to zip files, generated on the fly, which contain the most
***************
*** 28,32 ****
  __Dump__
  
! %%ADMIN-INPUT-dumpserial-Dump_serialized_pages%%
  
  Pages will be written out as "serialized" strings of a PHP
--- 38,42 ----
  __Dump__
  
! [ Dump Serialized Pages | phpwiki:?action=dumpserial&directory=%/tmp/wikidump ]
  
  Pages will be written out as "serialized" strings of a PHP
***************
*** 37,41 ****
  __Load__
  
! %%ADMIN-INPUT-loadserial-Load_serialized_pages%%
  
  If you have dumped a set of pages from PhpWiki, you can reload them here.
--- 47,51 ----
  __Load__
  
! [ Load Serialized Pages | phpwiki:?action=loadserial&directory=%/tmp/wikidump ]
  
  If you have dumped a set of pages from PhpWiki, you can reload them here.

Index: TextFormattingRules
===================================================================
RCS file: /cvsroot/phpwiki/phpwiki/pgsrc/TextFormattingRules,v
retrieving revision 1.10
retrieving revision 1.11
diff -C2 -r1.10 -r1.11
*** TextFormattingRules	2001/02/08 09:10:26	1.10
--- TextFormattingRules	2001/02/10 22:15:08	1.11
***************
*** 65,68 ****
--- 65,73 ----
  * If you really must use HTML, your system administrator can enable this feature. Start each line with a bar (|). Note that this feature is disabled by default.
  
+ ! More detail than you want to know
+ 
+ See MagicPhpWikiURLs for gory details on how to write
+ various kind of wiki maintainance links.
+ 
  -----