|
|
||
|---|---|---|
| local | ||
| README.md | ||
| __init__.py | ||
| __init__.pyc | ||
| config.py | ||
| config.pyc | ||
| plugin.py | ||
| plugin.pyc | ||
| test.py | ||
| test.pyc | ||
README.md
SpiffyTitles
Displays link titles when posted in a channel. This plugin has the following goals:
-
Extreme reliability and in the case of failure, robust error reporting to ease debugging. Errors are logged.
-
The ability to customize features that could conceivably need to change (within reason)
Using SpiffyTitles
- You should
unloadthe Web plugin and any other plugins that show link titles for best results
To unload the Web plugin:
!unload Web
Load SpiffyTitles:
!load SpiffyTitles
Available Options
defaultTitleTemplate - This is the template used when showing the title of a link.
Default value: ^ %s
Example output:
^ Google.com
youtubeTitleTemplate - This is the template used when showing the title of a YouTube video
Default value: ^ %s :: Views: %s :: Rating: %s
Example output:
^ Snoop Dogg - Pump Pump feat. Lil Malik :: Views: 188,681 :: Rating: 4.82
useBold - Whether to bold the title. Default value: False
channelWhitelist - a comma separated list of channels in which titles should be displayed. If False,
titles will be shown in all channels. Default value: []
ignoredDomainPatterns - a comma separated list of strings that are regular expressions to match
against URLs posted in channels. Default value: []
Examples
Ignore all domains matching *.tk
(.*)\.tk
Ignore all domains matching *.net
(.*)\.net
userAgents - A comma separated list of strings of user agents randomly chosen when requesting.
urlRegularExpression - A regular expression used to match URLs. You shouldn't need to change this.
FAQ
Q: Why not use the Web plugin?
A: My experience was that it didn't work very well and lacked the ability to customize the options I wanted to change.
Q: What about Supybot-Titler ?
A: I couldn't get this to work on my system and it has a lot of features I didn't want
Q: It doesn't work for me. What can I do?
A: Open an issue and include at minimum the following:
- Brief description of the problem
- Any errors that were logged (Look for the ones prefixed "SpiffyTitles")
- How to reproduce the effect
- Any other information you think would be helpful