Wiki guidelines

From TYPO3Wiki

At the top of each wiki page you will find a menu to create and administer your account. If you create an account and log in you can be identified by others and you can discuss with them about the changes you have made. Please log in before editing or creating new pages - it can be done automatically! It will be much easier for us adminstrators to detect spammers if every serious editor logs in!

Then see also some complement about the documentation and the docTeam.

Edit a wiki page

You can just change or add something on an existing page (like this one for example) by simply hitting "edit" button/tab of this page. You will get an input field where you can type directly.

Create a new page

You can create a whole new page in two ways:

• First you can simply type the name of it in the url above, just like this: "http://wiki.typo3.org/index.php?title=My information page".
  My information page can be replaced by everything you want, the page will be automatically created for you.
• Second you can first edit another page and make a wiki link like this: "[[My information page]]". When you save the page and clik on the link, you will get a new page to edit.

You can read about the basics of the easy Wiki-syntax on the wiki Help page.

Page names should only have the first letter capital, not the rest (unless it is a name). You should call the page "My information page", not "My Information Page".

Heading levels

The main header(s) on a wiki page should be at level 2. That means you should use this code for your first header:

== Header ==

There are two reasons for that:

1. The wiki page name is already using level 1
2. If we convert a wiki page to SXW (OpenOffice) the level 1 is reserved for the document name

Progress on wiki pages

First it is a document "To discuss". When we decide we want it, it is moved up to documents "In progress". After that it can get the status "draft" and "proofreading" and when it is finished it gets the status "final".

Document header

All major documents/pages should have a header containing meta-data about the document:

<table width=100% style="background: #F5F5F5; padding: 5px;"><tr><td>
''Main editor:'' Your Name <br/>
''Document status:'' In progress | Draft | Final <br/>
''Major revision:'' ## ### #### <br/>
''Minor revision:'' See page's Last modified date<br/>
''Prerequisites:'' Typo3 version, Extensions, other documents
</td><td> </td>
<td align=center>{{License-OPL}}</td></tr></table>