Prerequisites

The following documents describe the prerequisites for using WebClient 5.0:

Adapting templates

EasyEdit and InEdit - maintaining sections in WebClient

The “Easy-Edit” and “InEdit” functions in WebClient provide an even closer link between editorial maintenance and output in the preview or on the generated page. Also refer to WebClient 5.0 Online Documentation for Editors.

The relevant templates need to be adapted to take advantage of this functionality.

However, Easy-Edit can only be implemented in conjunction with Content Highlighting in JavaClient, since the same display mechanisms are used for both functionalities in the templates.

For more information on adapting templates for EasyEdit, refer to Content Highlighting and EasyEdit

Templates must always be adapted to the template set that was configured by the project administrator for this project (see FirstSpirit Manual for Administrators). Either an existing template set (e.g. HTML channel) or a separate template set (e.g. WebClient channel) can be used for the WebClient application.

When adapting a template, make sure that the layout of the pages is correct, including when viewed with control elements displayed (e.g. in a WebClient standalone view) as well as without control elements displayed (e.g. in a JavaClient preview).

WebClient-specific functions – adding sections to WebClient

WebClient offers numerous expansion and adaptation options to simplify complex work steps and to react flexibly to individual requirements.

FirstSpirit offers several classes for FS_BUTTON applications in the WebClient preview (i.e. button integration into an HTML output channel via the fsbutton(...) function). These classes can be used to trigger WebClient-specific functions from the preview, such as adding a section to a page or editing the menu structure of the project.

These classes are described on the WebClient 5.0 > Functions page.

Example: adding a new section
The desired FS_BUTTON handler class (in this case: onClick="class:NewSection") is simply specified in the form template. The form template defines how the button is displayed (label, style, icon) and the action associated with the button (in this case: add section):

<FS_BUTTON
    name="pt_createSection"
    hidden="yes"
    icon="fs:new"
    onClick="class:NewSection"
    style="firstspirit"
    useLanguages="no">
    <LANGINFOS>
      <LANGINFO lang="*" label="Create section"/>
      <LANGINFO lang="DE" label="Absatz anlegen"/>
    </LANGINFOS>
  </FS_BUTTON>

The relevant HTML code is rendered in the HTML output channel within a $CMS_VALUE(...)$ instruction via the fsbutton(...) function. To do this, the input component (in this case: “pt_createSection”) must be specified via the mandatory parameter editorName. Additional parameters specified are the page ID (#global.page.id) and the content area (in this case: “Content center”) (refer to the fsbutton(...) function for more examples).

<span$CMS_VALUE(
         fsbutton(
              editorName:"pt_createSection",
                   parameter:{
                             "page":#global.page.id,
                              "body":"Content center"
                           }
          )
)$></span>

Working with data records

The following requirements must be fulfilled in order to be able to work with data records in WebClient:

• A template template can be used only then in WebClient if the checkbox “Use in WebClient” is activated on the tab “Properties” of the table template (Template Store in JavaClient).
• Furthermore, an appropriate preview page must be set on the tab “Properties” for a correct display of the data records in WebClient.