Help:Contents

From TYPO3Wiki
(Redirected from HelpQuickstart)
Jump to: navigation, search

How do I work with the Wiki (short version)

This is a Wiki - please feel free to add or alter content. You cannot do anything wrong! The easiest way to learn is to edit a page and look, how it is done. There is a Sandbox, where you can just try it! Click here and play around, if you like.

Your wiki account

Please log in before editing or creating new pages. It is easier for adminstrators to detect spam when serious editors always log in.

You may also want to view information 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

There are two ways to create a new wiki page:

  1. Have a look at your browser's URL field. Simply replace the name of the page you are currently on with the name you want to have for your new page and press the Return key. A new, blank page will be automatically created.
  2. Edit another wiki page and add a wiki link to the page you want to have. When you save and view the edited page, you will see the link to that page. Clicking this link will bring up a new, blank page which you can immediately edit.

Page name syntax

Page names should be written in initial caps, i.e., only the first letter of the first word is capitalized. For example, "My information page" is correct, while "My Information Page" is incorrect. One exception is the use of proper names, such as "Mahatma Gandhi" or "TYPO3".

Start new sections with header lines

Headers are normal lines of text, which are surrounded by "=" signs. You can just type the "=" signs or use the 5. button (the big "A") of the wiki-editor - and you get this:

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

The main header(s) on a wiki page should be at level 2. The reasons are:

  1. The wiki page title already uses level 1.
  2. If we convert a wiki page to SXW (OpenOffice format), the level 1 heading is reserved for the document name.

Creating lists

So you get a list:

* Lists are easy to do
** Start every line with a star (and no space before the star). More stars means deeper levels.
*** This item is on level three.

How to create a link in the text

  • Internal links:
    Mark a word with the mouse and click the 3. button (the Ab underscored) and you get this:
Next is a link to the [[Sandbox]]. The word before is a link to the page called "Sandbox".
  • External links:
    Click the 4th button (the globe) and you get this:
[http://www.google.com/ Google] for a full URL

Image with link

This includes an image in a page:

[[Image:T3DD 150px.jpg]]

Alternatively you can use this:

[[Image:T3DD_150px.jpg|link=T3DD12|left|T3DD12 Developer days]]

How to use tagging - categories for your text

When you want to tag a keyword so klick in the wiki-editor at the button "Tag!" (next to "Note") and you get the following code:

TSref is very important for your {{Tag|TypoScript}}.

The page will then be added to the according category, in this example it would be added to the category Category:TypoScript.

Translation - and the LanguageSwitch

Please give every new page an English name. A language switch will become visible automatically, so it will be easy to translate your content. Feel free to write down in the language you want. And if you do not know a good English name please use some in your language and start writing documentation. We will find a solution afterwards.

You can select your language in the menu and translate the page.

Get an email when somebody changed a page

Question: Can I receive an email when a page is updated?

This would be encouraging for extension authors who are interested in maintaining their extension manuals online and want to know when users are having problems, or clean up user-submitted docs.

Answer: check your Special:Preferences and see if you have "authenticated" your address. Then you can put some pages to your watchlist.

Teamwork and page states - draft, review, publish, delete, merge, outdated

In a wiki everything is text. To signal other people about the state of a wiki page, see the following simple keywords. You can just copy/paste a keyword into a wiki page or just type it in.


The following keywords represent a whole workflow from starting a new document alone, inviting others in a mailing list to help you, and later telling the world that it's finished and people can review it.
The quality of your work increases by the work of many contributors. Some might just correct a word, some might translate the whole document to their own language. Two great examples of documents created by this workflow are Ts45min and TYPO3 Tutorial for Editors.

  • {{delete}} : marks a page as candidate for deletion
  • {{draft}} : marks a work in progress document, in other words a draft version
  • {{draft}} : marks a single section as draft quality
  • {{merge|Pagename}} : proposes a page to be merged with another one
  • {{review}} : announces that a page is ready for review
  • {{reviewed| +1 the typoscript is valid --~~~~}} : tells that the TypoScript on the page is reviewed by you and the examples are valid
  • {{publish}} : marks the document as reviewed and ready for publishing and translation
  • {{stable}} : tells that a document is reviewed, published and stable
  • {{outdated}} :marks a page as outdated and in need of updates

The full guide

This page tells about tips and tools for the documentation. To edit a MediaWiki page, click on the "Edit/Edit this page" link at one of its edges or at the headers. This will redirect you to a page with a text box containing the wiki text where you can edit the text. See below for advanced wiki markup codes.

After changing the wiki text, press Preview to see the page as it would appear with your changes. Check the results for errors in formatting, links, tables, and so on. Do this before saving to ensure that other people don't get confused by your editing errors as you fix them.

If you are not satisfied, you can make more changes and preview the page again. Then write a short edit summary in the small field below the textare 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.

Short URLs

When you enter an URI into the browser, you can omit mentions to /index.php:

http://wiki.typo3.org/RecentChanges
http://wiki.typo3.org/Category:Ajax
http://wiki.typo3.org/De - http://wiki.typo3.org/Jp

When you link from outside into the wiki so use the prefix "/wiki/".
The links would work without the prefix, but this isn't guaranteed for future wiki development.

http://wiki.typo3.org/wiki/De:TSref
http://wiki.typo3.org/wiki/Category:Ajax
http://wiki.typo3.org/wiki/TYPO3_4.3.2 - http://wiki.typo3.org/wiki/FLOW3_1.0.0_alpha7
http://wiki.typo3.org/wiki/De - http://wiki.typo3.org/wiki/Jp
Note Short URLs without "/wiki"-prefix don't work when a dot is in the name
http://wiki.typo3.org/File:Soccer09-2.jpg http://wiki.typo3.org/README.txt

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.

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

Links

External links and image links

You write this:

* See link: [http://typo3.org typo3.org]

and get this:

Link an extension key to its TER (TYPO3 Extension Repository) page

You write this:

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

and get this:


Link a Forge issue

* A forge issue: <issue>7889</issue>

7889: forge.typo3.org - SVN repository not created for project [Closed]


Wiki table

It's easy to insert a wiki table:

bold row1 row2 row3
bold aa bb cc

To create a simple table:

Switch to "Rich Editor" and add a table. This will insert the table including standard CSS classes for sorting and the header. You can switch back if you don't want to stay in the WYSIWYG mode.

Syntax highlighting

Syntax highlighting for PHP code

<php>
 $foo = 45;
 for ($i = 1; $i < $foo; ++$i) {
  print $foo;
 }
 </php>
PHP script:
$foo = 45;
for ($i = 1; $i < $foo; ++$i) {
  print $foo;
}
Syntax highlighting for TypoScript

Use the "TS"-tag for TypoScript code:

XML / HTML:
<TS>
 ...
</TS>
TS TypoScript:
#Author: Jonathan Uhlmann
#Aim: List the subpages
#
lib.submenu = HMENU
lib.submenu {
       special = directory
       includeNotInMenu = 1
       maxitems = 1
       1 = TMENU
       1.noBlur = 1
       1.NO = 1
       wrap = <p> | </p>
}

Syntax-Highlighting for JavaScript

Use the "JavaScript"-tag for JavaScript-code, so you get the highlighting! With linenumbers="1" you also get line numbers.

<JavaScript>
 ...
</JavaScript>
JavaScript:
var test = "JavaScript" + "Hello World";
alert (test.length);

Syntax-Highlighting for HTML and XML

Use the "XML"-tag for HTML / XML-code, so you get the highlighting!

<XML>
 ...
</XML>
XML / HTML:
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<title>DocTEAM - Overview - TYPO3 Forge</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
</head>
<body/>
</html>

Syntax-Highlighting for CSS

Use the "CSS"-tag for CSS-code, so you get the highlighting!

<CSS>
 ...
</CSS>
CSS styles:
div.underline {
  text-decoration: underline;
}

Syntax-Highlighting for SQL

Use the "SQL"-tag for SQL-queries, so you get the highlighting!

<SQL>
 ...
</SQL>
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

Use the "shell"-tag for shellScripts, so you get the highlighting!

<shell>
 ...
</shell>
shell script:
cd typo3conf/ext/

Translation - and the LanguageSwitch

At the top of each content page you can see a LanguageSwitch, which provides links to translated versions of the page. When the translations have not been created yet, you can just go to one of these pages and start it yourself!

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 typo3.org.

Licence for extensions and third-party tools

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

Categories for Users

Copy these into the bottom 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=<extension>tt_address</extension>,<extension>graytree</extension>,
<extension>dynaflex</extension>,<extension>moneylib</extension>,
<extension>static_info_tables</extension>
 |description=A shop extension
 }}

The following code is to create a footer:

{{Ext_manual_footer}}

Document header information

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>

Interwiki links

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

TYPO3 Documentation: Insert links to TYPO3 documentation. Examples:

{{doc|extension-name}}

{{doc|realurl}}

{{doc|news}}

{{doc|perfectlightbox}}

{{doc|tt_address}}

Links to the full MEDIAWIKI-documentation

How to write

Two very interesting articles on how to get information distributed:


Questions left?

There are questions open?

Feel free to write down your question here.

If you want to be noticed you could create an account on typo3.org and log in at https://forge.typo3.org and create an issue for the docteam.