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
80
81
82
83
84
85
86
87
88
89
90
91
|
<!--
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2018 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
-->
<refentry id="vspx_include">
<refmeta>
<refentrytitle>vspx_include</refentrytitle>
<refmiscinfo>vspx_control</refmiscinfo>
</refmeta>
<refnamediv>
<refname>vspx_include</refname>
<refpurpose>Macro expansion</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="syn_vspx_include">
<funcprototype id="proto_vspx_include">
<funcdef>
<function>include</function>
</funcdef>
<attributes>
<attribute>url (required) </attribute>
</attributes>
<childs />
<class>
<screen><![CDATA[
This element will not be instantiated.
instead of instantiating it wil lbe replaced with content of another document.
]]>
</screen>
</class>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_vspx_include">
<title>Description</title>
<para>
<function>vspx_include</function>A place where the source code of other page should be inserted.
This will include the content from the specified url at this point of the page. The url is relative to the page.
The inclusion will be done before VSPX compile stage, hence the include can contain vspx, HTML or either content.
The only requirement is that the included file be well formed. Note also that if you are using vspx namespace in the include file, it must be declared as such.
</para>
</refsect1>
<refsect1 id="attrs_vspx_include">
<title>Attributes</title>
<refsect2>
<title>url</title>
<para>Relative to the page URL of file to be included</para>
</refsect2>
</refsect1>
<refsect1 id="childs_vspx_include">
<title>Children</title>
</refsect1>
<refsect1 id="examples_vspx_include">
<title>Examples</title>
<example id="ex_vspx_include">
<title>Simple example</title>
<para>Include a common back-link
</para>
<screen><![CDATA[
-- footer.xml --
<P><a href="index.vsp">Back to index</a></P>
--- eof footer.xml ---
<v:include url="footer.xml"/> <!-- this will include file above -->
]]>
</screen>
</example>
</refsect1>
</refentry>
|
