Formatter: Timeline

Compatible with: R6.1
Current version: 0.2 (beta)
Credits: /Dev/NewFeatures/Timeline

This formatter converts inline data into a timeline.

1. Features

  • supports both pipe (default) and semicolon as separator
  • the timeline can be sorted in reverse order
  • description text allows links, images and additional formatting
  • allows empty lines between the sets

2. Usage

Call via (timeline [order="asc|desc"] [delim=[pipe|semicolon])


%%(timeline) source%%


formatter/highlight/timeline.php

<?php

/*
    converts inline data into a timeline

    %%(timeline
        [order="asc|desc"]
        [delim="comma|semicolon"]
        )
    content
    %%

    [0] direction: 'l|r'    (left|right)
    [1] flag: 'Amsterdam'
    [2] time: 'July 1 & 2, 2022'
    [3] description: 'Dutch PHP Conference 2022'

    e.g.
    l | Moscow | September 12-13, 2022 | PHP Russia 2022
    r | Amsterdam | July 1 & 2, 2022 | Dutch PHP Conference 2022

    https://wackowiki.org/doc/Dev/PatchesHacks/Timeline
*/

// set defaults
$options['delim']    ??= 'pipe';
$options['order']    ??= 'asc';

$delim    = match($options['delim']) {
    'semicolon'    => ';',
    default        => '|',
};

// set CSS styles once
if (!isset($this->timline))
{
    $this->timline    = true;
    $tpl->style_n    = true;
}

// get data
$lines    = preg_split('/[\n]/u', $text);

if ($options['order'] == 'desc')
{
    $lines = array_reverse($lines);
}

foreach ($lines as $line)
{
    // blank
    if (preg_match('/^#|^\s*$/u', $line))
    {
        continue;
    }

    $tpl->enter('n_');

    $item = explode('|', $line);
    {
        // debug
        #Ut::debug_print_r($item);

        $direction    = match(trim($item[0])) {
            'r'            => 'r',
            default        => 'l',
        };

        // further string processing here (links, filter, ...)
        $flag            = trim($item[1] ?? '');
        $time            = trim($item[2] ?? '');
        $description    = trim($item[3] ?? '');

        if ($flag)
        {
            $tpl->direction        = $direction;
            $tpl->flag            = $flag;
            $tpl->time            = $time;
            $tpl->description    = $this->format($description, 'wiki', ['post_wacko' => true]);
        }
    }

    $tpl->leave(); // n_
}

formatter/highlight/template/timeline.tpl

[ === main === ]
<ignore>
	<!--notypo-->
	[ ' style ' ]
	<ul class="timeline">
		[= n _ =
		<li>
			<div class="direction-[ ' direction ' ]">
				<div class="flag-wrapper">
					<span class="flag">[ ' flag | e ' ]</span>
					<span class="time-wrapper">
						<span class="time">[ ' time | e ' ]</span>
					</span>
				</div>
				<div class="desc">[ ' description ' ]</div>
			</div>
		</li>
		=]
	</ul>	
	<!--/notypo-->
</ignore>

[ === style === ]
<style>[ ' n css ' ]</style>

[ === css === ]
[ ' nonstatic ' ]
/* ================ The Timeline ================ */

.timeline {
	position: relative;
	width: 660px;
	margin: 0 auto;
	margin-top: 20px;
	padding: 1em 0;
	list-style-type: none;
}

.timeline:before {
	position: absolute;
	left: 50%;
	top: 0;
	content: ' ';
	display: block;
	width: 6px;
	height: 100%;
	margin-left: -3px;
	background: rgb(80,80,80);
	background: linear-gradient(to bottom, rgba(80,80,80,0) 0%, rgb(80,80,80) 8%, rgb(80,80,80) 92%, rgba(80,80,80,0) 100%);

	z-index: 5;
}

.timeline li {
	padding: 1em 0;
}

.timeline li:after {
	content: '';
	display: block;
	height: 0;
	clear: both;
	visibility: hidden;
}

.timeline div:hover {
	background: var(--ww-hover-secondary);
}

.direction-l {
	position: relative;
	width: 300px;
	float: left;
	text-align: right;
}

.direction-r {
	position: relative;
	width: 300px;
	float: right;
}

.flag-wrapper {
	position: relative;
	display: inline-block;

	text-align: center;
}

.flag {
	position: relative;
	display: inline;
	background: rgb(248,248,248);
	padding: 6px 10px;
	border-radius: 5px;

	font-weight: 600;
	text-align: left;
}

.direction-l .flag {
	box-shadow: -1px 1px 1px rgba(0,0,0,0.15), 0 0 1px rgba(0,0,0,0.15);
}

.direction-r .flag {
	box-shadow: 1px 1px 1px rgba(0,0,0,0.15), 0 0 1px rgba(0,0,0,0.15);
}

.direction-l .flag:before,
.direction-r .flag:before {
	position: absolute;
	top: 50%;
	right: -40px;
	content: ' ';
	display: block;
	width: 12px;
	height: 12px;
	margin-top: -10px;
	background: #fff;
	border-radius: 10px;
	border: 4px solid rgb(255,80,80);
	z-index: 10;
}

.direction-r .flag:before {
	left: -40px;
}

.direction-l .flag:after {
	content: '';
	position: absolute;
	left: 100%;
	top: 50%;
	height: 0;
	width: 0;
	margin-top: -8px;
	border: solid transparent;
	border-left-color: rgb(248,248,248);
	border-width: 8px;
	pointer-events: none;
}

.direction-r .flag:after {
	content: '';
	position: absolute;
	right: 100%;
	top: 50%;
	height: 0;
	width: 0;
	margin-top: -8px;
	border: solid transparent;
	border-right-color: rgb(248,248,248);
	border-width: 8px;
	pointer-events: none;
}

.time-wrapper {
	display: inline;
	
	line-height: 1rem;
	font-size: 0.66666rem;
	color: rgb(250,80,80);
	vertical-align: middle;
}

.direction-l .time-wrapper {
	float: left;
}

.direction-r .time-wrapper {
	float: right;
}

.time {
	display: inline-block;
	padding: 4px 6px;
	background: rgb(248,248,248);
}

.desc {
	margin: 1rem 0.75rem 0 0;
	
	font-size: 0.77777rem;
	font-style: italic;
	line-height: 1.5rem;
}

.direction-r .desc {
	margin: 1em 0 0 0.75rem;
}

/* ================ Timeline Media Queries ================ */

@media screen and (max-width: 660px) {

	.timeline {
		width: 100%;
		padding: 4rem 0 1rem 0;
	}
	
	.timeline li {
		padding: 2rem 0;
	}
	
	.direction-l,
	.direction-r {
		float: none;
		width: 100%;
	
		text-align: center;
	}
	
	.flag-wrapper {
		text-align: center;
	}
	
	.flag {
		background: rgb(255,255,255);
		z-index: 15;
	}
	
	.direction-l .flag:before,
	.direction-r .flag:before {
		position: absolute;
		top: -30px;
		left: 50%;
		content: ' ';
		display: block;
		width: 12px;
		height: 12px;
		margin-left: -9px;
		background: #fff;
		border-radius: 10px;
		border: 4px solid rgb(255,80,80);
		z-index: 10;
	}
	
	.direction-l .flag:after,
	.direction-r .flag:after {
		content: '';
		position: absolute;
		left: 50%;
		top: -8px;
		height: 0;
		width: 0;
		margin-left: -8px;
		border: solid transparent;
		border-bottom-color: rgb(255,255,255);
		border-width: 8px;
		pointer-events: none;
	}
	
	.time-wrapper {
		display: block;
		position: relative;
		margin: 4px 0 0 0;
		z-index: 14;
	}
	
	.direction-l .time-wrapper {
		float: none;
	}
	
	.direction-r .time-wrapper {
		float: none;
	}
	
	.desc {
		position: relative;
		margin: 1rem 0 0 0;
		padding: 1rem;
		background: rgb(245,245,245);
		box-shadow: 0 0 1px rgba(0,0,0,0.20);
	
		z-index: 15;
	}
	
	.direction-l .desc,
	.direction-r .desc {
		position: relative;
		margin: 1rem 1em 0 1rem;
		padding: 1rem;
	
		z-index: 15;
	}

}

@media screen and (min-width: 400px ?? max-width: 660px) {

	.direction-l .desc,
	.direction-r .desc {
		margin: 1em 4em 0 4em;
	}

}

2.1. local usage of repository

Symlink the formatter from community folder in the src/formatter/highlight folder and the corresponding template in the src/formatter/highlight/template folder in your repo.

ln -s ../../../community/formatter/highlight/timeline.php timeline.php
ln -s ../../../../community/formatter/highlight/template/timeline.tpl timeline.tpl

3. Example


%%(timeline)
l | Moscow | September 12-13, 2022 | PHP Russia 2022
r | Amsterdam | July 1 & 2, 2022 | Dutch PHP Conference 2022
%%


  • Moscow September 12-13, 2022
    PHP Russia 2022
  • Amsterdam July 1 & 2, 2022
    Dutch PHP Conference 2022

4. Changelog

0.1 Backported
0.2 Added template

5. To Do

  • add additional $options['parameter'] and CSS class styles
  • modify the formatter for your purpose
  • move inline CSS to CSS file

Referring pages:

  1. Dev/NewFeatures/Timeline
  2. Dev/PatchesHacks
  3. Dev/Release/R6.1/ReleaseNotes
  4. Dev/ReleaseNotes