Open main menu

Extension:LogEntry

MediaWiki extensions manual
OOjs UI icon advanced.svg
LogEntry
Release status: beta
Implementation Tag
Description Provides a form for appending to log pages
Author(s) Trevor Parscaltalk
Latest version SVN (2008-10-24)
MediaWiki 1.14alpha and higher
License GPL v2
Download
Translate the LogEntry extension if it is available at translatewiki.net
Check usage and version matrix.
Issues Open tasks · Report a bug

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.

User InterfaceEdit

Adding a LogEntry boxEdit

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.

Appending a log pageEdit

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.

InstallationEdit

  • Download and place the file(s) in a directory called LogEntry in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    wfLoadExtension( 'LogEntry' );
    
  •   Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'LogEntry' );, you need to use:

require_once "$IP/extensions/LogEntry/LogEntry.php";

ConfigurationEdit

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