/lizardlinky

A bot that will expand [[wikilinks]] seen in an IRC channel into full URLs. Please do not push directly to this repo - it is a publish-only mirror of a repository at LizardNet Code Review.

Primary LanguagePHPOtherNOASSERTION

LizardLinky - A Wikilink Expansion Bot

Please note that LizardLinky is still in its infancy. It is not yet ready for production use, and does not yet do everything described in this document (as of this writing, it doesn't even expand wikilinks -- yet).

Introduction

With the rise of Wikipedia has come the adoption of the wikilink to refer to Wikipedia articles (and, more generally, wiki articles). Wikilinks look like this: [[Main Page]]; text surrounded by double-brackets, with the text within the double brackets being the name of the article referred to.

LizardLinky is a bot that sits in IRC channels and looks for wikilinks like this. When it sees them, it will automatically "expand" them by sending a complete URL to the channel pointing to the wikilink's target. By default, LizardLinky bases its URLs off of Wikipedia, but this can be configured per-channel.

The name LizardLinky is derived from the name of a now long-defunct bot on the freenode IRC network, called unilinky, which LizardLinky attempts to replicate in functionality and features.

License

LizardLinky

By Andrew "FastLizard4" Adams and the LizardLinky Development Team (see AUTHORS.txt file)

Copyright (C) 2014 by Andrew "FastLizard4" Adams and the LizardLinky Development Team. Some rights reserved.

License GPLv3+: GNU General Public License version 3 or later (at your choice): http://gnu.org/licenses/gpl.html. This is free software: you are free to change and redistribute it at your will provided that your redistribution, with or without modifications, is also licensed under the GNU GPL. (Although not required by the license, we also ask that you attribute us!) There is NO WARRANTY FOR THIS SOFTWARE to the extent permitted by law.

Portions of this code are reused from a sister LizardNet project, the LizardIRC Network Operations Bot, which is also licensed under the GNU GPLv3+.

This is an open source project. The source Git repositories, which you are welcome to contribute to, can be found here:

Gerrit Code Review for the project:

Alternatively, the project source code can be found on the PUBLISH-ONLY mirror on GitHub.

Note: Pull requests and patches submitted to GitHub will be transferred by a developer to Gerrit before they are acted upon.