Skip to content
Provides a modern timeline visualization for Semantic MediaWiki as a result format
PHP Shell JavaScript CSS
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Delete PULL_REQUEST_TEMPLATE.md Aug 6, 2019
i18n Localisation updates from https://translatewiki.net. Aug 23, 2019
resources Only log when in debug mode Aug 14, 2019
src 1.1.0 release Aug 28, 2019
tests Run system tests with 3.1 dev Sep 5, 2019
.scrutinizer.yml Extend README and add ScrutinizerCI config Aug 8, 2019
.travis.install.sh
.travis.yml Update .travis.yml Aug 29, 2019
COPYING Add license file Jul 31, 2019
README.md Add config example Aug 28, 2019
RELEASE-NOTES.md Update RELEASE-NOTES.md Aug 29, 2019
composer.json 1.0.0 release Aug 16, 2019
extension.json 1.1.0 release Aug 28, 2019
phpunit.xml.dist Add JsonScript test class Aug 3, 2019

README.md

Modern Timeline

Build Status Code Coverage Scrutinizer Code Quality Latest Stable Version Download count

The Modern Timeline extension provides a modern timeline visualization for Semantic MediaWiki as a result format.

It was created by Professional.Wiki and funded by KDZ - Centre for Public Administration Research.

Platform requirements

  • PHP 7.1 or later
  • MediaWiki 1.31.x up to 1.34.x
  • Semantic MediaWiki 3.0 or later

Versions

See the RELEASE-NOTES for more information on the different versions of Modern Timeline.

Installation

The recommended way to install Modern Timeline is using Composer with MediaWiki's built-in support for Composer.

Note that the required extension Semantic MediaWiki must be installed first according to the installation instructions provided.

Step 1

Change to the base directory of your MediaWiki installation. If you do not have a "composer.local.json" file yet, create one and add the following content to it:

{
	"require": {
		"professional-wiki/modern-timeline": "~1.0"
	}
}

If you already have a "composer.local.json" file add the following line to the end of the "require" section in your file:

"professional-wiki/modern-timeline": "~1.0"

Remember to add a comma to the end of the preceding line in this section.

Step 2

Run the following command in your shell:

php composer.phar update --no-dev

Note if you have Git installed on your system add the --prefer-source flag to the above command.

Step 3

Add the following line to the end of your "LocalSettings.php" file:

wfLoadExtension( 'ModernTimeline' );

Usage

See also live demos at the following website: Professional.Wiki Starter demo wiki - Category:Modern Timeline examples.

The first date printout is used as date for the timeline events:

{{#ask:
 [[Modification date::+]]
 |format=moderntimeline
 |?Modification date
}}

If a second date printout is present it is used as end date and the event is displayed as a range:

{{#ask:
 [[Start date::+]]
 |format=moderntimeline
 |?Start date
 |?End date
}}

Display and behaviour of the timeline can be changed via several output parameters:

{{#ask:
 [[Modification date::+]]
 |format=moderntimeline
 |?Modification date
 |width=75%
 |height=500px
 |start at end=on
}}

Parameters

A full list of supported output parameters can be obtained in wiki via the smwdoc parser function:

{{#smwdoc: moderntimeline }}

Configuration

The default value of all parameters can be changed by placing configuration in LocalSettings.php. These configuration settings are available:

  • $wgModernTimelineWidth
  • $wgModernTimelineHeight
  • $wgModernTimelineBookmark
  • $wgModernTimelineBackground
  • $wgModernTimelineScaleFactor
  • $wgModernTimelinePosition
  • $wgModernTimelineTickWidth
  • $wgModernTimelineStartSlide
  • $wgModernTimelineStartAtEnd
  • $wgModernTimelineTransitionDuration
  • $wgModernTimelineNavHeight
  • $wgModernTimelineTemplate

Default values of these configuration settings can be found in extension.json. Do not change extension.json.

Example of changing one of the configuration settings:

$wgModernTimelineHeight = '500px';

Limitations

  • The template parameter is not supported on "Special:Ask"
  • The timeline style does not automatically match that of the wiki
  • The timeline language does not automatically match that of the wiki

Professional MediaWiki development is available via Professional Wiki.

Contribution and support

If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guideline.

Professional MediaWiki support is available via Professional Wiki.

License

GNU General Public License v2.0 or later (GPL-2.0-or-later).

You can’t perform that action at this time.