.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2011
.\"   National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts.  A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "mtext_serialize" 3m17n "Mon Sep 25 2023" "Version 1.8.4" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mtext_serialize \- 


.SH SYNOPSIS
\fBMText\fP*
\fBmtext_serialize\fP (\fBMText\fP *
\fImt\fP, int
\fIfrom\fP, int
\fIto\fP, \fBMPlist\fP *
\fIproperty_list\fP)


.SH DESCRIPTION
.PP
.nf
@brief Serialize text properties in an M\-text.

The mtext_serialize() function serializes the text between @b from
and @b to in M\-text @b mt.  The serialized result is an M\-text in a
form of XML.  @b property_list limits the text properties to be
serialized. Only those text properties whose key 

@li appears as the value of an element in @b property_list, and
@li has the symbol property #Mtext_prop_serializer

are serialized as a "property" element in the resulting XML
representation.

The DTD of the generated XML is as follows:

.fi
.fi
 
.PP
.nf
<!DOCTYPE mtext [
  <!ELEMENT mtext (property*,body+)>
  <!ELEMENT property EMPTY>
  <!ELEMENT body (#PCDATA)>
  <!ATTLIST property key CDATA #REQUIRED>
  <!ATTLIST property value CDATA #REQUIRED>
  <!ATTLIST property from CDATA #REQUIRED>
  <!ATTLIST property to CDATA #REQUIRED>
  <!ATTLIST property control CDATA #REQUIRED>
 ]>

.fi
.fi
 
.PP
.nf
This function depends on the libxml2 library.  If the m17n library
is configured without libxml2, this function always fails.

@par Return value:
If the operation was successful, mtext_serialize() returns an
M\-text in the form of XML.  Otherwise it returns @c NULL and assigns an
error code to the external variable #merror_code.

@par See Also:
mtext_deserialize(), #Mtext_prop_serializer   

.fi
.fi
 
.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2011 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License 
<http://www.gnu.org/licenses/fdl.html>.