Help:Contents

From TYPO3Wiki

1 Remove spam
2 The 1 minute tips
3 The full guide
4 How to write

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.

The 1 minute tips

Start new sections with header lines

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

* Lists are easy to do
** start every line with a star (and no space bevor it!!)
*** more stars means deeper levels

An important question

(See list of all pages with Wiki-Questions)

{{Question|The question? Add your signature with name and date}}

Wiki-Question:
The question? Add your signature with name and date

Please remove "{{Question}}" when the problem is solved. See all questions.

A good-looking TableOfContent

{{DesignTOC}}

To include a good-looking wiki-Table: see the examples.

Another language

{{Lang|PageName|Orange translated title|}}

The full 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 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.

Wiki-Table

So easy you can insert a wiki-table:

row1	row2	row3
AA	BB	CC

row1

row2

row3

three
four

this is a special part
and this, too.

So you make the standard one (=green table):
{| {{DesignTable}}
| ''row1'' || ''row2'' || ''row3''
|-
| AA || BB || CC
|}

So you make the complex table with special CSS-style:
{| {{DesignTable|background-color:white}}
| '''row1'''
| '''row2'''
| '''row3'''
|-
| 
* one
* two
|
* three
* four
 this is a special part
 and this, too.
| http://typo3.org/fileadmin/templates/images/logo-typo3.gif
|}

Would be good to use it for these tables: T3Sites#Official TYPO3 websites

Syntax-Highlighting for PHP-Code

Don't change this title because this is in use by the mediawiki-extension! --Daniel Brüßler

Use the "php"-tag for PHP-code, so you get the highlighting! with linenumbers="1" you get also linenumbers.

<php>
 $foo = 45;
 for ( $i = 1; $i < $foo; $i++ )
 {
  print $foo;
 }
 </php>

<PHP> :
$foo = 45;
for ( $i = 1; $i < $foo; $i++ )
{
  print $foo;
}

<PHP> :

 
$foo = 45;
for ( $i = 1; $i < $foo; $i++ )
{
  print $foo;
}

Syntax-Highlighting for TypoScript

Don't change this title because this is in use by the mediawiki-extension! --Daniel Brüßler

Use the "TS"-tag for TypoScript-code, so you get the highlighting! with linenumbers="1" you get also linenumbers.

Warning

In the moment it's not possible to have wiki-links like TMENU in the code. I'll fix this soon! --Daniel Brüßler 15:18, 1 December 2007 (CET)

<TS> :
#Autor: Jonathan Uhlmann
#Ziel: Die erste Unterseite der aktuellen Seite soll ausgegeben werden
#Hinweis: wenn beim Menu special = directory die Eigenschaft special.value nicht definiert ist, dann wird die aktuelle Seitenid (PID) verwendet.
#
lib.unterseite = HMENU
lib.unterseite {
       special = directory
       includeNotInMenu = 1
       maxitems = 1
       1 = TMENU
       1.noBlur = 1
       1.NO = 1
       wrap = <p> | </p>
}

Syntax-Highlighting for JavaScript

Don't change this title because this is in use by the mediawiki-extension! --Daniel Brüßler

Use the "php"-tag for JavaScript-code, so you get the highlighting! with linenumbers="1" you get also linenumbers.

<JavaScript> :

 
var test = "JavaScript" + "Hello World";
alert (test.length

Syntax-Highlighting for CSS

Don't change this title because this is in use by the mediawiki-extension! --Daniel Brüßler

Use the "CSS"-tag for CSS-code, so you get the highlighting! with linenumbers="1" you get also linenumbers.

<CSS> :

 
div.underline {
  text-decoration: underline;
}

Syntax-Highlighting for SQL

Don't change this title because this is in use by the mediawiki-extension! --Daniel Brüßler

Use the "SQL"-tag for SQL-queries, so you get the highlighting! with linenumbers="1" you get also linenumbers.

<SQL> :

 
 CREATE TABLE tx_realurl_uniqalias(
   uid int( 11 ) NOT NULL AUTO_INCREMENT ,
   tstamp int( 11 ) DEFAULT '0' NOT NULL ,
   PRIMARY KEY ( uid ) ,
   KEY tablename( tablename ) ,
 )

Syntax-Highlighting for shellScript

Don't change this title because this is in use by the mediawiki-extension! --Daniel Brüßler

Use the "shell"-tag for shellScripts, so you get the highlighting! with linenumbers="1" you get also linenumbers.

<shellScript> :

 
cd typo3conf/ext/

TRANSLATION - and the LanguageSwitch

Add LanguageSwitch on a non-english-page: {{subst:L}}

the subst will create this:

{{Lang|PageName|Orange translated title|}}
        
example for this: {{Lang|Dropdown Sitemap|Eine Anleitung zur Dropdown Sitemap|}}

Licence OPL OpenContent Licence

{{OPL-license}}

has this content:

This document is published under
the Open Content License

The content is related to TYPO3 - a GNU/GPL
CMS/Framework available from www.typo3.com

Licence for extensions and third-party tools

See http://wiki.typo3.org/Compatible_Licenses

Categories for Users

copy these into the HEAD of the page you're editing
and you'll see your page in the Document Matrix!

The SKILL-level

[[Category:Beginner]] ... [[Category:Intermediate]] ... [[Category:Expert]]

The Type of user

[[Category:Editor]] ... [[Category:Administrator]] ... [[Category:Developer]]

The Type of document

[[Category:FAQ]] ... [[Category:HowTo]] ... [[Category:Guidelines]] ... 
[[Category:Tutorial]] ... [[Category:Reference]]

Template - for new Extension-page

See Extensiontemplate and copy it. Use the extensionkey as name!

So you create a header:

 {{Ext_manual_header
 |key=<extension>commerce</extension>
 |version=9.2
 |authors=Ingo Schmitt, Volker Graubaum
 |deps=<extension2>tt_address</extension2>,<extension2>graytree</extension2>,
<extension2>dynaflex</extension2>,<extension2>moneylib</extension2>,
<extension2>static_info_tables</extension2>
 |description=A shop extension
 }}

The following code is to create a footer:

{{Ext_manual_footer}}

BRIDGE - to TER - TYPO3-Extension Repository

You write this

* See link: <extension>tt_address</extension>

and get this:

See link: Address list (tt_address) (contact: flyguide)

The short-version is this: tt_address

BRIDGE - to mantis bugtracker

You write this

* A new bug: <bug>3655</bug>

and get this:

A new bug: 3655: onunload missing in JSeventFuncCalls [closed to Martin Kutschker]

BRIDGE - Extension dependency

Example (list all examples): 1. Create a new page "Fgc_whoson", 2. copy-paste this:

<extension>xajax</extension>
== Dependency ==
{{extension|fgc_whoson}}
* ...
== See also ==
== Discussion ==
...

and you get a page like this: Fgc_whoson. See Teamwork#box

DocumentState

Marker to delete a page: {{Tag|delete}}
Marker to say a document is just a draft in the moment: {{Tag:draft}}

Interwiki links

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

TYPO3 Documentation: Insert links to TYPO3 documentation. Examples:

{{doc|tutorials|doc_tut_backend}}

{{doc|installation|doc_inst_upgr}}

{{doc|core-documentation|doc_core_cgl}}

{{doc|references|doc_core_tsref}}

{{doc|extension-manuals|tt_address}}

External Documentation:

See {{Tag|external link}}: [http://URL TUTORIAL of AUTHOR]

See example external link: Frontend Plugin Development of TYPO3 Video-Team always add the name of the author

TYPO3 Extensions:

Insert links to TYPO3 extensions with:

[[T3Ext:EXTENSIONKEY]]

for example: T3Ext:de_phpot

DocTeam todo: change the version-links and the links WITHOUT version to "current"-links. Example ameos_formidable / http://typo3.org/extensions/repository/view/ameos_formidable/0.5.0/ -> http://typo3.org/extensions/repository/view/ameos_formidable/current/ also inner links like http://typo3.org/documentation/document-library/core-documentation/doc_core_cgl/current/view/1/3/

DocTeam todo: change the subversion-links. Example https://svn.sourceforge.net/svnroot/typo3xdev/tx_ttproducts/trunk tt_products -> https://typo3xdev.svn.sourceforge.net/svnroot/typo3xdev/tx_ttproducts/trunk tt_products -> http://typo3xdev.svn.sourceforge.net/viewvc/typo3xdev/tx_ttproducts/trunk/

=> Better to use the search-box http://typo3.org/extensions/repository/?tx_terfe_pi1%5Bview%5D=search&no_cache=1&tx_terfe_pi1%5Bsword%5D=ameos_formidable

Links to the full MEDIAWIKI-documentation

How to write

Two very interesting articles on how to get information distributed:

How Users Read on the Web ( http://www.useit.com/alertbox/9710a.html )
Inverted Pyramids in Cyberspace ( http://www.useit.com/alertbox/9606.html ) Books

Hot text ( http://www.amazon.com/exec/obidos/tg/detail/-/0735711518/ )
Don't make me think ( http://www.amazon.com/exec/obidos/tg/detail/-/0789723107/ )

Retrieved from "http://wiki.typo3.org/index.php/Help:Contents"

Categories: Wiki-Question | Topic/Warning | Topic/external link | Topic/DocTeam todo

Help:Contents

From TYPO3Wiki

Contents

Remove spam

The 1 minute tips

Start new sections with header lines

An important question

A good-looking TableOfContent

Another language

The full guide

Sections & paragraphs

Wiki-Table

Syntax-Highlighting for PHP-Code

Syntax-Highlighting for TypoScript

Syntax-Highlighting for JavaScript

Syntax-Highlighting for CSS

Syntax-Highlighting for SQL

Syntax-Highlighting for shellScript

TRANSLATION - and the LanguageSwitch

Licence OPL OpenContent Licence

Licence for extensions and third-party tools

Categories for Users

The SKILL-level

The Type of user

The Type of document

Template - for new Extension-page

BRIDGE - to TER - TYPO3-Extension Repository

BRIDGE - to mantis bugtracker

BRIDGE - Extension dependency

DocumentState

Interwiki links

Links to the full MEDIAWIKI-documentation

How to write

Views

Personal tools

content

people

help 'N' beginners

Search

Toolbox