|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r52257 - website/public_html/beta/community
From: bdawes_at_[hidden]
Date: 2009-04-08 12:13:35
Author: bemandawes
Date: 2009-04-08 12:13:34 EDT (Wed, 08 Apr 2009)
New Revision: 52257
URL: http://svn.boost.org/trac/boost/changeset/52257
Log:
More effective table of contents, etc.
Text files modified:
website/public_html/beta/community/policy.html | 61 +++++++++++++++++++++++++++------------
1 files changed, 42 insertions(+), 19 deletions(-)
Modified: website/public_html/beta/community/policy.html
==============================================================================
--- website/public_html/beta/community/policy.html (original)
+++ website/public_html/beta/community/policy.html 2009-04-08 12:13:34 EDT (Wed, 08 Apr 2009)
@@ -41,12 +41,34 @@
<li>Unacceptable Topics</li>
- <li>Effective Posting</li>
+ <li>Effective Posting<ul class="toc">
+ <li>Well-Crafted Posting is Worth the Effort</li>
+ <li>Put the Library Name in the Subject Line</li>
+ <li>Don't Use Tabs</li>
+ <li><a href="#longlines">Limit Line
+ Length</a></li>
+ <li><a href="#quoting">Don't Overquote, Don't Top-Post, and Do
+ Use Inline Replies for Readable Quotations</a></li>
+ <li>Keep the Formatting of Quotations Consistent</li>
+ <li>Summarizing and Referring to Earlier Messages</li>
+ <li>Maintain the Integrity of Discussion Threads</li>
+ <li>Keep The Size of Your Posting Manageable</li>
+ </ul>
+
+ </li>
+
+ <li>Prohibited Behavior<ul class="toc">
+ <li>Flame wars</li>
+ <li>Third-party attacks</li>
+ <li>Off-topic posts</li>
+ </ul>
- <li>Prohibited Behavior</li>
+ </li>
<li>Culture</li>
+ <li>Guidelines for Effective Discussions</li>
+
<li>Library Names</li>
</ul>
@@ -100,7 +122,7 @@
communications. This section describes how to make sure it has
the desired impact.</p>
- <h3>Well-Crafted Posting is Worth the Effort</h3>
+ <h3><a name="well-crafted"></a>Well-Crafted Posting is Worth the Effort</h3>
<p>Don't forget, you're a single writer but there are many
readers, and you want them to stay interested in what you're
@@ -110,7 +132,7 @@
history of the work we do. A post's usefulness in the future is
determined by its readability.</p>
- <h3>Put the Library Name in the <a name="subject-line">Subject Line</a></h3>
+ <h3><a name="subject-liine"></a>Put the Library Name in the Subject Line</h3>
<p>When your post is related to a particular Boost library,
it's helpful to put the library name in square brackets at the
@@ -140,7 +162,8 @@
insert the code as an (inline, if possible) attachment. That
will help ensure others can read what you've posted.</p>
- <h3><a name="quoting" id="quoting"></a>Don't Overquote</h3>
+ <h3><a name="quoting" id="quoting"></a>Don't Overquote, Don't
+ Top-Post, and Do Use Inline Replies for Readable Quotations</h3>
<p>Please <strong>prune extraneous quoted text</strong> from
replies so that only the relevant parts are included. Some
@@ -150,8 +173,6 @@
out which exact part of a previous message you are responding
to.</p>
- <h3>Use a Readable <a name="quotation-style">Quotation Style</a></h3>
-
<p>Don't <a href=
"http://en.wikipedia.org/wiki/Posting_style#Top-posting">top-post</a>;
inline replies are the appropriate <a href=
@@ -182,7 +203,7 @@
"http://www.netmeister.org/news/learn2quote.html" class=
"external">this helpful guide</a>.</p>
- <h3>Keep the Formatting of Quotations Consistent</h3>
+ <h3><a name="formatting-quotations"></a>Keep the Formatting of Quotations Consistent</h3>
<p>Some email and news clients use poor word wrapping
algorithms that leave successive lines from the same quotation
@@ -207,7 +228,7 @@
"http://home.in.tum.de/~jain/software/oe-quotefix/" class=
"external">OE QuoteFix</a> for users of Outlook Express.</p>
- <h3>Summarizing and Referring to Earlier Messages</h3>
+ <h3><a name="summarizing-referring"></a>Summarizing and Referring to Earlier Messages</h3>
<p>A summary of the foregoing thread is only needed after a
long discussion, especially when the topic is drifting or a
@@ -224,7 +245,7 @@
of a message you link to is often helpful (if the citation is
small).</p>
- <h3>Maintain the Integrity of Discussion Threads</h3>
+ <h3><a name="discussion-threads"></a>Maintain the Integrity of Discussion Threads</h3>
<p><strong>When starting a new topic, always send a fresh
message</strong>, rather than beginning a reply to some other
@@ -248,12 +269,14 @@
"http://news.gmane.org/gmane.comp.lib.boost.devel" class=
"external">GMane web interface</a>.</p>
- <h3>Keep The Size of Your Posting Manageable</h3>
+ <h3><a name="max-size"></a>Keep The Size of Your Posting Manageable</h3>
- <p>The mailing list software automatically limits message and
- attachment size to a reasonable amount, typically 75K, which is
- adjusted from time-to-time by the moderators. This limit is a
- courtesy to those who rely on dial-up Internet access.</p>
+ <p>The mailing list software automatically limits message and
+ attachment size to a reasonable amount, typically 75K, which is
+ adjusted from time-to-time by the moderators. This limit is a
+ courtesy to those who rely on dial-up Internet access, and let's
+ face it, no one wants to read a posting that consists of 75K of
+ error message text.</p>
<h2><a name="behavior" id="behavior"></a>Prohibited
Behavior</h2>
@@ -261,7 +284,7 @@
<p>Prohibited behavior will not be tolerated. The moderators
will ban postings by abusers.</p>
- <h3>Flame wars</h3>
+ <h3><a name="flame-wars"></a>Flame wars</h3>
<p>Personal insults, argument for the sake of argument, and all
the other behaviors which fall into the "flame war" category
@@ -269,7 +292,7 @@
arguments, not the personality traits or motives of
participants.</p>
- <h3>Third-party attacks</h3>
+ <h3><a name="third-party-attacks"></a>Third-party attacks</h3>
<p>Attacks on third parties such as software vendors, hardware
vendors, or any other organizations, are prohibited. Boost
@@ -280,7 +303,7 @@
remark about a troublesome compiler? No, but be wary of
overdoing it.</p>
- <h3>Off-topic posts</h3>
+ <h3><a name="off-topic-posts"></a>Off-topic posts</h3>
<p>Discussions which stray from the acceptable topics are
strongly discouraged. While off-topic posts are often well
@@ -307,7 +330,7 @@
they may not be understood by all readers. Re-read your message
before submitting it.</p>
- <h2>Guidelines for Effective Discussions</h2>
+ <h2><a name="effective-discussions"></a>Guidelines for Effective Discussions</h2>
<p>Apply social engineering to prevent heated technical
discussion from degenerating into a shouting match, and to
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk