Help:Editing |
- Adapted from Wikipedia, the free encyclopedia.
Contents |
General
To edit an Eatoni page, click on the "edit" link at the right side of an editable page section, the "Post Comment" link on top of Comment pages, or the "Edit page" link next to the title of the page (if you are a sysop). This will bring you to a page with a text box containing the wikitext: the editable source code from which the server produces the webpage. For the special codes, see below.
After adding to or changing the wikitext it is useful to press "Preview", which produces the corresponding webpage in your browser but does not make it publicly available yet (not until you press "Save"). Errors in formatting, links, tables, etc., are often much easier to discover from the rendered page than from the raw wikitext.
If you are not satisfied you can make more changes and preview the page as many times as necessary. Then write a short edit summary in the small text field below the edit-box and when finished press "Save". Depending on your system, pressing the "Enter" key while the edit box is not active (i.e., there is no typing cursor in it) may have the same effect as pressing "Save".
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, but before you submit your changes, please make sure nobody else has edited the page since you saved your local copy (by checking the page history), otherwise you may accidentally revert someone else's edits. If someone has edited it since you copied the page, you'll have to merge their edits into your new version (you can find their specific edits by using the "diff" feature of the page history). These issues are handled automatically by the Mediawiki software if you edit the page online, retrieving and submitting the wikicode in the same text box.
Minor edit
When editing a page, a logged-in user has the option of flagging the edit as a "minor edit". When to use this is somewhat a matter of personal preference. The rule of thumb is that an edit of a page that is spelling corrections, formatting, and minor rearranging of text should be flagged as a "minor edit". A major edit is basically something that makes the entry worth relooking at for somebody who wants to watch the article rather closely, so any "real" change, even if it is a single word. This feature is important, because users can choose to hide minor edits in their view of the Recent Changes page, to keep the volume of edits down to a manageable level.
The reason for not allowing a user who is not logged in to mark an edit as minor is that vandalism could then be marked as a minor edit, in which case it would stay unnoticed longer. This limitation is another reason to log in.
Dummy edit
A dummy edit is a change in wikitext that has unnoticeable or no effect on the rendered page, but saves a useful dummy edit summary. The dummy edit summary can be used for text messaging, and correcting a previous edit summary such as an accidental marking of a previous edit as "minor" (see Minor edit). Text messaging via the edit summary is a way of communicating with other editors. Text messages may be seen by dotted IP number editors who don't have a user talk page, or editors who haven't read the subject's talk page, if it exists. Each edit summary can hold 202 text characters. A dummy edit should be checkboxed "minor" by logged-in editors.
- Examples:
- Changing the number of newlines in the edit text. Changing from 0 to 1 or from 2 to 3 (or vice versa) has no effect on the rendered page. Changing from 1 to 2 newlines makes a rendered difference that might not be a dummy edit. Adding newline(s) to the end of the article will not save as a dummy edit (see Null edit).
- Dot dummy edit. Adding a newline followed by "." (dot/period/full stop character) to the end of the article. The dot can be entered and removed repeatedly by two editors, to save each additional dummy edit summary during a text message dialog. This method is easier to learn and faster than seeking out suitable newlines to change, but it isn't applicable to section edits. In most articles a concluding dot is unnoticeable and harmless, but it should be removed if convenient during the next text edit.
Null edit
A null edit occurs if a page save is made when the wikitext has not changed, which is useful for refreshing the cache. A null edit will not record an edit, or make any entry in the page history, Recent Changes, user contributions, etc., and the edit summary is discarded.
- Examples:
- Opening the edit window and saving. A section edit save is sufficient.
- Adding newline(s) only to the end of the article and saving.
The wiki markup
In the left column of the table below, you can see what effects are possible. In the right column, you can see how those effects were achieved. In other words, to make text look like it looks in the left column, type it in the format you see in the right column.
Sections, paragraphs, lists and lines
What it looks like | What you type |
---|---|
Start your sections with header lines:
New section Subsection Sub-subsection |
== New section == === Subsection === ==== Sub-subsection ==== |
Newline: A single newline has no effect on the layout. But an empty line starts a new paragraph. (<p> disables this paragraphing until </p> or the end of the section) (in Cologne Blue two newlines and a div tag give just one newline; in the order newline, div tag, newline, the result is two newlines) |
A single newline has no effect on the layout. But an empty line starts a new paragraph. |
You can break lines without starting a new paragraph. Sufficient as wikitext code is <br>, the XHTML code <br /> is not needed, the system produces this code. |
You can break lines<br> without starting a new paragraph. |
marks the end of the list.
|
* Lists are easy to do: ** start every line with a star *** more stars means deeper levels *A newline *in a list marks the end of the list. *Of course *you can *start again. |
marks the end of the list.
|
# Numbered lists are also good ## very organized ## easy to follow #A newline #in a list marks the end of the list. #New numbering starts #with 1. |
|
* You can even do mixed lists *# and nest them *#* like this<br>or have newlines<br>inside lists |
|
* You can also **break lines<br>inside lists<br>like this |
|
; Definition list : list of definitions ; item : the item's definition |
A manual newline starts a new paragraph.
|
: A colon indents a line or paragraph. A manual newline starts a new paragraph. |
IF a line of plain text starts with a space THEN it will be formatted exactly as typed; in a fixed-width font; lines won't wrap; ENDIF this is useful for: * pasting preformatted text; * algorithm descriptions; * program source code * ASCII art; * chemical structures; WARNING If you make it wide,
you force the whole page to be wide and
hence less readable. Never start ordinary lines with spaces. (see also below)
|
IF a line of plain text starts with a space THEN it will be formatted exactly as typed; in a fixed-width font; lines won't wrap; ENDIF this is useful for: * pasting preformatted text; * algorithm descriptions; * program source code * ASCII art; * chemical structures; |
Centered text.
|
<center>Centered text.</center> |
A horizontal dividing line: above
and below. |
A horizontal dividing line: above ---- and below. |
Summarizing the effect of a single newline: no effect in general, but it ends a list item or indented part; thus changing some text into a list item, or indenting it, is more cumbersome if it contains newlines, they have to be removed.
Links, URLs
What it looks like | What you type |
---|---|
Eatoni has great products.
Thus the link above is to http://wiki.eatoni.com/wiki/index.php/Products, which is the page with the name "Products". |
Eatoni has great [[products]]. |
Link to a section on a page, e.g. Eatoni:FAQ#What_is_CEHLNSTY.3F; when section editing does not work the link is treated as link to the page, i.e. to the top; this applies for:
|
[[Eatoni:FAQ#What_is_CEHLNSTY.3F]]. |
Link target and link label are different: forum.
(This is called a piped link). |
Link target and link label are different: [[Community|forum]] |
Endings are blended into the link: Eatoni:FAQs |
Endings are blended into the link: [[FAQ]]s |
The weather in London is a page that doesn't exist yet.
|
[[The weather in London]] is a page that doesn't exist yet. |
Redirect one article title to another by putting text like this in its first line. |
#REDIRECT [[About Us]] |
"What links here" and "Related changes" can be linked as: Special:Whatlinkshere/Wikipedia:How to edit a page and Special:Recentchangeslinked/Wikipedia:How to edit a page |
[[Special:Whatlinkshere/ Wikipedia:How to edit a page]] and [[Special:Recentchangeslinked/ Wikipedia:How to edit a page]] |
External links: Wikipedia, [1] | External links: [http://www.wikipedia.com Wikipedia], [http://www.wikipedia.com] |
Or just give the URL: http://www.wikipedia.com.
|
Or just give the URL: http://www.nupedia.com. |
To include links to non-image uploads such as sounds, use a "media" link.
|
[[media:Test.mp3|Sound]] |
Use links for dates, so everyone can set their own display order. Use Special:Preferences to change your own date display setting. | [[July 20]], [[1969]] , [[20 July]] [[1969]] and [[1969]]-[[07-20]]will all appear as 20 July 1969 if you set your date display preference to 1 January 2001. |
Images
What it looks like | What you type |
---|---|
A picture:
|
A picture: [[Image:Logo.gif]] or, with alternate text (strongly encouraged) [[Image:Logo.gif|Eatoni Logo]] Web browsers render alternate text when not displaying an image -- for example, when the image isn't loaded, or in a text-only browser, or when spoken aloud. See Alternate text for images for help on choosing alternate text. See Extended image syntax for more options. |
To include links to images shown as links instead of drawn on the page, use a "media" link.
|
[[media:Logo.jpg|Eatoni Logo]] |
Character formatting
What it looks like | What you type |
---|---|
Emphasize, strongly, very strongly.
|
''Emphasize'', '''strongly''', '''''very strongly'''''. |
You can also write italic and bold if the desired effect
|
You can also write <i>italic</i> and <b>bold</b> if the desired effect<br/> is a specific font style rather than emphasis, as in mathematical formulae: :<b>F</b> = <i>m</i><b>a</b> |
A teletype (typewriter) font. |
A teletype (<tt>typewriter</tt>) font. |
You can use small text for captions. |
You can use <small>small text</small> for captions. |
You can |
You can <strike>strike out deleted material</strike> and <u>underline new material</u>. |
Umlauts and accents:
|
è é ê ë ì í À Á Â Ã Ä Å<br/> Æ Ç È É Ê Ë<br/> Ì Í Î Ï Ñ Ò<br/> Ó Ô Õ Ö Ø Ù<br/> Ú Û Ü ß à á<br/> â ã ä å æ ç<br/> è é ê ë ì í<br/> î ï ñ ò ó ô<br/> œ õ ö ø ù ú<br/> û ü ÿ |
Punctuation: |
¿ ¡ « » § ¶ † ‡ • — |
Commercial symbols: |
™ © ® ¢ € ¥ £ ¤ |
Subscript: x2
ε0 = 8.85 × 10−12 C² / J m.
|
Subscript: x<sub>2</sub><br/> Superscript: x<sup>2</sup> or x² or in projects with the templates sub and sup: Subscript: x{{sub|2}}<br/> Superscript: x{{sup|2}} ε<sub>0</sub> = 8.85 × 10<sup>−12</sup> C² / J m. |
Greek characters: |
α β γ δ ε ζ<br/> η θ ι κ λ μ ν<br/> ξ ο π ρ σ ς<br/> τ υ φ χ ψ ω<br/> Γ Δ Θ Λ Ξ Π<br/> Σ Φ Ψ Ω |
Math characters: |
∫ ∑ ∏ √ − ± ∞<br/> ≈ ∝ ≡ ≠ ≤ ≥ ←<br/> × · ÷ ∂ ′ ″<br/> ∇ ‰ ° ∴ ℵ ø<br/> ∈ ∉ ∩ ∪ ⊂ ⊃ ⊆ ⊇<br/> ¬ ∧ ∨ ∃ ∀ ⇒ ⇔<br/> → ↔ |
x2 ≥ 0 true.
|
<i>x</i><sup>2</sup> ≥ 0 true. |
Complicated formulae: |
<math>\sum_{n=0}^\infty \frac{x^n}{n!}</math> |
For comparison for the following examples: italics |
arrow → ''italics'' |
Use <nowiki> to suppress interpretation of wiki markup, but interpret character references and remove newlines and multiple spaces: |
<nowiki>arrow → ''italics'' </nowiki> |
Use <pre> to suppress interpretation of wiki markup and keep newlines and multiple spaces, and get typewriter font, but interpret character references: arrow → ''italics'' |
<pre>arrow → ''italics'' </pre> |
Use leading space on each line to keep newlines and multiple spaces, and get typewriter font: arrow → italics |
arrow → ''italics'' |
Use typewriter font: |
<tt>arrow →</tt> <tt>''italics''</tt> <tt></tt> |
Show character references by writing out the leading ampersand: |
&rarr; |
Commenting page source:
|
<!-- comment here --> |
HTML Tables
HTML tables can be quite useful as well. For details on how to use them and discussion about when they are appropriate.
Disable Wrap-Around
Float objects (layers tables etc.) have text wrapped around them by default. You can limit this by inserting:
<br style="clear:both" />
at the point you wish after the object.
Table Of Contents
MediaWiki automatically adds a TOC if there are at least 4 sections in the page. To disable it, include __NOTOC__. The opposite (if you don't have 4 sections) is done with __FORCETOC__. We have two templates for floating TOC. For those use {{TOCleft}} and {{TOCright}}.
Eatoni site specific editing
Image Link
The Eatoni MediaWiki system provides a way of creating images that link somewhere other than the image page.
Use the <imagelink> image.jpg | link | description | width | height | imagemapname | imagemapdata <imagelink> format for that purpose. All parameters after the first are optional.
Raw HTML
You can use raw html and enclose it in <rawhtml> tags. Be careful, as you should not have new lines between the tags.
Color Boxes
If you want to produce the light orange bordered boxes as in the Eatoni comment pages, use the html table tag and assign class="misctable" to the table or its rows/cells.
Rounded Boxes
For a rounded grey box enclose your text body in <div class="Box"> and your title in <div class="Top"><h2> tags. Be careful, if you use tables inside the div you have to set width=100% to your (outmost if nested) table. If you want to limit the size of the box you can either use width on the div.Box itself or put it inside a table. Avoid empty lines (use <br /> instead). If you have display problems when trying to float the box, try putting it inside a table and the table inside a <div style="float: xxx"> tag.
The blue rounded box is done using <div class="firstHeading">.
Templates
Currently supported templates:
- {{TOCleft}} and {{TOCright}}: Floating TOCs
- {{Tl}}: Template to allow posting links to templates (like the one next to this sentense).
Page tools: Help [Comments] [Printable version] |