[Webfetch-commits] SF.net SVN: webfetch:[64] branches/v0.13/lib/WebFetch/Output/TWiki.pm

[<ik...@us...>]

Revision: 64
          http://webfetch.svn.sourceforge.net/webfetch/?rev=64&view=rev
Author:   ikluft
Date:     2009-09-21 04:22:34 +0000 (Mon, 21 Sep 2009)

Log Message:
-----------
docs

Modified Paths:
--------------
    branches/v0.13/lib/WebFetch/Output/TWiki.pm

Modified: branches/v0.13/lib/WebFetch/Output/TWiki.pm
===================================================================
--- branches/v0.13/lib/WebFetch/Output/TWiki.pm	2009-09-14 23:32:54 UTC (rev 63)
+++ branches/v0.13/lib/WebFetch/Output/TWiki.pm	2009-09-21 04:22:34 UTC (rev 64)
@@ -104,10 +104,34 @@
     $obj->do_actions; # process output
     $obj->save; # save results
 
-=head1 FUNCTIONS
+=head1 configuration from TWiki topic
 
-=head2 get_twiki_config
+The configuration information on feeds is kept in a TWiki page.  You can
+specify any page with a web and topic name, for example C<--config_topic=Feeds.WebFetchConfig> .
 
+The contents of that configuration page could look like this, though with
+any feeds you want to configure.  The "Key" field matches the --config_key
+command-line parameter, and then brings in the rest of the configuration
+info from that line.  An example is shown below.
+
+=over
+C<< ---+ !WebFetch Configuration >>
+
+C<< The following table is used by !WebFetch to configure news feeds >>
+
+C<< %STARTINCLUDE% >>
+C<< | *Key* | *Web* | *Parent* | *Prefix* | *Template* | *Form* | *Options* | *Modul >>
+e* | *Source* |
+C<< | ikluft-twitter | Feeds | TwitterIkluftFeed | TwitterIkluft | AtomFeedTemplate | AtomFeedForm | separate_topics | Atom | http://twitter.com/statuses/user_timeline/37786023.rss | >>
+C<< | twiki-twitter | Feeds | TwitterTwikiFeed | TwitterTwiki | AtomFeedTemplate | AtomFeedForm | separate_topics | Atom | http://search.twitter.com/search.atom?q=%23twiki | >>
+C<< | cnn | Feeds | RssCnn | RssCnn | RssFeedTemplate | RssFeedForm | separate_topics | RSS | http://rss.cnn.com/rss/cnn_topstories.rss | >>
+C<< %STOPINCLUDE% >>
+=back
+
+The C<%STARTINCLUDE%> and C<%STOPINCLUDE%> are not required.  However, if
+present, they are used as boundaries for the inclusion like in a normal
+INCLUDE operation on TWiki.
+
 =cut
 
 # read the TWiki configuation
@@ -219,10 +243,7 @@
 	WebFetch::debug "twiki_config: ".join( " ", %{$self->{twiki_config}});
 }
 
-=head2 write_to_twiki
-
-=cut
-
+# write to a TWiki page
 sub write_to_twiki
 {
 	my $self = shift;
@@ -269,10 +290,7 @@
 	}
 }
 
-=head2 write_to_twiki_topics
-
-=cut
-
+# write to separate TWiki topics
 sub write_to_twiki_topics
 {
 	my $self = shift;
@@ -380,10 +398,7 @@
 	}
 }
 
-=head2 write_to_twiki_metadata
-
-=cut
-
+# write to successive items of TWiki metadata
 sub write_to_twiki_metadata
 {
 	my $self = shift;
@@ -475,10 +490,6 @@
 	}
 }
 
-=head2 fmt_handler_twiki
-
-=cut
-
 # TWiki format handler
 sub fmt_handler_twiki
 {


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.