Friendica/zen_postbox
1
0
Fork 0
mirror of https://gitlab.com/randompenguin/zen_postbox.git synced 2025-04-27 19:40:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
zen_postbox/README.md
Random Penguin ff049eed11 Edit README.md
2025-03-25 13:33:52 -05:00

3 KiB
Raw Permalink Blame History

Zen Postbox

This is a Friendica add-on that adds a Jot Plugin tool button to the Compose editor allowing users to easily select any of the "Postbox" color backgrounds.

Postbox color backgrounds are similar to a Facebook feature for text-only posts, except Friendica's allows any arbitrary content and users may have more than on Postbox per post. Support for Postbox is built into the Bookface 1.6+ scheme for Frio, but this addon will enable it regardless of what theme/scheme is being used.

This add-on also adds support for displaying Postbox content in all feeds no matter what theeme is in use.

Note: It has "zen" on the beginning of the name just to make the add-on load AFTER other Jot Plugins. In particular the "Smileybutton" add-on which has a typo that clears any Jot Plugins that load before it.

Getting started

  1. Place the "zen_postbox" folder in your friendica/addons subfolder.
  2. Go to the Main Menu > Admin > Addons and enable "Zen Postbox"
  3. On the Compose Modal or Compose Page you should see a rainbox button that opens a background selector.

Using Zen Postbox

  1. Open the message Compose modal or Page
  2. To wrap text, etc., in a Postbox select it in the message editor.
  3. Press the rainbow button at the bottom of the editor.
  4. Select which Postbox background you'd like to wrap the text in.
  5. Press the "Preview" tab to see what it will look like.

If no text is selected in the editor a Postbox will be appeneded to the text area with "..." for content. Replace the "..." with your text, etc.

While Postbox allows more content than the Facebook version (which is text only), there are limitations due to how Friendica parses BBcode.

It is STRONGLY recommended you only use Postboxes with text and emoji.

BBcodes you CANNOT put inside a Postbox:

  • [class] (which means you can’t nest Postboxes)
  • [hr]
  • [h1],[h2],[h3], etc…
  • [table],[tr],[th],[td]
  • [list],[ul],[ol]
  • [quote]
  • [abstract]
  • [spoiler]
  • [map]
  • [code]

BBcodes that do not work as intended inside a Postbox:

  • [pre]
  • [noparse]
  • [nobb]

The text will show but will be styled and centered.

BBcodes that CAN BE INSIDE a Postbox:

  • [i], [b], [u], [o], [s] (bold has no visible effect)
  • [url]
  • [img]
  • [audio]
  • [video]

And any plain text, including emoji

If you are using Markdown formatting what you can and can’t put in a Postbox is similar, with the exception that (because of how Markdown is parsed into BBcode) you can’t have both a URL and an image in the same Postbox. You can however put inline code in a Postbox with Markdown where BBcode cannot.

Known Issues

  • Postboxes are not shown on other platforms when your post is shared.
  • Postboxes are not shown in third-party apps (at least none do yet)

Changelog

1.0 (25 March 2025)

  • Initial Release for Friendica 'Interrupted Fern' 2024.12

Authors and acknowledgment

Random Penguin https://gitlab.com/randompenguin

License

Assuming AGPL for add-ons since that's the license Friendica is under

Project status

Unsupported by Friendica devs.