Some (layout) improvements for devel/wnpp/index
Hi.
I just read devel/wnpp/index and found it somewhat confusing.
I prepared a patch that adds a toc and makes some layout
changes.
Objections? (Yeah, I know this looks lika a pain for translators but I
can commit as much as possible for each translation so they
have only to add the toc part.)
Gruesse,
--
Frank Lichtenheld <frank@lichtenheld.de>
www: http://www.djpig.de/
Index: index.wml
===================================================================
RCS file: /cvs/webwml/webwml/english/devel/wnpp/index.wml,v
retrieving revision 1.20
diff -u -r1.20 index.wml
--- index.wml 24 Apr 2003 10:25:46 -0000 1.20
+++ index.wml 12 Sep 2003 18:26:27 -0000
@@ -1,13 +1,16 @@
#use wml::debian::template title="Work-Needing and Prospective Packages"
+#use wml::debian::toc
# $Id: index.wml,v 1.20 2003/04/24 10:25:46 kraai Exp $
+<define-tag toc-title-formatting endtag=required><h3>%body</h3></define-tag>
+
<p>Work-Needing and Prospective Packages, WNPP for short, is a list
of packages in need of new maintainers and prospective packages in Debian.
In order to closely track the real status of such things, WNPP is currently
operated as a pseudo-package in the <a href="http://bugs.debian.org/";>Debian
Bug Tracking System (BTS)</a>.
-<hr>
+<hrline>
<p><a href="work_needing">Packages in need of a new maintainer</a>:
<ul>
@@ -29,7 +32,11 @@
please check the <a href="http://bugs.debian.org/wnpp";>wnpp pseudo package</a>
entry in the BTS.
-<hr>
+<hrline>
+
+<h2>Using WNPP</h2>
+
+<toc-display />
<p>Since it uses the BTS, every developer is already familiar with the
technical details, such as submission of new information, modification of
@@ -43,12 +50,15 @@
only submit one bug per source package rather than one bug for each
binary package built from a source package.</p>
+
+<toc-add-entry>Adding new entries with "reportbug"</toc-add-entry>
+
<p>You can use <a href="http://packages.debian.org/reportbug";>reportbug</a>
-(apt-get install reportbug):</p>
+(<kbd>apt-get install reportbug</kbd>):</p>
<blockquote>
- $ reportbug --email username@domain.tld wnpp<br>
- Using 'Your Name <username@domain.tld>' as your from address.<br>
+ $ reportbug --email <var>username@domain.tld</var> wnpp<br>
+ Using '<var>Your Name <username@domain.tld></var>' as your from address.<br>
Getting status for wnpp...<br>
Querying Debian bug tracking system for reports on wnpp<br>
(Use ? for help at prompts.)<br>
@@ -85,8 +95,8 @@
<p>After your selection you will be asked for the package name:</p>
<blockquote>
-Choose the request type: x<br>
-Please enter the proposed package name: PACKAGENAME<br>
+Choose the request type: <var>x</var><br>
+Please enter the proposed package name: <var>PACKAGENAME</var><br>
Checking status database...<br>
</blockquote>
@@ -97,19 +107,19 @@
<blockquote>
Please briefly describe this package; this should be an appropriate short
description for the eventual package:<br>
-> A DESCRIPTION<br>
+> <var>A DESCRIPTION</var><br>
<br>
-Subject: ITP: PACKAGENAME -- A DESCRIPTION<br>
+Subject: ITP: <var>PACKAGENAME -- A DESCRIPTION</var><br>
Package: wnpp<br>
Version: N/A; reported 2002-01-30<br>
Severity: wishlist<br>
<br>
-* Package name : PACKAGENAME<br>
- Version : x.y.z<br>
- Upstream Author : Name <somebody@some.org><br>
-* URL : http://www.some.org/<br>
-* License : (GPL, LGPL, BSD, MIT/X, etc.)<br>
- Description : A DESCRIPTION<br>
+* Package name : <var>PACKAGENAME</var><br>
+ Version : <var>x.y.z</var><br>
+ Upstream Author : <var>Name <somebody@some.org></var><br>
+* URL : <var>http://www.some.org/</var><br>
+* License : <var>(GPL, LGPL, BSD, MIT/X, etc.)</var><br>
+ Description : <var>A DESCRIPTION</var><br>
<br>
<br>
-- System Information<br>
@@ -123,11 +133,11 @@
of the package.</p>
<blockquote>
-Choose the request type: x<br>
-Please enter the name of the package: PACKAGENAME<br>
+Choose the request type: <var>x</var><br>
+Please enter the name of the package: <var>PACKAGENAME</var><br>
Checking status database...<br>
<br>
-Subject: O: PACKAGENAME -- SHORT DESCRIPTION<br>
+Subject: O: <var>PACKAGENAME -- SHORT DESCRIPTION</var><br>
Package: wnpp<br>
Version: N/A; reported 2002-01-30<br>
Severity: normal<br>
@@ -150,20 +160,23 @@
Submit this bug report (e to edit) [Y|n|i|e|?]? <br>
</blockquote>
+
+<toc-add-entry>Adding new entries via email</toc-add-entry>
+
<p>It is also possible to report reports/bugs against the WNPP via email.
The format of the submission should be like this:</p>
<blockquote>
To: submit@bugs.debian.org<br>
- Subject: <<i>TAG</i>>: <<b>package name</b>> -- <short package description><br>
+ Subject: <var>TAG</var>: <var>package name</var> -- <var>short package description</var><br>
<br>
Package: wnpp<br>
- Severity: <see below><br>
+ Severity: <var>see below</var><br>
<br>
- < Some information about the package. If this is an ITP or RFP an URL
+ <var>Some information about the package.</var> (If this is an ITP or RFP an URL
where the package (either the .deb or the original source) can be downloaded
from is required, as well as
- information concerning its license. >
+ information concerning its license.)
</blockquote>
<p>The tags to be used and their corresponding severities are:
@@ -205,6 +218,9 @@
</tr>
</table>
+
+<toc-add-entry>Removing entries</toc-add-entry>
+
<p>The procedures for closing these bugs are as follows:
<table border=0 cellpadding=3 cellspacing=3>
@@ -263,7 +279,7 @@
<p>If you feel that the developers' mailing list should know about your ITP,
RFA or anything else, add the header
<pre>X-Debbugs-CC: debian-devel@lists.debian.org</pre>
-to the message (note: that's a real header, not a pseudo-header).
+<p>to the message (note: that's a real header, not a pseudo-header).
<p>Of course, the easiest way of closing these bugs is to include an entry
in the package changelog saying what you've done and append
@@ -271,7 +287,7 @@
automatically after the new package gets installed into the archive.
<p><strong>Attention:</strong> You can <strong>not</strong> reassign or
-retitle bug reports by mailing the report number @bugs.debian.org,
+retitle bug reports by mailing the report <var>number</var>@bugs.debian.org,
<strong>nor</strong> by filing new reports. You have to send an appropriate
message to the BTS control bot — <a href="$(HOME)/Bugs/server-control">
read the instructions for it</a>!
@@ -281,4 +297,4 @@
the FTP maintainers will be asked to remove the package from unstable.
<p>If for some reason you need to contact the WNPP maintainers, they can be
-reached at <tt>wnpp@debian.org</tt>.
+reached at <email wnpp@debian.org>.
Reply to: