A tutorial/howto for HTML_Progress

September 9, 2003

By Laurent Laville

Table of Contents

  1. What does it ?
  2. How to get it
  3. How to use it
  4. More on subject
  5. The End

  1. What does it ?

    It just put an horizontal or vertical loading bar on XHTML document of your choice, and allows user to wait and see progress status during a long procedure such an installation. You get a more or less decent result with just the basic settings, but it's also highly configurable, so you can almost get what you want.
    HTML_Progress package has more than 20 examples companion. Don't forget to have a look on them for some real uses and how to configure look and feel of your loading bars ... Go to
    references list.

    [Top]

  2. How to get it

    The recommended way is to use the pear-installer and then type
    pear install HTML_Progress-0.6.1.tgz 
    
    (the pear installer should be installed by default with PHP 4.3).
    You can get the class directly from PEAR website:
    http://pear.php.net/package-info.php?package=HTML_Progress

    [Top]

  3. How to use it

    Prerequisites

    You need to have 2 classes installed before to use HTML_Progress package.
    • HTML_CSS is a class for generating CSS declarations
    • HTML_Page package provides a simple interface for generating an XHTML compliant page

    [Top]

    Where to get ressources needed

    Even if it's still in beta state (2.0.0b5 on 2003-07-29) you can get the HTML_Page's class directly from the PEAR website
    (
    http://pear.php.net/package-info.php?package=HTML_Page).

    You can get the HTML_CSS's class directly from the PEAR website
    (http://pear.php.net/package-info.php?package=HTML_CSS).

    Author of these both classes is Klaus Gunther. Thanks to him to help me to make my dream a reality !

    [Top]

    The most simple example

    See
    how to create your first horizontal and/or vertical progress bar.

    [Top]

    Add text percent info on bar side

    It's so easy to make percent text info visible .

    [Top]

    Javascript customization

    Another level of customization with help of JavaScript.

    [Top]

    getProgress API usage

    How determines current value of progress bar.

    [Top]

    Plain bar

    How to make easily a horizontal and/or vertical plain bar.

    [Top]

    Template engine integration

    How to include your own progress bar with a basic template system.

    [Top]

    Message line

    Last but not least, how to put a message line that will display important information during progress.

    [Top]

  4. More on subject

    Searching a javascript solution for :

    [Top]

  5. The End

    For questions and remarks, contact me pear@laurent-laville.org.

    [Top]


Article URL: http://pear.laurent-laville.org/HTML/Progress/docs/index.html
Article publication: September 9, 2003
Article author: Laurent Laville

$Id: index.html,v 1.5 2003/09/09 21:52:55 Farell Exp $