kwiki-rules.wiki 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. = Kwiki Formatting Rules
  2. This page describes the particular [http://en.wikipedia.org/wiki/Wiki Wiki] markup language used by [http://www.kwiki.org/ Kwiki].
  3. You can try it out on the dedicated KwikiSandbox page.
  4. ----
  5. = Level 1 Heading
  6. == Level 2 Heading
  7. === Level 3 Heading
  8. ==== Level 4 Heading
  9. ===== Level 5 Heading
  10. ====== Level 6 Heading
  11. = Level 1 Heading
  12. == Level 2 Heading
  13. ==== Level 4 Heading
  14. ===== Level 5 Heading
  15. ====== Level 6 Heading
  16. ----
  17. Horizontal lines are made with 4 or more dashes:
  18. ----
  19. ----
  20. Paragraphs are separated by a blank line.
  21. Like this. Another paragraph.
  22. Paragraphs are separated by a blank line.
  23. Like this. Another paragraph.
  24. ----
  25. *Bold text*, /italic text/, _underlined text_, and -striked through text-.
  26. *Bold text*, /italic text/, _underlined text_, and -striked through text-.
  27. /*Combination of bold and italics*/
  28. /*Combination of bold and italics*/
  29. Inline code like [=/etc/passwd] or [=Kwiki::Theme::Basic]
  30. Inline code like [=/etc/passwd] or [=Kwiki::Theme::Basic]
  31. ----
  32. WikiLinks are formed by two or more words in /camel-case/.
  33. WikiLinks are formed by two or more words in /camel-case/.
  34. External links begin with !http://, like http://www.freepan.org
  35. External links begin with http://, like http://www.freepan.org
  36. On some cases links can appear as http://. This means that you entered an address that is not whitelisted. Wait for an admin to whitelist it.
  37. Forced wiki [links] are a alphanumeric string surrounded by square brackets.
  38. Forced wiki [links] are a alphanumeric string surrounded by square brackets.
  39. Named http links have text with an http:// link inside, like [Kwiki http://www.kwiki.org Site]
  40. Named http links have text with an http:// link inside, like [FreePAN
  41. http://www.freepan.org Site]
  42. Sometimes !WordsShouldNotMakeAWikiLink so put a '!' beforehand.
  43. Sometimes !WordsShouldNotMakeAWikiLink so put a '!' beforehand.
  44. Same thing with !http://foobar.com
  45. Same thing with !http://foobar.com
  46. Mailto links are just email addresses like foo@bar.com.
  47. Mailto links are just email addresses like foo@bar.com.
  48. ----
  49. Links to images display the image:
  50. http://www.google.com/images/logo.gif
  51. http://www.google.com/images/logo.gif
  52. ----
  53. Unordered lists begin with a '* '. The number of asterisks determines the level:
  54. * foo
  55. * bar
  56. ** boom
  57. ** bam
  58. * baz
  59. * foo
  60. * bar
  61. ** boom
  62. ** bam
  63. * baz
  64. Ordered lists begin with a '0 ' (zero):
  65. 0 foo
  66. 0 bar
  67. 00 boom
  68. 00 bam
  69. 0 baz
  70. 0 foo
  71. 0 bar
  72. 00 boom
  73. 00 bam
  74. 0 baz
  75. You can mix lists too:
  76. * Today:
  77. 00 Eat icecream
  78. 00 Buy a pony
  79. * Tomorrow:
  80. 00 Eat more icecream
  81. 00 Buy another pony
  82. * Today:
  83. 00 Eat icecream
  84. 00 Buy a pony
  85. * Tomorrow:
  86. 00 Eat more icecream
  87. 00 Buy another pony
  88. ----
  89. Any text that does not begin in the first column is rendered as preformatted text.
  90. foo bar
  91. x y
  92. 1 2
  93. ----
  94. Simple Tables:
  95. | | Dick | Jane |
  96. | height | 72" | 65" |
  97. | weight | 130lbs | 150lbs |
  98. | | Dick | Jane |
  99. | height | 72" | 65" |
  100. | weight | 130lbs | 150lbs |
  101. ----
  102. Inline HTML is escaped.
  103. <hr> <bold>No?</bold> <i>Yes?</i> <hr/>
  104. Renders as: <hr> <bold>No?</bold> <i>Yes?</i> <hr/>
  105. Notice the '[=/]' character in the tags is being rendered as /italic/ markers.