File: README

package info (click to toggle)
librdf-rdfa-generator-perl 0.200-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 252 kB
  • sloc: perl: 885; sh: 4; makefile: 2
file content (166 lines) | stat: -rw-r--r-- 6,838 bytes parent folder | download
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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
NAME
    RDF::RDFa::Generator - Generate data for RDFa serialization

DESCRIPTION
  Constructor
    `$gen = RDF::RDFa::Generator->new(style => $style, %options)`
        Creates a new generator object. $style is one of the following
        case-sensitive strings: 'HTML::Head' (the default), 'HTML::Hidden' or
        'HTML::Pretty'. You can also construct an object like this:

          $gen = RDF::RDFa::Generator::HTML::Head->new(%options);

        Options include:

        *   base - the base URL where the output data will be published. This
            allows in some cases for the generated RDFa to include relative
            URIs.

        *   data_context - if non-null, an Attean Blank or IRI object or an
            RDF::Trine::Node which indicates the context (named graph)
            containing the data to generate RDFa for.

        *   namespacemap - a URI::NamespaceMap object containing preferred
            CURIE prefixes. This is the preferred method, see note below.

        *   namespaces - a {prefix=>uri} hashref of preferred CURIE prefixes.

        *   ns - a {uri=>prefix} hashref of preferred CURIE prefixes.
            DEPRECATED - use namespaces instead.

        *   prefix_attr - use the @prefix attribute for CURIE prefixes (RDFa
            1.1 only). Boolean, defaults to false.

        *   safe_xml_literals - prevents XML literals from injecting arbitrary
            XHTML into the output. Boolean, defaults to FALSE.

        *   title - assign a <title> element for generated XHTML documents.

        *   version - set generated RDFa version. Valid values are '1.0' (the
            default) or '1.1'.

  Public Methods
    `$gen->create_document($model, %opts)`
        Creates a new RDFa file containing triples. $model is an
        RDF::Trine::Model object providing the triples. Returns an
        XML::LibXML::Document object suitable for serializing using its
        `toString` method.

        If you're planning on serving the RDFa with the text/html media type,
        then it is recommended that you use HTML::HTML5::Writer to serialize
        the document rather than `toString`.

        Can also be called as a class method:

         $document = RDF::RDFa::Generator->create_document($model)
         # Same as:
         # $document = RDF::RDFa::Generator->new->create_document($model)

        Options can also be passed as a HASH. This is typically used for
        style-specific options.

    `$gen->inject_document($document, $model)`
        Injects an existing document with triples. $document is an
        XML::LibXML::Document to inject, or a well-formed XML string. $model
        is an RDF::Trine::Model object providing the triples. Returns an
        XML::LibXML::Document object suitable for serializing using its
        `toString` method.

        See `create_document` for information about serving the RDFa with the
        text/html media type.

        Can also be called as a class method. See `create_document` for
        details.

    `$gen->nodes($model)`
        Provides triple-laden XML::LibXML::Elements to be added to a document.
        $model is an RDF::Trine::Model object providing the triples. If called
        in list context, returns a list of XML::LibXML::Element objects which
        can be added to a document; otherwise returns an XML::LibXML::NodeList
        containing a list of such elements.

        Can also be called as a class method. See `create_document` for
        details.

        The HTML::Pretty generator can be passed a couple of additional
        options:

          $gen->nodes($model, notes_heading=>'Additional Info', notes=>\@notes);

        The notes are a list of RDF::RDFa::Generator::HTML::Pretty::Note
        objects which are added as notes to the end of each subject's data.

UPGRADING TO 0.200
    The recommended upgrade path is to migrate your application to use Attean
    rather than RDF::Trine as your RDF library. If that is not an option, you
    may continue to use RDF::Trine, by using a compatibility layer. If you are
    using this module directly, to upgrade from earlier releases, you would
    simply add

     use RDF::TrineX::Compatibility::Attean;

    alongside the import of this module. It is in a separate distribution that
    needs to be installed. If you use the RDF::Trine::Serializer methods, you
    should instead use RDF::Trine::Serializer::RDFa.

NOTE
    Version 0.200 introduced a large number of changes to be compatible with
    both Attean and RDF::Trine. Some of these were backwards-incompatible,
    some were to support new features, such as the use of URI::NamespaceMap.

  Backwards-incompatible changes
    The methods `serialize_model_to_file`, `serialize_model_to_string`,
    `serialize_iterator_to_file` and `serialize_iterator_to_string` that were
    provided for compatibility with the RDF::Trine::Serializer interface have
    been moved to a module RDF::Trine::Serializer::RDFa that has to be
    installed separately to use this with RDF::Trine.

    `data_context` previously accepted a plain-text string URI. Now, it
    requires an appropriate object, as documented.

    Since RDF 1.1 abandons untyped literals, this module also ceases to emit
    them.

  Namespace mappings
    The way namespace mappings are handled have been rewritten. Now, the
    preferred method to add them is to pass an URI::NamespaceMap object to
    `namespacemap`. This will override any other options.

    The namespace mappings for the following prefixes will always be added:
    `rdfa`, `rdf`, `rdfs` and `xsd`.

    If URI::NamespaceMap is not used, but `namespaces` is given as a hashref
    of prefix-URI pairs, the pairs will be added. If neither are given, all
    mappings from RDF::NS::Curated, which includes all if RDFa Initial Context
    will be added. Finally, any pairs from the deprecated `ns` option will be
    added, but a warning will be emitted.

BUGS
    Please report any bugs to
    <https://github.com/kjetilk/p5-rdf-rdfa-generator/issues>.

SEE ALSO
    You may want to use the framework-specific frontends:
    RDF::Trine::Serializer::RDFa or AtteanX::Serializer::RDFa.

    Other relevant modules:

    HTML::HTML5::Writer, XML::LibXML, RDF::RDFa::Parser, RDF::Trine,
    URI::NamespaceMap, Attean.

AUTHOR
    Toby Inkster <tobyink@cpan.org>.

    Kjetil Kjernsmo <kjetilk@cpan.org>.

COPYRIGHT AND LICENCE
    Copyright (C) 2010 by Toby Inkster, 2017, 2018 Kjetil Kjernsmo

    This library is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself, either Perl version 5.8 or, at your
    option, any later version of Perl 5 you may have available.

  Icons
    RDF::RDFa::Generator::HTML::Pretty uses the FamFamFam Silk icons; see
    <http://famfamfam.com/lab/icons/silk/>.