Difference between revisions of "Wiki editing guide"
m |
m |
||
Line 30: | Line 30: | ||
3 apostrophes will '''bold''' the text. | 3 apostrophes will '''bold''' the text. | ||
− | |||
5 apostrophes will '''''bold and italicize''''' | 5 apostrophes will '''''bold and italicize''''' | ||
Line 89: | Line 88: | ||
You can break lines<br/> | You can break lines<br/> | ||
without a new paragraph.<br/> | without a new paragraph.<br/> | ||
+ | Using <nowiki><br/></nowiki>.<br/> | ||
Please use this sparingly. | Please use this sparingly. | ||
Line 95: | Line 95: | ||
You can break lines<br/> | You can break lines<br/> | ||
without a new paragraph.<br/> | without a new paragraph.<br/> | ||
+ | Using <nowiki><br/></nowiki>.<br/> | ||
Please use this sparingly. | Please use this sparingly. | ||
Line 101: | Line 102: | ||
and end on the next. | and end on the next. | ||
</pre> | </pre> | ||
+ | |} | ||
+ | |||
+ | |||
+ | == Organizing your writing == | ||
+ | {| border="1" cellpadding="2" cellspacing="0" | ||
+ | !width="1000"|What it looks like | ||
+ | !width="500"|What you type | ||
|- | |- | ||
+ | | | ||
− | + | ''Headings'' organize your writing into | |
− | + | sections. The ''Wiki'' software can automatically | |
− | + | generate a [[help:Section|table of contents]] from them. | |
− | + | ||
+ | <!-- don't use standard since it will move the edit block --> | ||
+ | |||
+ | <h3>Subsection</h3> | ||
+ | Using more "equals" (=) signs creates a subsection. | ||
+ | |||
+ | <h4>A smaller subsection</h4> | ||
+ | |||
+ | Don't skip levels, like from two to four equals signs. | ||
+ | |||
+ | Start with 2 equals signs, not 1. If you use only 1 on each side, it will be the equivalent of h1 | ||
+ | tags, which should be reserved for page titles. | ||
|<pre> | |<pre> | ||
− | + | == Section headings == | |
− | + | ||
− | + | ''Headings'' organize your writing into | |
− | + | sections. The ''Wiki'' software can automatically | |
− | + | generate a [[help:Section|table of contents]] from them. | |
− | + | ||
− | + | === Subsection === | |
− | + | Using more "equals" (=) signs creates a subsection. | |
+ | |||
+ | ==== A smaller subsection ==== | ||
+ | |||
+ | Don't skip levels, like from two to four equals signs. | ||
+ | |||
+ | Start with 2 equals signs, not 1. If you use only 1 on each side, it will be the equivalent of h1 tags, which should be reserved for page titles. | ||
</pre> | </pre> | ||
+ | |- id="lists" | ||
+ | | | ||
+ | * ''Unordered [[Help:List|list]]s'' are easy to do: | ||
+ | ** Start every line with a asterisk. | ||
+ | *** More asterisks indicate a deeper level. | ||
+ | *: Previous item continues. | ||
+ | ** A newline | ||
+ | * in a list | ||
+ | marks the end of the list. | ||
+ | *Of course you can start again. | ||
+ | |<pre> | ||
+ | * ''Unordered lists'' are easy to do: | ||
+ | ** Start every line with a asterisk. | ||
+ | *** More asterisks indicate a deeper level. | ||
+ | *: Previous item continues. | ||
+ | ** A newline | ||
+ | * in a list | ||
+ | marks the end of the list. | ||
+ | *Of course you can start again. | ||
+ | </pre> | ||
+ | |- | ||
+ | | | ||
+ | # ''Numbered lists'' are: | ||
+ | ## Very organized | ||
+ | ## Easy to follow | ||
+ | A newline marks the end of the list. | ||
+ | # New numbering starts with 1. | ||
+ | |||
+ | |<pre> | ||
+ | # ''Numbered lists'' are: | ||
+ | ## Very organized | ||
+ | ## Easy to follow | ||
+ | A newline marks the end of the list. | ||
+ | # New numbering starts with 1. | ||
+ | </pre> | ||
+ | |- | ||
+ | | | ||
+ | Here's a ''definition list'': | ||
+ | ; Word : Definition of the word | ||
+ | ; A longer phrase needing definition | ||
+ | : Phrase defined | ||
+ | ; A word : Which has a definition | ||
+ | : Also a second definition | ||
+ | : And even a third | ||
+ | |||
+ | Begin with a semicolon. One item per line; | ||
+ | a newline can appear before the colon, but | ||
+ | using a space before the colon improves | ||
+ | parsing. | ||
+ | |<pre> | ||
+ | Here's a ''definition list'': | ||
+ | ; Word : Definition of the word | ||
+ | ; A longer phrase needing definition | ||
+ | : Phrase defined | ||
+ | ; A word : Which has a definition | ||
+ | : Also a second definition | ||
+ | : And even a third | ||
+ | |||
+ | Begin with a semicolon. One item per line; | ||
+ | a newline can appear before the colon, but | ||
+ | using a space before the colon improves | ||
+ | parsing. | ||
+ | </pre> | ||
+ | |- | ||
+ | | | ||
+ | * You can even do mixed lists | ||
+ | *# and nest them | ||
+ | *# inside each other | ||
+ | *#* or break lines<br>in lists. | ||
+ | *#; definition lists | ||
+ | *#: can be | ||
+ | *#:; nested : too | ||
+ | |<pre> | ||
+ | * You can even do mixed lists | ||
+ | *# and nest them | ||
+ | *# inside each other | ||
+ | *#* or break lines<br>in lists. | ||
+ | *#; definition lists | ||
+ | *#: can be | ||
+ | *#:; nested : too | ||
+ | </pre> | ||
+ | |- | ||
+ | | | ||
+ | : A colon (:) indents a line or paragraph. | ||
+ | A newline starts a new paragraph. <br> | ||
+ | Should only be used on [[help:Talk page|talk pages]]. <br> | ||
+ | For articles, you probably want the blockquote tag. | ||
+ | : We use 1 colon to indent once. | ||
+ | :: We use 2 colons to indent twice. | ||
+ | ::: 3 colons to indent 3 times, and so on. | ||
+ | |<pre> | ||
+ | : A colon (:) indents a line or paragraph. | ||
+ | A newline starts a new paragraph. | ||
+ | Should only be used on talk pages. | ||
+ | For articles, you probably want the blockquote tag. | ||
+ | : We use 1 colon to indent once. | ||
+ | :: We use 2 colons to indent twice. | ||
+ | ::: 3 colons to indent 3 times, and so on. | ||
+ | </pre> | ||
+ | |- | ||
+ | | | ||
+ | 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. | ||
+ | |<pre> | ||
+ | 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. | ||
+ | </pre> | ||
+ | |- | ||
+ | | | ||
+ | You can add footnotes to sentences using the ''ref'' tag -- this is especially good for citing a source. | ||
+ | |||
+ | :There are over six billion people in the world.<ref>CIA World Factbook, 2006.</ref> | ||
+ | |||
+ | References: <references/> | ||
+ | |||
+ | For details, see [[Wikipedia:Footnotes]]. | ||
+ | | | ||
+ | <pre> | ||
+ | You can add footnotes to sentences using | ||
+ | the ''ref'' tag -- this is especially good | ||
+ | for citing a source. | ||
+ | |||
+ | :There are over six billion people in the | ||
+ | world.<ref>CIA World Factbook, 2006.</ref> | ||
+ | |||
+ | References: <references/> | ||
+ | |||
+ | For details, see [[Wikipedia:Footnotes]].</pre> | ||
|} | |} |
Revision as of 22:48, 4 February 2020
Documentation |
HOW TOs for shift crew |
Expert Tools |
Contents
Wiki editing guide
Some notes, largely borrowed from Wikipedia
Basic text formatting
You can format the page using Wikitext special characters.
What it looks like | What you type |
---|---|
You can italicize text by putting 2 apostrophes on each side. 3 apostrophes will bold the text. 5 apostrophes will bold and italicize the text. (Using 4 apostrophes doesn't do anything
special -- |
You can ''italicize'' text by putting 2 apostrophes on ''each'' side. 3 apostrophes will '''bold''' the text. 5 apostrophes will '''''bold and italicize''''' the text. (Using 4 apostrophes doesn't do anything special -- <br /> 3 of them '''bold''' the text as usual; the others are ''''just'''' apostrophes around the text.) |
A single newline generally has no effect on the layout. These can be used to separate sentences within a paragraph. Some editors find that this aids editing and improves the diff function (used internally to compare different versions of a page). But an empty line starts a new paragraph. When used in a list, a newline does affect the layout (see below). |
A single newline generally has no effect on the layout. These can be used to separate sentences within a paragraph. Some editors find that this aids editing and improves the ''diff'' function (used internally to compare different versions of a page). But an empty line starts a new paragraph. When used in a list, a newline ''does'' affect the layout ([[#lists|see below]]). |
You can break lines Please do not start a link or italics or bold text on one line and end on the next. |
You can break lines<br/> without a new paragraph.<br/> Using <br/>.<br/> Please use this sparingly. Please do not start a link or ''italics'' or '''bold''' text on one line and end on the next. |
Organizing your writing
What it looks like | What you type |
---|---|
Headings organize your writing into sections. The Wiki software can automatically generate a table of contents from them.
SubsectionUsing more "equals" (=) signs creates a subsection. A smaller subsectionDon't skip levels, like from two to four equals signs. Start with 2 equals signs, not 1. If you use only 1 on each side, it will be the equivalent of h1 tags, which should be reserved for page titles. |
== Section headings == ''Headings'' organize your writing into sections. The ''Wiki'' software can automatically generate a [[help:Section|table of contents]] from them. === Subsection === Using more "equals" (=) signs creates a subsection. ==== A smaller subsection ==== Don't skip levels, like from two to four equals signs. Start with 2 equals signs, not 1. If you use only 1 on each side, it will be the equivalent of h1 tags, which should be reserved for page titles. |
marks the end of the list.
|
* ''Unordered lists'' are easy to do: ** Start every line with a asterisk. *** More asterisks indicate a deeper level. *: Previous item continues. ** 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: ## Very organized ## Easy to follow A newline marks the end of the list. # New numbering starts with 1. |
Here's a definition list:
Begin with a semicolon. One item per line; a newline can appear before the colon, but using a space before the colon improves parsing. |
Here's a ''definition list'': ; Word : Definition of the word ; A longer phrase needing definition : Phrase defined ; A word : Which has a definition : Also a second definition : And even a third Begin with a semicolon. One item per line; a newline can appear before the colon, but using a space before the colon improves parsing. |
|
* 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 starts a new paragraph.
|
: A colon (:) indents a line or paragraph. A newline starts a new paragraph. Should only be used on talk pages. For articles, you probably want the blockquote tag. : We use 1 colon to indent once. :: We use 2 colons to indent twice. ::: 3 colons to indent 3 times, and so on. |
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. |
You can add footnotes to sentences using the ref tag -- this is especially good for citing a source.
References: <references/> For details, see Wikipedia:Footnotes. |
You can add footnotes to sentences using the ''ref'' tag -- this is especially good for citing a source. :There are over six billion people in the world.<ref>CIA World Factbook, 2006.</ref> References: <references/> For details, see [[Wikipedia:Footnotes]]. |