[ PHPXref.com ] [ Generated: Sun Jul 20 19:19:21 2008 ] [ Parasite 1.0.2 ]
[ Index ]     [ Variables ]     [ Functions ]     [ Classes ]     [ Constants ]     [ Statistics ]

title

Body

[close]

/ -> README (source)

   1  ** Attention Opera Users **
   2  
   3  Opera is *NOT* supported by Parasite for anything other than reading.
   4  From its mangling of line terminators to its bizarre implementation
   5  of MIME types to its poor CSS handling, to its bad Javascript/DOM
   6  model, Opera proves to be too much of a PITA to bother supporting.
   7  The author recommends that you use Mozilla or a derivative.
   8  
   9  ** 
  10  
  11  
  12  Connect to your database and create a table for use with Parasite.
  13  
  14  You can use the following to populate your database:
  15  mysql -u user -p Databasename < parasite.sql
  16  
  17  The Parasite SQL user will require INSERT, SELECT, and UPDATE rights
  18  to the Parasite table.
  19  
  20  Copy i.php-dist to i.php and edit it.
  21  
  22  If you have Aspell installed, copy dist.aspell.english.pws to
  23  .aspell.english.pws and feel free to add words to it. If you don't
  24  have Aspell installed, spell checking won't work.
  25  
  26  main.php is the "index", the main page, the big burger. You should
  27  probably move it to index.php.
  28  
  29  user.php is the maintenance page. You might want to rename it/hide
  30  it behind .htaccess.
  31  
  32  Parasite supports two kinds of RSS feeds. The first type is called
  33  "Type1" and it's what you get if you de-select Type2. The Type1 feed
  34  is similar to the meempool.com feed, in that it contains the first
  35  few words from the most recent published article and a link to the
  36  main Parasite page. The Type2 feed contains titles that point to
  37  individual articles. See Below.
  38  
  39  If you've elected to enable RSS Type2, you need to create PHP script
  40  called "article" (no ".php") in the same directory as the rest of
  41  Parasite. The first way to create article is to hard-link it to
  42  main.php using the following command:
  43  
  44  ln main.php article
  45  
  46  THIS IS NOT A SYMLINK. Do not make it one. If you choose this
  47  method, be sure to use a full URI when referring to the CSS files
  48  in the document. IE don't do: 
  49  @import ("my.css"); 
  50  do: 
  51  @import ("http://www.mysite.com/rt/my.css" );
  52  
  53  Also be aware that this option could possibly lower your upgrade
  54  maintenance.
  55  
  56  The other option is to copy main.php to article. This method allows you
  57  to make articles look differently than main.php and also allows you to
  58  use relative linking to style-sheets. Since there's trickiness going on
  59  with the URI of article, you'll need to prefix "../" to relative links
  60  within article if you choose to make article a copy rather than a link.
  61  
  62  In either case, you MUST use the gzip output handler in both main.php
  63  and article.
  64  
  65  The 'article' script MUST be named 'article'. user.php and main.php
  66  are the only scripts whose names can change.
  67  
  68  To get article to work, put the following 3 lines in a .htaccess file
  69  or in your httpd.conf file:
  70  
  71  <FilesMatch "^article$">
  72      ForceType application/x-httpd-php
  73  </FilesMatch>
  74  
  75  If you wish to password protect your user.php file, you can add this
  76  to the same .htaccess file:
  77  
  78  <Files specialfile.php>
  79      Authtype Basic
  80      AuthUserFile /www/bingo/htpasswd
  81      AuthName MyAuthName
  82      <Limit GET POST>
  83          require user sam
  84      </Limit>
  85  </Files>
  86  
  87  Obviously, change the path to the file so that it exists (use htpasswd
  88  to create that file) and, unless your name is Sam, you might want to
  89  change the required user too.
  90  
  91  Once you've configured the file-system side of things, you should
  92  hit user.php and click on the "config" button on the right.
  93  
  94  The config page from user.php contains "definitions" of how you want
  95  Parasite to print certain things to the page.
  96  
  97  
  98  The definitions can contain any HTML and will replace the following
  99  keywords:
 100  
 101  |thisarticlenumber|         The numeric ID of the article being printed
 102  
 103  |thisarticletitle|          The title of the article being printed
 104  
 105  |thisarticledate|           A formated time string of the article being printed
 106  
 107  |thisarticleuser|           The user that entered the article being printed
 108  
 109  |thisarticlebody|           The guts of the article being printed
 110  
 111  |thisarticlepermalink|      The permanent URI of the article being printed.
 112                              (The 'article' script above MUST be configured
 113                              to use this keyword.)
 114  
 115  |pingbackclass|             This keyword will be replaced with "invisible" if
 116                              no pingbacks exist and will be replaced with
 117                              "pingbacklist" if pingbacks exist. 
 118  
 119  |thisarticlepingbackid|     This keyword will be replaced with "pb" and then 
 120                              the numeric ID of the article being printed. This 
 121                              keyword is provided to aid in Javascripting 
 122                              pingback display.
 123  
 124  |thisarticlepingbacklist|   This keyword will be replaced with the list of
 125                              pingbacks to the current article. If no pingbacks
 126                              occurred, this keyword is replaced with an empty
 127                              string.
 128  
 129  |thisarticlepingbacktotal|  This keyword will be replaced with "Pingbacks: "
 130                              and then the number of pingbacks that the current
 131                              article has received. If no pingbacks have
 132                              occurred, this keyword is replaced with an empty
 133                              string.
 134  
 135  
 136  Credits:
 137  
 138  Parasite uses Simon Willison's SpellChecker.class.php and speling.js.
 139      See http://simon.incutio.com/archive/2003/03/18/#phpAndJavascriptSpellChecker
 140  Parasite uses Keith Devens xmlrpc.php
 141      http://www.keithdevens.com/software/xmlrpc/
 142  Thanks go to these authors for making their software available.
 143  
 144  Thanks to Michael Hall, Darrell Golliher, Smith Ellis, and Cary Whitley 
 145  for their help in beta-testing this software.
 146  
 147  Parasite is copyright 2002-2003 Sam Rowe. All rights reserved.
 148  
 149  Parasite is distributed under a BSD-style license. The only
 150  difference being that I don't concede my copyright to the Board of
 151  Regents of the state of California.


[ Powered by PHPXref - Served by Debian GNU/Linux ]