[CDB] Markdown

A place for Extension Authors to post and receive feedback on Extensions still in development. No Extensions within this forum should be used within a live environment!
Scam Warning
Forum rules
READ: phpBB.com Board-Wide Rules and Regulations

IMPORTANT: Extensions Development rules

IMPORTANT FOR NEEDED EVENTS!!!
If you need an event for your extension please read this for the steps to follow to request the event(s)
User avatar
AbaddonOrmuz
Registered User
Posts: 601
Joined: Wed Dec 25, 2013 9:06 pm
Location: /dev/null
Name: Alfredo Ramos
Contact:

[CDB] Markdown

Post by AbaddonOrmuz » Sun Jan 20, 2019 12:04 pm

Extension Name: Markdown
Author: Alfredo Ramos (Abaddon Ormuz)
Extension Description:

Allows the use of Markdown on posts, personal messages and signatures.

It uses the Litedown plugin to render Markdown, and PipeTables to render tables, both from the TextFormatter library bundled in phpBB.

Image Image

Extension Version: 1.0.0

Requirements:
  • PHP 5.6 or greater
  • phpBB 3.2 or greater
Features:
  • Use Markdown in posts, personal messages and signatures
  • Can be used instead of or alongside text formatted with BBCode
  • Configuration to enable/disable the use of Markdown globally in the ACP
  • Configuration to enable/disable the use of Markdown per user in the UCP
  • Set per user group permissions to use Markdown
  • Set per forum permissions to use Markdown
  • Posting option to disable Markdown only in the current message (see note below)
  • Add help page to explain users how write messages in Markdown
Note: You need phpBB v3.2.6-RC1 or greater (PHPBB3-15949, #5519) to use the custom posting editor option to disable Markdown in the signature.

Install instructions: https://www.phpbb.com/extensions/installing/

Screenshots:
ImageImage
ImageImage
ImageImage
ImageImage
ImageImage
ImageImage

Extension Download: alfredoramos_markdown_1.0.0.zip

Note: To update between development versions, disable and delete all the extension data before installing the new version.

GitHub Repository: AlfredoRamos/phpbb-ext-markdown
Last edited by AbaddonOrmuz on Tue Jun 18, 2019 4:04 pm, edited 16 times in total.
A proudly user of Arch Linux :: /r/sddm_themes

User avatar
AbaddonOrmuz
Registered User
Posts: 601
Joined: Wed Dec 25, 2013 9:06 pm
Location: /dev/null
Name: Alfredo Ramos
Contact:

Re: [3.2][DEV] Markdown

Post by AbaddonOrmuz » Sun Jan 20, 2019 12:04 pm

Changelog:
  • 1.0.0 - 2019-05-24
    • First official stable release. No changes
  • 0.9.0-beta - 2019-05-09
    • Add more granular permissions
  • 0.8.0-beta - 2019-04-24
    • Fix typo in English translation
    • Add a more granular user group permissions
    • Add signature posting box option to disable Markdown (requires phpBB 3.2.6-RC1)
  • 0.7.1-beta - 2019-04-17
    • Fix Markdown help page
    • Fix Markdown status in posting box for small screens
  • 0.7.0-beta - 2019-03-12
    • Fixes in English language files
    • Fixes in template files
    • Add Spanish translations
  • 0.6.0-dev - 2019-02-05
    • Small fix in Markdown status, in posting editor
    • Markdown help page finished
    • Add support for tables
  • 0.5.0-dev - 2019-01-24
    • Fix user posting preferences in UCP
    • Fix Markdown status in UCP
    • Fix version check in extension list (ACP > Customize)
  • 0.4.0-dev - 2019-01-23
    • Add per user group permissions to use Markdown
    • Add Markdown status in posting editor
    • User permissions simplified
  • 0.3.0-dev - 2019-01-21
    • First release
Last edited by AbaddonOrmuz on Fri May 24, 2019 7:53 pm, edited 10 times in total.
A proudly user of Arch Linux :: /r/sddm_themes

nou nou
Registered User
Posts: 319
Joined: Sat Oct 29, 2016 8:08 pm

Re: [3.2][DEV] Markdown

Post by nou nou » Sun Jan 20, 2019 3:55 pm

Ooooh nice idea!

(I think your extension name is a copy/paste victim in your op :) )

nou nou
Registered User
Posts: 319
Joined: Sat Oct 29, 2016 8:08 pm

Re: [3.2][DEV] Markdown

Post by nou nou » Sun Jan 20, 2019 5:42 pm

Just out of interest, how similar is the Litedown syntax to the one used on, say, GitHub for example?

Would one be able to just take the contents of a readme.md file and paste it, as is, in a post?

And would it be possible to support extensions (or vice versa) such as https://www.phpbb.com/customise/db/exte ... edge_base/

User avatar
canonknipser
Registered User
Posts: 1961
Joined: Thu Sep 08, 2011 4:16 am
Location: Germany
Name: Frank Jakobs
Contact:

Re: [3.2][DEV] Markdown

Post by canonknipser » Sun Jan 20, 2019 7:19 pm

nou nou wrote:
Sun Jan 20, 2019 5:42 pm
Just out of interest, how similar is the Litedown syntax to the one used on, say, GitHub for example?
Maybe reading the doc will give you a clue? -> https://s9etextformatter.readthedocs.io ... wn/Syntax/
Greetings, Frank
phpbb.de support team member
English is not my native language - no support via PM or mail
New arrival - Extensions and scripts for phpBB

User avatar
AbaddonOrmuz
Registered User
Posts: 601
Joined: Wed Dec 25, 2013 9:06 pm
Location: /dev/null
Name: Alfredo Ramos
Contact:

Re: [3.2][DEV] Markdown

Post by AbaddonOrmuz » Sun Jan 20, 2019 8:05 pm

nou nou wrote:
Sun Jan 20, 2019 3:55 pm
(I think your extension name is a copy/paste victim in your op :) )
Right :D fixed
nou nou wrote:
Sun Jan 20, 2019 5:42 pm
Just out of interest, how similar is the Litedown syntax to the one used on, say, GitHub for example?

Would one be able to just take the contents of a readme.md file and paste it, as is, in a post?
Well, I would say that it has all of the basic syntax implemented, but the GitHub Flavored Markdown has some extras that Litedown does not, like task lists and some other that are specifically for GitHub like mentions, commit, issues or pull request references.

If you don't use any of the extras in your README, you could just copy and paste its content and it should show you the same way as in GitHub, but Markdown hasn't been standardized yet so you would need to test.
nou nou wrote:
Sun Jan 20, 2019 5:42 pm
And would it be possible to support extensions (or vice versa) such as https://www.phpbb.com/customise/db/exte ... edge_base/
Does not work with that extension?

Because all the work is done by the same engine responsible for rendering BBCodes, so if you can render BBCodes you can also render Markdown.
A proudly user of Arch Linux :: /r/sddm_themes

User avatar
AbaddonOrmuz
Registered User
Posts: 601
Joined: Wed Dec 25, 2013 9:06 pm
Location: /dev/null
Name: Alfredo Ramos
Contact:

Re: [3.2][DEV] Markdown

Post by AbaddonOrmuz » Mon Jan 21, 2019 7:55 pm

A test version is available, see screenshots for configuration and usage examples.

https://s9etextformatter.readthedocs.io ... wn/Syntax/
A proudly user of Arch Linux :: /r/sddm_themes

nou nou
Registered User
Posts: 319
Joined: Sat Oct 29, 2016 8:08 pm

Re: [3.2][DEV] Markdown

Post by nou nou » Tue Jan 22, 2019 6:00 pm

Works beautifully so far!

Tested in Knowledge Base, Canidev Chat and mChat extensions so far and all is well.

There are indeed some differences with the GitHub syntax (excuse my ignorance, I didn't know there wasn't a standard) but I'll figure those out in good time and see what I can do to mitigate that...

Great work, I can see this becoming quite popular!

User avatar
3Di
Former Team Member
Posts: 13664
Joined: Mon Apr 04, 2005 11:09 pm
Location: Milan (IT) Frankfurt (DE)
Name: Marco
Contact:

Re: [3.2][DEV] Markdown

Post by 3Di » Tue Jan 22, 2019 6:24 pm

I like it :)
Not checked yet but a question arises: have you coded also an "on a per group" basis sort of thing?
Please PM me only to request paid works. Thx.
Want to compensate me for my interest? Donate
My development's activity º PhpStorm's proud user
Extensions, Scripts, MOD porting, Update/Upgrades
👨‍🏫 | Take a tour to | The Studio | 👨‍🏫

nou nou
Registered User
Posts: 319
Joined: Sat Oct 29, 2016 8:08 pm

Re: [3.2][DEV] Markdown

Post by nou nou » Tue Jan 22, 2019 6:46 pm

3Di wrote:
Tue Jan 22, 2019 6:24 pm
I like it :)
Not checked yet but a question arises: have you coded also an "on a per group" basis sort of thing?

It's per forum, but I haven't tested that part of the extension yet myself.

How could it work per group, though?

User avatar
3Di
Former Team Member
Posts: 13664
Joined: Mon Apr 04, 2005 11:09 pm
Location: Milan (IT) Frankfurt (DE)
Name: Marco
Contact:

Re: [3.2][DEV] Markdown

Post by 3Di » Tue Jan 22, 2019 6:51 pm

Using the same library if I am not mistaken.
Please PM me only to request paid works. Thx.
Want to compensate me for my interest? Donate
My development's activity º PhpStorm's proud user
Extensions, Scripts, MOD porting, Update/Upgrades
👨‍🏫 | Take a tour to | The Studio | 👨‍🏫

nou nou
Registered User
Posts: 319
Joined: Sat Oct 29, 2016 8:08 pm

Re: [3.2][DEV] Markdown

Post by nou nou » Tue Jan 22, 2019 8:31 pm

Maybe I'm not nuderstanding right - are you talking about per group permissions or something else?

I meant practically - if you have a group able to use this and another not, what would that look like?

User avatar
AbaddonOrmuz
Registered User
Posts: 601
Joined: Wed Dec 25, 2013 9:06 pm
Location: /dev/null
Name: Alfredo Ramos
Contact:

Re: [3.2][DEV] Markdown

Post by AbaddonOrmuz » Tue Jan 22, 2019 8:44 pm

nou nou wrote:
Tue Jan 22, 2019 6:00 pm
Tested in Knowledge Base, Canidev Chat and mChat extensions so far and all is well.
Thanks, please let me know if you find issues-
3Di wrote:
Tue Jan 22, 2019 6:24 pm
I like it :)
Not checked yet but a question arises: have you coded also an "on a per group" basis sort of thing?
Not yet, but that would be a good addition.

I will read more about permissions, this is the first extension I do more than admin checks, so this is new for me.
nou nou wrote:
Tue Jan 22, 2019 8:31 pm
Maybe I'm not nuderstanding right - are you talking about per group permissions or something else?
Yes user group permissions, I think he meant that only administrators or moderators could use this feature, for example.
A proudly user of Arch Linux :: /r/sddm_themes

User avatar
3Di
Former Team Member
Posts: 13664
Joined: Mon Apr 04, 2005 11:09 pm
Location: Milan (IT) Frankfurt (DE)
Name: Marco
Contact:

Re: [3.2][DEV] Markdown

Post by 3Di » Tue Jan 22, 2019 8:53 pm

Yes, I will give you an example tomorrow :) or you can have a look at the ABBC3 extension AFAIR.
Please PM me only to request paid works. Thx.
Want to compensate me for my interest? Donate
My development's activity º PhpStorm's proud user
Extensions, Scripts, MOD porting, Update/Upgrades
👨‍🏫 | Take a tour to | The Studio | 👨‍🏫

User avatar
AbaddonOrmuz
Registered User
Posts: 601
Joined: Wed Dec 25, 2013 9:06 pm
Location: /dev/null
Name: Alfredo Ramos
Contact:

Re: [3.2][DEV] Markdown

Post by AbaddonOrmuz » Tue Jan 22, 2019 8:58 pm

3Di wrote:
Tue Jan 22, 2019 8:53 pm
Yes, I will give you an example tomorrow :) or you can have a look at the ABBC3 extension AFAIR.
Thanks :cool:

Will check ABBC too.
A proudly user of Arch Linux :: /r/sddm_themes

Locked

Return to “Extensions in Development”