From 128d47430d4aec5d5aadba4b6e8d5c66ead7be3f Mon Sep 17 00:00:00 2001 From: Andrew Manning Date: Sun, 15 Jan 2017 07:22:19 -0500 Subject: pull latest doco from dev branch --- doc/member/bbcode.html | 316 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 316 insertions(+) create mode 100644 doc/member/bbcode.html (limited to 'doc/member/bbcode.html') diff --git a/doc/member/bbcode.html b/doc/member/bbcode.html new file mode 100644 index 000000000..99d0ce6bc --- /dev/null +++ b/doc/member/bbcode.html @@ -0,0 +1,316 @@ + +

Text Decoration

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BBcode syntaxRendered text
[b]bold[/b]bold
[i]italic[/i]italic
[u]underlined[/u]underlined
[s]strike[/s]strike
[color=red]red[/color]red
[font=courier]some text[/font] some text
[quote]quote[/quote]
quote
[quote=Author]Author? Me? No, no, no...[/quote]Author wrote:
Author? Me? No, no, no...
+ [size=small]small text[/size]
+ [size=xx-large]xx-large text[/size]
+ [size=20]20px exactly[/size]
+ + Size options include: xx-small, small, medium, large, xx-large		small text
xx-large text
20px exactly
Add a horizontal bar +[hr] +Like this + + Add a horizontal bar

Like this +
This is +[center]centered[/center] +text + This is
centered

text +
+ +

Code blocks

+Code can be rendered generically in a block or inline format (depending on if there are new line characters in the text), or you can specify a supported language for enhanced syntax highlighting. Supported languages include php, css, mysql, sql, abap, diff, html, perl, ruby, vbscript, avrc, dtd, java, xml, cpp, python, javascript, js, json, sh . +

+ + + + + + + + + + + + + + + +
BBcode syntaxOutput
[code]function bbcode() { }[/code]function bbcode() { }
[code=php]function bbcode() {
+ $variable = true;
+ if( $variable ) {
+ echo "true";
+ }
+}[/code]
  1.  function bbcode() {
  2.    $variable = true;
  3.    if( $variable ) {
  4.      echo "true";
  5.    }
  6.  }
[nobb][nobb]This is how [i]you[/i] can +[u]show[/u] how to use +[hl]BBcode[/hl] syntax[/nobb][/nobb][nobb]This is how [i]you[/i] can [u]show[/u] how to use [hl]BBcode[/hl] syntax[/nobb]
+ +

Lists

+ + + + + + + + + + + + + + + + + + +
BBcode syntaxRendered list
[ul]
+[*] First list element
+[*] Second list element
+[/ul]
  • First list element
  • Second list element
[ol]
+[*] First list element
+[*] Second list element
+[/ol]
  • First list element
  • Second list element
[list=A]
+[*] First list element
+[*] Second list element
+[/list] + The list type options are 1, i, I, a, A.
  • First list element
  • Second list element
[dl terms="b"]
+[*= First element term] First element description
+[*= Second element term] Second element description
+[/dl] + The terms style options can be any combination of: +
+
b
bold
+
i
italic
+
u
underline
+
m
monospace
+
l
large
+
h
horizontal — like this defintion list
+
+
+
First element term
First element description
+
Second element term
Second element description
+ +

Tables

+ + + + + + + + + + + + + + + + +
BBcode syntaxRendered table
[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]		 +
Header 1Header 2
ContentContent
ContentContent
[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]		 +
Header 1Header 2
ContentContent
ContentContent
[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]
Header 1Header 2
ContentContent
ContentContent
+
+ +

Links and Embedded Content

+ + + + + + + + + + + + + + + + +
BBcode syntaxOutput
[video]video URL[/video]
+[audio]audio URL[/audio]
[url=https://hubzilla.org]Hubzilla[/url]Hubzilla
An image [img]url/of/image.jpg[/img] +in some text + An image Image/photo in some text +
+ + +

$Projectname specific codes

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
BBcode syntaxOutput
Magic-auth version of [url] tag + [zrl=https://hubzilla.org]Identity-aware link[/zrl] + https://hubzilla.org/?zid=[observer=1][observer.address][/observer][observer=0]your_channel@your.home.hub[/observer]
Magic-auth version of [img] tag + [zmg]https://hubzilla.org/some/photo.jpg[/zmg] + Image is only viewable by those authenticated and with permission.
Observer-dependent output: + [nobb][observer=1]Text to display if observer IS authenticated[/observer][/nobb] +
+ + [nobb][observer=0]Text to display if observer IS NOT authenticated[/observer][/nobb] + +
+ + [nobb][observer.url][/nobb] + + channel URL of observer
+ + [nobb][observer.baseurl][/nobb] + + website of observer
+ + [nobb][observer.name][/nobb] + + name of observer
+ + [nobb][observer.webname][/nobb] + + short name in the url of the observer
+ + [nobb][observer.address][/nobb] + + address (ZOT-id) of observer
+ + [nobb][observer.photo][/nobb] + + profile photo of observer
What is a spoiler?
+ [spoiler]Text you want to hide.[/spoiler]		 + What is a spoiler?
Click to open/close
+
[toc data-toc='div.page-body' data-toc-headings='h1,h2']
+Create a table of content in a webpage or wiki page. Please refer to the original jQuery toc to get more explanations. +
    +
  • Optional param: 'data-toc'. If omitted the default is 'body'
    • +
  • Optional param: 'data-toc-headings'. If omitted the default is 'h1,h2,h3'
    • +
[nobb][rpost=title]Text to post[/rpost][/nobb]
+The observer will be returned to their home hub to enter a post with the specified title and body. Both are optional		[baseurl]/rpost?f=&title=title&body=Text+to+post
This requires the qrator plugin.
[qr]text to post[/qr]
This requires a suitable map plugin such as openstreetmap. + [map]Generate an inline map using the current browser coordinates of the poster, if browser location is enabled
This requires a suitable map plugin such as openstreetmap. + [map=latitude,longitude]Generate a map using global coordinates.
This requires a suitable map plugin such as openstreetmap. + [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. +
[©] ©
-- cgit v1.2.3