diff options
| -rw-r--r-- | doc/member/assets/qr_text_to_post.png | bin | 0 -> 273 bytes | |||
| -rw-r--r-- | doc/member/bbcode.html | 302 |
2 files changed, 190 insertions, 112 deletions
diff --git a/doc/member/assets/qr_text_to_post.png b/doc/member/assets/qr_text_to_post.png Binary files differnew file mode 100644 index 000000000..887c85492 --- /dev/null +++ b/doc/member/assets/qr_text_to_post.png diff --git a/doc/member/bbcode.html b/doc/member/bbcode.html index dcb5e2ce8..99d0ce6bc 100644 --- a/doc/member/bbcode.html +++ b/doc/member/bbcode.html @@ -1,3 +1,9 @@ +<style> + section { + display: inline-block; + overflow-x: scroll; + } +</style> <h3>Text Decoration</h3> <table class="table table-responsive table-bordered"> <tbody> @@ -5,48 +11,49 @@ <th>BBcode syntax</th><th>Rendered text</th> </tr> <tr> - <td><pre>[b]bold[/b]</pre></td><td><strong>bold</strong></td> + <td><code>[b]bold[/b]</code></td><td><strong>bold</strong></td> </tr> <tr> - <td><pre>[i]italic[/i]</pre></td><td><em>italic</em></td> + <td><code>[i]italic[/i]</code></td><td><em>italic</em></td> </tr> <tr> - <td><pre>[u]underlined[/u]</pre></td><td><u>underlined</u></td> + <td><code>[u]underlined[/u]</code></td><td><u>underlined</u></td> </tr> <tr> - <td><pre>[s]strike[/s]</pre></td><td><strike>strike</strike></td> + <td><code>[s]strike[/s]</code></td><td><strike>strike</strike></td> </tr> <tr> - <td><pre>[color=red]red[/color]</pre></td><td><span style="color: red;">red</span></td> + <td><code>[color=red]red[/color]</code></td><td><span style="color: red;">red</span></td> </tr> <tr> - <td><pre>[font=courier]some text[/font] </pre></td><td><span style="font-family: courier;">some text</span></td> + <td><code>[font=courier]some text[/font] </code></td><td><span style="font-family: courier;">some text</span></td> </tr> <tr> - <td><pre>[quote]quote[/quote]</pre></td><td><blockquote>quote</blockquote></td> + <td><code>[quote]quote[/quote]</code></td><td><blockquote>quote</blockquote></td> </tr> <tr> - <td><pre>[quote=Author]Author? Me? No, no, no...[/quote]</pre></td><td><strong class="author">Author wrote:</strong><blockquote>Author? Me? No, no, no...</blockquote></td> + <td><code>[quote=Author]Author? Me? No, no, no...[/quote]</code></td><td><strong class="author">Author wrote:</strong><blockquote>Author? Me? No, no, no...</blockquote></td> </tr> <tr> - <td><pre>[size=small]small text[/size] -[size=xx-large]xx-large text[/size] -[size=20]20px exactly[/size] - </pre> + <td><code> + [size=small]small text[/size]<br> + [size=xx-large]xx-large text[/size]<br> + [size=20]20px exactly[/size]<br> + </code> Size options include: <strong>xx-small, small, medium, large, xx-large</strong></td><td><span style="font-size: small;">small text</span><br><span style="font-size: xx-large;">xx-large text</span><br><span style="font-size: 20px;">20px exactly</span></td> </tr> <tr> - <td><pre>Add a horizontal bar + <td><code>Add a horizontal bar [hr] Like this - </pre></td><td> + </code></td><td> Add a horizontal bar<br><hr><br>Like this </td> </tr> <tr> - <td><pre>This is + <td><code>This is [center]centered[/center] -text</pre></td><td> +text</code></td><td> This is<br><div style="text-align:center;">centered</div><br>text </td> </tr> @@ -62,20 +69,20 @@ Code can be rendered generically in a block or inline format (depending on if th <th>BBcode syntax</th><th>Output</th> </tr> <tr> - <td><pre>[code]function bbcode() { }[/code]</pre></td><td><code>function bbcode() { }</code></td> + <td><code>[code]function bbcode() { }[/code]</code></td><td><code>function bbcode() { }</code></td> </tr> <tr> - <td><pre>[code=php]function bbcode() { - $variable = true; - if( $variable ) { - echo "true"; - } -}[/code]</pre></td><td><code><div class="hl-main"><ol class="hl-main"><li><span class="hl-code"> </span><span class="hl-reserved">function</span><span class="hl-code"> </span><span class="hl-identifier">bbcode</span><span class="hl-brackets">(</span><span class="hl-brackets">)</span><span class="hl-code"> </span><span class="hl-brackets">{</span><span class="hl-code"></span></li><li><span class="hl-code"> </span><span class="hl-var">$variable</span><span class="hl-code"> = </span><span class="hl-reserved">true</span><span class="hl-code">;</span></li><li><span class="hl-code"> </span><span class="hl-reserved">if</span><span class="hl-brackets">(</span><span class="hl-code"> </span><span class="hl-var">$variable</span><span class="hl-code"> </span><span class="hl-brackets">)</span><span class="hl-code"> </span><span class="hl-brackets">{</span><span class="hl-code"></span></li><li><span class="hl-code"> </span><span class="hl-reserved">echo</span><span class="hl-code"> </span><span class="hl-quotes">"</span><span class="hl-string">true</span><span class="hl-quotes">"</span><span class="hl-code">;</span></li><li><span class="hl-code"> </span><span class="hl-brackets">}</span><span class="hl-code"></span></li><li><span class="hl-code"> </span><span class="hl-brackets">}</span></li></ol></div></code></td> + <td><code>[code=php]function bbcode() {<br> + $variable = true;<br> + if( $variable ) {<br> + echo "true";<br> + }<br> +}[/code]</code></td><td><code><div class="hl-main"><ol class="hl-main"><li><span class="hl-code"> </span><span class="hl-reserved">function</span><span class="hl-code"> </span><span class="hl-identifier">bbcode</span><span class="hl-brackets">(</span><span class="hl-brackets">)</span><span class="hl-code"> </span><span class="hl-brackets">{</span><span class="hl-code"></span></li><li><span class="hl-code"> </span><span class="hl-var">$variable</span><span class="hl-code"> = </span><span class="hl-reserved">true</span><span class="hl-code">;</span></li><li><span class="hl-code"> </span><span class="hl-reserved">if</span><span class="hl-brackets">(</span><span class="hl-code"> </span><span class="hl-var">$variable</span><span class="hl-code"> </span><span class="hl-brackets">)</span><span class="hl-code"> </span><span class="hl-brackets">{</span><span class="hl-code"></span></li><li><span class="hl-code"> </span><span class="hl-reserved">echo</span><span class="hl-code"> </span><span class="hl-quotes">"</span><span class="hl-string">true</span><span class="hl-quotes">"</span><span class="hl-code">;</span></li><li><span class="hl-code"> </span><span class="hl-brackets">}</span><span class="hl-code"></span></li><li><span class="hl-code"> </span><span class="hl-brackets">}</span></li></ol></div></code></td> </tr> <tr> - <td><pre>[nobb][nobb]This is how [i]you[/i] can + <td><code>[nobb][nobb]This is how [i]you[/i] can [u]show[/u] how to use -[hl]BBcode[/hl] syntax[/nobb][/nobb]</pre></td><td>[nobb]This is how [i]you[/i] can [u]show[/u] how to use [hl]BBcode[/hl] syntax[/nobb]</td> +[hl]BBcode[/hl] syntax[/nobb][/nobb]</code></td><td>[nobb]This is how [i]you[/i] can [u]show[/u] how to use [hl]BBcode[/hl] syntax[/nobb]</td> </tr> </tbody> </table> @@ -87,29 +94,29 @@ Code can be rendered generically in a block or inline format (depending on if th <th>BBcode syntax</th><th>Rendered list</th> </tr> <tr> - <td><pre>[ul] -[*] First list element -[*] Second list element -[/ul]</pre></td><td><ul class="listbullet" style="list-style-type: circle;"><li> First list element</li><li> Second list element<br></li></ul></td> + <td><code>[ul]<br> +[*] First list element<br> +[*] Second list element<br> +[/ul]</code></td><td><ul class="listbullet" style="list-style-type: circle;"><li> First list element</li><li> Second list element<br></li></ul></td> </tr> <tr> - <td><pre>[ol] -[*] First list element -[*] Second list element -[/ol]</pre></td><td><ul class="listdecimal" style="list-style-type: decimal;"><li> First list element</li><li> Second list element<br></li></ul></td> + <td><code>[ol]<br> +[*] First list element<br> +[*] Second list element<br> +[/ol]</code></td><td><ul class="listdecimal" style="list-style-type: decimal;"><li> First list element</li><li> Second list element<br></li></ul></td> </tr> <tr> - <td><pre>[list=A] -[*] First list element -[*] Second list element -[/list]</pre> - The list type options are <pre>1, i, I, a, A</pre>.</td><td><ul class="listupperalpha" style="list-style-type: upper-alpha;"><li> First list element</li><li> Second list element</li></ul></td> + <td><code>[list=A]<br> +[*] First list element<br> +[*] Second list element<br> +[/list]</code> + The list type options are <code>1, i, I, a, A</code>.</td><td><ul class="listupperalpha" style="list-style-type: upper-alpha;"><li> First list element</li><li> Second list element</li></ul></td> </tr> <tr> - <td><pre>[dl terms="b"] -[*= First element term] First element description -[*= Second element term] Second element description -[/dl]</pre> + <td><code>[dl terms="b"]<br> +[*= First element term] First element description<br> +[*= Second element term] Second element description<br> +[/dl]</code> The <strong>terms</strong> style options can be any combination of: <dl class="bb-dl dl-horizontal"> <dt>b</dt><dd>bold</dd> @@ -123,13 +130,6 @@ Code can be rendered generically in a block or inline format (depending on if th <dt> First element term</dt><dd> First element description<br></dd> <dt> Second element term</dt><dd> Second element description<br></dd></dl></td> </tr> - <tr> - <td><pre></pre></td><td></td> - </tr> - <tr> - <td><pre></pre></td><td></td> - </tr> - </tbody> </table> @@ -141,33 +141,33 @@ Code can be rendered generically in a block or inline format (depending on if th <th>BBcode syntax</th><th>Rendered table</th> </tr> <tr> - <td><pre>[table border=0] -[tr] -[th]Header 1[/th][th]Header 2[/th] -[/tr] -[tr][td]Content[/td][td]Content[/td][/tr] -[tr][td]Content[/td][td]Content[/td][/tr] -[/table]</pre></td><td><table class="table table-responsive"><tbody><tr><th>Header 1</th><th>Header 2</th></tr> + <td><code>[table border=0]<br> +[tr]<br> +[th]Header 1[/th][th]Header 2[/th]<br> +[/tr]<br> +[tr][td]Content[/td][td]Content[/td][/tr]<br> +[tr][td]Content[/td][td]Content[/td][/tr]<br> +[/table]</code></td><td><table class="table table-responsive"><tbody><tr><th>Header 1</th><th>Header 2</th></tr> <tr><td>Content</td><td>Content</td></tr><tr><td>Content</td><td>Content</td></tr></tbody></table></td> </tr> <tr> - <td><pre>[table border=1] -[tr] -[th]Header 1[/th][th]Header 2[/th] -[/tr] -[tr][td]Content[/td][td]Content[/td][/tr] -[tr][td]Content[/td][td]Content[/td][/tr] -[/table]</pre></td><td><table class="table table-responsive table-bordered"><tbody><tr><th>Header 1</th><th>Header 2</th></tr> + <td><code>[table border=1]<br> +[tr]<br> +[th]Header 1[/th][th]Header 2[/th]<br> +[/tr]<br> +[tr][td]Content[/td][td]Content[/td][/tr]<br> +[tr][td]Content[/td][td]Content[/td][/tr]<br> +[/table]</code></td><td><table class="table table-responsive table-bordered"><tbody><tr><th>Header 1</th><th>Header 2</th></tr> <tr><td>Content</td><td>Content</td></tr><tr><td>Content</td><td>Content</td></tr></tbody></table></td> </tr> <tr> - <td><pre>[table] -[tr] -[th]Header 1[/th][th]Header 2[/th] -[/tr] -[tr][td]Content[/td][td]Content[/td][/tr] -[tr][td]Content[/td][td]Content[/td][/tr] -[/table]</pre></td><td><table><tbody><tr><th>Header 1</th><th>Header 2</th></tr><tr><td>Content</td><td>Content</td></tr><tr><td>Content</td><td>Content</td></tr></tbody></table> + <td><code>[table]<br> +[tr]<br> +[th]Header 1[/th][th]Header 2[/th]<br> +[/tr]<br> +[tr][td]Content[/td][td]Content[/td][/tr]<br> +[tr][td]Content[/td][td]Content[/td][/tr]<br> +[/table]</code></td><td><table><tbody><tr><th>Header 1</th><th>Header 2</th></tr><tr><td>Content</td><td>Content</td></tr><tr><td>Content</td><td>Content</td></tr></tbody></table> </td> </tr> </tbody> @@ -178,61 +178,139 @@ Code can be rendered generically in a block or inline format (depending on if th <table class="table table-responsive table-bordered"> <tbody> <tr> - <th>BBcode syntax</th><th>Rendered output</th> + <th>BBcode syntax</th><th>Output</th> </tr> <tr> - <td><pre>[video]video URL[/video] -[audio]audio URL[/audio]</pre></td><td></td> + <td><code>[video]video URL[/video]<br> +[audio]audio URL[/audio]</code></td><td></td> </tr> <tr> - <td><pre>[url=https://hubzilla.org]Hubzilla[/url]</pre></td><td><a href="https://hubzilla.org" target="_blank">Hubzilla</a></td> + <td><code>[url=https://hubzilla.org]Hubzilla[/url]</code></td><td><a href="https://hubzilla.org" target="_blank">Hubzilla</a></td> </tr> <tr> - <td><pre>An image [img]url/of/image.jpg[/img] -in some text </pre></td><td> + <td><code>An image [img]url/of/image.jpg[/img] +in some text </code></td><td> An image <img src="/images/default_profile_photos/rainbow_man/48.jpg" alt="Image/photo"> in some text </td> </tr> - <tr> - <td><pre></pre></td><td></td> - </tr> </tbody> </table> <h3>$Projectname specific codes</h3> -<ul class="listbullet" style="list-style-type: circle;"> -<li>[&copy;] © This works for many HTML entities</li> -<li>[zrl]https://zothub.com[/zrl] Magic-auth version of [url] tag</li> -<li>[zmg]https://zothub.com/some/photo.jpg[/zmg] Magic-auth version of [img] tag<br /></li> - -<li>[nobb][observer=1]Text to display if observer is authenticated in the matrix[/observer][/nobb]</li> -<li>[nobb][observer=0]Text to display if observer is <strong>not</strong> authenticated in the matrix[/observer][/nobb]</li> -<li>[nobb][observer.url][/nobb] channel URL of observer</li> -<li>[nobb][observer.baseurl][/nobb] website of observer</li> -<li>[nobb][observer.name][/nobb] name of observer</li> -<li>[nobb][observer.webname][/nobb] short name in the url of the observer</li> -<li>[nobb][observer.address][/nobb] address (zot-id) of observer</li> -<li>[nobb][observer.photo][/nobb] profile photo of observer<br /></li> -<li>[spoiler] for hiding spoilers<br /><br /></li> - -<li>[rpost=title]Text to post[/rpost] The observer will be returned to their home hub to enter a post with the specified title and body. Both are optional</li> -<li>[qr]text to post[/qr] - create a QR code (if the qrator plugin is installed).</li> -<li>[toc] - create a table of content in a webpage. Please refer to the <a href="http://ndabas.github.io/toc/" target="_blank">original jquery toc</a> to get more explanations. +<table class="table table-responsive table-bordered"> + <tbody> + <tr> + <th>BBcode syntax</th><th>Output</th> + </tr> + <tr> + <td>Magic-auth version of [url] tag + <code>[zrl=https://hubzilla.org]Identity-aware link[/zrl]</code> + </td><td><code>https://hubzilla.org/?zid=[observer=1][observer.address][/observer][observer=0]your_channel@your.home.hub[/observer]</code></td> + </tr> + <tr> + <td>Magic-auth version of [img] tag + <code>[zmg]https://hubzilla.org/some/photo.jpg[/zmg]</code> + </td><td>Image is only viewable by those authenticated and with permission.</td> + </tr> + <tr> + <td>Observer-dependent output:<code> + [nobb][observer=1]Text to display if observer IS authenticated[/observer][/nobb] + </code></td><td></td> + </tr> + <tr> + <td> + <code> + [nobb][observer=0]Text to display if observer IS NOT authenticated[/observer][/nobb] + </code> + </td> + <td></td> + </tr> + <tr> + <td> + <code> + [nobb][observer.url][/nobb] + </code> + </td> + <td>channel URL of observer</td> + </tr> + <tr> + <td> + <code> + [nobb][observer.baseurl][/nobb] + </code> + </td> + <td>website of observer</td> + </tr> + <tr> + <td> + <code> + [nobb][observer.name][/nobb] + </code> + </td> + <td>name of observer</td> + </tr> + <tr> + <td> + <code> + [nobb][observer.webname][/nobb] + </code> + </td> + <td>short name in the url of the observer</td> + </tr> + <tr> + <td> + <code> + [nobb][observer.address][/nobb] + </code> + </td> + <td>address (ZOT-id) of observer</td> + </tr> + <tr> + <td> + <code> + [nobb][observer.photo][/nobb] + </code> + </td> + <td>profile photo of observer</td> + </tr> + <tr> + <td><code>What is a spoiler?<br> + [spoiler]Text you want to hide.[/spoiler]</code></td><td> + What is a spoiler? <div onclick="openClose('opendiv-1131603764'); return false;" class="fakelink">Click to open/close</div><blockquote id="opendiv-1131603764" style="display: none;">Text you want to hide.</blockquote> + </td> + </tr> + <tr> + <td><code>[toc data-toc='div.page-body' data-toc-headings='h1,h2']</code><br> +Create a table of content in a webpage or wiki page. Please refer to the <a href="http://ndabas.github.io/toc/" target="_blank">original jQuery toc</a> to get more explanations. <ul> - <li>Optional param: 'data-toc'. If ommited the default is 'body'</li> - <li>Optional param: 'data-toc-headings'. If ommited the default is 'h1,h2,h3'</li> - <li>Full example: [toc data-toc='div.page-body' data-toc-headings='h1,h2']</li> - </ul> -</li> -</ul> -<br /> -<p>These require a suitable map plugin/addon such as openstreetmap or else the result will be blank</p> -<ul> -<li>[map] Generate an inline map using the current browser coordinates of the poster, if browser location is enabled<br /> -<li>[map=latitude,longitude] Generate a map using global coordinates.<br /> -<li>[map]Place Name[/map] Generate a map for a given named location. The first matching location is returned. For instance "Sydney" will usually return Sydney, Australia and not Sydney, Nova Scotia, Canada unless the more precise location is specified. It is highly recommended to use the post preview utility to ensure you have the correct location before submitting the post.<br /> -</ul> - -</div> + <li>Optional param: 'data-toc'. If omitted the default is 'body'</li> + <li>Optional param: 'data-toc-headings'. If omitted the default is 'h1,h2,h3'</li> + </ul></td><td></td> + </tr> + <tr> + <td><code>[nobb][rpost=title]Text to post[/rpost][/nobb]</code><br> +The observer will be returned to their home hub to enter a post with the specified title and body. Both are optional</td><td><a href="[baseurl]/rpost?f=&title=title&body=Text+to+post" target="_blank">[baseurl]/rpost?f=&title=title&body=Text+to+post</a></td> + </tr> + <tr> + <td>This requires the <a href="https://github.com/redmatrix/hubzilla-addons/tree/master/qrator"><strong>qrator</strong></a> plugin.<br><code>[qr]text to post[/qr]</code></td><td><img src="/doc/member/assets/qr_text_to_post.png"></td> + </tr> + <tr> + <td>This requires a suitable map plugin such as <strong><a href="https://github.com/redmatrix/hubzilla-addons/tree/master/openstreetmap">openstreetmap</a></strong>. + <code>[map]</code></td><td>Generate an inline map using the current browser coordinates of the poster, if browser location is enabled</td> + </tr> + <tr> + <td>This requires a suitable map plugin such as <strong><a href="https://github.com/redmatrix/hubzilla-addons/tree/master/openstreetmap">openstreetmap</a></strong>. + <code>[map=latitude,longitude]</code></td><td>Generate a map using global coordinates.</td></tr> + <tr> + <td>This requires a suitable map plugin such as <strong><a href="https://github.com/redmatrix/hubzilla-addons/tree/master/openstreetmap">openstreetmap</a></strong>. + <code>[map]Place Name[/map]</code></td><td> +Generate a map for a given named location. The first matching location is returned. For instance "Sydney" will usually return Sydney, Australia and not Sydney, Nova Scotia, Canada unless the more precise location is specified. It is highly recommended to use the post preview utility to ensure you have the correct location before submitting the post. +</td> + </tr> + <tr> + <td><code>[&copy;]</code></td><td> © </td> + </tr> + </tbody> +</table> |
