This is an automated email from the ASF dual-hosted git repository. markt pushed a commit to branch 8.5.x in repository https://gitbox.apache.org/repos/asf/tomcat.git
The following commit(s) were added to refs/heads/8.5.x by this push: new 5e0374d Standardize XSL files. Fix spelling. 5e0374d is described below commit 5e0374d6380844d85f22f2f2726d6f873cdf89ff Author: John Bampton <jbamp...@users.noreply.github.com> AuthorDate: Sun Jul 5 01:12:22 2020 +1000 Standardize XSL files. Fix spelling. Indents, lowercase HTML tags, blank lines --- modules/jdbc-pool/doc/package.xsl | 81 +++++++++++--------- webapps/docs/changelog.xml | 4 + webapps/docs/tomcat-docs.xsl | 153 ++++++++++++++++++-------------------- webapps/manager/xform.xsl | 133 ++++++++++++++++++--------------- 4 files changed, 194 insertions(+), 177 deletions(-) diff --git a/modules/jdbc-pool/doc/package.xsl b/modules/jdbc-pool/doc/package.xsl index 07f738a..d3fd7ea 100644 --- a/modules/jdbc-pool/doc/package.xsl +++ b/modules/jdbc-pool/doc/package.xsl @@ -25,13 +25,11 @@ <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"> - <!-- Output method --> <xsl:output method="html" - encoding="UTF-8" + encoding="UTF-8" indent="no"/> - <!-- Defined parameters (overrideable) --> <xsl:param name="relative-path" select="'.'"/> <xsl:param name="void-image" select="'/images/void.gif'"/> @@ -54,24 +52,20 @@ <!-- Process an entire document into an HTML page --> <xsl:template match="document"> - <xsl:variable name="project" - select="document('project.xml')/project"/> + <xsl:variable name="project" select="document('project.xml')/project"/> <html> - <head> - <title><xsl:value-of select="project/title"/> - <xsl:value-of select="properties/title"/></title> - </head> - - <body bgcolor="{$body-bg}" text="{$body-fg}" link="{$body-link}" - alink="{$body-link}" vlink="{$body-link}"> + <head> + <title><xsl:value-of select="project/title"/> - <xsl:value-of select="properties/title"/></title> + </head> + <body bgcolor="{$body-bg}" text="{$body-fg}" link="{$body-link}" + alink="{$body-link}" vlink="{$body-link}"> - <h2><xsl:value-of select="properties/title"/>.</h2> - <xsl:apply-templates select="body/section"/> - </body> + <h2><xsl:value-of select="properties/title"/>.</h2> + <xsl:apply-templates select="body/section"/> + </body> </html> - </xsl:template> - <!-- Process a documentation section --> <xsl:template match="section"> <xsl:variable name="name"> @@ -79,19 +73,26 @@ </xsl:variable> <table border="0" cellspacing="0" cellpadding="2"> <!-- Section heading --> - <tr><td bgcolor="{$banner-bg}"> + <tr> + <td bgcolor="{$banner-bg}"> <font color="{$banner-fg}" face="arial,helvetica.sanserif"> - <a name="{$name}"> - <strong><xsl:value-of select="@name"/></strong></a></font> - </td></tr> + <a name="{$name}"> + <strong><xsl:value-of select="@name"/></strong> + </a> + </font> + </td> + </tr> <!-- Section body --> - <tr><td><blockquote> - <xsl:apply-templates/> - </blockquote></td></tr> + <tr> + <td> + <blockquote> + <xsl:apply-templates/> + </blockquote> + </td> + </tr> </table> </xsl:template> - <!-- Process a documentation subsection --> <xsl:template match="subsection"> <xsl:variable name="name"> @@ -99,19 +100,26 @@ </xsl:variable> <table border="0" cellspacing="0" cellpadding="2"> <!-- Subsection heading --> - <tr><td bgcolor="{$sub-banner-bg}"> + <tr> + <td bgcolor="{$sub-banner-bg}"> <font color="{$sub-banner-fg}" face="arial,helvetica.sanserif"> - <a name="{$name}"> - <strong><xsl:value-of select="@name"/></strong></a></font> - </td></tr> + <a name="{$name}"> + <strong><xsl:value-of select="@name"/></strong> + </a> + </font> + </td> + </tr> <!-- Subsection body --> - <tr><td><blockquote> - <xsl:apply-templates/> - </blockquote></td></tr> + <tr> + <td> + <blockquote> + <xsl:apply-templates/> + </blockquote> + </td> + </tr> </table> </xsl:template> - <!-- Process a source code example --> <xsl:template match="source"> <xsl:variable name="void"> @@ -134,9 +142,11 @@ <td bgcolor="{$source-color}" width="1"> <img src="{$void}" width="1" height="1" vspace="0" hspace="0" border="0"/> </td> - <td bgcolor="#ffffff" height="1"><pre> - <xsl:value-of select="."/> - </pre></td> + <td bgcolor="#ffffff" height="1"> + <pre> + <xsl:value-of select="."/> + </pre> + </td> <td bgcolor="{$source-color}" width="1"> <img src="{$void}" width="1" height="1" vspace="0" hspace="0" border="0"/> </td> @@ -156,7 +166,6 @@ </div> </xsl:template> - <!-- Process an attributes list with nested attribute elements --> <xsl:template match="attributes"> <table border="1" cellpadding="5"> diff --git a/webapps/docs/changelog.xml b/webapps/docs/changelog.xml index 333fbc7..b40ba26 100644 --- a/webapps/docs/changelog.xml +++ b/webapps/docs/changelog.xml @@ -62,6 +62,10 @@ list of contexts and the Host Manager application list of hosts so that the output is more consistent. PR provided by Holomark. (markt) </fix> + <fix> + Clean-up / standardize the XSL files used to generate the documentation. + PR provided by John Bampton. (markt) + </fix> </changelog> </subsection> </section> diff --git a/webapps/docs/tomcat-docs.xsl b/webapps/docs/tomcat-docs.xsl index 9c7a01b..a9aa7b4 100644 --- a/webapps/docs/tomcat-docs.xsl +++ b/webapps/docs/tomcat-docs.xsl @@ -20,7 +20,6 @@ <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="3.0"> - <!-- Output method --> <xsl:output method="html" html-version="5.0" @@ -28,7 +27,6 @@ indent="no" doctype-system="about:legacy-compat"/> - <!-- Defined parameters (overrideable) --> <xsl:param name="home-name" select="'The Tomcat Project'"/> <xsl:param name="home-href" select="'https://tomcat.apache.org/'"/> @@ -55,13 +53,13 @@ <!-- Defined variables (non-overrideable) --> <xsl:variable name="project-xml-filename"><xsl:value-of select="$subdir"/>project.xml</xsl:variable> <xsl:variable name="project" - select="document($project-xml-filename)/project"/> + select="document($project-xml-filename)/project"/> <!-- Process an entire document into an HTML page --> <xsl:template match="document"> <html lang="en"> <head> - <!-- Note: XLST seems to always output a + <!-- Note: XSLT seems to always output a <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> when method="html", therefore we can't use @@ -88,40 +86,42 @@ --> <meta name="author" content="{$name}"/> </xsl:for-each> - </head> +</head> - <body> +<body> <div id="wrapper"> <!-- Header --> - <header><div id="header"> - <div> + <header> + <div id="header"> <div> - <xsl:if test="$project/logo"> + <div> + <xsl:if test="$project/logo"> + <xsl:variable name="src"> + <xsl:value-of select="$relative-path"/><xsl:value-of select="$home-logo"/> + </xsl:variable> + <div class="logo noPrint"> + <a href="{$project/@href}"><img alt="Tomcat Home" src="{$src}"/></a> + </div> + </xsl:if> + + <div style="height: 1px;"/> <xsl:variable name="src"> - <xsl:value-of select="$relative-path"/><xsl:value-of select="$home-logo"/> + <xsl:value-of select="$relative-path"/><xsl:value-of select="$apache-logo"/> </xsl:variable> - <div class="logo noPrint"> - <a href="{$project/@href}"><img alt="Tomcat Home" src="{$src}"/></a> + <div class="asfLogo noPrint"> + <a href="https://www.apache.org/" target="_blank"><img src="{$src}" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"/></a> </div> - </xsl:if> - - <div style="height: 1px;"/> - <xsl:variable name="src"> - <xsl:value-of select="$relative-path"/><xsl:value-of select="$apache-logo"/> - </xsl:variable> - <div class="asfLogo noPrint"> - <a href="https://www.apache.org/" target="_blank"><img src="{$src}" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"/></a> - </div> - <h1><xsl:value-of select="$project/title"/></h1> - <div class="versionInfo"> - Version <xsl:value-of select="$version"/>, - <time datetime="{$build-date-iso-8601}"><xsl:value-of select="$build-date"/></time> + <h1><xsl:value-of select="$project/title"/></h1> + <div class="versionInfo"> + Version <xsl:value-of select="$version"/>, + <time datetime="{$build-date-iso-8601}"><xsl:value-of select="$build-date"/></time> + </div> + <div style="height: 1px;"/> + <div style="clear: left;"/> </div> - <div style="height: 1px;"/> - <div style="clear: left;"/> </div> </div> - </div></header> + </header> <div id="middle"> <div> @@ -144,28 +144,26 @@ </div> <!-- Footer --> - <footer><div id="footer"> + <footer> + <div id="footer"> Copyright © 1999-<xsl:value-of select="$year"/>, The Apache Software Foundation - </div></footer> -</div> + </div> + </footer> + </div> </body> </html> - - </xsl:template> - <!-- Process a menu for the navigation bar --> <xsl:template match="menu"> - <div> - <h2><xsl:value-of select="@name"/></h2> - <ul> - <xsl:apply-templates select="item"/> - </ul> - </div> + <div> + <h2><xsl:value-of select="@name"/></h2> + <ul> + <xsl:apply-templates select="item"/> + </ul> + </div> </xsl:template> - <!-- Process a menu item for the navigation bar --> <xsl:template match="item"> <xsl:variable name="href"> @@ -174,7 +172,6 @@ <li><a href="{$href}"><xsl:value-of select="@name"/></a></li> </xsl:template> - <!-- Process a documentation section --> <xsl:template match="section"> <xsl:variable name="name2"> @@ -191,7 +188,6 @@ <xsl:value-of select="translate($name2, ' #', '__')"/> </xsl:variable> - <!-- Section heading --> <h3 id="{$name}"> <xsl:if test="@rtext"> @@ -206,10 +202,8 @@ <div class="text"> <xsl:apply-templates/> </div> - </xsl:template> - <!-- Process a documentation subsection --> <xsl:template match="subsection"> <xsl:variable name="name2"> @@ -219,8 +213,7 @@ </xsl:when> <xsl:otherwise> <xsl:if test=" - count(//*[self::section or self::subsection][@name=current()/@name]) > 1 - "> + count(//*[self::section or self::subsection][@name=current()/@name]) > 1"> <xsl:value-of select="concat(parent::*[self::section or self::subsection]/@name, '/')"/> </xsl:if> <xsl:value-of select="@name"/> @@ -243,10 +236,8 @@ <xsl:apply-templates/> </div> </div> - </xsl:template> - <!-- Generate table of contents --> <xsl:template match="toc"> <ul><xsl:apply-templates mode="toc" select="following::section"/></ul> @@ -260,8 +251,7 @@ </xsl:when> <xsl:otherwise> <xsl:if test="local-name()='subsection' and - count(//*[self::section or self::subsection][@name=current()/@name]) > 1 - "> + count(//*[self::section or self::subsection][@name=current()/@name]) > 1"> <xsl:value-of select="concat(parent::*[self::section or self::subsection]/@name, '/')"/> </xsl:if> <xsl:value-of select="@name"/> @@ -278,17 +268,16 @@ </li> </xsl:template> - <!-- Process a source code example --> <xsl:template match="source"> - <div class="codeBox"> - <pre> - <xsl:if test="@wrapped='true'"> - <xsl:attribute name="class">wrap</xsl:attribute> - </xsl:if> - <code><xsl:apply-templates/></code> - </pre> - </div> + <div class="codeBox"> + <pre> + <xsl:if test="@wrapped='true'"> + <xsl:attribute name="class">wrap</xsl:attribute> + </xsl:if> + <code><xsl:apply-templates/></code> + </pre> + </div> </xsl:template> <!-- Process an attributes list with nested attribute elements --> @@ -354,73 +343,73 @@ <xsl:template match="changelog/add"> <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/add.gif</xsl:variable> <li> - <img alt="Add: " class="icon" src="{$src}"/><xsl:apply-templates/> - </li> + <img alt="Add: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> </xsl:template> <xsl:template match="changelog/update"> <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/update.gif</xsl:variable> <li> - <img alt="Update: " class="icon" src="{$src}"/><xsl:apply-templates/> - </li> + <img alt="Update: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> </xsl:template> <xsl:template match="changelog/design"> <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/design.gif</xsl:variable> <li> - <img alt="Design: " class="icon" src="{$src}"/><xsl:apply-templates/> - </li> + <img alt="Design: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> </xsl:template> <xsl:template match="changelog/docs"> <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/docs.gif</xsl:variable> <li> - <img alt="Docs: " class="icon" src="{$src}"/><xsl:apply-templates/> - </li> + <img alt="Docs: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> </xsl:template> <xsl:template match="changelog/fix"> <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/fix.gif</xsl:variable> <li> - <img alt="Fix: " class="icon" src="{$src}"/><xsl:apply-templates/> - </li> + <img alt="Fix: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> </xsl:template> <xsl:template match="changelog/scode"> <xsl:variable name="src"><xsl:value-of select="$relative-path"/>/images/code.gif</xsl:variable> <li> - <img alt="Code: " class="icon" src="{$src}"/><xsl:apply-templates/> - </li> + <img alt="Code: " class="icon" src="{$src}"/><xsl:apply-templates/> + </li> </xsl:template> <!-- Link to a bug report --> <xsl:template match="bug"> - <xsl:variable name="link"><xsl:value-of select="$buglink"/><xsl:value-of select="text()"/></xsl:variable> - <a href="{$link}"><xsl:apply-templates/></a> + <xsl:variable name="link"><xsl:value-of select="$buglink"/><xsl:value-of select="text()"/></xsl:variable> + <a href="{$link}"><xsl:apply-templates/></a> </xsl:template> <!-- Link to a SVN revision report --> <xsl:template match="rev"> - <xsl:variable name="link"><xsl:value-of select="$revlink"/><xsl:value-of select="text()"/></xsl:variable> - <a href="{$link}">r<xsl:apply-templates/></a> + <xsl:variable name="link"><xsl:value-of select="$revlink"/><xsl:value-of select="text()"/></xsl:variable> + <a href="{$link}">r<xsl:apply-templates/></a> </xsl:template> <!-- Link to online docs --> <xsl:template match="doc"> - <xsl:variable name="link"><xsl:value-of select="$doclink"/><xsl:value-of select="@path"/></xsl:variable> - <a href="{$link}"><xsl:apply-templates/></a> + <xsl:variable name="link"><xsl:value-of select="$doclink"/><xsl:value-of select="@path"/></xsl:variable> + <a href="{$link}"><xsl:apply-templates/></a> </xsl:template> <!-- Link to security page --> <xsl:template match="security"> - <xsl:variable name="link"><xsl:value-of select="$sylink"/></xsl:variable> - <a href="{$link}"><xsl:apply-templates/></a> + <xsl:variable name="link"><xsl:value-of select="$sylink"/></xsl:variable> + <a href="{$link}"><xsl:apply-templates/></a> </xsl:template> <!-- Link to download page --> <xsl:template match="download"> - <xsl:variable name="link"><xsl:value-of select="$dllink"/></xsl:variable> - <a href="{$link}"><xsl:apply-templates/></a> + <xsl:variable name="link"><xsl:value-of select="$dllink"/></xsl:variable> + <a href="{$link}"><xsl:apply-templates/></a> </xsl:template> <!-- Version numbers --> diff --git a/webapps/manager/xform.xsl b/webapps/manager/xform.xsl index 06ced01..0f0753f 100644 --- a/webapps/manager/xform.xsl +++ b/webapps/manager/xform.xsl @@ -24,21 +24,21 @@ indent="no"/> <xsl:template match="status"> - <html> - <head> - <TITLE>Tomcat Status</TITLE> - <STYLE type="text/css"> + <html lang="en"> + <head> + <title>Tomcat Status</title> + <style> body, table, tr, td, a, div, span { - vertical-align : top; + vertical-align: top; } - </STYLE> - </head> - <body> - <div style='font-size:20px;'>Tomcat Status</div> - - <xsl:apply-templates select="jvm"/> - <xsl:apply-templates select="connector"/> - </body> + </style> + </head> + <body> + <div style='font-size:20px;'>Tomcat Status</div> + + <xsl:apply-templates select="jvm"/> + <xsl:apply-templates select="connector"/> + </body> </html> </xsl:template> @@ -50,24 +50,27 @@ </xsl:template> <xsl:template match="memory"> - <table><tr> - <td><b>JVM:</b></td> - <td><b>free:</b> <xsl:value-of select="@free"/></td> - <td><b>total:</b> <xsl:value-of select="@total"/></td> - <td><b>max:</b> <xsl:value-of select="@max"/></td> - </tr> - </table><hr /> + <table> + <tr> + <td><b>JVM:</b></td> + <td><b>free:</b> <xsl:value-of select="@free"/></td> + <td><b>total:</b> <xsl:value-of select="@total"/></td> + <td><b>max:</b> <xsl:value-of select="@max"/></td> + </tr> + </table> + <hr /> </xsl:template> <xsl:template match="memorypool"> - <table><tr> - <td><b>Name:</b> <xsl:value-of select="@name"/></td> - <td><b>Type:</b> <xsl:value-of select="@type"/></td> - <td><b>Initial:</b> <xsl:value-of select="@usageInit"/></td> - <td><b>Committed:</b> <xsl:value-of select="@usageCommitted"/></td> - <td><b>Maximum:</b> <xsl:value-of select="@usageMax"/></td> - <td><b>Used:</b> <xsl:value-of select="@usageUsed"/></td> - </tr> + <table> + <tr> + <td><b>Name:</b> <xsl:value-of select="@name"/></td> + <td><b>Type:</b> <xsl:value-of select="@type"/></td> + <td><b>Initial:</b> <xsl:value-of select="@usageInit"/></td> + <td><b>Committed:</b> <xsl:value-of select="@usageCommitted"/></td> + <td><b>Maximum:</b> <xsl:value-of select="@usageMax"/></td> + <td><b>Used:</b> <xsl:value-of select="@usageUsed"/></td> + </tr> </table> </xsl:template> @@ -80,46 +83,58 @@ </xsl:template> <xsl:template match="threadInfo"> - <table><tr> - <td><b>threadInfo</b></td> - <td><b>maxThreads:</b> <xsl:value-of select="@maxThreads"/></td> - <td><b>currentThreadCount:</b> <xsl:value-of select="@currentThreadCount"/></td> - <td><b>currentThreadsBusy:</b> <xsl:value-of select="@currentThreadsBusy"/></td> - </tr> - </table><hr /> + <table> + <tr> + <td><b>threadInfo</b></td> + <td><b>maxThreads:</b> <xsl:value-of select="@maxThreads"/></td> + <td><b>currentThreadCount:</b> <xsl:value-of select="@currentThreadCount"/></td> + <td><b>currentThreadsBusy:</b> <xsl:value-of select="@currentThreadsBusy"/></td> + </tr> + </table> + <hr /> </xsl:template> <xsl:template match="requestInfo"> - <table><tr> - <td><b>requestInfo </b></td> - <td><b>maxTime:</b> <xsl:value-of select="@maxTime"/></td> - <td><b>processingTime:</b> <xsl:value-of select="@processingTime"/></td> - <td><b>requestCount:</b> <xsl:value-of select="@requestCount"/></td> - <td><b>errorCount:</b> <xsl:value-of select="@errorCount"/></td> - <td><b>bytesReceived:</b> <xsl:value-of select="@bytesReceived"/></td> - <td><b>bytesSent:</b> <xsl:value-of select="@bytesSent"/></td> - </tr> - </table><hr /> + <table> + <tr> + <td><b>requestInfo </b></td> + <td><b>maxTime:</b> <xsl:value-of select="@maxTime"/></td> + <td><b>processingTime:</b> <xsl:value-of select="@processingTime"/></td> + <td><b>requestCount:</b> <xsl:value-of select="@requestCount"/></td> + <td><b>errorCount:</b> <xsl:value-of select="@errorCount"/></td> + <td><b>bytesReceived:</b> <xsl:value-of select="@bytesReceived"/></td> + <td><b>bytesSent:</b> <xsl:value-of select="@bytesSent"/></td> + </tr> + </table> + <hr /> </xsl:template> <xsl:template match="workers"> - <table> - <tr><th>Stage</th><th>Time</th><th>B Sent</th><th>B Recv</th><th>Client</th><th>VHost</th><th>Request</th></tr> - <xsl:apply-templates select="worker"/> - - </table><hr /> + <table> + <tr> + <th>Stage</th> + <th>Time</th> + <th>B Sent</th> + <th>B Recv</th> + <th>Client</th> + <th>VHost</th> + <th>Request</th> + </tr> + <xsl:apply-templates select="worker"/> + </table> + <hr /> </xsl:template> <xsl:template match="worker"> - <tr> - <td><xsl:value-of select="@stage"/></td> - <td><xsl:value-of select="@requestProcessingTime"/></td> - <td><xsl:value-of select="@requestBytesSent"/></td> - <td><xsl:value-of select="@requestBytesReceived"/></td> - <td><xsl:value-of select="@remoteAddr"/></td> - <td><xsl:value-of select="@virtualHost"/></td> - <td><xsl:value-of select="@method"/> <xsl:value-of select="@currentUri"/>?<xsl:value-of select="@currentQueryString"/> <xsl:value-of select="@protocol"/></td> - </tr> + <tr> + <td><xsl:value-of select="@stage"/></td> + <td><xsl:value-of select="@requestProcessingTime"/></td> + <td><xsl:value-of select="@requestBytesSent"/></td> + <td><xsl:value-of select="@requestBytesReceived"/></td> + <td><xsl:value-of select="@remoteAddr"/></td> + <td><xsl:value-of select="@virtualHost"/></td> + <td><xsl:value-of select="@method"/> <xsl:value-of select="@currentUri"/>?<xsl:value-of select="@currentQueryString"/> <xsl:value-of select="@protocol"/></td> + </tr> </xsl:template> </xsl:stylesheet> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org