develooper Front page | perl.perl5.porters | Postings from January 2001

[PATCH] format and rewording in perlfaq.pod

Thread Next
From:
Robin Barker
Date:
January 5, 2001 10:51
Subject:
[PATCH] format and rewording in perlfaq.pod
Message ID:
200101051851.SAA03310@tempest.npl.co.uk
Hi

I have three suggestions for changes to perlfaq.pod.

1)  Shorted the C<=item *> lines to avoid the problems with overlong item
    lines in pod2man.

2)  Make the C<=item L<perlfaqn>> lines into C<=head2> so they come out bold
    with pod2man, and are more noticeable.

3)  Reword some headings in perlfaq.pod to reflect the fact that the pod is
    now structured over several documents.

Suggestion (1) can be implemented with the following command
% perl -i.orig -pwe 's/^(=item \*)\s+(?=\S)/$1\n\n/' pod/perlfaq.pod

(I generated a patch, but it was longer than the perlfaq.pod document.)

Suggestions (2) and (3) can be implemented by the patch below.

Robin

--- pod/perlfaq.pod	
+++ pod/perlfaq.pod	
@@ -4,15 +4,14 @@
 
 =head1 DESCRIPTION
 
-This document is structured into the following sections:
+The perlfaq is structured into the following documents:
 
-=over 4
 
-=item perlfaq: Structural overview of the FAQ.
+=head2 perlfaq: Structural overview of the FAQ.
 
 This document.
 
-=item L<perlfaq1>: General Questions About Perl
+=head2 L<perlfaq1>: General Questions About Perl
 
 Very general, high-level information about Perl.
 
@@ -81,7 +80,7 @@
 =back
 
 
-=item L<perlfaq2>: Obtaining and Learning about Perl
+=head2 L<perlfaq2>: Obtaining and Learning about Perl
 
 Where to find source and documentation to Perl, support,
 and related matters.
@@ -163,7 +162,7 @@
 =back
 
 
-=item L<perlfaq3>: Programming Tools
+=head2 L<perlfaq3>: Programming Tools
 
 Programmer tools and programming support.
 
@@ -302,7 +301,7 @@
 =back
 
 
-=item L<perlfaq4>: Data Manipulation
+=head2 L<perlfaq4>: Data Manipulation
 
 Manipulating numbers, dates, strings, arrays, hashes, and
 miscellaneous data issues.
@@ -609,7 +608,7 @@
 =back
 
 
-=item L<perlfaq5>: Files and Formats
+=head2 L<perlfaq5>: Files and Formats
 
 I/O and the "f" issues: filehandles, flushing, formats and footers.
 
@@ -758,7 +757,7 @@
 =back
 
 
-=item L<perlfaq6>: Regexps
+=head2 L<perlfaq6>: Regexps
 
 Pattern matching and regular expressions.
 
@@ -859,7 +858,7 @@
 =back
 
 
-=item L<perlfaq7>: General Perl Language Issues
+=head2 L<perlfaq7>: General Perl Language Issues
 
 General Perl language issues that don't clearly fit into any of the
 other sections.
@@ -981,7 +980,7 @@
 =back
 
 
-=item L<perlfaq8>: System Interaction
+=head2 L<perlfaq8>: System Interaction
 
 Interprocess communication (IPC), control over the user-interface
 (keyboard, screen and pointing devices).
@@ -1187,7 +1186,7 @@
 =back
 
 
-=item L<perlfaq9>: Networking
+=head2 L<perlfaq9>: Networking
 
 Networking, the Internet, and a few on the web.
 
@@ -1292,16 +1291,16 @@
 =back
 
 
-=back
+=head1 About the perlfaq documents
 
-=head2 Where to get this document
+=head2 Where to get the perlfaq
 
 This document is posted regularly to comp.lang.perl.announce and
 several other related newsgroups.  It is available in a variety of
 formats from CPAN in the /CPAN/doc/FAQs/FAQ/ directory or on the web
 at http://www.perl.com/perl/faq/ .
 
-=head2 How to contribute to this document
+=head2 How to contribute to the perlfaq
 
 You may mail corrections, additions, and suggestions to
 perlfaq-suggestions@perl.com .  This alias should not be 

-- 
Robin Barker                        | Email: Robin.Barker@npl.co.uk
CMSC, Building 10,                  | Phone: +44 (0) 20 8943 7090
National Physical Laboratory,       | Fax:   +44 (0) 20 8977 7091
Teddington, Middlesex, UK. TW11 OLW | WWW:   http://www.npl.co.uk

Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About