Changeset 1279

Show
Ignore:
Timestamp:
11/25/08 17:42:59 (16 months ago)
Author:
mpaschal
Message:

Rewrap to 78 character lines
Point to the Template Author Guide for template authoring help

Files:
1 modified

Legend:

Unmodified
Added
Removed

  • trunk/ActionStreams/README.txt

    r1278 r1279  
    77OVERVIEW 
    88 
    9 Action Streams for Movable Type collects your action on third party web sites into your 
    10 Movable Type web site. Using it, you can aggregate those actions for your reference, promote 
    11 specific items to blog posts, and stream the whole set to your friends and readers. Action 
    12 Streams are a powerful part of your web profile. 
     9Action Streams for Movable Type collects your action on third party web sites 
     10into your Movable Type web site. Using it, you can aggregate those actions for 
     11your reference, promote specific items to blog posts, and stream the whole set 
     12to your friends and readers. Action Streams are a powerful part of your web 
     13profile. 
    1314 
    14 The plugin adds the ability for your Movable Type authors to list their accounts on third 
    15 party web services. A periodic task then automatically imports your authors' activity on those 
    16 services using XML feeds (where provided) and scraping HTML pages (where necessary). Your 
    17 authors can then publish their action streams completely under their control: the provided 
    18 template tags make it possible to display authors' accounts and actions on any page powered by 
    19 Movable Type. The example templates and the provided template set also use the XFN and hAtom 
    20 microformats and provide web feeds to integrate with tools your readers may be using. 
     15The plugin adds the ability for your Movable Type authors to list their 
     16accounts on third party web services. A periodic task then automatically 
     17imports your authors' activity on those services using XML feeds (where 
     18provided) and scraping HTML pages (where necessary). Your authors can then 
     19publish their action streams completely under their control: the provided 
     20template tags make it possible to display authors' accounts and actions on any 
     21page powered by Movable Type. The example templates and the provided template 
     22set also use the XFN and hAtom microformats and provide web feeds to integrate 
     23with tools your readers may be using. 
    2124 
    2225 
    … …  
    2629- Scheduled task or cron job to execute the Periodic Tasks script (see below) 
    2730 
    28 The Action Streams plugin ships with all of the external libraries you should need to run it. 
     31The Action Streams plugin ships with all of the external libraries you should 
     32need to run it. 
    2933 
    30 Note: Action Streams does not work when run-periodic-tasks is run in daemon mode. 
     34Note: Action Streams does not work when run-periodic-tasks is run in daemon 
     35mode. 
    3136 
    3237 
    … …  
    3944  4. Copy the contents of ActionStreams/plugins into /path/to/mt/plugins/ 
    4045  5. Navigate to your profile, and click on "Other Profiles." 
    41   6. Build a list of your accounts that you wish to display and stream actions from. 
     46  6. Build a list of your accounts from which to display and stream actions. 
    4247  7. Edit your stylesheet to include needed CSS. (see STYLES below) 
    43   8. Edit your templates to display your other profiles and your Action Stream. (see 
    44      example_templates folder)  A template set is also provided for convenience. 
    45   9. Edit the plugin's settings to enable automatically rebuilding your blog as new 
    46      actions are imported.  This setting is under each of your blog's plugin settings. 
     48  8. Edit your templates to display your other profiles and your Action 
     49     Stream. (See the Template Author Guide in the doc/ folder.) A template 
     50     set is also provided for convenience. 
     51  9. Edit the plugin's settings to enable automatically rebuilding your blog 
     52     as new actions are imported. This setting is under each of your blog's 
     53     plugin settings. 
    4754 
    4855 
    4956CRONJOB 
    5057 
    51 Action Streams uses Movable Type's scheduled task system to collect your action data 
    52 from remote services. To run scheduled tasks, configure a cron job to run MT's 
    53 tools/run-periodic-tasks script periodically. 
     58Action Streams uses Movable Type's scheduled task system to collect your 
     59action data from remote services. To run scheduled tasks, configure a cron job 
     60to run MT's tools/run-periodic-tasks script periodically. 
    5461 
    55 Add the following lines to your crontab to execute the script every 10 minutes: 
     62Add the following lines to your crontab to execute the script every 10 
     63minutes: 
    5664 
    5765  # Movable Type scheduled tasks 
    … …  
    6169STYLES 
    6270 
    63 To add icons to your Action Streams and other basic styling, add the following line to  
    64 the top of your main stylesheet (normally styles.css).  
     71To add icons to your Action Streams and other basic styling, add the following 
     72line to the top of your main stylesheet (normally styles.css). 
    6573 
    66   @import url(<MT:StaticWebPath>/plugins/ActionStreams/css/action-streams.css); 
     74  @import url(<MT:StaticWebPath>plugins/ActionStreams/css/action-streams.css); 
    6775 
    68 The classes used in the template code examples use the same classes as the default templates 
    69 and thus they work well with the default themes. 
     76The classes used in the template code examples use the same classes as the 
     77default templates and thus they work well with the default themes. 
    7078 
    7179 
    7280TEMPLATE CODE 
    7381 
    74 The example_templates folder within the Action Streams plugin includes example widgets and 
    75 index templates which make use of an author's Other Profiles and Action Stream.  Though it 
    76 is possible to create Action Streams combining actions from multiple authors, all of the  
    77 examples display profiles or actions from a single author. 
     82See the Template Author Guide in the doc/ folder for help with Action Streams' 
     83template tags. 
    7884 
    79 The following template code will produce a list of actions for the author "Melody Nelson": 
    80  
    81   <mt:ActionStreams display_name="Melody Nelson" lastn="20"> 
    82       <mt:if name="__first__"> 
    83   <div class="action-stream"> 
    84       <ul class="action-stream"> 
    85       </mt:if> 
    86           <li class="service-icon service-<mt:var name="service_type">"><mt:StreamAction></li> 
    87       <mt:if name="__last__"> 
    88       </ul> 
    89   </div> 
    90       </mt:if> 
    91   </mt:ActionStreams> 
    92  
    93 It is recommended that you add the above code as a template module or widget to make it 
    94 easier to include and display profile actions throughout your web site. 
    95  
    96 For more detailed examples see the templates in the example_templates directory. 
    97  
    98 There are additional template tags, such as mt:StreamActionThumbnailURL, which need to 
    99 be documented better in the future. 
    100     <mt:setvarblock name="thumb_url"><mt:StreamActionThumbnailURL></mt:setvarblock> 
    101     <mt:if name="thumb_url"> 
    102         <div style='padding-left: 20px; padding-bottom: 10px; padding-top: 5px;'> 
    103             <img src='<mt:var name='thumb_url'>' /> 
    104         </div> 
    105     </mt:if> 
    10685 
    10786CREDITS