I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

Difference between revisions of "Help:Formatting"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(doesn't need the TOCright template)
m
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
{{PD Help Page}}
+
__TOC__
−
You can format your text using wiki markup. This consists of normal characters like asterisks, single quotes or equation marks which have a special function in the wiki, sometimes depending on their position. For example, to format a word in ''italic'', you include it in two single quotes like <tt><nowiki>''this''</nowiki></tt>
+
  
−
== Text formatting markup ==
+
==Spaces, New Lines, Paragraphs, And More==
 +
You might have already noticed that single spaces between lines do not create spaces in the text. For example:
  
−
{| align="center" {{Prettytable}}
+
<pre><nowiki>
−
|-
+
Typing
−
|{{Hl2}} |'''Description'''
+
like
−
|{{Hl2}} |'''You type'''
+
this
−
|{{Hl2}} |'''You get'''
+
would come out
−
|-
+
like this:
−
| colspan="3" align="center" | ''applies anywhere''
+
</nowiki></pre>
−
|-
+
−
|Italic text
+
−
|<tt><nowiki>''italic''</nowiki></tt>
+
−
|''italic''
+
−
|-
+
−
| Bold text
+
−
|<tt><nowiki>'''bold'''</nowiki></tt>
+
−
|'''bold'''
+
−
|-
+
−
| Bold and italic
+
−
|<tt><nowiki>'''''bold & italic'''''</nowiki></tt>
+
−
|'''''bold & italic'''''
+
−
|-
+
−
|Escape wiki markup
+
−
|<tt><nowiki><nowiki>no ''markup''</nowiki></nowiki></tt>
+
−
|<nowiki>no ''markup''</nowiki>
+
−
|-
+
−
| colspan="3" align="center" | ''only at the beginning of the line''
+
−
|-
+
−
| Indent text
+
−
|<tt><nowiki>:Indent text</nowiki></tt>
+
−
|&nbsp;&nbsp;&nbsp;&nbsp;Indent text
+
−
|-
+
−
|Headings of<br />
+
−
different levels <ref>Use of a heading created by single equal signs is discouraged as it appears with the same formatting and size as the page title, which can be confusing.</ref><ref>An article with four or more headings will automatically create a [http://en.wikipedia.org/wiki/Wikipedia:Section#Table_of_contents_.28TOC.29 table of contents].</ref>
+
−
|
+
−
<tt><nowiki>==level 1==</nowiki></tt><br />
+
−
<tt><nowiki>===level 2===</nowiki></tt><br />
+
−
<tt><nowiki>====level 3====</nowiki></tt><br />
+
−
<tt><nowiki>=====level 4=====</nowiki></tt>
+
−
|
+
  
−
==Level 1==
+
Typing
−
===Level 2===
+
like
−
====Level 3====
+
this
−
=====Level 4=====
+
would come out
−
|-
+
like this:
−
|Horizontal rule
+
 
−
|
+
A blank space between the two lines, on the other hand, creates a new paragraph. For example:
−
<tt><nowiki>----</nowiki></tt>
+
 
−
|
+
<pre><nowiki>
 +
This would look like one paragraph.
 +
 
 +
This would look like another.
 +
 
 +
This would be the third.
 +
</nowiki></pre>
 +
 
 +
This would look like one paragraph.
 +
 
 +
This would look like another.
 +
 
 +
This would be the third.
 +
 
 +
For a new line, you must use the line break (br) command after the line. (Single Spaces are not necessary, but are used for clarity.)
 +
 
 +
Just do this:
 +
<pre><nowiki>
 +
Text Line 1<br>
 +
Text Line 2<br>
 +
 
 +
Paragraph 2 Line 1
 +
</nowiki></pre>
 +
 
 +
'''Remember:''' For the sake of clarity, it is best to place a line break, but not necessary.
 +
 
 +
==Emphasis==
 +
'''Hello!'''
 +
 
 +
''How Are You?''
 +
 
 +
This is basic, but important. Use three 's for a Bold and two for italics. The above section was made like this:
 +
 
 +
<pre><nowiki>
 +
'''Hello!'''
 +
 
 +
''How Are You?''
 +
</nowiki></pre>
 +
 
 +
HTML encoding also works, such as <b>Bold</b> and <i>Italics</i>
 +
 
 +
<pre><nowiki>
 +
<b>Bold</b> and <i>Italics</i>
 +
</nowiki></pre>
 +
 
 +
==Lists==
 +
*Creating a bulleted list is simple.
 +
**Creating Sub-Bullets is just as easy.
 +
***And so on and so on and so on.
 +
*Going back is easy too.
 +
 
 +
<pre><nowiki>
 +
*Creating a bulleted list is simple.
 +
**Creating Sub-Bullets is just as easy.
 +
***And so on and so on and so on.
 +
*Going back is easy too.
 +
</nowiki></pre>
 +
 
 +
#Numbered Lists are almost the same
 +
##So are sub numbers
 +
###sub sub numbers
 +
#and going back.
 +
 
 +
<pre><nowiki>
 +
#Numbered Lists are almost the same
 +
##So are sub numbers
 +
###sub sub numbers
 +
#and going back.
 +
</nowiki></pre>
 +
 
 +
*Mixing lists are possible too.
 +
*#Such as this one
 +
*#*You can also<br>have newlines<br>inside lists.
 +
 
 +
<pre><nowiki>
 +
*Mixing lists are possible too.
 +
*#Such as this one
 +
*#*You can also<br>have newlines<br>inside lists.
 +
</nowiki></pre>
 +
 
 +
==Horizontal Rules==
 +
Don't use these too often, as they break up the page. Instead, it is recommended you use section breaks (see below). If you really need them, however, this is the formatting:
 +
 
 +
<pre><nowiki>
 
----
 
----
−
|-
+
</nowiki></pre>
−
|Bullet list
+
−
|
+
−
&#42; one<br>
+
−
&#42; two<br>
+
−
&#42; three<br>
+
−
&#42;&#42; three and one-third<br>
+
−
&#42;&#42; three and two-thirds<br>
+
−
|
+
−
* one
+
−
* two
+
−
* three
+
−
** three and one-third
+
−
** three and two-thirds
+
−
|-
+
−
|Numbered list
+
−
|
+
−
&#35; one<br />
+
−
&#35; two<nowiki><br></nowiki>spanning several lines<nowiki><br></nowiki>without breaking the numbering<br />
+
−
&#35; three<br />
+
−
&#35;&#35; three point one<br />
+
−
&#35;&#35; three point two<br />
+
−
|
+
−
# one
+
−
# two<br>spanning several lines<br>without breaking the numbering
+
−
# three
+
−
## three point one
+
−
## three point two
+
−
|-
+
−
| Mixture of bulleted<br /> and numbered lists
+
−
|
+
−
&#35; one<br />
+
−
&#35; two<br />
+
−
&#35;&#42; two point one<br />
+
−
&#35;&#42; two point two<br />
+
−
|
+
−
# one
+
−
# two
+
−
#* two point one
+
−
#* two point two
+
−
|-
+
−
|Definition list
+
−
|
+
−
&#59;Definition<br />
+
−
&#58;item 1<br />
+
−
&#58;item 2<br />
+
−
|
+
−
;Definition
+
−
:item 1
+
−
:item 2
+
−
|-
+
−
|Preformatted text
+
−
|
+
−
&nbsp;&nbsp;preformatted text is done with<br />
+
−
&nbsp;&nbsp;a space at the<br />
+
−
&nbsp;&nbsp;beginning of the line<br />
+
−
|
+
−
preformatted text is done with
+
−
a space at the
+
−
beginning of the line
+
−
|}
+
  
−
Notes: <references/>
+
==Indentation==
 +
:A colon indents a line.
 +
<pre><nowiki>
 +
:A colon indents a line.
 +
</nowiki></pre>
  
−
== Paragraphs ==
+
==Alignment==
 +
A page is left-aligned by default.
 +
<center> Center Text Like This </center>
  
−
MediaWiki ignores normal line breaks. To start a new paragraph, leave an empty line. You can also start a new line with the HTML tags <tt><nowiki><br> or <br/></nowiki></tt>.
+
<pre><nowiki>
 +
<center> Center Text Like This </center>
 +
</nowiki></pre>
  
−
== HTML ==
+
==Section Breaks==
 +
Many articles on the wiki use section headers and tables of contents, like the ones above. Two equal(=) signs makes a topic.
  
−
Some [[w:HTML|HTML]] tags are allowed in MediaWiki, for example <tt><nowiki><code></nowiki></tt>, <tt><nowiki><div></nowiki></tt>, <tt><nowiki><span></nowiki></tt> and <tt><nowiki><font></nowiki></tt>.
+
<pre><nowiki>
 +
==This Is a Topic==
 +
===This Is a Subtopic===
 +
====This is a Sub Sub Topic====
 +
===This is a subtopic of the first topic, but not the other sub topics===
 +
==This is another topic==
 +
</nowiki></pre>
  
−
{{Admin tip|tip=If you trust your users you can allow full HTML by setting <code>[[Manual:$wgRawHtml|$wgRawHtml]] = true;</code> in [[Manual:LocalSettings.php|LocalSettings.php]].}}
+
To add a Table Of Contents, type:
  
 +
<pre><nowiki>
 +
__TOC__
 +
</nowiki></pre>
  
−
== Other formatting ==
+
If a Table of Contents is automatic for the article (true for certian namespaces and templates), you can use this formatting to remove one:
−
Beyond the text formatting markup shown above, here are some other formatting references:
+
−
*[[Help:Links|Links]]
+
−
*[[Help:Images|Images]]
+
−
*[[Help:Tables|Tables]]
+
−
[http://en.wikipedia.org/wiki/Wikipedia:WikiProject_User_Page_Help/Do-It-Yourself/Formatting_Text#Underlining More Formatting from Wikipedia]
+
  
−
== External Links ==
+
<pre><nowiki>
−
{{meta|Help:Editing}}
+
__NOTOC__
 +
</nowiki></pre>
  
−
{{Languages|Help:Formatting}}
+
'''Note:''' Table of contents lists only list topics that appear after they are inserted.
  
−
[[Category:Help|Formatting]]
+
[[Category:Help|{{PAGENAME}}]]

Latest revision as of 12:21, 18 February 2008

Spaces, New Lines, Paragraphs, And More[edit]

You might have already noticed that single spaces between lines do not create spaces in the text. For example:

Typing 
like 
this
would come out 
like this:

Typing like this would come out like this:

A blank space between the two lines, on the other hand, creates a new paragraph. For example:

This would look like one paragraph.

This would look like another.

This would be the third.

This would look like one paragraph.

This would look like another.

This would be the third.

For a new line, you must use the line break (br) command after the line. (Single Spaces are not necessary, but are used for clarity.)

Just do this:

Text Line 1<br>
Text Line 2<br>

Paragraph 2 Line 1

Remember: For the sake of clarity, it is best to place a line break, but not necessary.

Emphasis[edit]

Hello!

How Are You?

This is basic, but important. Use three 's for a Bold and two for italics. The above section was made like this:

'''Hello!'''

''How Are You?''

HTML encoding also works, such as Bold and Italics

<b>Bold</b> and <i>Italics</i>

Lists[edit]

  • Creating a bulleted list is simple.
    • Creating Sub-Bullets is just as easy.
      • And so on and so on and so on.
  • Going back is easy too.
*Creating a bulleted list is simple.
**Creating Sub-Bullets is just as easy.
***And so on and so on and so on.
*Going back is easy too.
  1. Numbered Lists are almost the same
    1. So are sub numbers
      1. sub sub numbers
  2. and going back.
#Numbered Lists are almost the same
##So are sub numbers
###sub sub numbers
#and going back.
  • Mixing lists are possible too.
    1. Such as this one
      • You can also
        have newlines
        inside lists.
*Mixing lists are possible too.
*#Such as this one
*#*You can also<br>have newlines<br>inside lists.

Horizontal Rules[edit]

Don't use these too often, as they break up the page. Instead, it is recommended you use section breaks (see below). If you really need them, however, this is the formatting:

----

Indentation[edit]

A colon indents a line.
:A colon indents a line.

Alignment[edit]

A page is left-aligned by default.

Center Text Like This
<center> Center Text Like This </center>

Section Breaks[edit]

Many articles on the wiki use section headers and tables of contents, like the ones above. Two equal(=) signs makes a topic.

==This Is a Topic==
===This Is a Subtopic===
====This is a Sub Sub Topic====
===This is a subtopic of the first topic, but not the other sub topics===
==This is another topic==

To add a Table Of Contents, type:

__TOC__

If a Table of Contents is automatic for the article (true for certian namespaces and templates), you can use this formatting to remove one:

__NOTOC__

Note: Table of contents lists only list topics that appear after they are inserted.

Retrieved from "https://wiki.beyondunreal.com/Help:Formatting?oldid=197"