Difference between revisions of "Wiki Markup"

From Hornbill
Jump to navigation Jump to search
(20 intermediate revisions by 4 users not shown)
Line 50: Line 50:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
    <td>* Item 1<br />* Item 2<br />* Item 3<br />** Sub Item 1<br />** Sub Item 2<br />*** Sub-sub Item 1</td>
+
<td style="vertical-align:top;">
−
    <td><ul><li> Item 1</li><li> Item 2</li><li> Item 3<ul><li>Sub Item 1</li><li>Sub Item 2</li><ul><li>Sub-sub Item 1</li></ul></ul></li></ul></td>
+
<pre>
 +
* Start each line
 +
* with an asterisk (*).
 +
** More asterisks give deeper
 +
*** and deeper levels.
 +
* Line breaks <br />don't break levels.
 +
*** But jumping levels creates empty space.
 +
Any other start ends the list.
 +
</pre>
 +
</td>
 +
<td>
 +
* Start each line
 +
* with an asterisk (*).
 +
** More asterisks give deeper
 +
*** and deeper levels.
 +
* Line breaks <br />don't break levels.
 +
*** But jumping levels creates empty space.
 +
Any other start ends the list.
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
  
 
=== Numbered List ===
 
=== Numbered List ===
−
<table width="75%">
+
<table width="65%">
 
<tr>
 
<tr>
 
     <td>''Markup''</td>
 
     <td>''Markup''</td>
Line 62: Line 80:
 
</tr>
 
</tr>
 
<tr>
 
<tr>
−
    <td># Item 1<br /># Item 2<br /># Item 3<br />## Sub Item 1<br />## Sub Item 2<br />### Sub-sub Item 1</td>
+
<td style="vertical-align:top;">
−
    <td><ol><li> Item 1</li><li> Item 2</li><li> Item 3<ol><li>Sub Item 1</li><li>Sub Item 2</li><ol><li>Sub-sub Item 1</li></ol></ol></li></ol></td>
+
<pre>
 +
# Start each line
 +
# with a [[Wikipedia:Number_sign|number sign]] (#).
 +
## More number signs give deeper
 +
### and deeper
 +
### levels.
 +
# Line breaks <br />don't break levels.
 +
### But jumping levels creates empty space.
 +
# Blank lines
 +
 
 +
# end the list and start another.
 +
Any other start also
 +
ends the list.
 +
</pre>
 +
</td>
 +
<td>
 +
# Start each line
 +
# with a [[Wikipedia:Number_sign|number sign]] (#).
 +
## More number signs give deeper
 +
### and deeper
 +
### levels.
 +
# Line breaks <br />don't break levels.
 +
### But jumping levels creates empty space.
 +
# Blank lines
 +
 
 +
# end the list and start another.
 +
Any other start also
 +
ends the list.
 +
</td>
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
 +
=== Indents ===
 +
{| width="65%" style="vertical-align:top;"
 +
|
 +
<pre>
 +
No indent
 +
: Single indent
 +
:: Double indent
 +
::: Triple indent
 +
</pre>
 +
|
 +
No indent
 +
: Single indent
 +
:: Double indent
 +
::: Triple indent
 +
|}
 +
 +
=== Mixture of different types of list ===
 +
{| width="65%" style="vertical-align:top;"
 +
|
 +
<pre>
 +
# one
 +
# two
 +
#* two point one
 +
#* two point two
 +
# three
 +
#: three def one
 +
# four
 +
#: four def one
 +
#: this looks like a continuation
 +
# five
 +
## five sub 1
 +
### five sub 1 sub 1
 +
## five sub 2
 +
</pre>
 +
|
 +
# one
 +
# two
 +
#* two point one
 +
#* two point two
 +
# three
 +
#: three def one
 +
# four
 +
#: four def one
 +
#: this looks like a continuation
 +
# five
 +
## five sub 1
 +
### five sub 1 sub 1
 +
## five sub 2
 +
|}
  
 
== Text Formatting ==
 
== Text Formatting ==
Line 96: Line 192:
 
</tr>
 
</tr>
 
</table>
 
</table>
−
 
−
|-
 
−
| <translate><!--T:56--> Indent text</translate>
 
−
| <pre>
 
−
<translate>
 
−
<!--T:57-->
 
−
: Single indent
 
−
:: Double indent
 
−
::::: Multiple indent
 
−
</translate>
 
−
</pre>
 
−
----
 
−
{{Note|<translate><!--T:58--> This workaround may harm accessibility.</translate>}}
 
−
|
 
−
<translate>
 
−
<!--T:59-->
 
−
: Single indent
 
−
:: Double indent
 
−
::::: Multiple indent
 
−
</translate>
 
  
 
== Links ==
 
== Links ==
Line 147: Line 223:
 
</tr>
 
</tr>
 
</table>
 
</table>
 +
 +
== Date Formatting ==
 +
 +
You can wrap a Date & Time value (e.g. 21-02-2020 16:10:30) with square brackets to apply the configured preferences in your Profile's Regional Settings.
 +
 +
For example, if the "Date Time Format" option in my Profile's Regional Settings is set to "21/02/2020 16:10", the syntax [01-01-1970 01:00:00] would result in 01/01/1970 01:00.
 +
 +
Another common use is using the Variable Picker in the Business Process Engine to post to a Timeline or Workspace. You can wrap the generated value (by the Variable Picker) with square brackets. For example, &[functions.pcf("askAQuestion","selectStartDate")] becomes [&[functions.pcf("askAQuestion","selectStartDate")]].
  
 
== Images ==
 
== Images ==
Line 186: Line 270:
 
     <td>''Displayed As''</td>
 
     <td>''Displayed As''</td>
 
</tr>
 
</tr>
−
<tr>
+
<tr><td>:-)</td><td>😀</td></tr>
−
    <td>:-)<br />:)<br />:D<br />:-(<br />:(<br />;)<br />;-)<br />:-o<br />:o<br />:P<br />:-bd<br />X(<br />~O)<br />:-S</td>
+
<tr><td>:)</td><td>😀</td></tr>
−
    <td>[[File:emoticons.png]]</td>
+
<tr><td>:D</td><td>😆</td></tr>
−
</tr>
+
<tr><td>:-(</td><td>😞</td></tr>
 +
<tr><td>:(</td><td>😞</td></tr>
 +
<tr><td>;)</td><td>😉</td></tr>
 +
<tr><td>;-)</td><td>😉</td></tr>
 +
<tr><td>:-o</td><td>😮</td></tr>
 +
<tr><td>:o</td><td>😮</td></tr>
 +
<tr><td>:O</td><td>😮</td></tr>
 +
<tr><td>:P</td><td>😛</td></tr>
 +
<tr><td>:p</td><td>😛</td></tr>
 +
<tr><td>:-bd</td><td>👍</td></tr>
 +
<tr><td>(y)</td><td>👍</td></tr>
 +
<tr><td>(yes)</td><td>👍</td></tr>
 +
<tr><td>(ok)</td><td>👍</td></tr>
 +
<tr><td>(n)</td><td>👎</td></tr>
 +
<tr><td>(no)</td><td>👎</td></tr>
 +
<tr><td>X(</td><td>😠</td></tr>
 +
<tr><td>~O)</td><td>☕</td></tr>
 +
<tr><td>:-S</td><td>😕</td></tr>
 +
<tr><td>:/</td><td>😕</td></tr>
 +
<tr><td>:-/</td><td>😕</td></tr>
 +
<tr><td>8-)</td><td>😎</td></tr>
 +
<tr><td>(cwl)</td><td>😂</td></tr>
 +
<tr><td>:\'(</td><td>😢</td></tr>
 +
<tr><td>:|</td><td>😐</td></tr>
 +
<tr><td>:$</td><td>☺</td></tr>
 +
<tr><td>:-$</td><td>☺</td></tr>
 +
<tr><td>|)</td><td>😴</td></tr>
 +
<tr><td>|-)</td><td>😴</td></tr>
 +
<tr><td>(zip)</td><td>🤐</td></tr>
 
</table>
 
</table>
  
Line 224: Line 336:
 
<td>
 
<td>
 
<blockquote>some text</blockquote>
 
<blockquote>some text</blockquote>
 +
</td>
 +
</tr>
 +
</table>
 +
 +
== Horizontal Rule ==
 +
 +
<table width="65%">
 +
<tr>
 +
    <td>''Markup''</td>
 +
    <td>''Displayed As''</td>
 +
</tr>
 +
<tr>
 +
<td>
 +
<nowiki>----</nowiki>
 +
</td>
 +
<td>
 +
----
 
</td>
 
</td>
 
</tr>
 
</tr>

Revision as of 23:42, 5 August 2020

Home > Collaboration > Wiki Markup

Introduction

For easy formatting of text in Hornbill, a subset of wiki markup can be used for decorating text with italics or bold, creating bulleted or numbered lists, and defining titles and subtitles. Wiki markup lets you quickly apply some basic formatting to your text as you type, giving it that extra touch to make it stand out.

Related Articles

Section Headings

Using the equal sign (=) on either side of a word creates a section heading. The number of equal signs determines the size of the heading. Each heading is followed by a line break.

Markup Displayed As
= Heading 1 =

Heading 1
== Heading 2 ==

Heading 2
=== Heading 3 ===

Heading 3

Lists

There are two available types of lists, numbered and bulleted.

Bullet List

Markup Displayed As 
* Start each line
* with an asterisk (*).
** More asterisks give deeper
*** and deeper levels.
* Line breaks <br />don't break levels.
*** But jumping levels creates empty space.
Any other start ends the list.
  • Start each line
  • with an asterisk (*).
    • More asterisks give deeper
      • and deeper levels.
  • Line breaks
    don't break levels.
      • But jumping levels creates empty space.

Any other start ends the list.

Numbered List

Markup Displayed As 
# Start each line
# with a [[Wikipedia:Number_sign|number sign]] (#).
## More number signs give deeper
### and deeper
### levels.
# Line breaks <br />don't break levels.
### But jumping levels creates empty space.
# Blank lines

# end the list and start another.
Any other start also
ends the list.
  1. Start each line
  2. with a number sign (#).
    1. More number signs give deeper
      1. and deeper
      2. levels.
  3. Line breaks
    don't break levels.
      1. But jumping levels creates empty space.
  4. Blank lines
  1. end the list and start another.

Any other start also ends the list.

Indents

No indent
: Single indent
:: Double indent
::: Triple indent

No indent

Single indent
Double indent
Triple indent

Mixture of different types of list

# one
# two
#* two point one
#* two point two
# three
#: three def one
# four
#: four def one
#: this looks like a continuation
# five
## five sub 1
### five sub 1 sub 1
## five sub 2
  1. one
  2. two
    • two point one
    • two point two
  3. three
    three def one
  4. four
    four def one
    this looks like a continuation
  5. five
    1. five sub 1
      1. five sub 1 sub 1
    2. five sub 2

Text Formatting

Single quotation marks ( ' ) are used to format text as either bold or italic. Typing two single quotation marks either side of some text will italicize the text. Typing three single quotation marks either side of some text will bold the text.

Markup Displayed As
''italics'' italics
'''bold''' bold
<del>strike through</del> strike through
<ins>underline</ins> underline
<span style="color:red;font-size:16px;font-family:fantasy">font formatting such as color and font type</span> font formatting such as color and font type

Links

Hyperlinks to other areas of Hornbill can be added. This includes the ability to provide some friendly text along with the link. These links are internal to your instance of Hornbill. The URL link will always be prefixed with https://live.hornbill.com/<your instance>/

Markup Displayed As
[[newsfeed]] newsfeed
[[newsfeed|Link to your Newsfeed]] Link to your Newsfeed


The same concept will be available for external links using absolute URLs

Markup Displayed As
[[http://forums.hornbill.com/|Hornbill Community]] Hornbill Community

Date Formatting

You can wrap a Date & Time value (e.g. 21-02-2020 16:10:30) with square brackets to apply the configured preferences in your Profile's Regional Settings.

For example, if the "Date Time Format" option in my Profile's Regional Settings is set to "21/02/2020 16:10", the syntax [01-01-1970 01:00:00] would result in 01/01/1970 01:00.

Another common use is using the Variable Picker in the Business Process Engine to post to a Timeline or Workspace. You can wrap the generated value (by the Variable Picker) with square brackets. For example, &[functions.pcf("askAQuestion","selectStartDate")] becomes [&[functions.pcf("askAQuestion","selectStartDate")]].

Images

Images can be added to any text field that allows wiki markup other than Posts or Comments as they have their own mechanism for managing images.

Syntax: [[File:filename.extension|options|caption]]

Legacy Image: namespace prefix is still supported as a synonym as well as Media.

Markup Displayed As
some [[File:https://www.hornbill.com/images/logo.png]] text some Youtube small logo.png text
some [[File:https://www.hornbill.com/images/logo.png|right|caption]] text some
caption
text
some [[File:https://www.hornbill.com/images/logo.png|center|50px|caption]] text some
caption
text

Images with Links

Images can also be linked to a URL.

The syntax is: [[File:https://www.hornbill.com/images/logo.png|link=http://www.hornbill.com|alt=Hornbill Logo]]

Symbols

Markup Displayed As
:-)😀
:)😀
:D😆
:-(😞
:(😞
;)😉
;-)😉
:-o😮
:o😮
:O😮
:P😛
:p😛
:-bd👍
(y)👍
(yes)👍
(ok)👍
(n)👎
(no)👎
X(😠
~O)☕
:-S😕
:/😕
:-/😕
8-)😎
(cwl)😂
:\'(😢
:|😐
:$☺
:-$☺
|)😴
|-)😴
(zip)🤐

Code Snippets

A language can be passed as an option after a colon [code:SOURCE-LANGUAGE] These are the available languages: "bsh", "c", "cc", "cpp", "cs", "csh", "cyc", "cv", "htm", "html", "java", "js", "m", "mxml", "perl", "pl", "pm", "py", "rb", "sh", "xhtml", "xml", "xsl", "sql"

Markup Displayed As

[code]
var a = 1;
[/code]

[code:xml]
<element>a</element>
[/code]

var a = 1;


<element>a</element>

Blockquote

Markup Displayed As

[blockquote]
some text
[/blockquote]

some text

Horizontal Rule

Markup Displayed As

----

Nowiki

Markup Displayed As

[nowiki]
This is '''bold''' and this is ''italic''
[/nowiki]

This is '''bold''' and this is ''italic''

Retrieved from "https://wiki.hornbill.com/index.php?title=Wiki_Markup&oldid=24816"