Difference between revisions of "Help:Editing"
(→Introduction) |
|||
| Line 4: | Line 4: | ||
==Introduction== | ==Introduction== | ||
| − | Editing most | + | Editing most Cheat Engine Wiki pages is easy. Simply click on the "'''edit this page'''" tab at the top of a Cheat Engine Wiki page (or on a [[CheatEngine: Section|section-edit link]]). This will bring you to a new page with a text box containing the editable text of the original page. |
| − | |||
<br clear=all> | <br clear=all> | ||
| − | + | When you are finished with an edit, you should write a short [[Help:Edit summary|edit summary]] in the small field below the edit-box. You may use shorthand to describe your changes, as described in the [[CheatEngine:Edit_summary_legend|legend]]. To see how the page looks with your edits, press the "'''Show preview'''" button. To see the differences between the page with your edits and the previous version of the page, press the "'''Show changes'''" button. If you're satisfied with what you see, [[CheatEngine:Be bold|be bold]] and press the "'''Save page'''" button. Your changes will immediately be visible to all CheatEngine users. | |
[[Image:Edit commands.PNG|frame|left|Edit commands]] | [[Image:Edit commands.PNG|frame|left|Edit commands]] | ||
<br clear=all> | <br clear=all> | ||
Revision as of 07:50, 30 July 2009
CheatEngine is a wiki, meaning that anyone can easily edit any unprotected page, and save those changes immediately to that page, making the alterations visible to every other reader. You do not even need to register to do this. After your first edit, you will be a CheatEngine editor!
Contents
Introduction
Editing most Cheat Engine Wiki pages is easy. Simply click on the "edit this page" tab at the top of a Cheat Engine Wiki page (or on a section-edit link). This will bring you to a new page with a text box containing the editable text of the original page.
When you are finished with an edit, you should write a short edit summary in the small field below the edit-box. You may use shorthand to describe your changes, as described in the legend. To see how the page looks with your edits, press the "Show preview" button. To see the differences between the page with your edits and the previous version of the page, press the "Show changes" button. If you're satisfied with what you see, be bold and press the "Save page" button. Your changes will immediately be visible to all CheatEngine users.
You can also click on the "Discussion" tab to see the corresponding talk page, which contains comments about the page from other CheatEngine users. Click on the "new section" tab to start a new section, or edit the page in the same way as an article page.
You should also remember to sign your messages on talk pages and some special-purpose project pages with four tildes (~~~~), but you should not sign edits you make to regular articles. In page history, the MediaWiki software automatically keeps track of which user makes each change.
Minor edits
Template:further A check to the "minor edit" box signifies that only superficial differences exist between the version with your edit and the previous version: typo corrections, formatting and presentational changes, rearranging of text without modifying content, etc. A minor edit is a version that the editor believes requires no review and could never be the subject of a dispute. The "minor edit" option is one of several options available only to registered users.
Major edits
All editors are encouraged to be bold, but there are several things that a user can do to ensure that major edits are performed smoothly. Before engaging in a major edit, a user should consider discussing proposed changes on the article discussion/talk page. During the edit, if doing so over an extended period, the {{Inuse}} tag can reduce the likelihood of an edit conflict. Once the edit has been completed, the inclusion of an edit summary will assist in documenting the changes. These steps will all help to ensure that major edits are well received by the CheatEngine community.
A major edit should be reviewed to confirm that it is consensual to all concerned editors. Therefore, any change that affects the meaning of an article is major (not minor), even if the edit is a single word.
There are no necessary terms to which you have to agree when doing major edits, but the recommendations above have become best practice. If you do it your own way, the likelihood of your edits being reedited may be higher.
Occasionally your browser will crash. When doing a large edit it is suggested you copy the code of the article you are working on and placing it in a text editor (preferably one without formatting, such as MS Notepad) periodically. This ensures that in the case of a browser crash you will not lose your work. It may also be a good idea to save the page after performing a substantial amount of work before adding additional content to the article.
Wiki markup
Wiki markup is the language you use to format a CheatEngine page; please see Editing for details on it, and Wikitext examples for a longer list of the possibilities of Wikitext.
Links and URLs
The anchor element, <a>, is not allowed. The following are used instead: [[ ]], [ ], ~~~~, ~~~, http, ISBN, RFC & {{ }}. See the table below.
| What it looks like | What you type |
|---|---|
|
London has public transport. (Article link)
|
|
|
San Francisco also has public transportation. (Renamed link)
|
|
|
San Francisco also has public transportation. (Blend link) Examples include buses, taxicabs, and trams.
|
|
|
See the CheatEngine:Manual of Style. (Other page link)
|
|
|
CheatEngine:Manual of Style#Italics is a link to a section within another page. #Links and URLs is a link to another section on the current page. Italics is a piped link to a section within another page.
|
|
|
(Example renamed links) Automatically hide stuff in parentheses: kingdom. Automatically hide namespace: Village pump. Or both: Manual of Style But not: [[CheatEngine:Manual of Style#Links|]]
|
|
|
(Create page link) Links to pages that don’t exist yet look red: Template:CheatEngine:Community portal/Opentask/Requested articles
|
|
|
(Navigation links) CheatEngine:How to edit a page is a link to this page.
|
|
|
(Signing comments) The character tilde (~) is used when adding a comment to a Talk page. You should sign your comment by appending four tildes (~~~~) to the comment so as to add your user name plus date/time:
Adding three tildes (~~~) will add just your user name: and adding five tildes (~~~~~) gives the date/time alone:
|
|
|
(Redirects)
|
|
|
(Wikimedia link) To connect, via interwiki link, to a page on the same subject in another language, put a link of the form: [[language code:Title]] near the bottom of the article. For example, in article "Plankton", which is available on a lot of other wikis, the interwiki link to the German CheatEngine looks like:
where the "de" is the language-code for "Deutsch" (the German language).
|
|
|
(Linked and why) What links here and Related changes
pages can be linked as: |
|
|
(User edits) A user's Contributions page can be linked as: Special:Contributions/UserName or Special:Contributions/192.0.2.0 |
|
|
(Categorize)
|
|
|
(Category page link)
|
|
|
(External links) Three ways to link to external (non-wiki) sources:
|
|
|
(Wikimedia text link) Linking to other wikis:
Linking to another language's wiktionary:
|
|
|
(Book sources) ISBN 012345678X ISBN 0-12-345678-X
|
|
|
(RFC number) Text mentioning an RFC number anywhere, e.g. RFC 4321. |
|
|
(“As of” tag) “As of” tags like "As of April 2009" and "as of April 2009" categorize info that will need updating. |
|
|
(Media link)
Some uploaded sounds are listed at Commons:Sound. |
|
|
(Edit links) Link directly to edit for an existing page, or apply other link attributes.
|
|
Images
Only images that have been uploaded to CheatEngine can be used. To upload images, use the upload page. You can find the uploaded image on the image list.
| What it looks like | What you type |
|---|---|
| A picture: | A picture: [[Image:wiki.png]] |
| With alternative text: | With alternative text: [[Image:wiki.png|CheatEngine, The Free Encyclopedia.]]
|
| Floating to the right side of the page using the frame attribute and a caption:
File:wiki.png CheatEngine Encyclopedia |
Floating to the right side of the page using the ''frame'' attribute and a caption: [[Image:wiki.png|frame|CheatEngine Encyclopedia]]
|
| Floating to the right side of the page using the thumb attribute and a caption:
File:wiki.png CheatEngine Encyclopedia |
Floating to the right side of the page using the ''thumb'' attribute and a caption: [[Image:wiki.png|thumb|CheatEngine Encyclopedia]]
|
| Floating to the right side of the page without a caption: | Floating to the right side of the page ''without'' a caption: [[Image:wiki.png|right|CheatEngine Encyclopedia]]
|
| A picture resized to 30 pixels... | A picture resized to 30 pixels... [[Image:wiki.png|30 px]]
|
| Linking directly to the description page of an image: | Linking directly to the description page of an image: [[:Image:wiki.png]]
(such as any of the ones above) also leads to the description page |
| Linking directly to an image without displaying it: | Linking directly to an image without displaying it: [[:media:wiki.png|Image of the jigsaw globe logo]]
|
| Using the span and div tag to separate images from text (note that this may allow images to cover text): | Example: <div style="display:inline; width:220px; float:right;"> Place images here </div> |
| Using wiki markup to make a table in which to place a vertical column of images (this helps edit links match headers, especially in Firefox browsers): | Example: {| align=right
|-
|
Place images here
|}
|
See the CheatEngine's image use policy as a guideline used on CheatEngine.
For further help on images, including some more versatile abilities, see the topic on Extended image syntax.
Headings
For a heading, put it on a separate line. A level-two heading, the highest level editors use in an article, for example:
== Introduction ==
Editing most CheatEngine pages is easy.
Subheadings use '===', '====', and so on, down to level-six.
Level-one headings are automatically generated for the articles title, which is not available in the edit box.
Character formatting
| What it looks like | What you type |
|---|---|
|
Italicized text |
''Italicized text'' '''Bold text''' '''''Italicized & Bold text''''' |
|
Syntax highlighting for source code. Computer code has a colored background
and more stringent formatting. Suppose we
want to define #include <iostream>
int main ( int argc, char **argv ) {
std::cout << "Hello World!";
return 0;
} |
Computer code has a colored background
and more stringent formatting. Suppose we
want to define <source lang=cpp>#include <iostream>
int main ( int argc, char **argv ) {
std::cout << "Hello World!";
return 0;
}</source>
|
|
You can use small text for captions. |
You can use <small>small text</small> for captions. |
|
Better stay away from big text, unless it's within small text. |
Better stay away from <big>big text</big>, unless <small> it's <big>within</big> small</small> text. |
|
You can You can also mark
|
You can <s>strike out deleted material</s> and <u>underline new material</u>. You can also mark <del>deleted material</del> and <ins>inserted material</ins> using logical markup. For backwards compatibility better combine this potentially ignored new <del>logical</del> with the old <s><del>physical</del></s> markup. |
|
Suppressing interpretation of markup:
|
<nowiki>Link → (''to'')
the [[CheatEngine FAQ]]</nowiki>
|
|
Commenting page source:
|
<!-- comment here --> |
|
Extra spacing within text can best be achieved using the pad template: Mary Template:pad had a little lamb. |
Mary {{pad|4em}} had a little lamb.
|
|
Diacritical marks:
|
À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í Î Ï Ñ Ò Ó Ô Õ Ö Ø Ù Ú Û Ü ß à á â ã ä å æ ç è é ê ë ì í î ï ñ ò ó ô œ õ ö ø ù ú û ü ÿ |
|
Punctuation:
|
¿ ¡ § ¶ † ‡ • – — ‹ › « » ‘ ’ “ ” |
|
Commercial symbols:
|
™ © ® ¢ € ¥ £ ¤ |
|
Subscripts:
Superscripts:
Combined:
|
x<sub>1</sub> x<sub>2</sub> x<sub>3</sub> or x₀ x₁ x₂ x₃ x₄ x₅ x₆ x₇ x₈ x₉ x<sup>1</sup> x<sup>2</sup> x<sup>3</sup> or x⁰ x¹ x² x³ x⁴ x⁵ x⁶ x⁷ x⁸ x⁹ ε<sub>0</sub> = 8.85 × 10<sup>−12</sup> C² / J m. 1 [[hectare]] = [[1 E4 m²]] |
|
Greek characters:
|
α β γ δ ε ζ η θ ι κ λ μ ν ξ ο π ρ σ ς τ υ φ χ ψ ω Γ Δ Θ Λ Ξ Π Σ Φ Ψ Ω |
|
Mathematical characters:
|
∫ ∑ ∏ √ − ± ∞ ≈ ∝ ≡ ≠ ≤ ≥ × · ÷ ∂ ′ ″ ∇ ‰ ° ∴ ℵ ø ∈ ∉ ∩ ∪ ⊂ ⊃ ⊆ ⊇ ¬ ∧ ∨ ∃ ∀ ⇒ ⇐ ⇓ ⇑ ⇔ → ↓ ↑ ← ↔ |
|
Mathematical formulae:
<math>\mathbf{x} = \mathbf{0}</math>
|
<math>\,\! \sin x + \ln y</math><br>
{{math|sin ''x'' + ln ''y''}}
<math>\mathbf{x} = \mathbf{0}</math><br>
{{math|<b>x</b> {{=}} <b>0</b>}}
|
|
Spacing in simple math formulae:
|
Obviously, {{math|''x<''<sup>2</sup> ≥ 0}} is true
when {{math|<VAR >x</VAR >}} is a real number.
|
|
Complicated formulae:
|
: <math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>
|
(see also: Chess symbols in Unicode)
No or limited formatting—showing exactly what is being typed
A few different kinds of formatting will tell the Wiki to display things as you typed them—what you see, is what you get!
| What it looks like | What you type |
|---|---|
| <nowiki> tag: 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> tag:The pre tag ignores [[Wiki]] ''markup''. It also doesn't reformat text. It still interprets special characters: → |
<pre> The pre tag ignores [[Wiki]] ''markup''. It also doesn't reformat text. It still interprets special characters: → </pre> |
| Leading space: 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: → |
Invisible text (comments)
Template:main It's uncommon, but on occasion acceptable, to add a hidden comment within the text of an article. The format is this:
<!-- This is an example of text that won't normally be visible except in "edit" mode. -->
Table of contents
At the current status of the wiki markup language, having at least four headers on a page triggers the table of contents (TOC) to appear in front of the first header (or after introductory sections). Putting __TOC__ anywhere forces the TOC to appear at that point (instead of just before the first header). Putting __NOTOC__ anywhere forces the TOC to disappear. See also Compact TOC for alphabet and year headings.
Tables
There are two ways to build tables:
- in special Wiki-markup (see Table)
- with the usual HTML elements: <table>, <tr>, <td> or <th>.
For the latter, and a discussion on when tables are appropriate, see When to use tables.
Variables
(See also Variable)
| Code | Effect |
|---|---|
| {{CURRENTWEEK}} | 47 |
| {{CURRENTDOW}} | 4 |
| {{CURRENTMONTH}} | 11 |
| {{CURRENTMONTHNAME}} | November |
| {{CURRENTMONTHNAMEGEN}} | November |
| {{CURRENTDAY}} | 21 |
| {{CURRENTDAYNAME}} | Thursday |
| {{CURRENTYEAR}} | 2024 |
| {{CURRENTTIME}} | 23:20 |
| {{NUMBEROFARTICLES}} | 579 |
| {{NUMBEROFUSERS}} | 62,210 |
| {{PAGENAME}} | Editing |
| {{NAMESPACE}} | Help |
| {{REVISIONID}} | 187 |
| {{localurl:pagename}} | /index.php?title=pagename |
| {{localurl:CheatEngine:Sandbox|action=edit}} | /index.php?title=CheatEngine:Sandbox&action=edit |
| {{fullurl:pagename}} | https://wiki.cheatengine.org/index.php?title=pagename |
| {{fullurl:pagename|query_string}} | https://wiki.cheatengine.org/index.php?title=pagename&query_string |
| {{SERVER}} | https://wiki.cheatengine.org |
| {{ns:1}} | Talk |
| {{ns:2}} | User |
| {{ns:3}} | User talk |
| {{ns:4}} | Cheat Engine |
| {{ns:5}} | Cheat Engine talk |
| {{ns:6}} | File |
| {{ns:7}} | File talk |
| {{ns:8}} | MediaWiki |
| {{ns:9}} | MediaWiki talk |
| {{ns:10}} | Template |
| {{ns:11}} | Template talk |
| {{ns:12}} | Help |
| {{ns:13}} | Help talk |
| {{ns:14}} | Category |
| {{ns:15}} | Category talk |
| {{SITENAME}} | Cheat Engine |
NUMBEROFARTICLES is the number of pages in the main namespace which contain a link and are not a redirect, in other words number of articles, stubs containing a link, and disambiguation pages.
CURRENTMONTHNAMEGEN is the genitive (possessive) grammatical form of the month name, as used in some languages; CURRENTMONTHNAME is the nominative (subject) form, as usually seen in English.
In languages where it makes a difference, you can use constructs like {{grammar:case|word}} to convert a word from the nominative case to some other case. For example, {{grammar:genitive|{{CURRENTMONTHNAME}}}} means the same as {{CURRENTMONTHNAMEGEN}}.
Templates
The MediaWiki software used by CheatEngine has support for templates. This means standardized text chunks (such as boilerplate text), can be inserted into articles. For example, typing Template:tl will appear as "This article is a stub. You can help CheatEngine by expanding it." when the page is saved. See Template messages for the complete list. Other commonly used templates are: Template:tl for disambiguation pages and Template:tl like an article stub but for a section. There are many subject-specific stubs for example: Template:tl, Template:tl, and Template:tl. For a complete list of stubs see Stub types.
