From josh@tcbug.org  Wed Sep 14 19:28:26 2005
Return-Path: <josh@tcbug.org>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id CE11616A41F
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 14 Sep 2005 19:28:26 +0000 (GMT)
	(envelope-from josh@tcbug.org)
Received: from rwcrmhc12.comcast.net (rwcrmhc14.comcast.net [204.127.198.54])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 2E5FD43D45
	for <FreeBSD-gnats-submit@freebsd.org>; Wed, 14 Sep 2005 19:28:25 +0000 (GMT)
	(envelope-from josh@tcbug.org)
Received: from gimpy.tcbug.org (c-24-118-173-219.hsd1.mn.comcast.net[24.118.173.219])
          by comcast.net (rwcrmhc14) with SMTP
          id <2005091419282401400a9kgce>; Wed, 14 Sep 2005 19:28:25 +0000
Message-Id: <1126726102.0@gimpy.tcbug.org>
Date: Wed, 14 Sep 2005 14:28:22 -0500
From: "Josh Paetzel" <josh@tcbug.org>
To: "FreeBSD gnats submit" <FreeBSD-gnats-submit@freebsd.org>
Subject: [patch] fix inconsistency in handbook section 9.4 regarding links to the ports collection
X-Send-Pr-Version: gtk-send-pr 0.4.6 
X-GNATS-Notify:

>Number:         86134
>Category:       docs
>Synopsis:       [patch] fix inconsistency in handbook section 9.4 regarding links to the ports collection
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    blackend
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Sep 14 19:30:11 GMT 2005
>Closed-Date:    Mon Jul 14 14:24:02 UTC 2008
>Last-Modified:  Mon Jul 14 14:24:02 UTC 2008
>Originator:     Josh Paetzel
>Release:        FreeBSD 5.4-RELEASE-p7 i386
>Organization:
>Environment:


System: FreeBSD 5.4-RELEASE-p7 #8: Fri Sep  9 16:38:25 CDT 2005
    jpaetzel@gimpy.tcbug.org:/usr/obj/usr/src/sys/GIMPY



>Description:


http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/printing-advanced.html

Several ports from the port collection are mentioned in this section of the
handbook.  In some places there is a link to: 

http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports.html

In other places there is no link.  This patch makes everything consistent.
>How-To-Repeat:
Read http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/printing-advanced.html
and look for the various ports that are mentioned in the document.
>Fix:
--- chapter.sgml.old    Wed Sep 14 13:57:57 2005
+++ chapter.sgml        Wed Sep 14 14:21:10 2005
@@ -1512,7 +1512,8 @@
         printers that can print plain text.  (It handles backspacing and tabs
         in the file, and does accounting, but that is about all it does.)
         There are also several filters and filter components in the FreeBSD
-        Ports Collection.</para>
+               Ports Collection.
+               (see <link linkend="ports">The Ports Collection</link>)</para>

       <para>Here is what you will find in this section:</para>

@@ -1930,8 +1931,10 @@
           special text filter for your printer, you can make your
           non &postscript; printer act like a real &postscript; printer.</para>

-        <para>Ghostscript is in the FreeBSD Ports Collection, if you
-          would like to install it from there.  You can fetch, build, and
+        <para>Ghostscript is in the FreeBSD Ports Collection,
+                 (see <link linkend="ports">The Ports Collection</link>)
+                 if you would like to install it from there.  You can
+                 fetch, build, and
           install it quite easily yourself, as well.</para>

         <para>To simulate &postscript;, we have the text filter detect if it is
@@ -2415,9 +2418,10 @@
             <tertiary>apsfilter</tertiary>
           </indexterm>
           <para>The FreeBSD Ports Collection has a text filter that performs
-            automatic conversion called <command>apsfilter</command>.  It can
-            detect plain text, &postscript;, and DVI files, run the proper
-            conversions, and print.</para>
+            automatic conversion called <command>apsfilter</command>.
+                       (see <link linkend="ports">The Ports Collection</link>)
+                       It can detect plain text, &postscript;, and DVI files,
+                       run the proper conversions, and print.</para>
         </sect4>
       </sect3>




>Release-Note:
>Audit-Trail:

From: Marc Fonvieille <blackend@FreeBSD.org>
To: Josh Paetzel <josh@tcbug.org>
Cc: FreeBSD gnats submit <FreeBSD-gnats-submit@FreeBSD.org>
Subject: Re: docs/86134: [patch] fix inconsistency in handbook section 9.4 regarding links to the ports collection
Date: Wed, 14 Sep 2005 21:51:24 +0200

 On Wed, Sep 14, 2005 at 02:28:22PM -0500, Josh Paetzel wrote:
 > 
 > >Description:
 > 
 > 
 > http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/printing-advanced.html
 > 
 > Several ports from the port collection are mentioned in this section of the handbook.  In some places there is a link to: 
 > 
 > http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports.html
 > 
 > In other places there is no link.  This patch makes everything consistent.
 >
 
 I don't think it's a good idea to repeat X times the same thing on the
 same page, once should be enough.  On the other hand a person configuring a
 printer should already know about Ports.
 
 
 > 
 > 
 > 
 > >How-To-Repeat:
 > 
 > 
 > Read http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/printing-advanced.html and look for the various ports that are mentioned in the document.
 > 
 > 
 > >Fix:
 > 
 > 
 > --- chapter.sgml.old    Wed Sep 14 13:57:57 2005
 > +++ chapter.sgml        Wed Sep 14 14:21:10 2005
 > @@ -1512,7 +1512,8 @@
 >          printers that can print plain text.  (It handles backspacing and tabs
 >          in the file, and does accounting, but that is about all it does.)
 >          There are also several filters and filter components in the FreeBSD
 > -        Ports Collection.</para>
 > +               Ports Collection.
 > +               (see <link linkend="ports">The Ports Collection</link>)</para>
 > 
 >        <para>Here is what you will find in this section:</para>
 > 
 > @@ -1930,8 +1931,10 @@
 >            special text filter for your printer, you can make your
 >            non &postscript; printer act like a real &postscript; printer.</para>
 > 
 > -        <para>Ghostscript is in the FreeBSD Ports Collection, if you
 > -          would like to install it from there.  You can fetch, build, and
 > +        <para>Ghostscript is in the FreeBSD Ports Collection,
 > +                 (see <link linkend="ports">The Ports Collection</link>)
 > +                 if you would like to install it from there.  You can
 > +                 fetch, build, and
 >            install it quite easily yourself, as well.</para>
 > 
 >          <para>To simulate &postscript;, we have the text filter detect if it is
 > @@ -2415,9 +2418,10 @@
 >              <tertiary>apsfilter</tertiary>
 >            </indexterm>
 >            <para>The FreeBSD Ports Collection has a text filter that performs
 > -            automatic conversion called <command>apsfilter</command>.  It can
 > -            detect plain text, &postscript;, and DVI files, run the proper
 > -            conversions, and print.</para>
 > +            automatic conversion called <command>apsfilter</command>.
 > +                       (see <link linkend="ports">The Ports Collection</link>)
 > +                       It can detect plain text, &postscript;, and DVI files,
 > +                       run the proper conversions, and print.</para>
 
 
 In fact I'd just s/<command>apsfilter</command>/<filename role="package">print/apsfilter</filename>/
 
 The same remark can be done for the previous changes.
 
 Marc
 
 PS: Your editor adds weird indentation and you should avoid to change
 7 lines just to add 1.

From: Josh Paetzel <josh@tcbug.org>
To: Marc Fonvieille <blackend@freebsd.org>
Cc: FreeBSD gnats submit <FreeBSD-gnats-submit@freebsd.org>
Subject: Re: docs/86134: [patch] fix inconsistency in handbook section 9.4 regarding links to the ports collection
Date: Wed, 14 Sep 2005 15:15:17 -0500

 On Wednesday 14 September 2005 14:51, Marc Fonvieille wrote:
 > On Wed, Sep 14, 2005 at 02:28:22PM -0500, Josh Paetzel wrote:
 > > >Description:
 > >
 > > http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/printin
 > >g-advanced.html
 > >
 > > Several ports from the port collection are mentioned in this
 > > section of the handbook.  In some places there is a link to:
 > >
 > > http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ports.h
 > >tml
 > >
 > > In other places there is no link.  This patch makes everything
 > > consistent.
 >
 > I don't think it's a good idea to repeat X times the same thing on
 > the same page, once should be enough.  On the other hand a person
 > configuring a printer should already know about Ports.
 >
 > > >How-To-Repeat:
 > >
 > > Read
 > > http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/printin
 > >g-advanced.html and look for the various ports that are mentioned
 > > in the document.
 > >
 > > >Fix:
 > >
 > > --- chapter.sgml.old    Wed Sep 14 13:57:57 2005
 > > +++ chapter.sgml        Wed Sep 14 14:21:10 2005
 > > @@ -1512,7 +1512,8 @@
 > >          printers that can print plain text.  (It handles
 > > backspacing and tabs in the file, and does accounting, but that
 > > is about all it does.) There are also several filters and filter
 > > components in the FreeBSD -        Ports Collection.</para>
 > > +               Ports Collection.
 > > +               (see <link linkend="ports">The Ports
 > > Collection</link>)</para>
 > >
 > >        <para>Here is what you will find in this section:</para>
 > >
 > > @@ -1930,8 +1931,10 @@
 > >            special text filter for your printer, you can make
 > > your non &postscript; printer act like a real &postscript;
 > > printer.</para>
 > >
 > > -        <para>Ghostscript is in the FreeBSD Ports Collection, if
 > > you -          would like to install it from there.  You can
 > > fetch, build, and +        <para>Ghostscript is in the FreeBSD
 > > Ports Collection, +                 (see <link
 > > linkend="ports">The Ports Collection</link>) +                 if
 > > you would like to install it from there.  You can +              
 > >   fetch, build, and
 > >            install it quite easily yourself, as well.</para>
 > >
 > >          <para>To simulate &postscript;, we have the text filter
 > > detect if it is @@ -2415,9 +2418,10 @@
 > >              <tertiary>apsfilter</tertiary>
 > >            </indexterm>
 > >            <para>The FreeBSD Ports Collection has a text filter
 > > that performs -            automatic conversion called
 > > <command>apsfilter</command>.  It can -            detect plain
 > > text, &postscript;, and DVI files, run the proper -           
 > > conversions, and print.</para>
 > > +            automatic conversion called
 > > <command>apsfilter</command>. +                       (see <link
 > > linkend="ports">The Ports Collection</link>) +                   
 > >    It can detect plain text, &postscript;, and DVI files, +      
 > >                 run the proper conversions, and print.</para>
 >
 > In fact I'd just s/<command>apsfilter</command>/<filename
 > role="package">print/apsfilter</filename>/
 >
 > The same remark can be done for the previous changes.
 >
 > Marc
 
 That seems sane and reasonable....probably a better idea than my 
 proposed changes.
 
 Here's the rundown:
 
 line 1515 Ports Collection with no link
 
 line 1861 Ports Collection with link
 
 line 1908 Ports Collection with link
 
 line 1933 Ports Collection with no link
 
 line 2291 Ports Collection with link
 
 line 2417 Ports Collection with no link
 
 I was aiming for consistancy, however you do have several valid 
 points.  Perhaps line 1515:
 
 There are also several filters and filter components in the FreeBSD
         Ports Collection.
 
 should have the link and the other 3 which currently have the link 
 should have it removed?
 
 -- 
 Thanks,
 
 Josh Paetzel
Responsible-Changed-From-To: freebsd-doc->blackend 
Responsible-Changed-By: blackend 
Responsible-Changed-When: Fri Sep 30 06:59:58 GMT 2005 
Responsible-Changed-Why:  
For me. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=86134 
State-Changed-From-To: open->closed 
State-Changed-By: blackend 
State-Changed-When: Mon Jul 14 14:23:37 UTC 2008 
State-Changed-Why:  
This has been fixed since a while. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=86134 
>Unformatted:
