Wiki Markup Guide - Format & Layout

This page provides a guide for doing simple formatting and layout within a wiki page.

Wiki Guides

Index

Basic Formatting

Allows for simple formatting of wiki text.
Source Markup
*bold*
_italics_
+underline+
~~strikethrough~~
^^superscript^^
,,subscript,,
---- (Horizontal rule - 4 dashes on a single line)

Rendered Markup
bold
italics
underline
strikethrough
superscript
subscript

Code Block

Allows for text to be formatted as code for languages in which syntax highlighting (see Wiki Markup Guide - Macros) is not supported.
Source Markup
// multi-line
{{ 
   public static void Main()
   { 
     // code goes here 
   }
}}

// single line
{{ single line of text }}

Rendered Markup
// multi-line
   public static void Main()
   { 
     // code goes here 
   } 


// single line
single line of text

Headings

Allows formatting text as a header.
Source Markup
! Heading 1   
!! Heading 2
!!! Heading 3
!!!! Heading 4
!!!!! Heading 5
!!!!!! Heading 6

Rendered Markup

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Escaped Markup

Allows use of wiki formatting characters as literal text.
Source Markup
{"text with *unrendered* wiki markup"}

Rendered Text
text with *unrendered* wiki markup

Note: Only use vertical (not curly) quotes to ensure that formatting will not apply.

Lists

Allows for the creation of bullted or numbered lists.
Source Markup
* Bulleted List 1
** Bulleted List 2
*** Bulleted List 3

# Numbered List 1
## Numbered List 1.1
### Numbered List 1.1.1
# Numbered List 2
## Numbered List 2.1

Rendered Markup
  • Bulleted List 1
    • Bulleted List 2
      • Bulleted List 3
  1. Numbered List 1
    1. Numbered List 1.1
      1. Numbered List 1.1.1
  2. Numbered List 2
    1. Numbered List 2.1

Tables

Allows for the creation of simple table layouts.
Source Markup
|| Table Heading 1 || Table Heading 2 || Table Heading 3 ||
| Row 1 - Cell 1 | Row 1 - Cell 2 | Row 1 - Cell 3 |
| Row 2 - Cell 1 | Row 2 - Cell 2 | Row 2 - Cell 3 |

Rendered Markup
Table Heading 1 Table Heading 2 Table Heading 3
Row 1 - Cell 1 Row 1 - Cell 2 Row 1 - Cell 3
Row 2 - Cell 1 Row 2 - Cell 2 Row 2 - Cell 3


Note on block level tags

Block level tags include headings, lists, tables, and multi-line formatted text
  • Tag must be the first thing on the line
  • Closing tag must be the last thing on the line
  • There should be no leading or trailing whitespace

Text Alignment

Allows for alignment of text on the page. Indentation allows for n-level depth.
Source Markup
<{this is left aligned content}<
>{this is right aligned content}>

: this is indented
:: this is double-indented

Rendered Markup
this is left aligned content
 

this is right aligned content
 

this is indented
this is double-indented

Last edited Jul 21, 2010 at 12:01 AM by Ethetica, version 13

Comments

LukeHansen Jan 11 at 2:19 PM 
Nice

Vaccano May 29, 2012 at 5:34 PM 
Need a way to show code that will use a scroll bar. Some times code has to stay on one line. (ie the post build steps are line sensitive in Visual Studio)

pcgeek86 Feb 22, 2012 at 9:08 PM 
How do you color the text in a post?

LordIkon Jan 5, 2012 at 7:54 PM 
Is there no way to colorize text using wiki markup? Or do you have to use HTML to do so?

rajeshwaranindia Aug 29, 2011 at 12:16 PM 
How to create menu , sub menu option and Quick links, text or images .
Where to create code blocks

smurfiv Sep 6, 2010 at 6:21 PM 
@chaiguy - Split the bits up, See what this does _*{{ "${specialfolder:folder=CommonApplicationData}}}_{{/LiquesceSvc/Logs" }}*

chaiguy Jun 25, 2010 at 4:07 PM 
Is it possible to format text within a code block, for example to italicize certain lines of code?

vajanko May 12, 2010 at 9:58 AM 
And what about comments. Can I add some comments lines, like <!-- not displayed text -->

chrisweber Feb 24, 2010 at 8:22 PM 
+Prodeos - I wish that would change too. I like to make lists with descriptions after each item.

Prodeos Feb 1, 2010 at 12:37 PM 
is there any problem with numbering? it's not working for me as soon as i put text between two list items

gpeipman Aug 15, 2009 at 3:20 PM 
I need custom HTML that is not shown as HTML encoded string. Is it possible?

colint Jun 8, 2009 at 11:51 PM 
jw32181, we need to update the wiki guide because we just recently added this. Just add < for left align or > for right align in front of the image link (see http://codeplex.codeplex.com/Wiki/View.aspx?title=Wiki%20Links&referringTitle=CodePlex%20Help%20Wiki).

Example: >[image:http://www.codeplex.com/Images/logo-home.png]

barkgj Mar 13, 2009 at 10:12 PM 
Aha, I was wrong apparently; in the Macro section (http://codeplex.codeplex.com/Wiki/View.aspx?title=Wiki%20Macros&referringTitle=CodePlex%20Wiki%20Markup%20Guide) is explained how to use codeblocks, would be nice if someone could cleanup the incorrect layout feature above. Anyways, I am happy my project looks much better now that I can actually mark the wiki-code with a good markup.

barkgj Mar 13, 2009 at 5:14 PM 
Maybe we should have a codeplex project on codeplex to improve this wiki; the html / markup / layout capabilities are quite weak... :(

heaths Feb 7, 2009 at 4:49 PM 
The section about code markup was not properly escaped in this version of this wiki page. It was in the previous, but the previous also didn't show how to write code that is not supported by syntax coloring.

MichaelScott Dec 6, 2008 at 4:37 PM 
Would it be possible to remove the top/bottom padding from Heading 2's. It is currently set to .7em, which, in addition to the default margin already applied by most browsers, it awkwardly large. (The other heading levels do not have this extra padding.)

jamiet Oct 30, 2008 at 8:35 AM 
Echoing MarkLTX. Would line line breaks in table cells. Is there a list of escape characters anywhere?

Thanks

joaosantana Oct 11, 2008 at 3:33 PM 
@MylesMcDonnell: try put this _ at the start and the end of the paragraph...

MylesMcDonnell Sep 1, 2008 at 9:36 AM 
How do I set a whole paragraph in italics?

ra00l Jul 5, 2008 at 5:30 PM 
horizontal line <hr /> would be helpful!

comun Dec 24, 2007 at 12:29 AM 
How to add a new wiki to project?(Not home page)

MarkLTX Dec 14, 2007 at 4:57 PM 
I would like to be able to force a line break within a table cell.

joegtp Nov 1, 2007 at 6:20 PM 
Is there a way to create code blocks that have syntax highlighting?

Rhy Oct 5, 2007 at 1:05 AM 
Is there a way to create numbered lists that start from something other than 1?

bhavbhuti Aug 21, 2007 at 5:17 PM 
An option for a Dividing Line

dataking May 7, 2007 at 3:24 PM 
I too miss an option to specify positioning of images relative to text!!

dijeferson Feb 2, 2007 at 7:20 PM 
Same question as above.
May I set the align for something... like... ahmm ... text, or images ??

vermorel Dec 19, 2006 at 7:09 AM 
Is there anyway to specify the css style for an image? Basically "float:right;" would be a must have.

blainew Dec 1, 2006 at 6:59 PM 
Do you have a bookmark capability to jump to a section within a page?