]> git.mxchange.org Git - friendica.git/blob - doc/BBCode.md
Some documentation for the usage of the "abstract" element.
[friendica.git] / doc / BBCode.md
1 Friendica BBCode tags reference
2 ========================
3
4 * [Home](help)
5
6 Inline
7 -----
8
9
10 <pre>[b]bold[/b]</pre> : <strong>bold</strong>
11
12 <pre>[i]italic[/i]</pre> : <em>italic</em>
13
14 <pre>[u]underlined[/u]</pre> : <u>underlined</u>
15
16 <pre>[s]strike[/s]</pre> : <strike>strike</strike>
17
18 <pre>[color=red]red[/color]</pre> : <span style="color:  red;">red</span>
19
20 <pre>[url=http://www.friendica.com]Friendica[/url]</pre> : <a href="http://www.friendica.com" target="external-link">Friendica</a>
21
22 <pre>[img]http://friendica.com/sites/default/files/friendika-32.png[/img]</pre> : <img src="http://friendica.com/sites/default/files/friendika-32.png" alt="Immagine/foto">
23
24 <pre>[size=xx-small]small text[/size]</pre> : <span style="font-size: xx-small;">small text</span>
25
26 <pre>[size=xx-large]big text[/size]</pre> : <span style="font-size: xx-large;">big text</span>
27
28 <pre>[size=20]exact size[/size] (size can be any number, in pixel)</pre> :  <span style="font-size: 20px;">exact size</span>
29
30
31
32
33
34
35
36 Block
37 -----
38
39 <pre>[code]code[/code]</pre>
40
41 <code>code</code>
42
43 <p style="clear:both;">&nbsp;</p>
44
45 <pre>[quote]quote[/quote]</pre>
46
47 <blockquote>quote</blockquote>
48
49 <p style="clear:both;">&nbsp;</p>
50
51 <pre>[quote=Author]Author? Me? No, no, no...[/quote]</pre>
52
53 <strong class="author">Author wrote:</strong><blockquote>Author? Me? No, no, no...</blockquote>
54
55 <p style="clear:both;">&nbsp;</p>
56
57 <pre>[center]centered text[/center]</pre>
58
59 <div style="text-align:center;">centered text</div>
60
61 <p style="clear:both;">&nbsp;</p>
62
63 <pre>You should not read any further if you want to be surprised.[spoiler]There is a happy end.[/spoiler]</pre>
64
65 You should not read any further if you want to be surprised.<br />*click to open/close*
66
67 (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.)
68
69 <p style="clear:both;">&nbsp;</p>
70
71 **Table**
72 <pre>[table border=1]
73  [tr] 
74    [th]Tables now[/th]
75  [/tr]
76  [tr]
77    [td]Have headers[/td]
78  [/tr]
79 [/table]</pre>
80
81 <table border="1"><tbody><tr><th>Tables now</th></tr><tr><td>Have headers</td></tr></tbody></table>
82
83 <p style="clear:both;">&nbsp;</p>
84
85 **List**
86
87 <pre>[list]
88  [*] First list element
89  [*] Second list element
90 [/list]</pre>
91 <ul class="listbullet" style="list-style-type: circle;">
92 <li> First list element<br>
93 </li>
94 <li> Second list element</li>
95 </ul>
96
97 [list] is equivalent to [ul] (unordered list). 
98
99 [ol] can be used instead of [list] to show an ordered list:
100
101 <pre>[ol]
102  [*] First list element
103  [*] Second list element
104 [/ol]</pre>
105 <ul class="listdecimal" style="list-style-type: decimal;"><li> First list element<br></li><li> Second list element</li></ul>
106
107 For more options on ordered lists, you can define the style of numeration on [list] argument:
108 <pre>[list=1]</pre> : decimal
109
110 <pre>[list=i]</pre> : lover case roman
111
112 <pre>[list=I]</pre> : upper case roman
113
114 <pre>[list=a]</pre> : lover case alphabetic
115
116 <pre>[list=A] </pre> : upper case alphabetic
117
118
119
120
121 Embed
122 ------
123
124 You can embed video, audio and more in a message.
125
126 <pre>[video]url[/video]</pre>
127 <pre>[audio]url[/audio]</pre>
128
129 Where *url* can be an url to youtube, vimeo, soundcloud, or other sites wich supports oembed or opengraph specifications.
130 *url* can be also full url to an ogg  file. HTML5 tag will be used to show it.
131
132 <pre>[url]*url*[/url]</pre>
133
134 If *url* supports oembed or opengraph specifications the embedded object will be shown (eg, documents from scribd).
135 Page title with a link to *url* will be shown.
136
137 Map
138 ---
139
140 <pre>[map]address[/map]</pre>
141 <pre>[map=lat,long]</pre>
142
143 You can embed maps from coordinates or addresses. 
144 This require "openstreetmap" addon version 1.3 or newer.
145
146 -----------------------------------------------------------
147
148 Abstract for longer posts
149 -------------------------
150
151 If you want to spread your post to several third party networks you can 
152 have the problem that these networks have (for example) a length 
153 limitation. (Like on Twitter)
154
155 Friendica is using a semi intelligent mechanism to generate a fitting 
156 abstract. But it can be interesting to define an own abstract that will 
157 only be displayed on the external network. This is done with the 
158 [abstract]-element. Example:
159
160 <pre>[abstract]Totally interesting! A must-see! Please click the link![/abstract]
161 I want to tell you a really boring story that you really never wanted 
162 to hear.</pre>
163
164 Twitter would display the text "Totally interesting! A must-see! Please 
165 click the link!". On Friendica you would only see the text after "I 
166 want to tell you a really ..."
167
168 It is even possible to define abstracts for separate networks:
169
170 <pre>
171 [abstract]Hi friends Here are my newest pictures![abstract]
172 [abstract=twit]Hi my dear Twitter followers. Do you want to see my new 
173 pictures?[abstract]
174 [abstract=apdn]Helly my dear followers on ADN. I made sone new pictures 
175 that I wanted to share with you.[abstract]
176 Today I was in the woods and took some real cool pictures ...
177 </pre>
178
179 For Twitter and App.net the system will use the defined abstracts. For 
180 other networks (e.g. when you are using the Statusnet connector) the 
181 general abstract element will be used.
182
183 If you use (for example) the "buffer" connector to post to Facebook or 
184 Google+ you can use this element to define an abstract for a longer 
185 blogpost that you don't want to post completely to these networks.
186
187 Networks like Facebook or Google+ aren't length limited. For this reason 
188 the [abstract] element isn't used. Instead you have to name the explicit 
189 network:
190
191 <pre>
192 [abstract]These days I had a strange encounter ...[abstract]
193 [abstract=goog]Helly my dear Google+ followers. You have to read my 
194 newest blog post![abstract]
195 [abstract=face]Hello my Facebook friends. These days happened something 
196 really cool.[abstract]
197 While taking pictures in the woods I had a really strange encounter ... </pre>
198
199 The [abstract] element isn't working with the native OStatus connection 
200 or with connectors where we post the HTML. (Like Tumblr, Wordpress or 
201 Pump.io)
202
203 Special
204 -------
205
206 If you need to put literal bbcode in a message, [noparse], [nobb] or [pre] are used to escape bbcode:
207
208 <pre>[noparse][b]bold[/b][/noparse]</pre> : [b]bold[/b]