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
|
=encoding utf8
=head1 NAME
XML::Compile::Translate::Template - create an XML or PERL example
=head1 INHERITANCE
XML::Compile::Translate::Template
is a XML::Compile::Translate
=head1 SYNOPSIS
my $schema = XML::Compile::Schema->new(...);
print $schema->template(XML => $type, ...);
print $schema->template(PERL => $type, ...);
# script as wrapper for this module
schema2example -f XML ...
=head1 DESCRIPTION
The translator understands schemas, but does not encode that into
actions. This module interprets the parse results of the translator,
and creates a kind of abstract syntax tree from it, which can be used
for documentational purposes. Then, it implements to ways to represent
that knowledge: as an XML or a Perl example of the data-structure which
the schema describes.
Extends L<"DESCRIPTION" in XML::Compile::Translate|XML::Compile::Translate/"DESCRIPTION">.
=head1 METHODS
Extends L<"METHODS" in XML::Compile::Translate|XML::Compile::Translate/"METHODS">.
=head1 DETAILS
Extends L<"DETAILS" in XML::Compile::Translate|XML::Compile::Translate/"DETAILS">.
=head2 Translator options
Extends L<"Translator options" in XML::Compile::Translate|XML::Compile::Translate/"Translator options">.
=head2 Processing Wildcards
Wildcards are not (yet) supported.
=head2 Schema hooks
Hooks are implemented since version 0.82. They can be used to
improve the template output.
=head3 hooks executed before the template is generated
None defined yet.
=head3 hooks executed as replacement
The predefined hook C<COLLAPSE> can be used to remove the extensive
listing of some elements. Usually used with a type of which you
know the structure or which is repeated often.
=head3 hooks for post-processing, after the data is collected
None defined yet.
=head2 Typemaps
Typemaps are currently only available to improve the PERL output.
=head3 Typemaps for PERL template output
You can pass C<< &function_name >> to indicate that the code reference
with variable name C<< $function_name >> will be called. Mind the change
of C<< & >> into C<< $ >>.
When C<< $object_name >> is provided, then that object is an interface
object, which will be called for the indicated type.
In case class name (any bareword will do) is specified, it is shown
as a call to the C<toXML()> instance method call from some data object
of the specified class.
B<. Example: typemaps with template>
$schemas->template(PERL => $some_type, typemap =>
{ $type1 => '&myfunc' # $myfunc->('WRITER', ...)
, $type2 => '$interf' # $interf->($object, ...)
, $type3 => 'My::Class'
});
=head1 SEE ALSO
This module is part of XML-Compile distribution version 1.64,
built on October 21, 2024. Website: F<http://perl.overmeer.net/xml-compile/>
=head1 LICENSE
Copyrights 2006-2024 by [Mark Overmeer <markov@cpan.org>]. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://dev.perl.org/licenses/>
|
