Extension:LogEntry

From MediaWiki.org

Jump to: navigation, search

           

Manual on MediaWiki Extensions
List of MediaWiki Extensions
Crystal Clear action run.png
LogEntry

Release status: beta

Implementation  Tag
Description Provides a form for appending to log pages
Author(s)  Trevor ParscalTalk
Last Version  SVN (2008-10-24)
MediaWiki  1.14alpha and higher
License GPL v2
Download Download snapshot

Subversion [Help]
Browse source code

check usage (experimental)

This tag extension provides a way to add a single-line text input box to a page that will append the contents in a log-like fashion.

Contents

[edit] User Interface

[edit] Adding a LogEntry box

To add a LogEntry box to a page, place a <logentry /> tag to the page. The tag can be placed anywhere on the page, however it's recommended that it be placed at the top.

[edit] Appending a log page

LogEntry follows a simple format in the way that it appends to a page. Entries are grouped by month/day, and entries are list items which include (automatically) the time of entry and user who entered the text. Each day becomes a section using the format == section name == which is viewed as a header.

LogEntry does not parse the entire page - it finds the first section (a line that begins with an = sign) and evaluates if that section is for today or not, then either adds an entry to the section or creates a new section.

[edit] Installation

  • Copy the LogEntry folder into your extensions directory.
  • Add a <logentry /> tag to any page you wish to use the extension on.

[edit] Configuration

The following parameters can be set by defining values for the following variables in your LocalSettings.php file.

Parameter Description Default Value
$egLogEntryUserName Inserts the username of the user who created the entry true
$egLogEntryTimeStamp Inserts the timestamp for when the entry was created true
$egDraftsMultiLine true: multi-line input / false: single-line input false
$egDraftsMultiLineRows Number of rows for the multi-line input box if enabled 3