Edit README.md

This commit is contained in:
Random Penguin 2025-04-27 16:43:26 -05:00
parent 1fefa2a148
commit 7b4a067f20

113
README.md
View file

@ -12,12 +12,14 @@ _**NOTE:** Support for Postbox is built into Bookface 1.6+. This adddon adds sup
2. Go to the Main _Menu > Admin > Addons_ and enable "Postbox" 2. Go to the Main _Menu > Admin > Addons_ and enable "Postbox"
3. Any posts using Postbox will now display the colorful backgrounds. 3. Any posts using Postbox will now display the colorful backgrounds.
## Using Zen Postbox ## Using Postbox
1. Open the message Compose modal or Page 1. Open the message Compose modal or Page
2. Type `[class=postbox-red]Wrapped text goes here[/class]` (substitute "-red" with any of the available styles) 2. Type `[class=postbox-red]Wrapped text goes here[/class]` (substitute "-red" with any of the available styles)
3. Press the "Preview" tab to see what it will look like. 3. Press the "Preview" tab to see what it will look like.
There is a visual reference of available styles at: _/addon/postbox/view/sampler.htm_
While Postbox allows more content than the Facebook version (which is text only), there are limitations due to how Friendica parses BBcode. 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.** **It is STRONGLY recommended you only use Postboxes with text and emoji.**
@ -57,44 +59,119 @@ If you are using Markdown formatting what you can and cant put in a Postbox i
### Available Postbox styles ### Available Postbox styles
Old names are in parenthesis next to the new names to which they've been mapped.
**Solid Color Backgrounds:** **Solid Color Backgrounds:**
- .postbox-black - .postbox-black
- .postbox-red - .postbox-cornflowerblue (.postbox-blue)
- .postbox-green - .postbox-darkblue (.postbox-ocean)
- .postbox-blue - .postbox-darkgray
- .postbox-orange - .postbox-darkorange (.postbox-orange)
- .postbox-purple - .postbox-darkred
- .postbox-forest - .postbox-darkslateblue
- .postbox-ocean - .postbox-forestgreen (.postbox-forest)
- .postbox-gold
- .postbox-goldenrod
- .postbox-honeydew
- .postbox-hotpink
- .postbox-lavender
- .postbox-lightpink
- .postbox-lightyellow
- .postbox-limegreen (.postbox-green)
- .postbox-lightsalmon (.postbox-salmon)
- .postbox-mediumaquamarine
- .postbox-mediumslateblue
- .postbox-mediumvioletred
- .postbox-mintcream
- .postbox-olivedrab
- .postbox-palegreen
- .postbox-peachpuff
- .postbox-pink - .postbox-pink
- .postbox-salmon - .postbox-purple
- .postbox-red
- .postbox-seagreen
- .postbox-sienna
- .postbox-skyblue
- .postbox-thistle
- .postbox-violet
- .postbox-whitesmoke
- .postbox-yellowgreen
**Gradient Backgrounds:** **Gradient Backgrounds:**
- .postbox-darkgray - .postbox-aurora
- .postbox-bluegray
- .postbox-graygrey (.postbox-darkgray)
- .postbox-grayblack
- .postbox-greengray
- .postbox-lavendergray
- .postbox-minty - .postbox-minty
- .postbox-mintgray - .postbox-mintgray
- .postbox-rainbow
- .postbox-redblue - .postbox-redblue
- .postbox-violets - .postbox-sherbet (.postbox-sherbert)
- .postbox-grayblack - .postbox-spectrum
- .postbox-tealblue - .postbox-strawberrycream
- .postbox-greengray
- .postbox-tealgray
- .postbox-bluegray
- .postbox-lavendergray
- .postbox-sunset - .postbox-sunset
- .postbox-sherbert - .postbox-tealblue
- .postbox-tealgray
- .postbox-violets
- .postbox-violetblue
**Pattern Backgrounds:**
- .postbox-blueprint
- .postbox-birds
- .postbox-checkered
- .postbox-cubes
- .postbox-lemonlime
- .postbox-gingham
- .postbox-grid
- .postbox-hearts
- .postbox-honeycomb
- .postbox-notebook
- .postbox-plaid
- .postbox-polkadots
- .postbox-shadedots
- .postbox-shadowbox
- .postbox-stars
- .postbox-warpgrid
- .postbox-wavy
**Animated Backgrounds:**
These are ONLY available on servers with the _Postbox_ or _Zen Postbox_ add-on installed.
- .postbox-anigradient
- .postbox-blob
- .postbox-colorfade
- .postbox-gridrunner
- .postbox-heartbeat
- .postbox-moonrise
- .postbox-rainy
- .postbox-rocket
- .postbox-snowy
- .postbox-sunrise
- .postbox-waves
## Known Issues ## Known Issues
- Postboxes are not shown on other platforms when your post is shared. - 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) - Postboxes are not shown in third-party apps (at least none do yet)
- Some of the animated backgrounds have glitches in older WebKit browsers
- Currently Postbox BBcode is not parsed correctly by either Diaspora or Hubzilla
## Changelog ## Changelog
1.1 (28 April 2025)
* Changed names of solid colors to match HTML named colors
* Added 24 new solid colors.
* Added 5 new gradient backgrounds.
* Added 17 new pattern and 11 animated backgrounds.
* Fixed conflict between Postbox and Zen Postbox add-ons [Issue #1]
* Fixed load-order for main stylesheet [Issue #2]
1.0 (25 March 2025) 1.0 (25 March 2025)
* Initial Release for Friendica 'Interrupted Fern' 2024.12 * Initial Release for Friendica 'Interrupted Fern' 2024.12