Help:Editing

From TYPO3Wiki
Jump to: navigation, search

Full official wiki documentation

The following links contains all info about the wiki syntax and how to use this wiki in general:

Further editing information, including syntax highlighting tags

Remove spam

I have noticed that some people just remove the spam text from spammed pages. But they sometimes miss that the spammer not only added text, but also removed the original text. So to be sure to roll back to the last correct page, do like this:

  • Go to the page and click on the "history" tab. Then click on the time and date of the earlier version you want to revert to. It will not work if you click on 'cur', 'last', or "Compare selected versions".
  • Then when that page comes up, you'll see something like "(Revision as of 23:19 Jul 15, 2003)" below the title, rather than "From {project name}".
  • Verify that you've selected the correct version, and click to edit the page, as you would normally.
  • You'll get a warning, above the edit box, about editing an out-of-date revision.
  • Ignore the warning and save the page. Please be sure to add the text "Spam removal" to the Summary field.

Cool wiki-helpers

  • Add current Date: {{subst:Date}}
  • Add LanguageSwitch: {{subst:L}}
  • Marker for not finished page is: [[Category:NotFinished]]   info
  • Marker to delete a page: {{delete}}
  • Marker for outdated page is: {{outdated}}

Interwiki links

There are two interwiki links you can use to make you writing a little easier:

TYPO3 Documentation

Insert links to TYPO3 documentation with

[[T3Doc:CoreManualName]]

for example: T3Doc:TyposcriptReference or TypoScript reference

If you want to link an extension manual, just prepend the word "extensions/" to the extension name. For example

[[T3Doc:extensions/realurl]]

will create this link:

T3Doc:extensions/realurl

User´s Quick guide

To edit a MediaWiki page, click on the "Edit/Edit this page" link at one of its edges or at the headers. This will bring you to a page with a text box containing the wikitext. Here you can edit the text, see below for some of the special codes.

After adding to or changing the wikitext it is useful to press Preview. Now you see a rendered page, although that is not publicly available yet. Errors in formatting, links, tables, etc. are often much easier to discover from the rendered page than from the wikitext.

If you are not satisfied you can make more changes and preview the page again. Then write a short edit summary on the small field below the edit-box and when finished press "Save"! 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 Save.

Sections & paragraphs

  • Start a new sections with header lines:

== New section == === Subsection === ==== Sub-subsection ====

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 without starting a new paragraph: You can break lines<br/> without starting a new paragraph.

Colon can be used for indenting paragraphs: : A colon indents a line or paragraph. And a manual newline starts a new paragraph.

Headline text

Lists and lines

What it looks like What you type
  • Lists are easy to do:
    • start every line with a star
      • more stars means deeper levels
* Lists are easy to do:
** start every line with a star
*** more stars means deeper levels
  1. Numbered lists are also good
    1. very organized
    2. easy to follow
# Numbered lists are also good
## very organized
## easy to follow
  • You can also
    • break lines
      inside lists
      like this
* You can also
**break lines<br/>inside lists<br/>like this
IF a line of 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.

 IF a line of 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;
A horizontal dividing line: above

and below.

Mainly useful for separating threads on Talk pages.

A horizontal dividing line: above
----
and below. 

Links, URLs

What it looks like What you type
Sue is reading the video policy.
  • First letter of target is automatically capitalized.
  • Internally spaces are automatically represented as underscores (typing an underscore has the same effect as typing a space, but is not recommended).

Thus the link above is to http://meta.wikipedia.org/wiki/Video_policy, which is the page with the name "Video policy".

Sue is reading the video policy.

Link to a section on a page, e.g. List_of_cities_by_country#Morocco; when section editing does not work the link is treated as link to the page, i.e. to the top; this applies for:

  • links to non-existent sections
  • links in redirects
  • interwiki links
[[List_of_cities_by_country#Morocco]].
Link target and link label are different: answers.

(This is called a piped link).

Same target, different name:
[[User:OldLarry Sanger|answers]]
When adding a comment to a Talk page,

you should sign it. You can do this by adding three tildes for your user name:

Karl Wick

or four for user name plus date/time:

Karl Wick 08:10 Oct 5, 2002 (UTC)
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:
: ~~~~
The weather in London is a page that doesn't exist yet.
  • You can create it by clicking on the link.
  • To create a new page:
    1. Create a link to it on some other page.
    2. Save that page.
    3. Click on the link you just made. The new page will open for editing.
  • Have a look at how to start a page guide and the naming conventions page for your project.
[[The weather in London]] is a page
that doesn't exist yet.
External links: inter.by, [1]

Always try to follow the no click here links paradigm, i.e. always have some sensible text as the link text. Do not use

use this instead:

External links:
[http://inter.by Inter.By],
[http://inter.by]
Or just give the URL: http://inter.by.
  • In the URL all symbols must be among: A-Z a-z 0-9 ._\/~%-+&#?!=()@ \x80-\xFF. If a URL contains a different character it should be converted; for example, ^ has to be written %5E (to be looked up in ASCII). A blank space can also be converted into an underscore.
Or just give the URL:
http://inter.by.

Character formatting

What it looks like What you type

Emphasize, strongly, very strongly.

  • These are double and triple apostrophes, not double quotes.
''Emphasize'', '''strongly''',
'''''very strongly'''''.
A typewriter font for technical terms.
A typewriter font for 
<tt>technical terms</tt>.
You can use small text for captions.
You can use <small>small text</small> 
for captions.
You can strike out deleted material

and underline new material.

You can <strike>strike out deleted material</strike>
and <u>underline new material</u>.

Commenting page source:
not shown in page

  • Used to leave comments in a page for future editors.
<!-- comment here -->

How to write technical copy

Web articles

Paper books