Custom BBcode

boxofficebuz

Has anyone figured out how to create custom BBcodes ?

I made one for phpBB for embedly [embedly={title}]{URL}[embedly] and basically it just added the embedly API js, and than pulled down an embedly card for the url that was posted.

Trying to figure out the best way to do this within Flarum.

0E800

Review:
https://discuss.flarum.org/d/4981-fontawesome-bbcode-extension

A good file to edit would probably be this one:
https://github.com/AntoineFr/flarum-ext-bbcode-fa/blob/master/src/Listeners/AddBBCode.php

0E800

I am going to try an attempt at creating my own custom bbcode but appending it to @Antoine extension.
I was going to try an easy one like [fractions] from here:
https://www.phpbb.com/customise/db/bbcode/fraction_bbcode/?sid=baf4a5bef659b9c35955f5063ce49afb

However, my test is not working as I am unable to get Flarum to recognize superscript.

Here is the code I am working with..

<?php namespace AntoineFr\BBCode\FA\Listeners;

use Flarum\Event\ConfigureFormatter;
use Illuminate\Contracts\Events\Dispatcher;

class AddBBCode
{
    public function subscribe(Dispatcher $events)
    {
        $events->listen(ConfigureFormatter::class, [$this, 'addBBCode']);
    }

    public function addBBCode(ConfigureFormatter $event)
    {
        $event->configurator->BBCodes->addCustom(
            '[FA]{IDENTIFIER}[/FA]',
            '<i class="fa fa-fw fa-{IDENTIFIER}"></i>'
        );
        $event->configurator->BBCodes->addCustom2(
            '[fraction]{NUMBER1}, {NUMBER2}[/fraction]',
            '<sup>{NUMBER1}</sup>&frasl;<sub>{NUMBER2}</sub>'

        );

    }
}

What I am wanting to believe is all I need to do is keep adding those '$event->configurator->BBCodes->addCustom#' for each custom bbcode I add.

This looks interesting:
https://github.com/golonka/BBCodeParser/blob/master/src/BBCodeParser.php
Not sure how to take the sub and sup code from that.

JoshyPHP

Beside the fact that there's no method called addCustom2, there's no reason to use a comma and a space to separate numbers. Why not simply use a slash? That's the obvious choice.

$event->configurator->BBCodes->addCustom(
	'[fraction sup={NUMBER1} sub={NUMBER2}]{NUMBER1}/{NUMBER2}[/fraction]',
	'<sup>{NUMBER1}</sup>&frasl;<sub>{NUMBER2}</sub>'
);

In that BBCode, I gave explicit names to the first and second numbers so they can be referenced by name. If you feel fancy, you can try to match vulgar fractions in plain text with something like that:

$event->configurator->Preg->match(
	'#\\b(?<sup>\\d+)/(?<sub>\\d+)(?!/)\\b#',
	'FRACTION'
);

0E800

JoshyPHP Thank you for your corrections. I am not familiar with the formatting.
The Fraction attempt was just to see if I could add another custom bbcode and how I would go about doing it.

Your totally correct with the addCustom2. I learned to just keep it the same, I was just not familiar with how to add another $event.

So I was able to successfully add another custom bbcode for Typicons:
http://typicons.com/

I wrote a small tutorial here showing how I added the addition bbcode:
https://discuss.flarum.org/d/5241-additions-to-antoine-fa-bbcode-extension-typicons

boxofficebuz

JoshyPHP I am going to try that out. Thank you !

010101

I wonder if this will work. I'll have to try it later.

Stealing the idea from:

JoshyPHP $event->configurator->BBCodes->addCustom(
'[fraction sup={NUMBER1} sub={NUMBER2}]{NUMBER1}/{NUMBER2}[/fraction]',
'<sup>{NUMBER1}</sup>&frasl;<sub>{NUMBER2}</sub>'
);

Change that to:

$event->configurator->BBCodes-addCustom(
'[audio]{MP3URL}/{OGGURL}/{WAVURL}[/audio]',
'<audio><source src="{OGGURL}" type="audio/ogg">
  <source src="{MP3URL}" type="audio/mpeg"> <source src="{WAVURL}" type="audio/wav">
  Your browser does not support the audio tag.
</audio>'
 );

Or, instead of slashes do mp3= ogg= and so on. Hmmm. ?

boxofficebuz

0E800 A+++ for the tutorial.

boxofficebuz

0E800

I forgot to mention, if icons don't apear, try
php flarum cache:clear

TB54

That thread is really old, but anyone still has the project of an extension for this? It would be a great way to bring a solution to the impossibily to directly add html into messages.

Creating BBcode (whether it's for the admin only, or for a new button everyone could use) is one of the only thing I miss from phpBB, it was a very easy way to solve tiny problems from different extensions (right now, for instance, I could solve my problems with the "Discussion thumbnail" extension by just adding the images needed in diplay:none).

It's a naive suggestion, as I suppose it's not compatible at all, but maybe it's possible to start from the code they used?

clarkwinkelmann

TB54 while such an extension could relatively easily be created, it's also not very complicated to do this locally by adding a few lines of code to the root extend.php file. The code Joshy shows above still works in the latest Flarum version, except you can use the Flarum\Extend\Formatter::configure() extender with a callback that takes $configurator as parameter instead of an event.

The syntax for BBCodes->addCustom() is probably extremely similar to the one used in phpbb if not identical.

Personally I've never had the need to make this into a database-backed extension since it's quicker and slightly more performant to do it via extend.php for one-offs. But it's probably under 1h of work if it was to be made as a sponsored extension.

TB54

Thanks! Well as always (I know it's an annoying answer, sorry!), I can't access it, being of freeflarum (I will move to flarum as soon as an interface is available, but for this year I'm afraid I will have to say it a lot...). But your explanation could help someone who have the same problem anyway!

Sponsored extension, if I'm sure it can be after that adopted on freeflarum, it's a possibility for me, but (newbie here) I have no idea how much such thing usually costs?