1 |
<refentry id="{@id}"> |
2 |
<refnamediv> |
3 |
<refname>Getting Started</refname> |
4 |
<refpurpose>how to begin with phpHtmlLib package</refpurpose> |
5 |
</refnamediv> |
6 |
<refsynopsisdiv> |
7 |
<refsynopsisdivinfo> |
8 |
<author> |
9 |
by Walter A. Boring IV |
10 |
<authorblurb>{@link mailto:waboring@3gstech.com}</authorblurb> |
11 |
</author> |
12 |
<copyright>March 2004, Walter A. Boring IV</copyright> |
13 |
<releaseinfo>phpHtmlLib 2.4.x</releaseinfo> |
14 |
</refsynopsisdivinfo> |
15 |
</refsynopsisdiv> |
16 |
{@toc} |
17 |
<refsect1 id="{@id installing}"> |
18 |
<title>Installing</title> |
19 |
<orderedlist> |
20 |
<listitem> |
21 |
<para>For most people that use Linux with Apache, the install will be |
22 |
very easy. You just need to copy the untared package directory phphtmllib-2.4.1 |
23 |
to your DOCUMENT_ROOT and rename the directory to 'phphtmllib'. |
24 |
</para> |
25 |
</listitem> |
26 |
<listitem> |
27 |
<para>Then you just include the main include file inside phphtmllib.</para> |
28 |
</listitem> |
29 |
<listitem> |
30 |
<para>phpHtmlLib is now installed</para> |
31 |
</listitem> |
32 |
</orderedlist> |
33 |
</refsect1> |
34 |
<refsect1 id="{@id impatient}"> |
35 |
<title>Overview for the impatient</title> |
36 |
<para>You can't wait to read the full documentation and tutorials, so you write few lines |
37 |
of code as below ... |
38 |
</para> |
39 |
<para> |
40 |
<unorderedlist> |
41 |
<listitem> |
42 |
<para>From the shell move the phphtmllib directory to your DOCUMENT_ROOT</para> |
43 |
</listitem> |
44 |
<listitem> |
45 |
<para>Create an include script.</para> |
46 |
<para> |
47 |
<example><![CDATA[<?php |
48 |
$phphtmllib = $_SERVER["DOCUMENT_ROOT"] . "/phphtmllib"; |
49 |
include_once($phphtmllib."/includes.inc"); |
50 |
?>]]> |
51 |
</example> |
52 |
</para> |
53 |
</listitem> |
54 |
<listitem> |
55 |
<para>phpHtmlLib is now installed and ready to be used.</para> |
56 |
</listitem> |
57 |
</unorderedlist> |
58 |
</para> |
59 |
</refsect1> |
60 |
<refsect1 id="{@id intro}"> |
61 |
<title>Introduction</title> |
62 |
<para> |
63 |
I have tried to make the phpHtmlLib fairly easy to install |
64 |
and to use on anyone's current running site. There are a few assumptions |
65 |
I've made, but it shouldn't be a problem for 99% of the folks out there. I |
66 |
haven't tested the libs in a windows environment, as I don't have a M$ O.S. |
67 |
installed anywhere in my house. If you encounter any issues, please let me |
68 |
know. I welcome any and all feedback. |
69 |
</para> |
70 |
</refsect1> |
71 |
<refsect1 id="{@id pkg-overview}"> |
72 |
<title>Package Overview</title> |
73 |
<para> |
74 |
phpHtmlLib provides 3 main classes to help you build Tags: |
75 |
</para> |
76 |
<refsect2 id="{@id class-bar}"> |
77 |
<title>Global Classes</title> |
78 |
<para> |
79 |
<unorderedlist> |
80 |
<listitem>Container |
81 |
<para>This class is nothing more then a container widget. It lets you |
82 |
add data into it, and it will render each item indented properly |
83 |
so it works with the rest of the libs. |
84 |
</para> |
85 |
</listitem> |
86 |
<listitem>XMLTagClass |
87 |
<para>This class is a child of the Container class and is for building and rendering |
88 |
an XML tag. This class is the base class for the HTMLTagClass. |
89 |
</para> |
90 |
</listitem> |
91 |
<listitem>HTMLTagClass |
92 |
<para>Base class for all HTML Tag classes. Tag class renders an html tag, its |
93 |
attributes, the content (if any), and close tag (if needed). |
94 |
</para> |
95 |
</listitem> |
96 |
</unorderedlist> |
97 |
</para> |
98 |
</refsect2> |
99 |
<refsect2 id="{@id class-dm}"> |
100 |
<title>Document/Page Classes</title> |
101 |
<para> |
102 |
<unorderedlist> |
103 |
<listitem>XMLDocumentClass |
104 |
<para>This class lets you build a complete xml document and render it.</para> |
105 |
</listitem> |
106 |
<listitem>HTMLPageClass |
107 |
<para>class the constructs and renders an entire HTML/XHTML document.</para> |
108 |
</listitem> |
109 |
<listitem>PageWidget |
110 |
<para>This child class of the HTMLPageClass is used to build content |
111 |
for an entire page. It uses the HTMLPageClass widget from phphtmllib |
112 |
to render the final output.</para> |
113 |
</listitem> |
114 |
</unorderedlist> |
115 |
</para> |
116 |
</refsect2> |
117 |
<refsect2 id="{@id class-ui}"> |
118 |
<title>HTML Widgets</title> |
119 |
<para> |
120 |
<unorderedlist> |
121 |
<listitem>BaseWidget |
122 |
<para>this is the base widget class, that all widgets |
123 |
are based off of. It provides some basic members and methods. |
124 |
</para> |
125 |
</listitem> |
126 |
<listitem>CSSBuilder |
127 |
<para>This class is a widget for constructing and rendering css. |
128 |
It exports API's for adding classes, ids and their attributes. |
129 |
It can render as either a stand alone foo.css type of file, with the appropriate |
130 |
httpd header, or as part of a |
131 |
style tag's content that lives as part of an html |
132 |
document. |
133 |
</para> |
134 |
</listitem> |
135 |
<listitem>CSSContainer |
136 |
<para>This class is a container for CSSBuilder objects. |
137 |
It is meant to make the theming of many CSSBuilder objects easy to manage. |
138 |
</para> |
139 |
</listitem> |
140 |
</unorderedlist> |
141 |
</para> |
142 |
</refsect2> |
143 |
</refsect1> |
144 |
</refentry> |