Help:Editing
From phpCMS
Contents |
[edit] This page is under construction
I copied the content of this page from Wikipedia and started to adopt it to the phpCMS docu wiki. But work isn't done yet and I would appreciate it if anybody else could continue that work so I can concentrate on other parts of the phpCMS project.
Ignatius 22:30, 16 Aug 2004 (CEST)
[edit] Introduction
The phpCMS documentation wiki is a Wiki, which means that anyone can easily edit any unprotected page and have those changes posted immediately.
It is very easy to edit a Wiki page! Simply click on the "Edit this page" tab at the top (or the edit links on the right) of a Wiki page to change the page itself, or click on the "Discussion" tab and then on the "+" tab (or, on the original classic skin, click on the "Discuss this page" link and then on "Edit this page") to add a comment to the discussion on the corresponding usercomment page. This will bring you to a page with a text box containing the editable text of that Wiki page.
Type away, write a short edit summary on the small field below the edit-box and when finished, press "Save". You can also preview your changes before saving if you like. Depending on your system, pressing Enter while the edit box is not active (there is no typing cursor in it) may have the same effect as pressing the save button.
[edit] Tips on editing phpCMS docu wiki pages
To avoid collisions with other editors, you can use a template that puts a warning message on top of the page like this (example only):
This article is currently undergoing a major edit.
As a courtesy, please do not make edits to this article while this message is posted,
in order to avoid edit conflicts.
See Help:Templates. To do this, one puts "{{inuse}}" on top of the text and saves it immediatly as minor edit, and later, when the work is finished, i.e. during the last edit, one deletes that template again.
It is often more convenient to copy and paste the text first into your favorite text editor, edit and spell check there, and then paste it back into the Wiki's editing box to preview. This way, you can also keep a local backup copy of the pages you authored so that you can make changes offline. But be careful with that as others might have changed your text inbetween.
Some text editors can be specially adapted to edit MediaWiki articles: see [highlighting].
If during editing you want to see the current version again, open "Cancel" in a new window. This does not cancel your edit.
After creating or heavily modifying page, it's a good idea to
- use - with your page displayed - What links here in the "toolbox" to check the articles that already link to it, and make sure they are all expecting the same meaning that you have supplied;
- use the Search to find other articles that mention yours, and make links from them if appropriate.
[edit] Minor edits
When editing a page, a logged-in user can mark that edit as "minor". Minor edits generally mean spelling corrections, formatting, and minor rearranging of text. It is possible to hide minor edits when viewing Special:Recentchanges. Marking a significant change as a minor edit is considered bad behavior, and even more so if it involves the deletion of some text. If one has accidentally marked an edit as minor, the person should edit the source once more, mark it major (or, rather, ensure that the check-box for "This is a minor edit" is not checked), and, in the summary, state that the previous change was a major one.
[edit] The wiki markup
In the left column of the tables 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.
You may want to keep this page open in a separate browser window for reference. If you want to try out things without danger of doing any harm, you can do so in the Sandbox.
[edit] Sections, paragraphs, lists and lines
| What it looks like | What you type |
|---|---|
|
Start your sections as follows: [edit] New section[edit] Subsection[edit] Sub-subsection |
==New section== ===Subsection=== ====Sub-subsection==== |
|
A single newline 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. But an empty line starts a new paragraph. |
A single newline 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. But an empty line starts a new paragraph. |
|
You can break lines |
You can break lines<br /> without starting a new paragraph. |
|
* Lists are easy to do: ** start every line with a star *** more stars means deeper levels |
|
# Numbered lists are also good ## very organized ## easy to follow |
|
* You can even do mixed lists *# and nest them *#* 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 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:
WARNING: If you make it wide, you force the whole page to be wide and hence less readable, especially for people who use lower resolutions. Never start ordinary lines with spaces. |
IF a line starts with a space THEN
it will be formatted exactly
as typed;
in a fixed-width font;
lines won't wrap;
ENDIF
|
|
|
<center>Centered text.</center> |
| A horizontal dividing line: this is above it
and this is below it. Mainly useful for separating threads on Talk pages. In rare times used to disambiguate an expression without creating a separate page. |
A horizontal dividing line: this is above it ---- and this is below it. |
[edit] Links, URLs and Images
| What it looks like | What you type |
|---|---|
|
See the system requirements.
Thus the link above is to http://docs.phpcms.de/index.php/System_requirements, which is the article with the name "System requirements". |
See the [[system requirements]]. |
|
Same target, different name: license. |
Same target, different name: [[phpCMS License|license]] |
E ndings are blended into the link: [[test]]ing, [[gene]]s |
|
|
Automatically hide stuff in parentheses: kingdom. Automatically hide namespace: Village Pump. The server fills in the part after the | when you save the page. Next time you open the edit box you will see the expanded piped link. A preview interprets the abbreviated form correctly, but does not expand it yet in the edit box. Press Save and again Edit, and you will see the expanded version. The same applies for the following feature. |
Automatically hide stuff in parentheses: [[kingdom (biology)|]]. Automatically hide namespace: [[Wikipedia:Village Pump|]]. |
|
Economics#See also is a link to a section within another page. The part after the # must exactly match a heading on the page (in spelling, case and punctuation). See == headers == above for how to create headings. Links to non-existent sections aren't broken, they are treated as links to the top of the page. |
[[Economics#See also]] is a link...<br /> [[#Links, URLs]] is a link... |
|
When adding a comment to a Talk page, you should sign it. You can do this by adding three tildes for your user name: or four for user name plus date/time:
|
When adding a comment to a Talk page, you should sign it. You can do this by adding three tildes for your user name: : ~~~ or four for user name plus date/time: : ~~~~ |
|
Non existing page is a page that doesn't exist yet.
|
[[Non existing page]] is a page that doesn't exist yet. |
|
"What links here" and "Related changes" can be linked as: |
[[Special:Whatlinkshere/Help:Editing]] and [[Special:Recentchangeslinked/Help:Editing]] |
|
A user's "Contributions" page can be linked as: |
[[Special:Contributions/UserName]] or [[Special:Contributions/192.0.2.0]] |
|
To put an article in a Category: |
[[Category:Article name]] |
|
External link: Plain URL: http://www.nupedia.com/ (no markup) |
External link: Plain URL: http://www.nupedia.com/ This is an unnamed link. [http://www.nupedia.com/] Named link to [http://www.nupedia.com Nupedia].
|
|
To link to books, you can use Wikipedia:ISBN links. This is preferred to linking to a specific online bookstore, because it gives the reader a choice of vendors. ISBN links do not need any extra markup, provided you use this format. |
ISBN 012345678X ISBN 0-123-45678-X |
|
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 15 January 2001, but July 20, 1969 if you set it to January 15, 2001. |
|
To include links to non-image uploads such as sounds, use a "media" link. |
[[media:Sg_mrob.ogg|Sound]] |
|
A picture: Image:Wiki.png Wikipedia Encyclopedia
|
A picture: [[Image:Wiki.png]] or, with alternate text [[Image:Wiki.png|jigsaw globe]] or, floating to the right side of the page and with a caption. A picture: [[Image:Wiki.png|frame|right|Wikipedia Encyclopedia]] or, floating to the right side of the page without a caption. [[Image:Wiki.png|right|]] Note the extra | after the word right. This is to make sure the image floats to the right side of the page, and not so that the alternate text is "right". |
|
Clicking on an uploaded image displays a description page, which you can also link directly to: Image:Wiki.png |
[[:Image:Wiki.png]] |
|
To include links to images shown as links instead of drawn on the page, use a "media" link. |
[[media:Tornado.jpg|Image of a Tornado]] |
[edit] Character formatting
| What it looks like | What you type |
|---|---|
|
Emphasize, strongly, very strongly.
|
''Emphasize'', '''strongly''', '''''very strongly'''''. |
|
A typewriter font for monospace text.
|
A typewriter font for <tt>monospace text</tt>. |
|
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:
À Á Â Ã Ä Å |
è é ê ë ì í À Á Â Ã Ä Å Æ Ç È É Ê Ë Ì Í Î Ï Ñ Ò Ó Ô Õ Ö Ø Ù Ú Û Ü ß à á â ã ä å æ ç è é ê ë ì í î ï ñ ò ó ô œ õ ö ø ù ú û ü ÿ |
|
Punctuation:
|
¿ ¡ § ¶ † ‡ • – — ‹ › « » ‘ ’ “ ” |
|
Commercial symbols:
|
™ © ® ¢ € ¥ £ ¤ |
|
Subscripts:
Superscripts:
ε0 = 8.85 × 10−12 C² / J m. |
x<sub>1</sub> x<sub>2</sub> x<sub>3</sub> x<sup>1</sup> x<sup>2</sup> x<sup>3</sup> or x¹ x² x³ ε<sub>0</sub> = 8.85 × 10<sup>−12</sup> C² / J m. |
|
Greek characters:
|
α β γ δ ε ζ η θ ι κ λ μ ν ξ ο π ρ σ ς τ υ φ χ ψ ω Γ Δ Θ Λ Ξ Π Σ Φ Ψ Ω |
|
Math characters:
|
∫ ∑ ∏ √ − ± ∞ ≈ ∝ ≡ ≠ ≤ ≥ → × · ÷ ∂ ′ ″ ∇ ‰ ° ∴ ℵ ø ∈ ∉ ∩ ∪ ⊂ ⊃ ⊆ ⊇ ¬ ∧ ∨ ∃ ∀ ⇒ ⇔ → ↔ |
|
Spacing in simple math formulas:
|
Obviously, <i>x</i>² ≥ 0 is true. |
|
Complicated formulas:
|
: <math>\sum_{n=0}^\infty \frac{x^n}{n!}</math>
|
|
Suppressing interpretation of markup:
|
<nowiki>Link → (<i>to</i>) the [[Wikipedia FAQ]]</nowiki> |
|
Commenting page source:
|
<!-- comment here --> |
[edit] Tables
[edit] Placement of the Table of Contents (TOC)
At the current status of the wiki markup language, having at least four headers on a page triggers the TOC to appear in front of the first header (or after introductory sections). Putting __NOTOC__ anywhere forces the TOC to disappear. See also compact TOC for alphabet and year headings.
[edit] Tables
There are two ways to build tables:
- in special Wiki-markup (see m:Help:Table)
- with the usual HTML elements: <table>, <tr>, <td> or <th>.
For the latter, and a discussion on when tables are appropriate, see Wikipedia:How to use tables.
[edit] Variables
| Code | Effect |
|---|---|
| {{CURRENTMONTH}} | 08 |
| {{CURRENTMONTHNAME}} | August |
| {{CURRENTMONTHNAMEGEN}} | August |
| {{CURRENTDAY}} | 22 |
| {{CURRENTDAYNAME}} | Wednesday |
| {{CURRENTYEAR}} | 2007 |
| {{CURRENTTIME}} | 11:59 |
| {{NUMBEROFARTICLES}} | 180 |
| {{PAGENAME}} | Editing |
| {{NAMESPACE}} | Help |
| {{localurl:pagename}} | /index.php/Pagename |
| {{localurl:Wikipedia:Sandbox|action=edit}} | http://www.wikipedia.org/wiki/Sandbox?action=edit |
| {{SERVER}} | http://docs.phpcms.de |
| {{ns:1}} | Talk |
| {{ns:2}} | User |
| {{ns:3}} | User_talk |
| {{ns:4}} | phpCMS |
| {{ns:5}} | phpCMS_talk |
| {{ns:6}} | Image |
| {{ns:7}} | Image_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}} | phpCMS |
NUMBEROFARTICLES is the number of pages in the main namespace which contain a link and are not a redirect, i.e. number of articles, stubs containing a link, and disambiguation pages).
[edit] Templates
The MediaWiki software used by Wikipedia has limited support for template inclusion. This means standardized text chunks (such as boilerplate text) can be inserted into articles. For example, typing {{stub}} will appear as This article is a stub. You can help Wikipedia by expanding it. when the page is saved. Other commonly used ones are {{disambig}} for disambiguation pages and {{spoiler}} for spoiler warnings. See Wikipedia:Template messages for the complete list.

