Changes between Version 24 and Version 25 of IrcLogsPlugin


Ignore:
Timestamp:
Nov 19, 2015, 9:28:00 AM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • IrcLogsPlugin

    v24 v25  
    11[[PageOutline(2-5,Contents,pullout)]]
    22
    3 = IRC Logs Plugin
     3= Display IRC logs
    44
    55== Description
    … …  
    99Key features:
    1010 * Multi-channel support.
    11  * JS calendar provided by jquery-ui (much prettier).
     11 * Javascript calendar provided by jquery-ui (much prettier).
    1212 * Hard pyndexter dependency removed.
    1313 * Out-of-the-box gozerbot support.
    1414 * More flexible parser:
    15    * configuration based (add new formats with no code changes).
    16    * multi-file support (some loggers split logs into different files, gozerbot simple format for example).
    17  * DB backend support (look at the gozerbot chatlog plugin to create db irclogs).
     15   * configuration based: add new formats with no code changes.
     16   * multi-file support: some loggers split logs into different files, gozerbot simple format for example.
     17 * Database backend support: look at the gozerbot chatlog plugin to create database irc logs.
    1818 * Better timezone support, logs are displayed in the user's timezone.
    1919 * Unit tests.
    … …  
    2121=== Known issues
    2222 
    23  * Search is busted. It's on my list.
    24  * Days without logs are no longer shaded in the calendar. This is because we are using the user's timezone and it's much harder to tell what days have logs without doing an insane amount of parsing on each request. I hope to have some caching in the future that will allow this feature to come back. For most people it's not a problem because there is at least one message in their irc channel everyday.
     23 * Search is not functional yet.
     24 * Days without logs are no longer shaded in the calendar. This is because we are using the user's timezone and it's much harder to tell what days have logs without doing an insane amount of parsing on each request. I hope to have some caching in the future that will allow this feature to come back. For most people it's not a problem, because there is at least one message in their irc channel everyday.
    2525
    2626== Bugs/Feature Requests
    2727
    28 Existing bugs and feature requests for IrcLogsPlugin are [query:status!=closed&component=IrcLogsPlugin&order=priority here].
     28Existing bugs and feature requests for IrcLogsPlugin are [report:9?COMPONENT=IrcLogsPlugin here].
    2929
    3030If you have any issues, create a [/newticket?component=IrcLogsPlugin new ticket].
    … …  
    3434== Download and Source
    3535
    36 Download the  [download:irclogsplugin zipped source], check out [/svn/irclogsplugin using Subversion], or [source:irclogsplugin browse the source] with Trac.
     36Download the zipped source from [export:irclogsplugin here].
     37
     38== Source
     39
     40Check out IrcLogsPlugin from [/svn/irclogsplugin here] using Subversion, or [source:irclogsplugin browse the source] with Trac.
    3741
    3842== Installation
    3943
    40 Run "easy_install http://trac-hacks.org/svn/irclogsplugin/0.10/" for 0.10.4 Trac installations (not supported).
    41 
    42 Run "easy_install http://trac-hacks.org/svn/irclogsplugin/0.11/" for 0.11+ Trac installations.
    43 
    44 Run "easy_install http://trac-hacks.org/svn/irclogsplugin/parsing_refactor/" for cutting edge beta version (0.11+ Trac).
    45 
    46 The IrcLogsPlugin 0.11 depends on the http://swapoff.org/wiki/pyndexter python indexer. The beta version doesn't require pyndexter, but it will be needed for search capability. It is installed automatically by easy_install.
     44Run `easy_install http://trac-hacks.org/svn/irclogsplugin/0.10/` for 0.10.4 Trac installations (not supported).
     45
     46Run `easy_install http://trac-hacks.org/svn/irclogsplugin/0.11/` for 0.11+ Trac installations.
     47
     48Run `easy_install http://trac-hacks.org/svn/irclogsplugin/parsing_refactor/` for cutting edge beta version (0.11+ Trac).
     49
     50The IrcLogsPlugin 0.11 depends on the [http://swapoff.org/wiki/pyndexter python indexer]. The beta version doesn't require pyndexter, but it will be needed for search capability. It is installed automatically by easy_install.
    4751
    4852== Configuration 0.11
    … …  
    8387}}}
    8488
    85 To (re)index your log files, use this [attachment:"indexer.py" pydexter indexing python script]. Be sure to edit the two variables for file locations in the script.
     89To (re)index your log files, use this [attachment:"indexer.py" pyndexter indexing python script]. Be sure to edit the two variables for file locations in the script.
    8690
    8791'''Note:''' In order to enable indexing for 0.11, you'll currently need a patch, see comment:ticket:1183:6.
    … …  
    121125=== Database Configuration
    122126
    123 The database should take a standard Trac db connection string. If none is specified, then the Trac db will be used as the default. The database must contain a table with the following columns (time, network, target, nick, type, message). It is suggested that indexes are put on the time, (network, target) sets. Target is usually the channel name.
     127The database should take a standard Trac database connection string. If none is specified, then the Trac database will be used as the default. The database must contain a table with the following columns (time, network, target, nick, type, message). It is suggested that indexes are put on the time, (network, target) sets. Target is usually the channel name.
    124128
    125129{{{#!ini
    … …  
    188192=== "Live" Log
    189193
    190 Show a "live" AJAX log display.  '''Note:''' This macro should be used sparingly; it should not be on the front page of a project in most cases.
     194Show a "live" AJAX log display. '''Note:''' This macro should be used sparingly; it should not be on the front page of a project in most cases.
    191195{{{
    192196[[IrcLogLive]]
    … …  
    203207}}}
    204208
    205 The format is (channel)-(timestamp).  For the default channel, simply use timestamp. Timestamp is UTC date formatted to ''UTCYYYY-MM-DDTHH:MM:SS''.
     209The format is (channel)-(timestamp). For the default channel, simply use timestamp. Timestamp is UTC date formatted to ''UTCYYYY-MM-DDTHH:MM:SS''.
    206210
    207211=== Quote
    … …  
    211215[[IrcLogQuote(channel=trac, datetime=UTC2009-07-19T13:20:30, offset=3360)]]
    212216}}}
    213 channel is the default channel if none is specified. ''There may not be a default channel setup though.''
     217channel is the default channel if none is specified. There may not be a default channel setup though.
    214218
    215219UTC date formatted to ''UTCYYYY-MM-DDTHH:MM:SS'', and (optional) offset, number of seconds to display.
    … …  
    224228'''Note:''' This macro should be used sparingly; it should not be on the front page of a project in most cases.
    225229
    226 This macro optionally takes three arguments: poll_frequency (default is 60), count (default is 10) and channel (default is default):
     230This macro takes 3 optional arguments: poll_frequency (default is 60), count (default is 10) and channel (default is default):
    227231
    228232{{{