From 1a5dd5c87c60f28fd799397e2aa0081f9b6c58ed Mon Sep 17 00:00:00 2001 From: Andrew Manning Date: Mon, 26 Dec 2016 08:58:40 -0500 Subject: Updated markup language support doco. Modified parseIdentityAwareHTML BBcode parsing to support the BBcode reference which is now in /help/member/bbcode.html. Add Bootstrap classes to tables for BBcode tables that have the border=0 or border=1 options set. --- doc/about/about_hubzilla.bb | 9 ---- doc/bbcode.html | 109 -------------------------------------------- doc/member/bbcode.html | 105 ++++++++++++++++++++++++++++++++++++++++++ doc/member/member_guide.bb | 9 ++++ 4 files changed, 114 insertions(+), 118 deletions(-) delete mode 100644 doc/bbcode.html create mode 100644 doc/member/bbcode.html (limited to 'doc') diff --git a/doc/about/about_hubzilla.bb b/doc/about/about_hubzilla.bb index 3568ca200..3327e0b50 100644 --- a/doc/about/about_hubzilla.bb +++ b/doc/about/about_hubzilla.bb @@ -186,17 +186,8 @@ Any number of profiles may be created containing different information and these $Projectname offers a simple, one-click account backup, where you can download a complete backup of your profile(s). Backups can then be used to clone or restore a profile. [h4]Account Deletion[/h4] - Accounts can be immediately deleted by clicking on a link. That's it. All associated content is then deleted from the grid (this includes posts and any other content produced by the deleted profile). Depending on the number of connections you have, the process of deleting remote content could take some time but it is scheduled to happen as quickly as is practical. -[h4]Content Creation[/h4] - -[h4]Writing Posts[/h4] - -$Projectname supports a number of different ways of adding rich-text content. The default is a custom variant of BBcode, tailored for use in $Projectname. You may also enable the use of Markdown if you find that easier to work with. A visual editor may also be used. The traditional visual editor for $Projectname had some serious issues and has since been removed. We are currently looking for a replacement. - -When creating "Websites", content may be entered in HTML, Markdown, BBcode, and/or plain text. - [h4]Deletion of content[/h4] Any content created in $Projectname remains under the control of the member (or channel) that originally created it. At any time, a member can delete a message, or a range of messages. The deletion process ensures that the content is deleted, regardless of whether it was posted on a channel's primary (home) hub, or on another hub, where the channel was remotely authenticated via Zot ($Projectname communication and authentication protocol). diff --git a/doc/bbcode.html b/doc/bbcode.html deleted file mode 100644 index 36f40d3f4..000000000 --- a/doc/bbcode.html +++ /dev/null @@ -1,109 +0,0 @@ -

BBcode reference

-
-

-
- -
You can make lists with:
-For example:
[ul]
[*] First list element
[*] Second list element
[/ul]

Will render something like:
- - -or

[dl terms="b"]
[*= First element term] First element description
[*= Second element term] Second element description
[/dl]

Will render something like:

-
-
First element term
First element description
-
Second element term
Second element description
-

- - -
There's also:
-
-
Tables? Yes!

[table border=1]
[tr]
[th]Tables now[/th]
[/tr]
[tr]
[td]Have headers[/td]
[/tr]
[/table]

Tables now
Have headers

All sizes,
From the [size=xx-small] - xx-small.
To the [size=xx-large] - xx-large.
To fit exactly 20px use [size=20].

- -

$Projectname specific codes

- -
-

These require a suitable map plugin/addon such as openstreetmap or else the result will be blank

- - -#include doc/macros/main_footer.bb; -
- - - diff --git a/doc/member/bbcode.html b/doc/member/bbcode.html new file mode 100644 index 000000000..e186085d3 --- /dev/null +++ b/doc/member/bbcode.html @@ -0,0 +1,105 @@ +

BBcode reference

+
+

+
+ +
You can make lists with:
+For example:
[ul]
[*] First list element
[*] Second list element
[/ul]

Will render something like:
+ + +or

[dl terms="b"]
[*= First element term] First element description
[*= Second element term] Second element description
[/dl]

Will render something like:

+
+
First element term
First element description
+
Second element term
Second element description
+

+ + +
There's also:
+
+
Tables? Yes!

[table border=1]
[tr]
[th]Tables now[/th]
[/tr]
[tr]
[td]Have headers[/td]
[/tr]
[/table]

Tables now
Have headers

All sizes,
From the [size=xx-small] - xx-small.
To the [size=xx-large] - xx-large.
To fit exactly 20px use [size=20].

+ +

$Projectname specific codes

+ +
+

These require a suitable map plugin/addon such as openstreetmap or else the result will be blank

+ + +
diff --git a/doc/member/member_guide.bb b/doc/member/member_guide.bb index 53cc6b8c7..b68eef12a 100644 --- a/doc/member/member_guide.bb +++ b/doc/member/member_guide.bb @@ -287,6 +287,15 @@ The connection edit screen offers a slider to select a degree of friendship with The slider on the matrix page has both a minimum and maximum value. Posts will only be shown from people who fall between this range. Affinity has no relation to permissions, and is only useful in conjunction with the affinity tool feature. +[h3]Markup Languages[/h3] +$Projectname supports several markup languages for advanced formatting of content. The default markup language is a [url=[baseurl]/help/member/bbcode]custom variant of BBcode[/url], tailored for use in $Projectname. BBcode is supported for posts, wiki pages, and web page elements. Wiki pages and webpage elements may also be written using standard Markdown. +[table border=0] +[tr][th]Content Type[/th][th]Supported Markup[/th][/tr] +[tr][td]Post[/td][td]BBcode[/td][/tr] +[tr][td]Wiki[/td][td]BBcode, Markdown[/td][/tr] +[tr][td]Webpage element[/td][td]BBcode, Markdown, HTML[/td][/tr] +[/table] + [h3]Personal Cloud Storage[/h3] $Projectname provides an ability to store privately and/or share arbitrary files with friends. -- cgit v1.2.3