Extension:LogEntry

From mediawiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
LogEntry
Release status: unmaintained
Implementation Tag
Description Provides a form for appending to log pages
Author(s) Trevor Parscaltalk
MediaWiki 1.29+
License GNU General Public License 2.0 only
Download
  • $egLogEntryMultiLine
  • $egLogEntryMultiLineRows
  • $egLogEntryUserName
  • $egLogEntryTimeStamp
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 Interface[edit]

Adding a LogEntry box[edit]

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 page[edit]

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.

Installation[edit]

  • 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' );
    
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit]

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