New CSH-System¶

• New CSH-System
  • General idea
  • Editing CSH
    • Other GUI elements
  • Markup, CSS, Images
  • Summary
  • Some screenshots from Yahoo that may be inspiring

General idea¶

The context sensitive help has to serve the following target groups

1. editors/authors
2. TYPO3 admins/sitedevelopers

When TYPO3 ships to admins/sitedevelopers, the context sensitive help should provide information

1. how a field is treated by the sysexts (e.g. css_styled_content etc)
2. tips for what else one could do with them

After admins/sitedevelopers have adapted the system for their project's need, they themselves or someone who knows how to use the system needs to adapt CSH. This counts for both the editor's section and the admin's section:

1. what does a field do in a specific installation (for editors and admins)
2. where is the configuration for this field done (in case someone wants to change the configuration later)

Editing CSH¶

Editing CSH has to be easy and intuitive for everyone who is doing it. This does not always have to be an admin!

A click on the help icon will open up the detailed view plus an edit icon.

Clicking the edit icon brings up the edit form. I could imagine four tabs:

General - Editor's section - Admin's section - Media

• General:
  • description
  • seeAlso
  • alttitle
• Editor's section:
  • RTE field
• Admin's section
  • RTE field
• Media:
  • Whether or not we need that TAB depends on whether we need to 'register' the images used for one CSH item.

Note: There is also a node <syntax> which is occasionally used, e.g. for explaining the date format. If we really use RTE, this field is not needed anymore (too much formalization in my eyes).

Other GUI elements¶

We also need a save, save as, close. Somehow a CSH author has to decide whether he wants to edit the original file or the project specific file.

Which language to edit? Perhaps a select list under general is ok. Or is it sufficient to say the language to edit is the current BE language?

Markup, CSS, Images¶

We need real markup to make csh as readable as possible. We want paragraphs, headlines, lists and even tables where we need them. TCEForms only allows a few inline elements currently!

Also, one might need more than one image per CSH item, e.g. for explaining displaying icons of the different page types. The easiest way to add them might be to allow them in RTE, thus they can be placed exactly where they are needed.

Summary¶

• CSH texts will be opened in a popup.
• They will be edited directly in rtehtmlarea with a special configuration.
• Who is entitled to do so will be managable through the rights system.
• When the a CSH entry is edited a checkbox will be available that allows to send the updated entry to a central TYPO3 CSH server.
• As with other translation stuff we will be able to load the current CSH. Installation specific modifications will not be overridden by this procedure.
• Other than with the normal translation handling the CSH sever will allow specific versions for each TYPO3 major version.

Some screenshots from Yahoo that may be inspiring¶