massivebox/feed2toot-docker
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

add explainations for no_tags_in_toot, toot_max_len and line break in toot

Browse source
This commit is contained in:
Carl Chenet 2019-12-31 12:26:43 +01:00
parent 976fc03224
commit 4ed27c721f
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/source/configure.rst
View file

@ -41,6 +41,7 @@ In order to configure Feed2toot, you need to create a feed2toot.ini file (or any
uri=https://www.journalduhacker.net/rss uri=https://www.journalduhacker.net/rss
uri_list=/etc/feed2toot//rsslist.txt uri_list=/etc/feed2toot//rsslist.txt
toot={title} {link} toot={title} {link}
; toot_max_len=125
title_pattern=Open Source title_pattern=Open Source
title_pattern_case_sensitive=true title_pattern_case_sensitive=true
no_uri_pattern_no_global_pattern=true no_uri_pattern_no_global_pattern=true
@ -48,6 +49,7 @@ In order to configure Feed2toot, you need to create a feed2toot.ini file (or any
[hashtaglist] [hashtaglist]
several_words_hashtags_list=/etc/feed2toot/hashtags.txt several_words_hashtags_list=/etc/feed2toot/hashtags.txt
; no_tags_in_toot=false
[feedparser] [feedparser]
accept_bozo_exceptions=true accept_bozo_exceptions=true
@ -81,7 +83,8 @@ For the [rss] section:
- uri: the url of the rss feed to parse - uri: the url of the rss feed to parse
- uri_list: a path to a file with several adresses of rss feeds, one by line. Absolute path is mandatory. - uri_list: a path to a file with several adresses of rss feeds, one by line. Absolute path is mandatory.
- toot: format of the toot you want to post. It should use existing entries of the RSS fields like {title} or {link}. Launch it with this field empty to display all available entries. If you want to shorten the size of a field, you can use the syntax {summary:.100} to cut the field "summary" of the rss feed after the first 100 characters (starting from Feed2toot 0.10). - toot: format of the toot you want to post. It should use existing entries of the RSS fields like {title} or {link}. Launch it with this field empty to display all available entries. If you want to shorten the size of a field, you can use the syntax {summary:.100} to cut the field "summary" of the rss feed after the first 100 characters (starting from version 0.10). To add new lines you can use \n (starting from version 0.14)
- toot_max_len: the max length of a toot can be defined here. If the toot size is longer, the toot is truncated and "..." added at the end. Defaults is 500 characters.
- {one field of the rss feed}_pattern: takes a string representing a pattern to match for a specified field of each rss entry of the rss feed, like title_pattern or summary_pattern. - {one field of the rss feed}_pattern: takes a string representing a pattern to match for a specified field of each rss entry of the rss feed, like title_pattern or summary_pattern.
- {one field of the rss feed}_pattern_case_sensitive: either the pattern matching for the specified field should be case sensitive or not. Default to true if not specified. - {one field of the rss feed}_pattern_case_sensitive: either the pattern matching for the specified field should be case sensitive or not. Default to true if not specified.
- no_uri_pattern_no_global_pattern: don't apply global pattern (see above) when no pattern-by-uri is defined in the uri_list. Allows to get all entries of a rss in the uri_list because no pattern is defined so we match them all. Defaults to false, meaning the global patterns will be tried on every rss in the uri_list NOT HAVING specific patterns and so ONLY entries from the specific uri in the uri_list matching the global patterns will be considered. - no_uri_pattern_no_global_pattern: don't apply global pattern (see above) when no pattern-by-uri is defined in the uri_list. Allows to get all entries of a rss in the uri_list because no pattern is defined so we match them all. Defaults to false, meaning the global patterns will be tried on every rss in the uri_list NOT HAVING specific patterns and so ONLY entries from the specific uri in the uri_list matching the global patterns will be considered.
@ -91,6 +94,7 @@ For the [rss] section:
For the [hashtaglist] section: For the [hashtaglist] section:
- several_words_hashtags_list: a path to the file containing hashtags in two or more words. Absolute path is mandatory. By default Feed2toot adds a # before every words of a hashtag. See documentation below for an example of this file. - several_words_hashtags_list: a path to the file containing hashtags in two or more words. Absolute path is mandatory. By default Feed2toot adds a # before every words of a hashtag. See documentation below for an example of this file.
- no_tags_in_toot: stop hash tags to be added at the toot. Defaults to false.
for the [feedparser] section: for the [feedparser] section: