mod/wiki/ewiki/fragments/README

   1
   2 ewiki/fragments/
   3 ================
   4
   5 This directory contains various (code) snippets, which may or may not
   6 be useful for you. You are on your own, when it comes to make them
   7 work.
   8
   9
  10
  11 mkhuge
  12 ¯¯¯¯¯¯
  13    Is a shell script to merge the core "ewiki.php" with some of the common
  14    extension plugins into a "huge-ewiki.php" script - for lazy people ;->
  15
  16
  17
  18 core.css
  19 ¯¯¯¯¯¯¯¯
  20    Is an example (text/css) stylesheet, which shows how to tweak
  21    the look of rendered pages using CSS.
  22
  23    You could copy it into yoursites.css or do something like this in
  24    yoursite.php:
  25
  26    <HTML>
  27    <HEAD>
  28      <STYLE TYPE="text/css"><!--
  29      <?php
  30             include("fragments/core.css");
  31      ?>
  32      //--></STYLE>
  33
  34
  35
  36 calendar.css
  37 ¯¯¯¯¯¯¯¯¯¯¯¯
  38    These stylesheet definitions show all possible CSS classes that
  39    are used within the calendar.php plugin. Use like core.css
  40
  41
  42
  43 binary.php
  44 ¯¯¯¯¯¯¯¯¯¯
  45    If yoursite.php is not designed carefully enough or EWIKI_SCRIPT_BINARY
  46    cannot be set correctly, you may want to use this wrapper script to
  47    allow for uploading and retrieval of binary content (images) via ewiki.
  48
  49    Copy it to where the main ewiki.php script is, and set the
  50    EWIKI_SCRIPT_BINARY constant to the correct absolute position (possibly
  51    including http://server.name/) of "binary.php".
  52    (this constant must be set on top of ewiki.php)
  53
  54    You must set the database access params in here, too.
  55
  56    It may also be useful if you'd like to divide the database into its
  57    two parts again - text content and binary content. You could even
  58    let it save binary content in a flat file database, while WikiPages
  59    remain in a RDBMS.
  60
  61
  62
  63
  64 homepage.src
  65 ¯¯¯¯¯¯¯¯¯¯¯¯
  66    Is an __EXAMPLE__ on how to build a crippled Wiki (using authentication)
  67    for a private homepage.
  68    There is a lot of infos inside the script. And please remember all
  69    files labeled with "example" are just examples!!!!!!! (read: I'm rarely
  70    interested in bug reports)
  71
  72
  73
  74 funcs.inc
  75 ¯¯¯¯¯¯¯¯¯
  76    Possibly useful pseudo-external helper functions are collected in here.
  77
  78    function save_newest_pages()
  79    ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
  80       Reads the recently updated pages list from the database (like
  81       "UpdatedPages") and tries to save it in another database table
  82       (this example does so in my privately used webcms for speed purposes).
  83
  84
  85
  86 htaccess
  87 ¯¯¯¯¯¯¯¯
  88    Shows how to use mod_rewrite with ewiki.
  89
  90    * old style:  http://www.example.com/wiki.php?page=WikiPage
  91    * PATH_INFO:  http://www.example.com/WikiPage
  92
  93    Remember to enable EWIKI_USE_PATH_INFO inside ewiki.php - this was
  94    disabled once, because of the many broken Apache implementations (they
  95    seem to support that broken CGI/1.1 specification, which was for good
  96    reasons and luckily never blessed to become an official RFC).
  97
  98
  99
 100 strip_wonderful_slashes.php
 101 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
 102    Fixes the very bad "magic_quotes_gpc" setting from php.ini for PHP
 103    versions prior to 4.3
 104
 105    Does not hurt a well configured PHP interpreter setup.
 106
 107
 108
 109 wiki_format.inc
 110 ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯
 111    Stripped version of the wiki rendering core for easier inclusion into
 112    your own projects.
 113
 114