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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision: 322205 $ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="hwapi.content">
<refnamediv>
<refname>hw_api::content</refname>
<refpurpose>Returns content of an object</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>HW_API_Content</type><methodname>hw_api::content</methodname>
<methodparam><type>array</type><parameter>parameter</parameter></methodparam>
</methodsynopsis>
<para>
This function returns the content of a document as an object of type
<classname>hw_api_content</classname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>parameter</parameter></term>
<listitem>
<para>
The parameter array contains the required elements 'objectidentifier'
and the optional element 'mode'. The mode can be one of the constants
<constant>HW_API_CONTENT_ALLLINKS</constant>,
<constant>HW_API_CONTENT_REACHABLELINKS</constant> or
<constant>HW_API_CONTENT_PLAIN</constant>.
</para>
<para>
<constant>HW_API_CONTENT_ALLLINKS</constant> means to insert all
anchors even if the destination is not reachable.
</para>
<para>
<constant>HW_API_CONTENT_REACHABLELINKS</constant> tells this method
to insert only reachable links and
<constant>HW_API_CONTENT_PLAIN</constant> will lead to document
without any links.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns an instance of <classname>hw_api_content</classname>.
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
