[Phpslash-commit] CVS: phpslash-ft/doc/html phpslash.sgml,1.20,1.21

[nathan h. <nh...@us...>]

Update of /cvsroot/phpslash/phpslash-ft/doc/html
In directory usw-pr-cvs1:/tmp/cvs-serv24492/doc/html

Modified Files:
	phpslash.sgml 
Log Message:
add backend documentation


Index: phpslash.sgml
===================================================================
RCS file: /cvsroot/phpslash/phpslash-ft/doc/html/phpslash.sgml,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -d -r1.20 -r1.21
*** phpslash.sgml	18 Mar 2002 16:11:22 -0000	1.20
--- phpslash.sgml	19 Mar 2002 22:39:45 -0000	1.21
***************
*** 16,20 ****
  <author>
    <url url="http://phpslash.sourceforge.net/" name="The phpSlash Group">
! <date>v0.3, November 23, 2001
  
  <abstract>
--- 16,20 ----
  <author>
    <url url="http://phpslash.sourceforge.net/" name="The phpSlash Group">
! <date>v0.4, March 19, 2002
  
  <abstract>
***************
*** 974,977 ****
--- 974,1051 ----
  <sect1>Glossary
  <p> Add / edit entries in the glossary
+ 
+ <sect1>Backend Module
+ <p> The backend module is what exports RSS, OML, Javascript and plaintext 
+ version of your headlines to the rest of the world.  You should take a 
+ look at it so the community and more importnantly, your readers, can get 
+ your site data anywhere.
+ 
+ <sect2>Seting up
+ <p> Make sure you edit the $metatags, site_owner, Site_title and 
+ site_slogan entries in config.php3.  These are used by the export module.  
+ Once done you should probable want to edit the backend template files to
+ change the default phpslash logo to your own.  (Note this should be a 
+ small logo about 40 pixels tall by 100 pixels wide or so.)  This will be 
+ automated in the next release. Be sure not to chnage any other parts of 
+ the files, as the RSS versions and OML versions depend on the XML being 
+ well-formated.
+ 
+ <sect2>Giving out your information
+ <p> There are a lot of different formats out there, the phpslash backend 
+ exporter tries to be as flexible as possible in terms of the info it gives 
+ out and the formats it gives it out in.  Options for specfic information 
+ and formats are given in the GET query string for backend.php3.  The 
+ default is for backend to give out a RSS-1.0 document containting the 15 
+ most recent stories psoted to your site.  Other options as as follows and 
+ should be handed to the backend script like: 
+ backend.php3?option1=value1&amp;option2=value2
+ <descrip>
+   <tag/section/ The name of the section you would like your feed to display
+                 (Default is to have no filter)
+   <tag/topic/   The name of the topic you would liek your feed to display
+                 (Default is to have no filter)
+   <tag/author/  The name of the author author your would like your feed to display
+                 (Default is to have no filter)
+   <tag/date/    The starting date in "to_days" format 
+                 (default is now)
+   <tag/start/   The "starting" point 
+                 (default is the first entry)
+   <tag/max/     The maximum number of stories returned 
+                 (default is 15)
+   <tag/order/   Order by time, hits, title,
+                 (default is to order by time)
+   <tag/asc/     Ascending or Descending Ordering
+                 (defualt id Decending)
+   <tag/query/   A urlencoded text string to search the stories with
+                 (default is none)
+   <tag/view/    The export format desired.  RSS-1.0 is the default
+                 <itemize>
+                   <item>rss91   - RSS 0.91 
+                   <item>rss92   - RSS 0.92  
+                   <item>rss1    - RSS 1.0 - default
+                   <item>html    - fancybox 
+                   <item>txt     - simple text output of title and intro
+                   <item>block   - text delimited by %%
+                   <item>js      - javascript 
+                   <item>jsdata  - javascript array
+                   <item>mozilla - for adding to Netscape 6 My Sidebar
+                   <item>opml    - OPML (http://radio.userland.com)
+                   <item>wml     - WML - for WAP phones
+                 </itemize>
+   <tag/d/       The description format.  the description is the into text 
+                 possibly with some prefixed text. (Default is jsut the 
+                 into_text, no prefix)
+                 <itemize>
+                   <item>d - include description
+                   <item>s - site name
+                   <item>l - site name plus description
+                   <item>0 - empty description
+                </itemize>
+ </descrip>
+ <sect2> Making your site known.
+ <p> Once you know what your backend string will look like (or at least 
+ what it can do) you're ready to submit your feeds to numberious places on 
+ the 'net.  Once place to start is <url url="http://www.syndic8.com" 
+ name="syndic8.com">
  
  <!-- START SECTION: Templates -->