You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by rj...@apache.org on 2012/12/05 16:22:04 UTC
svn commit: r1417476 - in /tomcat/trunk/webapps/docs: appdev/project.xml
architecture/project.xml comments.xml config/project.xml
funcspecs/project.xml project.xml tomcat-docs.xsl tribes/project.xml
Author: rjung
Date: Wed Dec 5 15:22:03 2012
New Revision: 1417476
URL: http://svn.apache.org/viewvc?rev=1417476&view=rev
Log:
Add user comments system to docs.
Added:
tomcat/trunk/webapps/docs/comments.xml (with props)
Modified:
tomcat/trunk/webapps/docs/appdev/project.xml
tomcat/trunk/webapps/docs/architecture/project.xml
tomcat/trunk/webapps/docs/config/project.xml
tomcat/trunk/webapps/docs/funcspecs/project.xml
tomcat/trunk/webapps/docs/project.xml
tomcat/trunk/webapps/docs/tomcat-docs.xsl
tomcat/trunk/webapps/docs/tribes/project.xml
Modified: tomcat/trunk/webapps/docs/appdev/project.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/appdev/project.xml?rev=1417476&r1=1417475&r2=1417476&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/appdev/project.xml (original)
+++ tomcat/trunk/webapps/docs/appdev/project.xml Wed Dec 5 15:22:03 2012
@@ -31,6 +31,7 @@
<item name="Docs Home" href="../index.html"/>
<item name="App Dev Guide Home" href="index.html"/>
<item name="FAQ" href="http://wiki.apache.org/tomcat/FAQ" />
+ <item name="User Comments" href="#comments_section"/>
</menu>
<menu name="Contents">
Modified: tomcat/trunk/webapps/docs/architecture/project.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/architecture/project.xml?rev=1417476&r1=1417475&r2=1417476&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/architecture/project.xml (original)
+++ tomcat/trunk/webapps/docs/architecture/project.xml Wed Dec 5 15:22:03 2012
@@ -31,6 +31,7 @@
<item name="Docs Home" href="../index.html" />
<item name="Architecture Home" href="index.html"/>
<item name="FAQ" href="http://wiki.apache.org/tomcat/FAQ" />
+ <item name="User Comments" href="#comments_section"/>
</menu>
<menu name="Contents">
Added: tomcat/trunk/webapps/docs/comments.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/comments.xml?rev=1417476&view=auto
==============================================================================
--- tomcat/trunk/webapps/docs/comments.xml (added)
+++ tomcat/trunk/webapps/docs/comments.xml Wed Dec 5 15:22:03 2012
@@ -0,0 +1,118 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<!DOCTYPE document [
+ <!ENTITY project SYSTEM "project.xml">
+]>
+<document url="comments.html">
+
+ &project;
+
+ <properties>
+ <title>Documentation User Comments</title>
+ </properties>
+
+<body>
+
+<section name="Introduction">
+
+<p>The Tomcat documentation integrates the
+<a href="https://comments.apache.org/help.html">Apache Comments System</a>.
+It allows users to add comments to most documentation pages. The comments
+section can be found at the end of each page.</p>
+
+</section>
+
+<section name="Allowed Content">
+
+<p>Please use the Apache Comments System responsibly. We can only provide
+this service to the community as long as it isn't misused.</p>
+
+<p>The comments are not for general Q&A.
+Comments should be pointed towards suggestions on improving the documentation
+or server. Questions on how to use Apache Tomcat should be directed
+to our <a href="http://tomcat.apache.org/lists.html">mailing lists</a>.</p>
+
+<p>Comments may be removed by moderators if they are either
+implemented or considered invalid/off-topic.</p>
+
+<p>HTML is not allowed in comments, and will just display as raw source code
+if attempted. Links that do not point to an Apache site (*.apache.org) will
+need approval by a moderator before the comment is visible to regular visitors.</p>
+
+</section>
+
+<section name="License">
+
+<p>Any submitted comments must be contributed under the terms of the
+<a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
+
+</section>
+
+<section name="Verified Users">
+
+<p>Verified users gain the Apache feather next to their name,
+and may post comments with links in them without requiring approval
+by a moderator before the comments are shown. Being a verified user
+in itself does not give you moderating rights. If you are interested
+in becoming a verified user, please contact us on the
+<a href="http://tomcat.apache.org/lists.html#tomcat-users">users mailing list</a>.</p>
+
+<p>All ASF committers are automatically verified users.</p>
+
+</section>
+
+<section name="Moderators">
+
+<p>Moderators are allowed to mark comments as "Resolved", "Invalid"
+or "Sticky", remove marks, approve comments e.g. if they contain
+a link, and delete comments. Moderators can also subscribe to new
+comments and comment updates and use the dashboard to gain some
+overview over all comments of a site.</p>
+
+<p>To use the moderation features, you need to login to the comments
+system. Furthermore you will need to allow cookies to be set for
+comments.apache.org (this is done using a secure https cookie). Once
+logged in as a moderator you will see additional moderation
+options attached to each comment.</p>
+
+<p>If you are a long time follower of the Apache Tomcat projects
+and you are interested in becoming a moderator, please contact us on the
+<a href="http://tomcat.apache.org/lists.html#tomcat-users">users mailing list</a>.</p>
+
+</section>
+
+<section name="Privacy Policy">
+
+<p>No data except what you personally submit is kept on record.
+A cookie is used to keep track of moderators and other people
+who wish to create an account to avoid having to enter their
+credentials whenever they wish to post a comment.</p>
+
+<p>To prevent spam and unsolicited comments, we use a digest of
+visitors' IPs to keep track of comments posted by them.</p>
+
+<p>Entering an email address when you post a comment is completely
+optional, and will not be shared with anyone. If you enter an
+email address, it will be used to notify you when someone posts
+a reply to one of your comments, provided you have registered
+an account and validated your email address.</p>
+
+</section>
+
+</body>
+</document>
Propchange: tomcat/trunk/webapps/docs/comments.xml
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: tomcat/trunk/webapps/docs/comments.xml
------------------------------------------------------------------------------
svn:keywords = Author Date Id Revision
Modified: tomcat/trunk/webapps/docs/config/project.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/config/project.xml?rev=1417476&r1=1417475&r2=1417476&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/config/project.xml (original)
+++ tomcat/trunk/webapps/docs/config/project.xml Wed Dec 5 15:22:03 2012
@@ -31,6 +31,7 @@
<item name="Docs Home" href="../index.html"/>
<item name="Config Ref. Home" href="index.html"/>
<item name="FAQ" href="http://wiki.apache.org/tomcat/FAQ" />
+ <item name="User Comments" href="#comments_section"/>
</menu>
<menu name="Top Level Elements">
Modified: tomcat/trunk/webapps/docs/funcspecs/project.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/funcspecs/project.xml?rev=1417476&r1=1417475&r2=1417476&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/funcspecs/project.xml (original)
+++ tomcat/trunk/webapps/docs/funcspecs/project.xml Wed Dec 5 15:22:03 2012
@@ -30,6 +30,7 @@
<item name="Docs Home" href="../index.html"/>
<item name="Functional Specs" href="index.html"/>
<item name="FAQ" href="http://wiki.apache.org/tomcat/FAQ" />
+ <item name="User Comments" href="#comments_section"/>
</menu>
<menu name="Administrative Apps">
Modified: tomcat/trunk/webapps/docs/project.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/project.xml?rev=1417476&r1=1417475&r2=1417476&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/project.xml (original)
+++ tomcat/trunk/webapps/docs/project.xml Wed Dec 5 15:22:03 2012
@@ -30,6 +30,7 @@
<menu name="Links">
<item name="Docs Home" href="index.html"/>
<item name="FAQ" href="http://wiki.apache.org/tomcat/FAQ" />
+ <item name="User Comments" href="#comments_section"/>
</menu>
<menu name="User Guide">
Modified: tomcat/trunk/webapps/docs/tomcat-docs.xsl
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/tomcat-docs.xsl?rev=1417476&r1=1417475&r2=1417476&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/tomcat-docs.xsl (original)
+++ tomcat/trunk/webapps/docs/tomcat-docs.xsl Wed Dec 5 15:22:03 2012
@@ -61,6 +61,7 @@
<xsl:variable name="attributes-color" select="'#023264'"/>
<xsl:variable name="table-th-bg" select="'#039acc'"/>
<xsl:variable name="table-td-bg" select="'#a0ddf0'"/>
+ <xsl:variable name="commentslink">/<xsl:value-of select="$sitedir"/>comments.html</xsl:variable>
<!-- Process an entire document into an HTML page -->
<xsl:template match="document">
@@ -172,6 +173,53 @@
</tr>
+ <tr class="noPrint">
+
+ <td width="20%" valign="top" nowrap="nowrap" class="noPrint">
+ </td>
+ <td width="80%" valign="top" align="left">
+ <table border="0" cellspacing="0" cellpadding="2">
+ <!-- Comment heading -->
+ <tr><td bgcolor="{$banner-bg}">
+ <font color="{$banner-fg}" face="arial,helvetica.sanserif">
+ <a name="comments_section" id="comments_section"><strong>Comments</strong></a></font>
+ </td>
+ </tr>
+ <!-- Comment body -->
+ <tr><td>
+ <blockquote>
+ <p class="notice">
+ <strong>Notice: </strong>This is not a Q&A section.
+ The Apache Comments System is explained
+ <a href="{$commentslink}">here</a>.
+ Comments should be pointed towards suggestions on improving the documentation
+ or server, and may be removed again by our moderators if they are either
+ implemented or considered invalid/off-topic.
+ Questions on how to manage Apache Tomcat should be directed
+ to our <a href="http://tomcat.apache.org/lists.html">mailing lists</a>.</p>
+ <script type="text/javascript">
+ <xsl:text disable-output-escaping="yes"><![CDATA[<!--//--><![CDATA[//><!--
+ var comments_shortname = 'tomcat';
+ var comments_identifier = 'http://tomcat.apache.org/]]></xsl:text><xsl:value-of select="$sitedir"/><xsl:value-of select="$subdir"/><xsl:value-of select="substring($filename,1,string-length($filename)-4)"/><xsl:text disable-output-escaping="yes"><![CDATA[.html';
+ (function(w, d) {
+ if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {
+ d.write('<div id="comments_thread"><\/div>');
+ var s = d.createElement('script');
+ s.type = 'text/javascript';
+ s.async = true;
+ s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
+ (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
+ }
+ else {
+ d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.</strong><\/div>');
+ }
+ })(window, document);
+ //--><!]]]]>></xsl:text></script>
+ </blockquote></td></tr>
+ </table>
+ </td>
+ </tr>
+
<xsl:comment>FOOTER SEPARATOR</xsl:comment>
<tr>
<td colspan="2">
Modified: tomcat/trunk/webapps/docs/tribes/project.xml
URL: http://svn.apache.org/viewvc/tomcat/trunk/webapps/docs/tribes/project.xml?rev=1417476&r1=1417475&r2=1417476&view=diff
==============================================================================
--- tomcat/trunk/webapps/docs/tribes/project.xml (original)
+++ tomcat/trunk/webapps/docs/tribes/project.xml Wed Dec 5 15:22:03 2012
@@ -29,6 +29,7 @@
<item name="Docs Home" href="../index.html"/>
<item name="Tribes Docs Home" href="index.html"/>
<item name="FAQ" href="http://wiki.apache.org/tomcat/FAQ" />
+ <item name="User Comments" href="#comments_section"/>
</menu>
<menu name="User Guide">
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org