Began work on markup for mediawiki enabled on this site |
m →Just show what I typed: another fix |
||
(20 intermediate revisions by 6 users not shown) | |||
Line 1: | Line 1: | ||
{{Project|Markup|image=BSG WIKI Wiki.png|shortcut=BW:CODE<br/>BW:MARK<br/>BW:MARKUP}} | |||
Having trouble learning '''Wiki markup''' code? This page shows you how! | |||
''Note: For most default resolutions, this page will expands further horizontally beyond the page's margins because of the content of this page. Do not worry, it is not a malfunction of your browser.'' | |||
== Editing basics == | == Editing basics == | ||
;Start editing | ;Start editing | ||
:To start editing a ''Battlestar Wiki'' page, click on the "'''Edit this page'''" (or just "'''edit'''") link at one of its edges. This will bring you to the '''edit page''': a page with a text box containing the editable source code from which the server produces the webpage. ''If you just want to experiment, please do so in the [[Sandbox]], not here''. | :To start editing a ''Battlestar Wiki'' page, click on the "'''Edit this page'''" (or just "'''edit'''") link at one of its edges. This will bring you to the '''edit page''': a page with a text box containing the editable source code from which the server produces the webpage. ''If you just want to experiment, please do so in the [[BW:SAND|Sandbox]], not here''. | ||
;Summarize your changes | ;Summarize your changes | ||
Line 132: | Line 135: | ||
''Headings'' organize your writing into sections. | ''Headings'' organize your writing into sections. | ||
The Wiki software can automatically generate | The Wiki software can automatically generate | ||
a | a table of contents from them. | ||
Line 142: | Line 145: | ||
<b>A smaller subsection</b> | <b>A smaller subsection</b> | ||
Do not skip levels, like from two to four equals signs. | |||
Start with two equals signs; | Start with two equals signs; do not use single equals signs. | ||
|<pre><nowiki> | |<pre><nowiki> | ||
== Section headings == | == Section headings == | ||
Line 157: | Line 160: | ||
==== A smaller subsection ==== | ==== A smaller subsection ==== | ||
Do not skip levels, like from two to four equals signs. | |||
Start with two equals signs; | Start with two equals signs; do not use single equals signs. | ||
</nowiki></pre> | </nowiki></pre> | ||
|- | |- | ||
Line 262: | Line 265: | ||
|- | |- | ||
| | | | ||
Here | Here is a link to a page named [[Raptor]]. | ||
You can even say [[raptor]]s | You can even say [[raptor]]s | ||
and the link will show up correctly. | and the link will show up correctly. | ||
|<pre><nowiki> | |<pre><nowiki> | ||
Here | Here is a link to a page named [[Raptor]]. | ||
You can even say [[raptor]]s | You can even say [[raptor]]s | ||
and the link will show up correctly. | and the link will show up correctly. | ||
Line 290: | Line 293: | ||
|- | |- | ||
| | | | ||
[[ | [[Example]] is a page that does not exist | ||
yet. You could create it by clicking on the link. | yet. You could create it by clicking on the link. | ||
|<pre><nowiki> | |<pre><nowiki> | ||
[[ | [[Example]] is a page that does not exist | ||
yet. You could create it by clicking on the link. | yet. You could create it by clicking on the link. | ||
</nowiki></pre> | </nowiki></pre> | ||
Line 324: | Line 327: | ||
|<pre><nowiki> | |<pre><nowiki> | ||
You can make a link point to a different place | You can make a link point to a different place | ||
with a | with a piped link. Put the link | ||
target first, then the pipe character "|", then | target first, then the pipe character "|", then | ||
the link text. | the link text. | ||
Line 361: | Line 364: | ||
|- | |- | ||
| | | | ||
Category links | Category links do not show up, but add the page | ||
to a category. | to a category. | ||
Add an extra colon to actually link to the category: | Add an extra colon to actually link to the category: | ||
Line 420: | Line 423: | ||
<pre> | <pre> | ||
The pre tag ignores Wiki ''markup''. | The pre tag ignores Wiki ''markup''. | ||
It also | It also does not reformat text. | ||
It still interprets special characters: → | It still interprets special characters: → | ||
</pre> | </pre> | ||
| | | | ||
<pre> | <pre> | ||
The pre tag ignores Wiki ''markup''. | The pre tag ignores Wiki ''markup''. | ||
It also | It also does not reformat text. | ||
It still interprets special characters: &rarr; | It still interprets special characters: &rarr; | ||
</pre> | |||
|- | |- | ||
|'''Leading spaces''' | |'''Leading spaces''' | ||
Line 460: | Line 462: | ||
#The list continues. | #The list continues. | ||
| | | | ||
#<nowiki>A newline | |||
#<nowiki>A newline | surrounded by nowiki tags | ||
surrounded by nowiki tags | in a list | ||
in a list | does not mark the end of the list. | ||
does not mark the end of the list. | </nowiki><pre><nowiki> | ||
</nowiki> | You can combine pre tags with nowiki tags so | ||
You can combine pre tags with nowiki tags so | preformatted examples can go inside of lists. | ||
preformatted examples can go inside of lists. | </nowiki></pre> | ||
</nowiki> | #The list continues. | ||
#The list continues. | |||
|} | |} | ||
Line 651: | Line 651: | ||
|- | |- | ||
| | | | ||
{{ | {{WikiFrakr}} | ||
|<pre><nowiki> | |<pre><nowiki> | ||
{{ | {{WikiFrakr}} | ||
</nowiki></pre> | </nowiki></pre> | ||
|- | |- | ||
| | | | ||
This template takes | This template takes a parameter, allowing the template to be modified ''without'' modifying the code for said template directly: | ||
for | |||
{{ | {{WikiFrakr|He That Puteth In Me}} | ||
Go to this page to see the | Go to this page to see the WikiFrakr template | ||
itself: {{tl| | itself: {{tl|WikiFrakr}} | ||
|<pre><nowiki> | |<pre><nowiki> | ||
{{ | This template takes a parameter, allowing the template to be modified ''without'' modifying the code for said template directly: | ||
{{WikiFrakr|He That Puteth In Me}} | |||
Go to this page to see the | Go to this page to see the WikiFrakr template | ||
itself: {{tl| | itself: {{tl|WikiFrakr}} | ||
</nowiki></pre> | </nowiki></pre> | ||
|} | |} | ||
Line 686: | Line 681: | ||
===Edit conflicts=== | ===Edit conflicts=== | ||
If someone else makes an edit while you are making yours, the result is an edit conflict. Many conflicts can be automatically resolved by the Wiki. If it can | If someone else makes an edit while you are making yours, the result is an edit conflict. Many conflicts can be automatically resolved by the Wiki. If it can not be resolved, however, you will need to resolve it yourself. The Wiki gives you two text boxes, where the top one is the other person's edit and the bottom one is your edit. Merge your edits into the top edit box, which is the only one that will be saved. | ||
===Reverting=== | ===Reverting=== | ||
Line 693: | Line 687: | ||
===Error messages=== | ===Error messages=== | ||
If you get an error message upon saving a page, you can | If you get an error message upon saving a page, you can not tell whether the actual save has failed or just the confirmation. You can go back and save again, and the second save will have no effect, or you can check "My contributions" to see whether the edit went through. | ||
===Checking spelling and editing in your favorite editor=== | ===Checking spelling and editing in your favorite editor=== | ||
You may find it more convenient to copy and paste the text first into your favorite text editor, edit and spell check it there, and then paste it back into your web browser to preview. This way, you can also keep a local backup copy of the pages you have edited. It also allows you to make changes offline. Google Toolbar offers a spell-checker for all fields, for example. | You may find it more convenient to copy and paste the text first into your favorite text editor, edit and spell check it there, and then paste it back into your web browser to preview. This way, you can also keep a local backup copy of the pages you have edited. It also allows you to make changes offline. Google Toolbar offers a spell-checker for all fields, for example. | ||
If you edit this way, it | If you edit this way, it is best to leave the editing page open after you copy from it, using the same edit box to submit your changes, so that the usual edit conflict mechanism can deal with it. If you return to the editing page later, please make sure that nobody else has edited the page in the meantime. If someone has, you will need to merge their edits into yours by using the diff feature in the page history. | ||
===Composition of the edit page=== | ===Composition of the edit page=== | ||
Line 716: | Line 710: | ||
*Category|Categories | *Category|Categories | ||
*The magic words <nowiki>__NOTOC__ and __FORCETOC__</nowiki>. | *The magic words <nowiki>__NOTOC__ and __FORCETOC__</nowiki>. | ||
==External links== | ==External links== | ||
*[http://meta.wikimedia.org/wiki/Help:Editing MediaWiki Handbook] on Meta-Wiki | *[http://meta.wikimedia.org/wiki/Help:Editing MediaWiki Handbook] on Meta-Wiki | ||
*[http://home.earthlink.net/~awinkelried/keyboard_shortcuts.html Special characters in HTML] | *[http://home.earthlink.net/~awinkelried/keyboard_shortcuts.html Special characters in HTML] |
Latest revision as of 14:07, 15 April 2008
| |||||
Having trouble learning Wiki markup code? This page shows you how!
Note: For most default resolutions, this page will expands further horizontally beyond the page's margins because of the content of this page. Do not worry, it is not a malfunction of your browser.
Editing basics[edit]
- Start editing
- To start editing a Battlestar Wiki page, click on the "Edit this page" (or just "edit") link at one of its edges. This will bring you to the edit page: a page with a text box containing the editable source code from which the server produces the webpage. If you just want to experiment, please do so in the Sandbox, not here.
- Summarize your changes
- You should write a short edit summary in the small field below the edit-box. You may use shorthand to describe your changes.
- Preview before saving
- When you have finished, press preview to see how your changes will look -- before you make them permanent. Repeat the edit/preview process until you are satisfied, then click "Save" and your changes will be immediately applied to the article.
Minor edits[edit]
A logged-in user can mark an edit as "minor". Minor edits are generally spelling corrections, formatting, and minor rearrangement of text. Users may choose to hide minor edits when viewing Recent Changes.
Marking a significant change as a minor edit is considered bad Wikiquette. If you have accidentally marked an edit as minor, make a dummy edit, verify that the "[ ] This is a minor edit" check-box is unchecked, and explain in the edit summary that the previous edit was not minor.
Wikitext markup -- making the page look the way you want[edit]
Basic text formatting[edit]
What it looks like | What you type |
---|---|
You can emphasize text by putting two apostrophes on each side. Three apostrophes will emphasize it strongly. Five apostrophes is even stronger. |
You can ''emphasize text'' by putting two apostrophes on each side. Three apostrophes will emphasize it '''strongly'''. Five apostrophes is '''''even stronger'''''. |
A single newline has no effect on the layout. But an empty line starts a new paragraph. |
A single newline has no effect on the layout. But an empty line starts a new paragraph. |
You can break lines |
You can break lines<br> without starting a new paragraph.<br> Please use this sparingly. |
You should "sign" your comments on talk pages: |
You should "sign" your comments on talk pages: : Three tildes gives your user name: ~~~ : Four tildes give your user name plus date/time: ~~~~ : Five tildes gives the date/time alone: ~~~~~ |
You can use HTML tags, too, if you want. Some useful ways to use HTML: Put text in a typewriter font.
The same font is generally used for
Superscripts and subscripts: X2, X2 Invisible comments that only appear while editing the page. Comments should usually go on the talk page, though. |
You can use <b>HTML tags</b>, too, if you want. Some useful ways to use HTML: Put text in a <tt>typewriter font</tt>. The same font is generally used for <code>computer code</code>. <strike>Strike out</strike> or <u>underline</u> text, or write it <span style="font-variant:small-caps"> in small caps</span>. Superscripts and subscripts: X<sup>2</sup>, X<sub>2</sub> Invisible comments that only appear while editing the page. <!-- Note to editors: blah blah blah. --> Comments should usually go on the talk page, though. |
For a list of HTML tags that are allowed, see HTML in wikitext. However, you should avoid HTML in favor of Wiki markup whenever possible.
Organizing your writing[edit]
What it looks like | What you type |
---|---|
Section headings Headings organize your writing into sections. The Wiki software can automatically generate a table of contents from them.
Using more equals signs creates a subsection.
Do not skip levels, like from two to four equals signs. Start with two equals signs; do not use single equals signs. |
== Section headings == ''Headings'' organize your writing into sections. The Wiki software can automatically generate a table of contents from them. === Subsection === Using more equals signs creates a subsection. ==== A smaller subsection ==== Do not skip levels, like from two to four equals signs. Start with two equals signs; do not use single equals signs. |
marks the end of the list.
|
* ''Unordered lists'' are easy to do: ** Start every line with a star. *** More stars indicate a deeper level. * A newline * in a list marks the end of the list. * Of course you can start again. |
A newline marks the end of the list.
|
# ''Numbered lists'' are also good: ## Very organized ## Easy to follow A newline marks the end of the list. # New numbering starts with 1. |
Another kind of list is a definition list:
|
Another kind of list is a ''definition list'': ; word : definition of the word ; here is a longer phrase that needs a definition : phrase defined ; a word : with a definition : that requires : multiple paragraphs |
|
* You can even do mixed lists *# and nest them *# inside each other *#* or break lines<br>in lists. *#; definition lists *#: can be *#;; nested too |
A newline after that starts a new paragraph.
|
: A colon indents a line or paragraph. A newline after that starts a new paragraph. :: This is often used for discussion on talk pages. |
You can make horizontal dividing lines to separate text. But you should usually use sections instead, so that they go in the table of contents. |
You can make horizontal dividing lines to separate text. ---- But you should usually use sections instead, so that they go in the table of contents. |
Links[edit]
You will often want to make clickable links to other pages.
What it looks like | What you type |
---|---|
Here is a link to a page named Raptor. You can even say raptors and the link will show up correctly. |
Here is a link to a page named [[Raptor]]. You can even say [[raptor]]s and the link will show up correctly. |
You can put formatting around a link. Example: Galactica. |
You can put formatting around a link. Example: ''[[Galactica]]''. |
The first letter of articles is automatically capitalized, so miniseries goes to the same place as Miniseries. Capitalization matters after the first letter. |
The ''first letter'' of articles is automatically capitalized, so [[miniseries]] goes to the same place as [[Miniseries]]. Capitalization matters after the first letter. |
Example is a page that does not exist yet. You could create it by clicking on the link. |
[[Example]] is a page that does not exist yet. You could create it by clicking on the link. |
You can link to a page section by its title: If multiple sections have the same title, add a number. |
You can link to a page section by its title: *[[Season 2 (2005-06)#Episodes]]. If multiple sections have the same title, add a number. |
You can make a link point to a different place with a piped link. Put the link target first, then the pipe character "|", then the link text. |
You can make a link point to a different place with a piped link. Put the link target first, then the pipe character "|", then the link text. *[[Kara Thrace|Starbuck]] *[[Season 2 (2005-06)#Cast| Season 2 cast]] |
You can make an external link just by typing a URL: http://www.wikipedia.com You can give it a title: Wikipedia Or leave the title blank: [1] |
You can make an external link just by typing a URL: http://www.wikipedia.com You can give it a title: [http://www.wikipedia.com Wikipedia] Or leave the title blank: [http://www.wikipedia.com] |
You can redirect the user to another page. |
#REDIRECT [[Kara Thrace]] |
Category links do not show up, but add the page to a category. Add an extra colon to actually link to the category: Category:People from Caprica |
Category links don't show up, but add the page to a category. [[Category:People from Caprica]] Add an extra colon to actually link to the category: [[:Category:People from Caprica]] |
The Wiki reformats linked dates to match the reader's date preferences. These three dates will show up the same if you choose a format in your Preferences: |
The Wiki reformats linked dates to match the reader's date preferences. These three dates will show up the same if you choose a format in your [[Special:Preferences|]]: * [[July 20]], [[1969]] * [[20 July]] [[1969]] * [[1969]]-[[07-20]] |
Just show what I typed[edit]
A few different kinds of formatting will tell the Wiki to display things as you typed them.
What it looks like | What you type | |
---|---|---|
<nowiki> tags |
The nowiki tag ignores Wiki ''markup''. It reformats text by removing newlines and multiple spaces. It still interprets special characters: → |
<nowiki> The nowiki tag ignores Wiki ''markup''. It reformats text by removing newlines and multiple spaces. It still interprets special characters: → </nowiki> |
<pre> tags |
The pre tag ignores Wiki ''markup''. It also does not reformat text. It still interprets special characters: → |
The pre tag ignores Wiki ''markup''. It also does not reformat text. It still interprets special characters: → |
Leading spaces |
Leading spaces are another way to preserve formatting. Putting a space at the beginning of each line stops the text from being reformatted. It still interprets Wiki markup and special characters: → |
Leading spaces are another way to preserve formatting. Putting a space at the beginning of each line stops the text from being reformatted. It still interprets Wiki ''markup'' and special characters: → |
What to do inside of lists |
You can combine pre tags with nowiki tags so preformatted examples can go inside of lists.
|
#<nowiki>A newline surrounded by nowiki tags in a list does not mark the end of the list. </nowiki><pre><nowiki> You can combine pre tags with nowiki tags so preformatted examples can go inside of lists. </nowiki></pre> #The list continues. |
Images, tables, video, and sounds[edit]
This is a very quick introduction.
What it looks like | What you type | ||||
---|---|---|---|---|---|
A picture, including alternate text: You can put the image in a frame with a caption: |
A picture, including alternate text: [[Image:BSG-WIKI_SM.png|The mini logo for this Wiki]] You can put the image in a frame with a caption: [[Image:BSG-WIKI_SM.png|frame|The mini logo for this Wiki]] | ||||
A link to the page for the image: Image:BSG-WIKI_SM.png Or a link directly to the image itself: Media:BSG-WIKI_SM.png |
A link to the page for the image: [[:Image:BSG-WIKI_SM.png]] Or a link directly to the image itself: [[Media:BSG-WIKI_SM.png]] | ||||
Use media: links to link directly to sounds or videos: A sound file |
Use '''media:''' links to link directly to sounds or videos: [[media:Sg_mrob.ogg|A sound file]] | ||||
|
{| border="1" cellspacing="0" cellpadding="5" align="center" ! This ! is |- | a | table |} |
Special characters[edit]
Now that Mediawiki supports UTF-8, many of these can be entered directly into articles, without the HTML markup. On many wikis, a tool appears under the edit box to make this easier. See Special characters.
Umlauts and accents: |
À Á Â Ã Ä Å |
Punctuation: |
¿ ¡ « » § ¶ |
Commercial symbols: |
™ © ® ¢ € ¥ £ ¤ |
Greek characters: α β γ δ ε ζ |
α β γ δ ε ζ |
Math characters: (TeX is often better) |
∫ ∑ ∏ √ − ± ∞ |
Problem symbols: |
ℵ ∉ |
Templates[edit]
Templates are segments of Wiki markup that are meant to be copied automatically ("transcluded") into a page. You add them by putting the template's name in {{double braces}}.
Some templates take parameters, as well, which you separate with the pipe character.
What it looks like | What you type |
---|---|
{{WikiFrakr}} | |
This template takes a parameter, allowing the template to be modified without modifying the code for said template directly:
Go to this page to see the WikiFrakr template itself: {{WikiFrakr}} |
This template takes a parameter, allowing the template to be modified ''without'' modifying the code for said template directly: {{WikiFrakr|He That Puteth In Me}} Go to this page to see the WikiFrakr template itself: {{tl|WikiFrakr}} |
Tips and tricks[edit]
Page protection[edit]
In a few cases, where an administrator has protected a page, the link labeled "MediaWiki:Editthispage" is replaced by the text "View source" (or equivalents in the language of the project). In that case the page cannot be edited. Protection of an image page includes protection of the image itself.
Edit conflicts[edit]
If someone else makes an edit while you are making yours, the result is an edit conflict. Many conflicts can be automatically resolved by the Wiki. If it can not be resolved, however, you will need to resolve it yourself. The Wiki gives you two text boxes, where the top one is the other person's edit and the bottom one is your edit. Merge your edits into the top edit box, which is the only one that will be saved.
Reverting[edit]
The edit link of a page showing an old version leads to an edit page with the old wikitext. This is a useful way to restore the old version of a page. However, the edit link of a diff page gives the current wikitext, even if the diff page shows an old version below the table of differences.
Error messages[edit]
If you get an error message upon saving a page, you can not tell whether the actual save has failed or just the confirmation. You can go back and save again, and the second save will have no effect, or you can check "My contributions" to see whether the edit went through.
Checking spelling and editing in your favorite editor[edit]
You may find it more convenient to copy and paste the text first into your favorite text editor, edit and spell check it there, and then paste it back into your web browser to preview. This way, you can also keep a local backup copy of the pages you have edited. It also allows you to make changes offline. Google Toolbar offers a spell-checker for all fields, for example.
If you edit this way, it is best to leave the editing page open after you copy from it, using the same edit box to submit your changes, so that the usual edit conflict mechanism can deal with it. If you return to the editing page later, please make sure that nobody else has edited the page in the meantime. If someone has, you will need to merge their edits into yours by using the diff feature in the page history.
Composition of the edit page[edit]
The editing page consists of these sections:
- The edit toolbar (optional)
- The editing text box
- The edit summary box
- Save/Preview/Cancel links
- A list of templates used on the page
- A preview, if you have requested one. Your preferences may place the preview at the top of the page instead.
Position-independent wikitext[edit]
No matter where you put these things in the wikitext, the resulting page is displayed the same way:
- Interlanguage links
- Category|Categories
- The magic words __NOTOC__ and __FORCETOC__.
External links[edit]
- MediaWiki Handbook on Meta-Wiki
- Special characters in HTML