deprecated/buildtools/buildsystemtools/lib/XML/DOM/EntityReference.pod
author lorewang
Wed, 01 Dec 2010 16:05:36 +0800
changeset 715 e0739b8406dd
parent 655 3f65fd25dfd4
permissions -rw-r--r--
Specify extenal tool with path
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
655
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
     1
=head1 NAME
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
     2
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
     3
XML::DOM::EntityReference - An XML ENTITY reference in XML::DOM
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
     4
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
     5
=head1 DESCRIPTION
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
     6
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
     7
XML::DOM::EntityReference extends L<XML::DOM::Node>.
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
     8
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
     9
EntityReference objects may be inserted into the structure model when
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    10
an entity reference is in the source document, or when the user wishes
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    11
to insert an entity reference. Note that character references and
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    12
references to predefined entities are considered to be expanded by the
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    13
HTML or XML processor so that characters are represented by their
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    14
Unicode equivalent rather than by an entity reference. Moreover, the
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    15
XML processor may completely expand references to entities while
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    16
building the structure model, instead of providing EntityReference
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    17
objects. If it does provide such objects, then for a given
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    18
EntityReference node, it may be that there is no Entity node
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    19
representing the referenced entity; but if such an Entity exists, then
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    20
the child list of the EntityReference node is the same as that of the
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    21
Entity node. As with the Entity node, all descendants of the
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    22
EntityReference are readonly.
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    23
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    24
The resolution of the children of the EntityReference (the replacement
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    25
value of the referenced Entity) may be lazily evaluated; actions by the
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    26
user (such as calling the childNodes method on the EntityReference
3f65fd25dfd4 sync up SVN codes
kelvzhu
parents:
diff changeset
    27
node) are assumed to trigger the evaluation.