<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>comment-escape-string</title><link rel="stylesheet" type="text/css" href="../reference.css"><meta name="generator" content="DocBook XSL Stylesheets V1.78.1"><link rel="home" href="../index.html" title="DocBook XSL Stylesheets: Reference Documentation"><link rel="up" href="generallibrary.html" title="General Library Templates"><link rel="prev" href="xpath.location.html" title="xpath.location"><link rel="next" href="comment-escape-string.recursive.html" title="comment-escape-string.recursive"><link rel="copyright" href="copyright.html" title="License"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">comment-escape-string</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="xpath.location.html">Prev</a> </td><th width="60%" align="center">General Library Templates</th><td width="20%" align="right"> <a accesskey="n" href="comment-escape-string.recursive.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="comment-escape-string"></a><div class="titlepage"></div> <div class="refnamediv"><h2>comment-escape-string</h2><p> comment-escape-string — Prepare a string for inclusion in an XML comment </p></div> <div class="refsect1"><a name="idp9568688"></a><h2>Description</h2> <p>The <code class="function">comment-escape-string</code> template returns a string that has been transformed so that it can safely be output as an XML comment. Internal occurrences of "--" will be replaced with "- -" and a leading and/or trailing space will be added to the string, if necessary.</p> <a name="comment-escape-string.frag"></a><pre class="programlisting"> <xsl:template name="comment-escape-string"> <xsl:param name="string" select="''"></xsl:param> <xsl:if test="starts-with($string, '-')"> <xsl:text> </xsl:text> </xsl:if> <xsl:call-template name="comment-escape-string.recursive"> <xsl:with-param name="string" select="$string"></xsl:with-param> </xsl:call-template> <xsl:if test="substring($string, string-length($string), 1) = '-'"> <xsl:text> </xsl:text> </xsl:if> </xsl:template> </pre> </div> </div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="xpath.location.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="generallibrary.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="comment-escape-string.recursive.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">xpath.location </td><td width="20%" align="center"><a accesskey="h" href="../index.html">Home</a></td><td width="40%" align="right" valign="top"> comment-escape-string.recursive</td></tr></table></div></body></html>