From 4b2ef3964811173172e631ee1039f2893a56bdb8 Mon Sep 17 00:00:00 2001 From: Andrew Manning Date: Tue, 27 Dec 2016 07:32:39 -0500 Subject: BBcode reference page is essentially complete. There is still room for improvement. --- doc/member/assets/qr_text_to_post.png | Bin 0 -> 273 bytes doc/member/bbcode.html | 302 +++++++++++++++++++++------------- 2 files changed, 190 insertions(+), 112 deletions(-) create mode 100644 doc/member/assets/qr_text_to_post.png (limited to 'doc/member') diff --git a/doc/member/assets/qr_text_to_post.png b/doc/member/assets/qr_text_to_post.png new file mode 100644 index 000000000..887c85492 Binary files /dev/null and b/doc/member/assets/qr_text_to_post.png differ 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 @@ +

Text Decoration

@@ -5,48 +11,49 @@ - + - + - + - + - + - + - + - + - - - @@ -62,20 +69,20 @@ Code can be rendered generically in a block or inline format (depending on if th - + - + - +[hl]BBcode[/hl] syntax[/nobb][/nobb]
BBcode syntaxRendered text 
[b]bold[/b]
bold[b]bold[/b]bold 
[i]italic[/i]
italic[i]italic[/i]italic 
[u]underlined[/u]
underlined[u]underlined[/u]underlined 
[s]strike[/s]
strike[s]strike[/s]strike 
[color=red]red[/color]
red[color=red]red[/color]red 
[font=courier]some text[/font]
some text[font=courier]some text[/font] some text 
[quote]quote[/quote]
quote
[quote]quote[/quote]
quote
 
[quote=Author]Author? Me? No, no, no...[/quote]
Author wrote:
Author? Me? No, no, no...
[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=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
+
Add a horizontal bar [hr] Like this - + Add a horizontal bar

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

text
BBcode syntaxOutput 
[code]function bbcode() { }[/code]
function bbcode() { }[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.  }
[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 
+
[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][nobb]This is how [i]you[/i] can [u]show[/u] how to use [hl]BBcode[/hl] syntax[/nobb]
@@ -87,29 +94,29 @@ Code can be rendered generically in a block or inline format (depending on if th BBcode syntaxRendered list - 
[ul]
-[*] First list element
-[*] Second list element
-[/ul]
+ [ul]
+[*] First list element
+[*] Second list element
+[/ul] - 
[ol]
-[*] First list element
-[*] Second list element
-[/ol]
+ [ol]
+[*] First list element
+[*] Second list element
+[/ol] - 
[list=A]
-[*] First list element
-[*] Second list element
-[/list]
- The list type options are 
1, i, I, a, A
. + [list=A]
+[*] First list element
+[*] Second list element
+[/list] + The list type options are 1, i, I, a, A. - 
[dl terms="b"]
-[*= First element term] First element description
-[*= Second element term] Second element description
-[/dl]
+ [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
@@ -123,13 +130,6 @@ Code can be rendered generically in a block or inline format (depending on if th
First element term
First element description
Second element term
Second element description
- - 

-		
-		
-			

-		
-		
 	
 
 
@@ -141,33 +141,33 @@ Code can be rendered generically in a block or inline format (depending on if th
 			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
[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]

+			
-			
@@ -178,61 +178,139 @@ Code can be rendered generically in a block or inline format (depending on if th
 
Header 1Header 2
[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

+					[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

 		
 		

 	

-			
+			
-			
+			
-			
+			
-			
-		
-			
-		

 	
 		
BBcode syntaxRendered outputBBcode syntaxOutput
 		

 		
[video]video URL[/video]
-[audio]audio URL[/audio]
[video]video URL[/video]

+[audio]audio URL[/audio]		
 		

 		
[url=https://hubzilla.org]Hubzilla[/url]
Hubzilla[url=https://hubzilla.org]Hubzilla[/url]Hubzilla
 		

 		
An image [img]url/of/image.jpg[/img] 
-in some text 

+			An image [img]url/of/image.jpg[/img] 
+in some text 
 				An image Image/photo in some text
 			
 		

 	
 

 	
 
 
$Projectname specific codes

-
    
-
  • [©] ©  This works for many HTML entities
    • 
-
  • [zrl]https://zothub.com[/zrl] Magic-auth version of [url] tag
    • 
-
  • [zmg]https://zothub.com/some/photo.jpg[/zmg] Magic-auth version of [img] tag
    • 
-
-
  • [nobb][observer=1]Text to display if observer is authenticated in the matrix[/observer][/nobb]
    • 
-
  • [nobb][observer=0]Text to display if observer is not authenticated in the matrix[/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
    • 
 
-
  • [spoiler] for hiding spoilers

    • 
-
-
  • [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
    • 
-
  • [qr]text to post[/qr] - create a QR code (if the qrator plugin is installed).
    • 
-
  • [toc] - create a table of content in a webpage. Please refer to the original jquery toc to get more explanations.
+
+	
+		
+			
+		
+		
+			
+		
+		
+			
+		
+		
+			
+		
+		
+			
+			
+		
+		
+			
+			
+		
+		
+			
+			
+		
+		
+			
+			
+		
+		
+			
+			
+		
+		
+			
+			
+		
+		
+			
+			
+		
+		
+			
+		
+		
+			
+		
+		
+			
+		
+		
+			
+		
+		
+			
+		
+		
+			
+		
+			
+		
+		
+			
+		
+	
+
    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 ommited the default is 'body'
      • 
-		
    • Optional param: 'data-toc-headings'. If ommited the default is 'h1,h2,h3'
      • 
-		
    • Full example: [toc data-toc='div.page-body' data-toc-headings='h1,h2']
      • 
-	
    
-
-
-
    
-
    These require a suitable map plugin/addon such as openstreetmap or else the result will be blank
    
-
      
-
    • [map] Generate an inline map using the current browser coordinates of the poster, if browser location is enabled
      
-
    • [map=latitude,longitude] Generate a map using global coordinates.
      
-
    • [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.
       
-
    
-
-
+		
  • 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