Main -> Documentation -> The WebZ Interface -> WebZ Rules-Based Formatting
WebZ Rules-Based Formatting

Introduction

Beginning in SiteSearch 4.1.0, rules-based formatting becomes an option for you to define how data is formatted for presentation in the WebZ Interface. It departs from existing WebZ formatting functionality in that it does not require you to create or modify code in order to implement it.


A New Formatting Approach

Instead of programming and compiling Java source code files, implementing WebZ rules-based formatting involves:

Note: The directory, <WebZ_root>classes/ORG/oclc/fmts/rules should contain most of the basic formatting classes that you will need to define the elements in a typical display. If one of these classes is not suitable, however, the flexibility still remains in WebZ for you to create your own formatting class.

WebZ Rules-Based Formatting Functionality

With the release of SiteSearch 4.1, new formatting capabilities are available for displaying the records that you retrieve using the WebZ Interface. To discover more about these capabilities, the functions underneath them, and how they can be implemented into your own interface, visit the topics below.

Topic

Description of Topic

Rules-Based Formatting Process Overview

This topic provides an illustrated overview of how the rules-based formatting process works within the WebZ Interface. It identifies some of the files and constructs that you can expect to use when employing rules-based formatting to display your records.

Formatting Configuration Files

This topic introduces you to formatting configuration files and it points out the major constructs in these files that make it possible for you to configure rules-based formatting for your interface. Additionally, you are given the path to a directory containing predefined formatting configuration files shipped with SiteSearch, starting with the 4.1.0 release.

Formatting Specifications

The central constructs of rules-based formatting are defined under this topic. Examples are provided and syntax is broken down into parameters and values.

Formatting Classes

This topic defines the key concept of formatting classes. A example is provided to demonstrate how a formatting class creates an element in a display.

Display Formatting Configuration Files This topic identifies .ini files (in addition to formatting configuration files) that are involved in the formatting process. Examples of the files and their constructs are provided to demonstrate how data is formatted for display in a browser.
Formatting Your Display Eight procedures for implementing WebZ rules-based formatting into your interface are provided under this topic. Following these procedures, you should be able to define or modify a format.

See Also

Create a New Formatting Class


[Main][Documentation][Support][Technical Reference][Community][Glossary][Search]

Last Modified: