templates/README

   1 $Id: README,v 1.1 2000-06-18 16:05:34 ahollosi Exp $
   2
   3 PhpWiki distinguishes between four different templates:
   4
   5 - template for browsing pages (default: browse.html)
   6   This template is used when viewing Wiki pages.
   7
   8 - template for editing pages (default: editpage.html)
   9   This template is used when users edit a page by clicking on
  10   the EditText link.
  11
  12 - template for editing references (default: editlinks.html)
  13   This template is used when users edit references of a page
  14   by clicking on the EditLinks link on the EditText page.
  15
  16 - template for plain messages from PhpWiki (default: message.html)
  17   This template is used when displaying search results, or when
  18   displaying error messages.
  19
  20
  21 The location of the template files is defined in wiki_config.php3
  22 The specification is relative to the index.php3 script.
  23
  24 Template files are regular HTML files, which contain special
  25 placeholders. Placeholders are surrounded by '###'.
  26 You must not use '###' for other purposes.
  27
  28
  29 Following placeholders are provided by PhpWiki:
  30
  31 ###SCRIPTURL###
  32         This is the URL of the main PhpWiki script.
  33         All URL's referring to the Wiki itself should use this placeholder.
  34
  35 ###PAGE###
  36         The page title. Any special HTML characters are replaced by their
  37         entities. Do not use this placeholder in links. Use ###PAGEURL###
  38         instead.
  39
  40 ###CONTENT###
  41         The actual page content. This is either the Wikipage itself,
  42         the search result, or a message text.
  43
  44 ###ALLOWEDPROTOCOLS###
  45         Protocols allowed for external links and references.
  46         Default: http|https|mailto|ftp|news|gopher
  47
  48
  49 The following placeholders are not available for the 'MESSAGE' template:
  50
  51 ###PAGEURL###
  52         Page title encoded for use in URLs.
  53
  54 ###LASTMODIFIED###
  55         Date when the page was last modified.
  56
  57 ###LASTAUTHOR###
  58         Author of latest modification. Usually this is the hostname or
  59         the IP address.
  60
  61 ###VERSION###
  62         Revision number of the page.
  63         Note: this is also used for detecting concurrent updates to a page.
  64         See hidden input field in EDITPAGE template for how to use it.
  65
  66 ###IFCOPY###
  67         Special placeholder. Should only be used in EDITPAGE template.
  68         If EditCopy link should be shown, then ###IFCOPY### is ignored.
  69         If EditCopy should not be shown, the rest of the line is deleted.
  70
  71
  72 Only for EditLinks:
  73 ###1###, ###2###, ....
  74         Placeholder for references. Up to NUM_LINKS placeholders will be
  75         substituted. NUM_LINKS is defined in wiki_config.php3
  76
  77
  78
  79 Examples:
  80
  81 <A HREF="###SCRIPTURL###">the entry (default) page</A>
  82 <A HREF="###SCRIPTURL###?###PAGEURL###">the current page</A>
  83 <A HREF="###SCRIPTURL###?FindPage">the FindPage page</A>
  84 <head><title>PhpWiki Page: ###PAGE###</title></head>
  85
  86 see default templates for more examples.