| 1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 3 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 4 |
<head> |
| 5 |
<!-- template designed by Marco Von Ballmoos --> |
| 6 |
<title>Getting Started</title> |
| 7 |
<link rel="stylesheet" href="../media/stylesheet.css" /> |
| 8 |
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> |
| 9 |
</head> |
| 10 |
<body> |
| 11 |
<div class="page-body"> |
| 12 |
|
| 13 |
<table class="tutorial-nav-box"> |
| 14 |
<tr> |
| 15 |
<td style="width: 30%"> |
| 16 |
<a href="../phpHtmlLib/tutorial_phpHtmlLib.pkg.html" class="nav-button">Previous</a> |
| 17 |
</td> |
| 18 |
<td style="text-align: center"> |
| 19 |
<a href="../phpHtmlLib/tutorial_phpHtmlLib.pkg.html" class="nav-button">Up</a> |
| 20 |
</td> |
| 21 |
<td style="text-align: right; width: 30%"> |
| 22 |
<span class="nav-button-disabled">Next</span> |
| 23 |
</td> |
| 24 |
</tr> |
| 25 |
<tr> |
| 26 |
<td style="width: 30%"> |
| 27 |
<span class="detail">phpHtmlLib Guide</span> |
| 28 |
</td> |
| 29 |
<td style="text-align: center"> |
| 30 |
<span class="detail">phpHtmlLib Guide</span> |
| 31 |
</td> |
| 32 |
<td style="text-align: right; width: 30%"> |
| 33 |
</td> |
| 34 |
</tr> |
| 35 |
</table> |
| 36 |
|
| 37 |
<div><a name=""></a><div class="ref-title-box"><h1 class="ref-title">Getting Started</h1> |
| 38 |
<h2 class="ref-purpose">how to begin with phpHtmlLib package</h2></div> |
| 39 |
<div class="ref-synopsis"><span class="author">by Walter A. Boring IV |
| 40 |
<div class="author-blurb"><a href="mailto:waboring@3gstech.com">mailto:waboring@3gstech.com</a></div></span> |
| 41 |
<div class="notes">March 2004, Walter A. Boring IV</div> |
| 42 |
<div class="release-info">(phpHtmlLib 2.4.x)</div></div> |
| 43 |
<h1 class="title">Table of Contents</h1> |
| 44 |
<ul class="toc"> |
| 45 |
|
| 46 |
|
| 47 |
<li><a href="../phpHtmlLib/tutorial_gettingstarted.pkg.html#installing">Installing</a></li> |
| 48 |
|
| 49 |
<li><a href="../phpHtmlLib/tutorial_gettingstarted.pkg.html#impatient">Overview for the impatient</a></li> |
| 50 |
|
| 51 |
<li><a href="../phpHtmlLib/tutorial_gettingstarted.pkg.html#intro">Introduction</a></li> |
| 52 |
|
| 53 |
<li><a href="../phpHtmlLib/tutorial_gettingstarted.pkg.html#pkg-overview">Package Overview</a></li> |
| 54 |
|
| 55 |
<ul class="toc"> |
| 56 |
<li><a href="../phpHtmlLib/tutorial_gettingstarted.pkg.html#pkg-overview.class-bar">Global Classes</a></li> |
| 57 |
|
| 58 |
|
| 59 |
<li><a href="../phpHtmlLib/tutorial_gettingstarted.pkg.html#pkg-overview.class-dm">Document/Page Classes</a></li> |
| 60 |
|
| 61 |
<li><a href="../phpHtmlLib/tutorial_gettingstarted.pkg.html#pkg-overview.class-ui">HTML Widgets</a></li> |
| 62 |
</ul> |
| 63 |
</ul> |
| 64 |
|
| 65 |
<span><a name="installing"></a><h2 class="title">Installing</h2><ol><li><p>For most people that use Linux with Apache, the install will be |
| 66 |
very easy. You just need to copy the untared package directory phphtmllib-2.4.1 |
| 67 |
to your DOCUMENT_ROOT and rename the directory to 'phphtmllib'.</p></li> |
| 68 |
<li><p>Then you just include the main include file inside phphtmllib.</p></li> |
| 69 |
<li><p>phpHtmlLib is now installed</p></li></ol></span> |
| 70 |
<span><a name="impatient"></a><h2 class="title">Overview for the impatient</h2><p>You can't wait to read the full documentation and tutorials, so you write few lines |
| 71 |
of code as below ...</p> |
| 72 |
<p><li><p>From the shell move the phphtmllib directory to your DOCUMENT_ROOT</p></li> |
| 73 |
<li><p>Create an include script.</p> |
| 74 |
<p><pre class="example"><pre><?php |
| 75 |
$phphtmllib = $_SERVER["DOCUMENT_ROOT"] . "/phphtmllib"; |
| 76 |
include_once($phphtmllib."/includes.inc"); |
| 77 |
?></pre></pre></p></li> |
| 78 |
<li><p>phpHtmlLib is now installed and ready to be used.</p></li></p></span> |
| 79 |
<span><a name="intro"></a><h2 class="title">Introduction</h2><p>I have tried to make the phpHtmlLib fairly easy to install |
| 80 |
and to use on anyone's current running site. There are a few assumptions |
| 81 |
I've made, but it shouldn't be a problem for 99% of the folks out there. I |
| 82 |
haven't tested the libs in a windows environment, as I don't have a M$ O.S. |
| 83 |
installed anywhere in my house. If you encounter any issues, please let me |
| 84 |
know. I welcome any and all feedback.</p></span> |
| 85 |
<span><a name="pkg-overview"></a><h2 class="title">Package Overview</h2><p>phpHtmlLib provides 3 main classes to help you build Tags:</p> |
| 86 |
<span><a name="pkg-overview.class-bar"></a><h3 class="title">Global Classes</h3><p><li>Container |
| 87 |
<p>This class is nothing more then a container widget. It lets you |
| 88 |
add data into it, and it will render each item indented properly |
| 89 |
so it works with the rest of the libs.</p></li> |
| 90 |
<li>XMLTagClass |
| 91 |
<p>This class is a child of the Container class and is for building and rendering |
| 92 |
an XML tag. This class is the base class for the HTMLTagClass.</p></li> |
| 93 |
<li>HTMLTagClass |
| 94 |
<p>Base class for all HTML Tag classes. Tag class renders an html tag, its |
| 95 |
attributes, the content (if any), and close tag (if needed).</p></li></p></span> |
| 96 |
<span><a name="pkg-overview.class-dm"></a><h3 class="title">Document/Page Classes</h3><p><li>XMLDocumentClass |
| 97 |
<p>This class lets you build a complete xml document and render it.</p></li> |
| 98 |
<li>HTMLPageClass |
| 99 |
<p>class the constructs and renders an entire HTML/XHTML document.</p></li> |
| 100 |
<li>PageWidget |
| 101 |
<p>This child class of the HTMLPageClass is used to build content |
| 102 |
for an entire page. It uses the HTMLPageClass widget from phphtmllib |
| 103 |
to render the final output.</p></li></p></span> |
| 104 |
<span><a name="pkg-overview.class-ui"></a><h3 class="title">HTML Widgets</h3><p><li>BaseWidget |
| 105 |
<p>this is the base widget class, that all widgets |
| 106 |
are based off of. It provides some basic members and methods.</p></li> |
| 107 |
<li>CSSBuilder |
| 108 |
<p>This class is a widget for constructing and rendering css. |
| 109 |
It exports API's for adding classes, ids and their attributes. |
| 110 |
It can render as either a stand alone foo.css type of file, with the appropriate |
| 111 |
httpd header, or as part of a |
| 112 |
style tag's content that lives as part of an html |
| 113 |
document.</p></li> |
| 114 |
<li>CSSContainer |
| 115 |
<p>This class is a container for CSSBuilder objects. |
| 116 |
It is meant to make the theming of many CSSBuilder objects easy to manage.</p></li></p></span></span></div> |
| 117 |
|
| 118 |
<table class="tutorial-nav-box"> |
| 119 |
<tr> |
| 120 |
<td style="width: 30%"> |
| 121 |
<a href="../phpHtmlLib/tutorial_phpHtmlLib.pkg.html" class="nav-button">Previous</a> |
| 122 |
</td> |
| 123 |
<td style="text-align: center"> |
| 124 |
<a href="../phpHtmlLib/tutorial_phpHtmlLib.pkg.html" class="nav-button">Up</a> |
| 125 |
</td> |
| 126 |
<td style="text-align: right; width: 30%"> |
| 127 |
<span class="nav-button-disabled">Next</span> |
| 128 |
</td> |
| 129 |
</tr> |
| 130 |
<tr> |
| 131 |
<td style="width: 30%"> |
| 132 |
<span class="detail">phpHtmlLib Guide</span> |
| 133 |
</td> |
| 134 |
<td style="text-align: center"> |
| 135 |
<span class="detail">phpHtmlLib Guide</span> |
| 136 |
</td> |
| 137 |
<td style="text-align: right; width: 30%"> |
| 138 |
</td> |
| 139 |
</tr> |
| 140 |
</table> |
| 141 |
|
| 142 |
<p class="notes" id="credit"> |
| 143 |
Documentation generated on Thu, 1 Apr 2004 09:37:05 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC2</a> |
| 144 |
</p> |
| 145 |
</div></body> |
| 146 |
</html> |