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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
<refentry id="vc_include">
<refmeta>
<refentrytitle>include</refentrytitle>
<refmiscinfo>vspx_control</refmiscinfo>
</refmeta>
<refnamediv>
<refname>include</refname>
<refpurpose>A place where the source code of other page should be inserted.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="vc_syn_include">
<funcprototype id="vc_proto_include">
<funcdef>
<<function>include</function> <attribute>
<parameter>url</parameter> (required) </attribute>
<attribute>
<parameter>active</parameter> (optional) </attribute>
<attribute>
<parameter>initial-active</parameter> (optional) </attribute>
<attribute>
<parameter>debug-srcfile</parameter> (optional) </attribute>
<attribute>
<parameter>debug-srcline</parameter> (optional) </attribute>
<attribute>
<parameter>debug-log</parameter> (optional) </attribute>
/></funcdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="vc_desc_include">
<title>Description</title>
<para>The VSPX compiler replaces this control with the content of another page.
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 compilation of VSPX into Virtuoso/PL, hence the include can contain either vspx or static HTML 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.
This element will not be instantiated.
instead of instantiating it will be replaced with content of the specified document.
The included page may or may not contain a 'page' element.
If a 'page' element is found in the included file
this will be skipped in the resulting page.
Also names of controls in the included file MUST NOT conflict with names of controls in the top level page or other included content.
</para>
</refsect1>
<refsect1 id="vc_attrs_include">
<title>Attributes</title>
<formalpara>
<title>url</title>
<para>URL of file to be included. If relative then the base is the page where the control resides.
E.g. If '/home/pageA' includes 'subdir1/pageB' and the included page includes 'subdir2/pageC' then 'pageC' should reside
in '/home/subdir1/subdir2', not in '/home/subdir2'.
</para>
</formalpara>
<formalpara>
<title>active = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>A data bound value to enable or disable the link. The default is '1' meaning 'enable'.</para>
</formalpara>
<formalpara>
<title>initial-active = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
</title>
<para>A data bound value to enable or disable the link. The default is '1' meaning 'enable'.
Unlike 'active' attribute, this one is effective only when the page is displayed in the first time, not after user posts data back to the page.</para>
</formalpara>
<formalpara>
<title>debug-srcfile</title>
<para>URI of the source document where the tag comes from.</para>
</formalpara>
<formalpara>
<title>debug-srcline</title>
<para>Line number in the source document where the tag comes from.</para>
</formalpara>
<formalpara>
<title>debug-log</title>
<para>This defines what sort of data are saved to the debugging log.
</para>
</formalpara>
</refsect1>
<refsect1 id="vc_ex_include">
<title>Examples</title>
<example id="vc_ex_include__0">
<title>
Include a common back-link into the end of page
</title>
<para>
<?xml version="1.0"?>
<!--
-
- $Id: include__0.vspx,v 1.2 2006/08/16 00:04:15 source Exp $
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2006 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
-
-
If the file footer.xml is placed in the same directory where this sample page is located
and contains the paragraph
<P><a href="index.vspx">Back to index</a></P>
then the resulting page will have additional paragraph at the end.
</para>
<screen>
<v:page name="include__0" xmlns:v="http://www.openlinksw.com/vspx/">
<html>
<head><title>VSPX samples | v:include</title></head>
<body>
<p>The link after the horizontal ruler is included from footer.xml</p>
<hr/>
<v:include url="footer.xml"/> <!-- this will include the file described above -->
</body>
</html>
</v:page>
</screen>
</example>
</refsect1>
</refentry>
|
