From 106f003447eae11060f026c48981ebaafd60f279 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Wed, 2 Nov 2016 22:42:19 -0400 Subject: [PATCH] bbcode documentation: BBCodes.md complete rewrite - Switched to table display to put BBCodes and result side-by-side - Added all missing BBCodes --- doc/BBCode.md | 739 ++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 571 insertions(+), 168 deletions(-) diff --git a/doc/BBCode.md b/doc/BBCode.md index d22f7afa58..aeb5e06c95 100644 --- a/doc/BBCode.md +++ b/doc/BBCode.md @@ -1,208 +1,611 @@ Friendica BBCode tags reference ======================== -* [Home](help) +* [Creating posts](help/Text_editor) -Inline ------ +## Inline + -
[u]underlined[/u]
: underlined + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BBCodeResult
[b]bold[/b]bold
[i]italic[/i]italic
[u]underlined[/u]underlined
[s]strike[/s]strike
[o]overline[/o]overline
[color=red]red[/color]red
[url=http://www.friendica.com]Friendica[/url]Friendica
[img]http://friendica.com/sites/default/files/friendika-32.png[/img]Immagine/foto
[img=64x32]http://friendica.com/sites/default/files/friendika-32.png[/img]
+
Note: provided height is simply discarded.
[size=xx-small]small text[/size]small text
[size=xx-large]big text[/size]big text
[size=20]exact size[/size] (size can be any number, in pixel)exact size
[font=serif]Serif font[/font]Serif font
-
[s]strike[/s]
: strike +### Links -
[color=red]red[/color]
: red + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BBCodeResult
[url]http://friendica.com[/url]http://friendica.com
[url=http://friendica.com]Friendica[/url]Friendica
[bookmark]http://friendica.com[/bookmark]

+#^[url]http://friendica.com[/url]

Friendica: http://friendica.com

[bookmark=http://friendica.com]Bookmark[/bookmark]

+#^[url=http://friendica.com]Bookmark[/url]

+#[url=http://friendica.com]^[/url][url=http://friendica.com]Bookmark[/url]

Friendica: Bookmark

[url=/posts/f16d77b0630f0134740c0cc47a0ea02a]Diaspora post with GUID[/url]Diaspora post with GUID
#Friendica#Friendica
@Mention@Mention
acct:account@friendica.host.com (WebFinger)acct:account@friendica.host.com
[mail]user@mail.example.com[/mail]user@mail.example.com
[mail=user@mail.example.com]Send an email to User[/mail]Send an email to User
-
[url=http://www.friendica.com]Friendica[/url]
: Friendica +## Blocks -
[img]http://friendica.com/sites/default/files/friendika-32.png[/img]
: Immagine/foto + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BBCodeResult
[p]A paragraph of text[/p]

A paragraph of text

Inline [code]code[/code] in a paragraphInline code in a paragraph
[code]Multi
line
code[/code]		Multi +line +code
[code=php]function text_highlight($s,$lang)[/code]
  1.  function text_highlight($s,$lang)
[quote]quote[/quote]
quote
[quote=Author]Author? Me? No, no, no...[/quote]Author wrote:
Author? Me? No, no, no...
[center]Centered text[/center]
Centered text
You should not read any further if you want to be surprised.[spoiler]There is a happy end.[/spoiler] +
+ You should not read any further if you want to be surprised.
+ Click to open/close + +
+
+
[spoiler=Author]Spoiler quote[/spoiler] +
+ Author wrote:
+ Click to open/close + +
+
+
[hr] (horizontal line)
-
[size=xx-small]small text[/size]
: small text +### Titles -
[size=xx-large]big text[/size]
: big text + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BBCodeResult
[h1]Title 1[/h1]

Title 1

[h2]Title 2[/h2]

Title 2

[h3]Title 3[/h3]

Title 3

[h4]Title 4[/h4]

Title 4

[h5]Title 5[/h5]
Title 5
[h6]Title 6[/h6]
Title 6
-
[size=20]exact size[/size] (size can be any number, in pixel)
: exact size +### Tables + + + + + + + + + + + + + + + + + +
BBCodeResult
[table]
+  [tr]
+    [th]Header 1[/th]
+    [th]Header 2[/th]
+    [th]Header 2[/th]
+  [/tr]
+  [tr]
+    [td]Cell 1[/td]
+    [td]Cell 2[/td]
+    [td]Cell 3[/td]
+  [/tr]
+  [tr]
+    [td]Cell 4[/td]
+    [td]Cell 5[/td]
+    [td]Cell 6[/td]
+  [/tr]
+[/table]		 + + + + + + + + + + + + + + + + + + +
Header 1Header 2Header 3
Cell 1Cell 2Cell 3
Cell 4Cell 5Cell 6
+
[table border=0] + + + + + + + + + + + + + + + + + + +
Header 1Header 2Header 3
Cell 1Cell 2Cell 3
Cell 4Cell 5Cell 6
+
[table border=1] + + + + + + + + + + + + + + + + + + +
Header 1Header 2Header 3
Cell 1Cell 2Cell 3
Cell 4Cell 5Cell 6
+
+### Lists + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BBCodeResult
[ul]
+  [li] First list element
+  [li] Second list element
+[/ul]
+[list]
+  [*] First list element
+  [*] Second list element
+[/list]		 +
    +
  • First list element
    • +
  • Second list element
    • +
+
[ol]
+  [*] First list element
+  [*] Second list element
+[/ol]
+[list=1]
+  [*] First list element
+  [*] Second list element
+[/list]		 +
    +
  • First list element
    • +
  • Second list element
    • +
+
[list=]
+  [*] First list element
+  [*] Second list element
+[/list]		 +
    +
  • First list element
    • +
  • Second list element
    • +
+
[list=i]
+  [*] First list element
+  [*] Second list element
+[/list]		 +
    +
  • First list element
    • +
  • Second list element
    • +
+
[list=I]
+  [*] First list element
+  [*] Second list element
+[/list]		 +
    +
  • First list element
    • +
  • Second list element
    • +
+
[list=a]
+  [*] First list element
+  [*] Second list element
+[/list]		 +
    +
  • First list element
    • +
  • Second list element
    • +
+
[list=A]
+  [*] First list element
+  [*] Second list element
+[/list]		 +
    +
  • First list element
    • +
  • Second list element
    • +
+
- - - -Block ------ - -
[code]code[/code]
- -code - -

 

- -
[code=php]function text_highlight($s,$lang)[/code]
- -
  1.  function text_highlight($s,$lang)
 - -

 

- -
[quote]quote[/quote]
- -
quote
- -

 

- -
[quote=Author]Author? Me? No, no, no...[/quote]
- -Author wrote:
Author? Me? No, no, no...
- -

 

- -
[center]centered text[/center]
- -
centered text
- -

 

- -
You should not read any further if you want to be surprised.[spoiler]There is a happy end.[/spoiler]
- -You should not read any further if you want to be surprised.
*click to open/close* - -(The text between thhe opening and the closing of the spoiler tag will be visible once the link is clicked. So *"There is a happy end."* wont be visible until the spoiler is uncovered.) - -

 

- -**Table** -
[table border=1]
- [tr] 
-   [th]Tables now[/th]
- [/tr]
- [tr]
-   [td]Have headers[/td]
- [/tr]
-[/table]
- -
Tables now
Have headers
- -

 

- -**List** - -
[list]
- [*] First list element
- [*] Second list element
-[/list]
- - -[list] is equivalent to [ul] (unordered list). - -[ol] can be used instead of [list] to show an ordered list: - -
[ol]
- [*] First list element
- [*] Second list element
-[/ol]
- - -For more options on ordered lists, you can define the style of numeration on [list] argument: -
[list=1]
: decimal - -
[list=i]
: lover case roman - -
[list=I]
: upper case roman - -
[list=a]
: lover case alphabetic - -
[list=A]
: upper case alphabetic - - - - -Embed ------- +## Embed You can embed video, audio and more in a message. -
[video]url[/video]
-
[audio]url[/audio]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BBCodeResult
[video]url[/video]Where *url* can be an url to youtube, vimeo, soundcloud, or other sites wich supports oembed or opengraph specifications.
[video]Video file url[/video] +[audio]Audio file url[/audio]Full URL to an ogg/ogv/oga/ogm/webm/mp4/mp3 file. An HTML5 player will be used to show it.
[youtube]Youtube URL[/youtube]Youtube video OEmbed display. May not embed an actual player.
[youtube]Youtube video ID[/youtube]Youtube player iframe embed.
[vimeo]Vimeo URL[/vimeo]Vimeo video OEmbed display. May not embed an actual player.
[vimeo]Vimeo video ID[/vimeo]Vimeo player iframe embed.
[iframe]URL[/iframe]General embed, iframe size is limited by the theme size for video players.
[url]*url*[/url]If *url* supports oembed or opengraph specifications the embedded object will be shown (eg, documents from scribd). +Page title with a link to *url* will be shown.
-Where *url* can be an url to youtube, vimeo, soundcloud, or other sites wich supports oembed or opengraph specifications. -*url* can be also full url to an ogg file. HTML5 tag will be used to show it. +## Map -
[url]*url*[/url]
+This require "openstreetmap" addon version 1.3 or newer. If the addon isn't activated, +the raw coordinates are shown instead. -If *url* supports oembed or opengraph specifications the embedded object will be shown (eg, documents from scribd). -Page title with a link to *url* will be shown. + + + + + + + + + + + + + + + + + +
BBCodeResult
[map]address[/map]Embeds a map centered on this address.
[map=lat,long]Embeds a map centered on those coordinates.
[map]Embeds a map centered on the post's location.
-Map ---- +## Abstract for longer posts -
[map]address[/map]
-
[map=lat,long]
+If you want to spread your post to several third party networks you can have the problem that these networks have a length limitation like on Twitter. -You can embed maps from coordinates or addresses. -This require "openstreetmap" addon version 1.3 or newer. - ------------------------------------------------------------ - -Abstract for longer posts -------------------------- - -If you want to spread your post to several third party networks you can have the problem that these networks have (for example) a length limitation. -(Like on Twitter) - -Friendica is using a semi intelligent mechanism to generate a fitting abstract. -But it can be interesting to define an own abstract that will only be displayed on the external network. -This is done with the [abstract]-element. -Example: - -
[abstract]Totally interesting! A must-see! Please click the link![/abstract]
-I want to tell you a really boring story that you really never wanted 
-to hear.
- -Twitter would display the text "Totally interesting! A must-see! Please click the link!". -On Friendica you would only see the text after "I want to tell you a really ..." +Friendica is using a semi intelligent mechanism to generate a fitting abstract. +But it can be interesting to define a custom abstract that will only be displayed on the external network. +This is done with the [abstract]-element. + + + + + + + + + +
BBCodeResult
[abstract]Totally interesting! A must-see! Please click the link![/abstract]
+I want to tell you a really boring story that you really never wanted to hear.		Twitter would display the text "Totally interesting! A must-see! Please click the link!". +On Friendica you would only see the text after "I want to tell you a really ..."
It is even possible to define abstracts for separate networks: -
-[abstract]Hi friends Here are my newest pictures![abstract]
-[abstract=twit]Hi my dear Twitter followers. Do you want to see my new 
-pictures?[abstract]
-[abstract=apdn]Helly my dear followers on ADN. I made sone new pictures 
-that I wanted to share with you.[abstract]
-Today I was in the woods and took some real cool pictures ...
-
- -For Twitter and App.net the system will use the defined abstracts. -For other networks (e.g. when you are using the "statusnet" connector that is used to post to GNU Social) the general abstract element will be used. + + + + + + + + + +
BBCodeResult
+[abstract]Hi friends Here are my newest pictures![/abstract]
+[abstract=twit]Hi my dear Twitter followers. Do you want to see my new +pictures?[/abstract]
+[abstract=apdn]Helly my dear followers on ADN. I made sone new pictures +that I wanted to share with you.[/abstract]
+Today I was in the woods and took some real cool pictures ...		For Twitter and App.net the system will use the defined abstracts.
+For other networks (e.g. when you are using the "statusnet" connector that is used to post to GNU Social) the general abstract element will be used.
If you use (for example) the "buffer" connector to post to Facebook or Google+ you can use this element to define an abstract for a longer blogpost that you don't want to post completely to these networks. -Networks like Facebook or Google+ aren't length limited. -For this reason the [abstract] element isn't used. +Networks like Facebook or Google+ aren't length limited. +For this reason the [abstract] element isn't used. Instead you have to name the explicit network: -
-[abstract]These days I had a strange encounter ...[abstract]
-[abstract=goog]Helly my dear Google+ followers. You have to read my 
-newest blog post![abstract]
-[abstract=face]Hello my Facebook friends. These days happened something 
-really cool.[abstract]
-While taking pictures in the woods I had a really strange encounter ...
+ + + + + + + + + +
BBCodeResult
+[abstract]These days I had a strange encounter...[/abstract]
+[abstract=goog]Helly my dear Google+ followers. You have to read my newest blog post![/abstract]
+[abstract=face]Hello my Facebook friends. These days happened something really cool.[/abstract]
+While taking pictures in the woods I had a really strange encounter...		Google and Facebook will show the respective abstracts while the other networks will show the default one.
+
Meanwhile, Friendica won't show any of the abstracts.
-The [abstract] element isn't working with the native OStatus connection or with connectors where we post the HTML. -(Like Tumblr, Wordpress or Pump.io) +The [abstract] element isn't working with the native OStatus connection or with connectors where we post the HTML like Tumblr, Wordpress or Pump.io. -Special -------- +## Special -If you need to put literal bbcode in a message, [noparse], [nobb] or [pre] are used to escape bbcode: + + + + + + + + + + + + + + + + + + + + + +
BBCodeResult
If you need to put literal bbcode in a message, [noparse], [nobb] or [pre] are used to escape bbcode:
+
    +
  • [noparse][b]bold[/b][/noparse]
    • +
  • [nobb][b]bold[/b][/nobb]
    • +
  • [pre][b]bold[/b][/pre]
    • +
+ 		[b]bold[/b]
[nosmile] is used to disable smilies on a post by post basis
+
+ [nosmile] ;-) :-O + 		;-) :-O
Custom inline styles
+
+[style=text-shadow: 0 0 4px #CC0000;]You can change all the CSS properties of this block.[/style]		You can change all the CSS properties of this block.
Custom class block
+
+[class=custom]If the class exists, this block will have the custom class style applied.[/class]
<span class="custom">If the class exists,
 this block will have the custom class
 style applied.</span>
-
[noparse][b]bold[/b][/noparse]
: [b]bold[/b]