Skip to content

Latest commit

 

History

History
388 lines (278 loc) · 8.1 KB

TextFormattingRules.md

File metadata and controls

388 lines (278 loc) · 8.1 KB
Raw

Paragraphs

Consecutive lines are concatenated into a single paragraph.

Blank lines (ones with only a carriage return or with only spaces and tabs) mark the end of a paragraph.

  • Example statement
For example,
if I write like this, these lines
will be formatted as one paragraph.
  • Example output

For example, if I write like this, these lines will be formatted as one paragraph.

Links

WikiNames

WikiNames are comprised of two or more words put together; each word begins with an uppercase letter, and is followed by at least one lowercase letter or number.

Words in which this condition is met become a WikiName, and a link is automatically attached.

  • Example statement
WikiName     - WikiName
HogeRule1    - WikiName
NOTWIKINAME  - All of the letters are uppercase, so this is not a WikiName
WikiNAME     - All of the letters in NAME are uppercase, so this is not a WikiName
fooWikiName  - This begins with "foo", which is in all lowercase, so this is not a WikiName
  • Example output
    • WikiName - WikiName
    • HogeRule1 - WikiName
    • NOTWIKINAME - All of the letters are uppercase, so this is not a WikiName
    • WikiNAME - All of the letters in NAME are uppercase, so this is not a WikiName
    • fooWikiName - This begins with "foo", which is in all lowercase, so this is not a WikiName

You can disable an auto WikiName link by putting ^ to the WikiName.

  • Example statement
WikiName     - WikiName
^WikiName    - Disable WikiName link
  • Example output

Linking to other Wiki pages

If a page name is surrounded with two pairs of brackets, it becomes a link to that page.

  • Example statement
For example, if you write [[TextFormattingRules]], it becomes a link to that page.
  • Example output

For example, if you write TextFormattingRules, it becomes a link to that page.

Linking to an arbitrary URL

If a phrase and URL, separated by a vertical line, are surrounded with two pairs of brackets, it becomes a link to an arbitrary URL.

  • Example statement
Links like [[Yahoo!|http://www.yahoo.com/]] are also possible.
  • Example output

Links like Yahoo! are also possible.

Text in a paragraph that looks like a URL will automatically become a link.

  • Example statement
Hiki's home page is http://hikiwiki.org/en/ (English).
  • Example output

Hiki's home page is http://hikiwiki.org/en/ (English).

In this case, if the URL ends with jpg., .jpeg, .png, or .gif, the image is displayed on the page.

  • Example statement
http://jp.rubyist.net/theme/clover/clover_h1.png
  • Example output

clover_h1.png

#Preformatted text

Lines beginning with spaces or tabs will be treated as preformatted text.

  • Example output
require 'cgi'

cgi = CGI::new
cgi.header

puts <<EOS
<html>
  <head>
    <title>Hello!</title>
  </head>
  <body>
  <p>Hello!</p>
  </body>
</html>
EOS

Text decoration

Text surrounded by sets of two single quotes ('') is emphasised.

Text surrounded by sets of three single quotes (''') is strongly emphasised.

Text surrounded by sets of double equal signs (===) is struck out.

Text surrounded by sets of double backquotes (``) is inline literal.

  • Example statement
If you write like this, it becomes ''emphasised''.
And if you write like this, it becomes '''strongly emphasised'''.
==This is dull, but== And struck-out text is supported, too!
If you write like this, it becomes ``monospaced text``.
  • Example output

If you write like this, it becomes emphasised. And if you write like this, it becomes strongly emphasised. This is dull, but And struck-out text is supported, too! If you write like this, it becomes monospaced text.

Headings

Lines with exclamation marks at the beginning become headings.

One can use up to six exclamation marks; they will be converted to <h1> to <h6> tags.

  • Example statement
!Heading1
!!Heading2
!!!Heading3
!!!!Heading4
!!!!!Heading5
  • Example output

Heading1

Heading2

Heading3

Heading4

Heading5

Horizontal lines

Four hyphens at the beginning of the line (----) become a horizontal rule.

  • Example statement
A B C D E
----
F G H I J
  • Example output

A B C D E

F G H I J

Lists

Lines beginning with asterisks become list items.

It is possible to use up to three asterisks; it is also possible to create nested lists.

Lines beginning with a # become numbered lists.

  • Example statement
*Item 1
**Item 1.1
**Item 1.2
***Item 1.2.1
***Item 1.2.2
***Item 1.2.3
**Item 1.3
**Item 1.4
*Item 2

#Item 1
#Item 2
##Item 2.1
##Item 2.2
##Item 2.3
#Item 3
##Item 3.1
###Item 3.1.1
###Item 3.1.2
  • Example output
  • Item 1
    • Item 1.1
    • Item 1.2
      • Item 1.2.1
      • Item 1.2.2
      • Item 1.2.3
    • Item 1.3
    • Item 1.4
  • Item 2
  1. Item 1
  2. Item 2
    1. Item 2.1
    2. Item 2.2
    3. Item 2.3
  3. Item 3
    1. Item 3.1
      1. Item 3.1.1
      2. Item 3.1.2

Quotations

Lines beginning with two double quotes become quotations.

  • Example statement
""This is a quotation.
""This is another quote.
""This is a continued quote.  When there are consecutive quotations,
""they are displayed as one quote,
""like this.
  • Example output

This is a quotation. This is another quote. This is a continued quote. When there are consecutive quotations, they are displayed as one quote, like this.

Definitions

Lines beginning with a colon and have a phrase and explanation separated by another colon will become a definition.

  • Example statement
:ringo:apple
:gorira:gorilla
:rakuda:camel
  • Example output
ringo
apple
gorira
gorilla
rakuda
camel

Tables

Tables begin with two vertical bars.

Leading `!' in a cell means that it is a heading cell.

To concatenate columns or rows, put \>'(columns) or ^'(rows) at head of the cell.

  • Example statement
||!row heading \ column heading||!column A||!column B||!column C||!>column D-E (horizontal concatenation)
||!row 1||A1||B1||^C1-C2 (vertical concatenation)||D1||E1
||!row 2||A2||B2||^>D2-E2-D3-E3 (vertical and horizontal concatenation)
||!row 3||>>A3-C3 (horizontal concatenation)
  • Example output
row heading \ column headingcolumn Acolumn Bcolumn Ccolumn D-E (horizontal concatenation)
row 1A1B1C1-C2 (vertical concatenation)D1E1
row 2A2B2D2-E2-D3-E3 (vertical and horizontal concatenation)
row 3A3-C3 (horizontal concatenation)

Comments

Lines starting with `//' becomes a comment line. Comment lines is not outputted.

  • Example statement
 // This is a comment line.
  • Example output (not displayed)

#Plugins

One can use a plugin by surrounding text with two pairs of brackets. Multiple lines parameter is supported. When a line contains plugin only, it becomes a block plugin, which is not surrounded by <p> ... </p>.

  • Example statement
{{recent(3)}}
  • Example statement of multiple lines
{{pre('
...
')}}