Help:Markup: Difference between revisions
Created page with "<center><span style="font-size: 125%;">'''Table of Contents'''</span></center> {{HelpContents}} <br> <center><span style="font-size: 125%;">❮ Guidelines || Markup || References ❯</span></center> <br> Category:Help" |
No edit summary |
||
| Line 2: | Line 2: | ||
{{HelpContents}} | {{HelpContents}} | ||
To format pages on Coppermind a basic wiki markup language is used. Below you can find the most common and useful features. For more details, see Wikipedia's Help page on [https://en.m.wikipedia.org/wiki/Help:Wiki_markup Markup]. | |||
== Line Breaks == | |||
A '''line break''' creates the white space between two paragraphs. To create a line break, press Enter/Return ''twice''. A single press of Enter/Return will move the cursor to a new line in the editor, but it will not create a line break. | |||
{| width=100% class=wikitable | |||
|- | |||
| width=50%|This... | |||
|...produces: | |||
|- | |||
|<pre style="white-space:pre-wrap; width:150px"> | |||
Hello. | |||
How are you? | |||
I'm fine. | |||
</pre> | |||
|Hello. How are you? | |||
I'm fine. | |||
|} | |||
== Text Formatting == | |||
;Italics | |||
: For '''italics''' use two apostrophes (<code><nowiki>''</nowiki></code>) on either side: | |||
: <code><nowiki>''italicized text''</nowiki></code> produces ''italicized text'' | |||
;Bold | |||
: For '''bold text''' use three apostrophes (<code><nowiki>'''</nowiki></code>) on either side: | |||
: <code><nowiki>'''bold text'''</nowiki></code> produces '''bold text''' | |||
;Small Text | |||
: For '''small text''' surround the text with <code><small></code> and <code></small></code>: | |||
: <code><nowiki><small>Small Text</small></nowiki></code> produces <small>Small Text</small> | |||
== Section Headings == | |||
Create '''sections headings''' with equals signs (<code>=</code>) on both sides of the text: | |||
<pre style="white-space:pre-wrap; width:250px"> | |||
== Level 2 Heading == | |||
=== Level 3 Heading === | |||
==== Level 4 Heading ==== | |||
etc. | |||
</pre> | |||
Don't use level 1 headings; that's for the page title! | |||
Note: A '''Table of Contents''' will automatically be created after a set number of headings are used. | |||
== Indents == | |||
Use colons (<code>:</code>) to '''indent''': | |||
<code>: indent once</code> produces: | |||
: indent once | |||
<code>:: indent twice</code> produces: | |||
:: indent twice | |||
Note: Use indents when replying to someone on discussion pages. See [[:Help:Discussion]]. | |||
== Lists == | |||
=== Bulleted Lists === | |||
Create '''bulleted lists''' with asterisks (<code>*</code>): | |||
{| width=100% class=wikitable | |||
|- | |||
| width=50%|This... | |||
|...produces: | |||
|- | |||
|<pre style="white-space:pre-wrap; width:150px"> | |||
* Item 1 | |||
* Item 2 | |||
** Item 2a | |||
** Item 2b | |||
* Item 3 | |||
</pre> | |||
| | |||
* Item 1 | |||
* Item 2 | |||
** Item 2a | |||
** Item 2b | |||
* Item 3 | |||
|} | |||
=== Numbered Lists === | |||
Create '''numbered lists''' with number signs (<code>#</code>): | |||
{| width=100% class=wikitable | |||
|- | |||
| width=50%|This... | |||
|...produces: | |||
|- | |||
|<pre style="white-space:pre-wrap; width:150px"> | |||
# Item 1 | |||
# Item 2 | |||
## Item 2a | |||
## Item 2b | |||
# Item 3 | |||
</pre> | |||
| | |||
# Item 1 | |||
# Item 2 | |||
## Item 2a | |||
## Item 2b | |||
# Item 3 | |||
|} | |||
=== Mixed Lists === | |||
You can mix and match bulleted and numbered lists: | |||
{| width=100% class=wikitable | |||
|- | |||
| width=50%|This... | |||
|...produces: | |||
|- | |||
|<pre style="white-space:pre-wrap; width:150px"> | |||
# Item 1 | |||
# Item 2 | |||
#* Item 2a | |||
#* Item 2b | |||
# Item 3 | |||
</pre> | |||
| | |||
# Item 1 | |||
# Item 2 | |||
#* Item 2a | |||
#* Item 2b | |||
# Item 3 | |||
|} | |||
=== Description Lists === | |||
A '''description list''' is a list of bold terms, each followed by one or more lines of indented normal text. To create a description list, place each term on a new line and precede it with a semicolon (<code>;</code>). The following description is then preceded with a colon (<code>:</code>). Use multiple lines if desired. Do not use a semicolon simply to make something bold! | |||
{| width=100% class=wikitable | |||
|- | |||
| width=50%|This... | |||
|...produces: | |||
|- | |||
|<pre style="white-space:pre-wrap; width:150px"> | |||
;Item 1 | |||
: description 1a | |||
: description 1b | |||
;Item 2 | |||
: description 2 | |||
</pre> | |||
| | |||
;Item 1 | |||
: description 1a | |||
: description 1b | |||
;Item 2 | |||
: description 2 | |||
|} | |||
== Links & URLs == | |||
=== Internal Links === | |||
An '''internal link''', or '''wikilink''', is a direct link to another article on Coppermind. Just use double brackets (<code>[[</code> and <code>]]</code>) around the article name. Remember, ''case matters'' with article titles. | |||
;Basic Wikilink | |||
: <code><nowiki>[[Allomancy]]</nowiki></code> produces [[Allomancy]], which links to the "Allomancy" article. | |||
;Blend Link | |||
: Note that you can append to the article name if needed for grammatical purposes. | |||
: <code><nowiki>[[Herald]]s</nowiki></code> produces [[Herald]]s, which links to the "Herald" article. | |||
;Renamed Link | |||
: More extensive changes can be made with a vertical bar (<code>|</code>) followed by alternate text. | |||
: <code><nowiki>[[Gold|a valuable metal]]</nowiki></code> produces [[Gold|a valuable metal]], which links to the "Gold" article. | |||
;Link to a section on a page | |||
: Link to a specific section on a page by including a number sign (<code>#</code>) followed by the section name. | |||
: <code><nowiki>[[Iron#Allomantic Use]]</nowiki></code> produces [[Iron#Allomantic Use]], which links to the "Allomantic Use" section in the "Iron" article. | |||
;Link to pages on other namespaces | |||
: The methods above assume you're linking to simple articles (on the "main" [[:Help:Namespaces|namespace]]). If you want to link to a page on another namespace, begin with a colon (<code>:</code>), the namespace, and then another colon. | |||
: <code><nowiki>[[:Help:Contents]]</nowiki></code> produces [[:Help:Contents]], which links to the "Contents" page on the Help namespace. | |||
: <code><nowiki>[[:User:Fbstj|Joe]]</nowiki></code> produces [[:User:Fbstj|Joe]], which links to FBstj's User page. | |||
: <code><nowiki>[[:File:Roshar.jpg|Roshar Map]]</nowiki></code> produces [[:File:Roshar.jpg|Roshar Map]], which links to the "Roshar.jpg" File page. | |||
: <code><nowiki>[[:Category:Cosmere]]</nowiki></code> produces [[:Category:Cosmere]], which links to the "Cosmere" Category page. | |||
=== External Links === | |||
'''External links''' point to somewhere outside of Coppermind. | |||
;Unnamed External Link | |||
: Use single brackets (<code>[</code> and <code>]</code>) to produce an unnamed external URL. | |||
: <code><nowiki>[http://www.google.com]</nowiki></code> produces [http://www.google.com]. | |||
;Named External Link | |||
: Follow the URL with a space and some other text to rename the link. ''This is the preferred method.'' | |||
: <code><nowiki>[http://www.google.com Google]</nowiki></code> produces [http://www.google.com Google]. | |||
;Wikipedia Link | |||
: Use double bracket followed by the article name, then how you wish for the link to appear. | |||
: <code><nowiki>[[wikipedia:Google|Google]]</nowiki></code> produces [[wikipedia:Google|Google]]. | |||
;Bare External Link | |||
: Simply type the URL for a bare external link. ''This method should be avoided.'' | |||
: <code><nowiki>http://www.google.com</nowiki></code> produces http://www.google.com. | |||
== References & Citations == | |||
See [[:Help:References]] for more on how to insert references and citations into an article. | |||
== Images == | |||
See [[:Help:Images]] for more on how to insert and format images. | |||
== Templates == | |||
Templates can be used for some more complicated formatting tricks. Make sure to see [[:Help:Templates]] for more on these. | |||
== Other Tricks == | |||
;Username and timestamp | |||
: Use four tildes (<code><nowiki>~~~~</nowiki></code>) to automatically leave your username and a timestamp. Use this on article discussion pages. | |||
== Ignore Markup == | |||
;<code><nowiki></code> Tag | |||
: Surround the text with <code><nowiki></code> and <code></nowiki></code> to ignore markup. | |||
: <code><nowiki><small>''small, italic text''</small></nowiki></code> produces <small>''small, italic text''</small>. | |||
: <code><nowiki><nowiki><small>''small, italic text''</small></nowiki></nowiki></code> produces <nowiki><small>''small, italic text''</small></nowiki>. | |||
;<code><pre></code> Tag | |||
: Alternatively, use <code><pre></code> and <code></pre></code>. | |||
: It behaves the same as <code><nowiki></code>, but also allows mono-spaced font and preserves spacing. | |||
<br> | <br> | ||
Revision as of 17:36, 12 February 2025
| Contents | Introduction | Guidelines | Markup | References | Images | Categories | Templates | What's Next? |
To format pages on Coppermind a basic wiki markup language is used. Below you can find the most common and useful features. For more details, see Wikipedia's Help page on Markup.
Line Breaks
A line break creates the white space between two paragraphs. To create a line break, press Enter/Return twice. A single press of Enter/Return will move the cursor to a new line in the editor, but it will not create a line break.
| This... | ...produces: |
Hello. How are you? I'm fine. |
Hello. How are you?
I'm fine. |
Text Formatting
- Italics
- For italics use two apostrophes (
'') on either side: ''italicized text''produces italicized text
- Bold
- For bold text use three apostrophes (
''') on either side: '''bold text'''produces bold text
- Small Text
- For small text surround the text with
<small>and</small>: <small>Small Text</small>produces Small Text
Section Headings
Create sections headings with equals signs (=) on both sides of the text:
== Level 2 Heading == === Level 3 Heading === ==== Level 4 Heading ==== etc.
Don't use level 1 headings; that's for the page title!
Note: A Table of Contents will automatically be created after a set number of headings are used.
Indents
Use colons (:) to indent:
: indent once produces:
- indent once
:: indent twice produces:
- indent twice
Note: Use indents when replying to someone on discussion pages. See Help:Discussion.
Lists
Bulleted Lists
Create bulleted lists with asterisks (*):
| This... | ...produces: |
* Item 1 * Item 2 ** Item 2a ** Item 2b * Item 3 |
|
Numbered Lists
Create numbered lists with number signs (#):
| This... | ...produces: |
# Item 1 # Item 2 ## Item 2a ## Item 2b # Item 3 |
|
Mixed Lists
You can mix and match bulleted and numbered lists:
| This... | ...produces: |
# Item 1 # Item 2 #* Item 2a #* Item 2b # Item 3 |
|
Description Lists
A description list is a list of bold terms, each followed by one or more lines of indented normal text. To create a description list, place each term on a new line and precede it with a semicolon (;). The following description is then preceded with a colon (:). Use multiple lines if desired. Do not use a semicolon simply to make something bold!
| This... | ...produces: |
;Item 1 : description 1a : description 1b ;Item 2 : description 2 |
|
Links & URLs
Internal Links
An internal link, or wikilink, is a direct link to another article on Coppermind. Just use double brackets ([[ and ]]) around the article name. Remember, case matters with article titles.
- Basic Wikilink
[[Allomancy]]produces Allomancy, which links to the "Allomancy" article.
- Blend Link
- Note that you can append to the article name if needed for grammatical purposes.
[[Herald]]sproduces Heralds, which links to the "Herald" article.
- Renamed Link
- More extensive changes can be made with a vertical bar (
|) followed by alternate text. [[Gold|a valuable metal]]produces a valuable metal, which links to the "Gold" article.
- Link to a section on a page
- Link to a specific section on a page by including a number sign (
#) followed by the section name. [[Iron#Allomantic Use]]produces Iron#Allomantic Use, which links to the "Allomantic Use" section in the "Iron" article.
- Link to pages on other namespaces
- The methods above assume you're linking to simple articles (on the "main" namespace). If you want to link to a page on another namespace, begin with a colon (
:), the namespace, and then another colon. [[:Help:Contents]]produces Help:Contents, which links to the "Contents" page on the Help namespace.[[:User:Fbstj|Joe]]produces Joe, which links to FBstj's User page.[[:File:Roshar.jpg|Roshar Map]]produces Roshar Map, which links to the "Roshar.jpg" File page.[[:Category:Cosmere]]produces Category:Cosmere, which links to the "Cosmere" Category page.
External Links
External links point to somewhere outside of Coppermind.
- Unnamed External Link
- Use single brackets (
[and]) to produce an unnamed external URL. [http://www.google.com]produces [1].
- Named External Link
- Follow the URL with a space and some other text to rename the link. This is the preferred method.
[http://www.google.com Google]produces Google.
- Wikipedia Link
- Use double bracket followed by the article name, then how you wish for the link to appear.
[[wikipedia:Google|Google]]produces Google.
- Bare External Link
- Simply type the URL for a bare external link. This method should be avoided.
http://www.google.comproduces http://www.google.com.
References & Citations
See Help:References for more on how to insert references and citations into an article.
Images
See Help:Images for more on how to insert and format images.
Templates
Templates can be used for some more complicated formatting tricks. Make sure to see Help:Templates for more on these.
Other Tricks
- Username and timestamp
- Use four tildes (
~~~~) to automatically leave your username and a timestamp. Use this on article discussion pages.
Ignore Markup
<nowiki>Tag- Surround the text with
<nowiki>and</nowiki>to ignore markup. <small>''small, italic text''</small>produces small, italic text.<nowiki><small>''small, italic text''</small></nowiki>produces <small>''small, italic text''</small>.
<pre>Tag- Alternatively, use
<pre>and</pre>. - It behaves the same as
<nowiki>, but also allows mono-spaced font and preserves spacing.