Bug 86134

Summary: [patch] fix inconsistency in handbook section 9.4 regarding links to the ports collection
Product: Documentation Reporter: Josh Paetzel <josh> <josh>
Component: Books & ArticlesAssignee: Marc Fonvieille <blackend>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Josh Paetzel <josh@tcbug.org> 2005-09-14 20:30:11 UTC

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.

Fix: 

<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>--3p8TXvbQfm5MsgsMK3sgGWByFNlMQLvGWTeri76bqHpli9yq
Content-Type: text/plain; name="file.diff"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="file.diff"

--- 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>
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.
Comment 1 Marc Fonvieille freebsd_committer freebsd_triage 2005-09-14 20:51:24 UTC
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.
Comment 2 Josh Paetzel <josh@tcbug.org> 2005-09-14 21:15:17 UTC
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
Comment 3 Marc Fonvieille freebsd_committer freebsd_triage 2005-09-30 07:59:58 UTC
Responsible Changed
From-To: freebsd-doc->blackend

For me.
Comment 4 Marc Fonvieille freebsd_committer freebsd_triage 2008-07-14 15:23:37 UTC
State Changed
From-To: open->closed

This has been fixed since a while.