PEAR Progress2 logo

HTML_Progress2 : The Definitive Guide

Preface
Prev     Next

Preface

Table of Contents

Organization of This Book
Pre-requisites

Organization of This Book

This book is divided into five parts, they are:

  • Introduction

    This section contains a gentle introduction to what HTML_Progress2 is and has to offer. Included is general information about installing and using this PEAR package, and answers to frequently asked HTML_Progress2 related questions.

  • Getting Started

    This section is intended to provide a quick introduction to get started understanding, installing, and running the bundle examples.

  • Migrating Guide

    This section is intended to help users to migrate easily all their scripts from version 1.2.x to the major 2.0.0.

  • Reference Guide

    This section describes every API in the HTML_Progress2 package. The description of each function may contain some or all of the following parts:

    • Synopsis

      Shows the structure and prototype of the function.

    • Description

      Gives a description about what the function does.

    • Parameter

      Describes each parameter for the function along with the paramater types and names. Both required and optional parameters are listed.

    • Returns

      Describes the returned value, if the function doesn't fail.

    • Throws

      Describes the returned PEAR_Error objects, if the function fails.

    • Note

      Additional notes and information about the function. An example note would be if the function can be called statically.

    • See

      Links to other related functions or manual entries.

    • Example

      An example use of the function or class.

  • Appendixes

    This section is intended to provide some examples included into the distribution. It will also give a features comparative between HTML_Progress2 and HTML_Progress2_Lite.

HTML_Progress2 : The Definitive Guide v 2.4.0 : April 20, 2007
Prev     Next
HTML_Progress2 Manual  Home  Pre-requisites