KTAPI.pkg
1.73 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
<refentry id="{@id}">
<refnamediv>
<refname>KTAPI User Guide</refname>
<refpurpose>Documentation, examples and tutorials for the KnowledgeTree API (KTAPI)</refpurpose>
</refnamediv>
<refsynopsisdiv>
<author>
KnowledgeTree Team
<authorblurb>
This documentation is maintained by the {@link mailto:info@knowledgetree.com KnowledgeTree Team}.
</authorblurb>
</author>
</refsynopsisdiv>
{@toc}
<refsect1 id="{@id intro}">
<title>Introduction</title>
<para>
<strong>PLEASE NOTE: This is currently just a place holder for the API documentation and tutorials that are to come.</strong><br>
<br>Many examples can already be found in the classes and methods documentation. We intend updating and adding to this documentation each iteration.
</para>
<refsect2 id="{@id examples}">
<title>Examples</title>
<para>
KTAPI examples can be found here.
</para>
<refsect3 id="{@id example1}">
<title>Example 1</title>
<para>
This is KTAPI example one.
<example><title>Example 1</title>
<programlisting role="tutorial">
public function KTAPI_Error($msg, $obj = null)
{
if (PEAR::isError($obj))
{
parent::PEAR_Error($msg . ' - ' . $obj->getMessage());
}
else
{
parent::PEAR_Error($msg);
}
}
</programlisting>
</example>
</para>
</refsect3>
</refsect2>
</refsect1>
</refentry>