DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

EXT: Form Result¶

Author:	Kasper Skårhøj
Created:	2002-11-01T00:32:00
Changed:	2005-01-12T13:25:53
Author:	Stefan Hafeneger
Email:	hafeneger@gst-im.de
Info 3:
Info 4:

EXT: Form Result¶

Extension Key: gst_formresult

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Table of Contents¶

EXT: My Extension 1

Introduction 1

What does it do? 1

Screenshots 1

Users manual 1

FAQ 1

Adminstration 1

FAQ 2

Configuration 2

FAQ 2

Reference 2

Tutorial 2

Known problems 2

To-Do list 2

Changelog 2

Introduction¶

What does it do?¶

- Overview; What does it do? What problem is solved? Who is interested in this? Brief technical insight. Basically everything people need to know if they should go on with this extension.

Screenshots¶

- Screenshots are very much welcome for a visual impression.

- This section will have a link in the EM, so therefore it's very important that it conveys this message.

- Target group: Mostly Developers and administrators, but should be a non-technical and visual presentation.

- This section is required and in some cases it basically tells it all.

Users manual¶

- Documentation of how to use the extension, how it works, how to apply it if it's a website plugin. A user manual.

- Language should be non-technical, explaining, using small examples.

- Examples: For the "News" plugin this would be a manual showing how to create the news-items, explaining the options etc.

- Target group: Users, Administrators or Developers in that priority. Depends on the extension.

FAQ¶

- Possible subsections: FAQ

Adminstration¶

- Describes how to manage the extension from a superuser point of view. That relates to Page/User TSconfig, permissions, configuration etc. which administrator level users have access to.

- language should be non/semi-technical, explaining, using small examples.

- Target group: Administrators

FAQ¶

- Possible subsections: FAQ

Configuration¶

- Technical information; Installation, Reference of TypoScript, configuration options on system level, how to extend it, the technical details, how to debug it.

- language should be technical, assuming developer knowledge of TYPO3. Small examples/visuals are always encouraged.

- Target group: Developers

FAQ¶

- Possible subsections: FAQ

Subheadlines¶

You can produce subheadlines in a section using “Heading 4” or “Heading 5” (normally used for “Examples”)

Reference¶

- Possible subsections: Reference (TypoScript)

allWrap /+stdWrap¶

Property

allWrap /+stdWrap

Data type

wrap

Description

Wraps the whole item

Default

wrapItemAndSub¶

Property

wrapItemAndSub

Data type

wrap

Description

Wraps the whole item and any submenu concatenated to it.

Default

subst_elementUid¶

Property

subst_elementUid

Data type

boolean

Description

If set, all appearances of the string '{elementUid}' in the total element html-code (after wrapped in .allWrap} is substituted with the uid number of the menu item.

This is useful if you want to insert an identification code in the HTML in order to manipulate properties with JavaScript.

Default

RO_chBgColor¶

Property

RO_chBgColor

Data type

string

Description

If property RO is set (see below) then you can set this property to a certain set of parameters which will allow you to change the background color of eg. the tablecell when the mouse rolls over you text-link.

Syntax:

[over-color] | [out-color] | [id-prefix]

Example:

page = PAGE
page.typeNum = 0
page.10 = HMENU
page.10.wrap = <table border=1>|</table>
page.10.1 = TMENU
page.10.1.NO {
  allWrap = <tr><td valign=top id="1tmenu{elementUid}" style="background:#eeeeee;">|</td></tr>
  subst_elementUid = 1
  RO_chBgColor = #cccccc | #eeeeee | 1tmenu
  RO = 1
}

This example will start out with the table cells in #eeeeee and change them to #cccccc (and back) when rolled over. The “1tmenu” string is a unique id for the menu items. You may not need it (unless the same menu items are more than once on a page), but the important thing is that the id of the table cell has the exact same label before the {elementUid} (red marks). The other important thing is that you DO set a default background color for the cell with the style-attribute (blue marking). If you do not, Mozilla browsers will behave a little strange by not capturing the mouseout event the first time it's triggered.

Default

[tsref:(cObject).TEST]

((generated))¶

Example¶

Here you would show an example of the stuff from the reference or so:

page = PAGE
page.typeNum = 0
page.10 = TEXT
page.10.value = HELLO WORLD

Tutorial¶

- A full point-a-to-b-to-c walk-through of an application of the extension. Include screendumps.

- Language: As tutorials are...

- Target group: Whatever fits.

Known problems¶

- Use this section for important warnings about bugs, problems or performance issues. This is where you should explain shortcomings of the extension, so people are properly warned. Be honest.

- Target group: Mostly Developers

To-Do list¶

- A wish list of things you want to add or fix. This includes smaller problems/bugs which are best described as a todo item.

- Visions for what the extension could become with more development.

Changelog¶

- Use this sections to document all the changes through the versions.

EXT: Form Result - 3