"Fossies" - the Fresh Open Source Software Archive

Member "phplist-3.5.0/doc/README.rssfeeds" (14 Jan 2020, 2776 Bytes) of package /linux/www/phplist-3.5.0.tgz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 
    2 How to use RSS feeds in phpList
    3 
    4 
    5 
    6 If you are puzzled what RSS is, check out http://backend.userland.com/rss or 
    7 http://www.syndic8.com/
    8 
    9 Quick overview, more comprehensive documentation will follow
   10 
   11 In order to allow PHPlist to send out RSS you need to follow these steps:
   12 
   13 - set ENABLE_RSS to 1 in your config file
   14 
   15 PHPlist will now have additional functionality that allows you to set up RSS mailings.
   16 
   17 The steps to add mailings are:
   18 
   19 1. add a RSS source to a list. Currently you can have one source per list.
   20 
   21 2. create a subscribe page that has RSS frequency selection set up for the users who subscribe
   22 Current possible values for frequencies are "daily", "weekly" and "monthly"
   23 
   24 3. regularly run the page "getrss". You can set this up similarly to "processqueue"
   25 The getrss page (which is linked from the admin homepage at the bottom) will find all 
   26 data from the RSS feeds you have set up on your lists.
   27 This data is cached (by Onyx RSS) and the cache file is written in your "tmpdir" directory
   28 as identified in your config file.
   29 
   30 The cache will expire every 3 hours. 
   31 
   32 4. Create a message that will be the template for your RSS messages, and identify the 
   33 frequency for the message. You can send the message like a normal PHPlist message, and 
   34 you need to add [RSS] to the content of the message to identify where the list of RSS items 
   35 needs to go.
   36 
   37 You can set up one message per frequency. If you have a previous message for the frequency
   38 you create, that one will be marked "sent" instead of "submitted".
   39 If you run a multi admin system the messages are unique for a frequency-admin combinarion
   40 
   41 5. Run your "processqueue" page as normal
   42 
   43 What will happen:
   44 
   45 When PHPlist encounters a message that is a template for RSS feeds, it will find the users
   46 who match the lists it exists for and assemble the RSS items for the user. A message will be 
   47 used only for users who have identified the same RSS-frequency as the message. 
   48 
   49 If there is something to send, the message will be send to the user containing the RSS items
   50 in the place where you identified [RSS] in the body.
   51 
   52 Notes:
   53 
   54 1. PHPlist uses a threshold for sending emails. If there are less than the threshold items 
   55 to be send to the user, the message will not be sent. The threshold is set in your PHPlist
   56 configuration (not the config file)
   57 
   58 2. PHPlist uses templates for the items to be sent, one for text items and one for HTML items
   59 You can change these in the PHPlist configuration.
   60 use [title], [link] and [description] as the placeholders.
   61 
   62 3. The order of RSS items is by list and you can add separators between sets of items
   63 if you use [listname] as a placeholder in the separator it will be replaced by the listname
   64 for that set of RSS items, and only once per set of items (ie per list)
   65 
   66 
   67 
   68 
   69 
   70 
   71 
   72