aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEiner von Vielen <tomwie@users.sourceforge.net>2015-02-14 20:33:51 +0100
committerEiner von Vielen <tomwie@users.sourceforge.net>2015-02-14 20:33:51 +0100
commit6ed8fb30b8b6b70c1f9a2ff5651d6a4892060db9 (patch)
tree871a9637fc113c817321f5f13f17a75c55232cd8 /doc
parent59828593c14a64cecf7ee5c077da9f918062ed60 (diff)
downloadvolse-hubzilla-6ed8fb30b8b6b70c1f9a2ff5651d6a4892060db9.tar.gz
volse-hubzilla-6ed8fb30b8b6b70c1f9a2ff5651d6a4892060db9.tar.bz2
volse-hubzilla-6ed8fb30b8b6b70c1f9a2ff5651d6a4892060db9.zip
Changed bb code [toc] to make it more flexible
This usage is know closer to the original usage of http://ndabas.github.io/toc/ Changed: - jquery.toc.js: Do not check for empty headings - bbcode.php: Added processing of [toc] with parameters - main.js: Use the default params for jquery.toc.js - bbcode.html: Added more help for [toc] and corrected some html
Diffstat (limited to 'doc')
-rw-r--r--doc/bbcode.html41
1 files changed, 23 insertions, 18 deletions
diff --git a/doc/bbcode.html b/doc/bbcode.html
index f0b61b33c..f75b1c90b 100644
--- a/doc/bbcode.html
+++ b/doc/bbcode.html
@@ -49,26 +49,31 @@
<p>Red Matrix specific codes</p>
<ul class="listbullet" style="list-style-type: circle;">
-<li>[&amp;copy;] &copy; This works for many HTML entities<br />
-<li>[zrl]https://redmatrix.me[/zrl] Magic-auth version of [url] tag<br />
-<li>[zmg]https://redmatrix.me/some/photo.jpg[/zmg] Magic-auth version of [img] tag<br />
-<br />
-<li>[observer=1]Text to display if observer is authenticated in the matrix[/observer]
-<li>[observer=0]Text to display if observer is <strong>not</strong> authenticated in the matrix[/observer]<br />
-<li>[observer.baseurl] website of observer <br />
-<li>[observer.url] channel URL of observer <br />
-<li>[observer.name] name of observer <br />
-<li>[observer.address] address (zot-id) of observer <br />
-<li>[observer.photo] profile photo of observer <br />
-<br />
-<li>[spoiler] for hiding spoilers<br /><br />
+<li>[&amp;copy;] &copy; This works for many HTML entities</li>
+<li>[zrl]https://redmatrix.me[/zrl] Magic-auth version of [url] tag</li>
+<li>[zmg]https://redmatrix.me/some/photo.jpg[/zmg] Magic-auth version of [img] tag<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 <br />
-<li>[qr]text to post[/qr] - create a QR code.<br />
-<li>[toc] - create a table of content in a webpage (level h1,...,h4).<br />
-<br /><br />
-</ul>
+<li>[observer=1]Text to display if observer is authenticated in the matrix[/observer]</li>
+<li>[observer=0]Text to display if observer is <strong>not</strong> authenticated in the matrix[/observer]</li>
+<li>[observer.baseurl] website of observer</li>
+<li>[observer.url] channel URL of observer</li>
+<li>[observer.name] name of observer</li>
+<li>[observer.address] address (zot-id) of observer</li>
+<li>[observer.photo] 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.</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.
+ <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 />