Code Monkey home page Code Monkey logo

ikiwiki-irclog's Introduction

irclog Plugin for IkiWiki

This IkiWiki plugin provides the [[!irclog]] directive which formats an IRC log for inclusion in your wiki.

Installation

The following CPAN modules must be available on the system on which your wiki is built:

  • Parse::IRCLog
  • String::Formatter
  • File::Temp (depending on log retrieval method)

The following core (in 5.18 at least) modules are also required:

  • URI
  • Time::Piece

The repository contains two modules: IkiWiki::Plugin::irclog and Parse::IRCLog::dircproxy; this module I've also pushed on a fork of Parse::IRCLog here.

You need to ensure that IkiWiki can see both of those modules, e.g. put (or symlink) them in custom plugins directory (~/.ikiwiki is common).

Usage

The [[!irclog]] directive takes the following arguments:

location

The URI of your IRC log file. Currently the URI schemes file:, http:, and ssh: have been implemented. Only ssh: has been tested: ssh://host/path/to/#channel.

earliest

A date/time in the format %F %T (i.e. YYYY-MM-DD HH:MM:SS). Events before this time will not be included. String comparison is used, so you can omit portions of the date/time if you like, e.g. YYYY-MM.

latest

A date/time. Events after this time will not be included.

keywords

A mapping of keywords to translations, formatted like a Perl hash, e.g.: richard=>[[richard]]. In this case occurrences of "richard" will be replaced with "[[richard]]" (which will later be processed as a WikiLink).

Limitations

Including, but not limited to:

  • Retrieval by SSH makes no provision for needing to supply a login password or private key password. (Consider using a key agent or a password-less key.)
  • Other retrieval methods are untested.

Others greatly received, especially with pull requests.

Richard Lewis, London.

ikiwiki-irclog's People

Contributors

ironchicken avatar

Watchers

 avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.