Subject: misc/28536: commas inside element result in broken links
To: None <,,>
From: None <>
List: netbsd-bugs
Date: 12/04/2004 13:06:00
>Number:         28536
>Category:       misc
>Synopsis:       commas inside <pkg> element result in broken links
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    misc-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Sat Dec 04 13:06:00 +0000 2004
>Originator:     Giorgos Keramidas
>Release:        n/a
Some <pkg> elements in the XML sources of htdocs/ contain commas.
Typographically, I also think it's more appropriate to write:

        Configuring <pkg>www/apache,</pkg> despite being easy...

The comma inside the <pkg> element is also included in the
generated link that points to the package description page.
Since there is no package whose name includes a comma, all
such links are broken.


The following diff is also available online at:

Index: Misc/features.xml
RCS file: /cvsroot/netbsd/htdocs/Misc/features.xml,v
retrieving revision 1.4
diff -u -r1.4 features.xml
--- Misc/features.xml	27 Nov 2004 22:50:12 -0000	1.4
+++ Misc/features.xml	4 Dec 2004 12:55:06 -0000
@@ -433,9 +433,9 @@
     The <ulink url="../Documentation/software/packages.html">package
     system</ulink> (pkg) provides easy source or binary installation
     of a large number of third party applications.  It includes
-    all the essentials such as <pkg>meta-pkgs/kde3,</pkg> <pkg>meta-pkgs/gnome2,</pkg>
-    <pkg>www/mozilla,</pkg> <pkg>www/apache2,</pkg> <pkg>lang/perl5,</pkg>
-    <pkg>net/samba,</pkg> <pkg>misc/openoffice,</pkg> <pkg>graphics/gimp,</pkg>
+    all the essentials such as <pkg>meta-pkgs/kde3</pkg>, <pkg>meta-pkgs/gnome2</pkg>,
+    <pkg>www/mozilla</pkg>, <pkg>www/apache2</pkg>, <pkg>lang/perl5</pkg>,
+    <pkg>net/samba</pkg>, <pkg>misc/openoffice</pkg>, <pkg>graphics/gimp</pkg>,
     and more.  Features include:
     <listitem>Easy install from local or remote binary packages, including
@@ -528,7 +528,7 @@
     The <ulink url="../Documentation/software/packages.html">package system</ulink>
-    includes many <pkg>emulators,</pkg> including
+    includes many <pkg>emulators</pkg>, including
     <listitem><pkg>emulators/bochs</pkg> - i386 machine emulator</listitem>
     <listitem><pkg>emulators/ia64sim</pkg> - IA64 (Intel(R) Architecture 64)</listitem>
Index: developers/htdocs.xml
RCS file: /cvsroot/netbsd/htdocs/developers/htdocs.xml,v
retrieving revision 1.11
diff -u -r1.11 htdocs.xml
--- developers/htdocs.xml	28 Nov 2004 20:32:03 -0000	1.11
+++ developers/htdocs.xml	4 Dec 2004 12:55:13 -0000
@@ -41,7 +41,7 @@
     <listitem>Read <ulink url="cvs-repos/cvs_intro.html">the CVS introduction</ulink>.</listitem>
-    <listitem>Install <pkg>meta-pkgs/netbsd-www,</pkg> which provides the tools
+    <listitem>Install <pkg>meta-pkgs/netbsd-www</pkg>, which provides the tools
 	required to build the web site.</listitem>
     <listitem>Set your CVSROOT as indicated and run
 	<para><programlisting>cvs checkout htdocs</programlisting></para></listitem>
@@ -57,7 +57,7 @@
 <title>Validate your HTML</title>
     After making any changes you should run your html through an HTML
-    verifier such as <pkg>www/weblint,</pkg> or better still <ulink
+    verifier such as <pkg>www/weblint</pkg>, or better still <ulink
     The URL for a link to an index.html file should not include the
     trailing index.html.
Index: gallery/testimonial.xml
RCS file: /cvsroot/netbsd/htdocs/gallery/testimonial.xml,v
retrieving revision 1.1
diff -u -r1.1 testimonial.xml
--- gallery/testimonial.xml	2 Dec 2004 15:30:27 -0000	1.1
+++ gallery/testimonial.xml	4 Dec 2004 12:55:17 -0000
@@ -111,7 +111,7 @@
     "The file servers serve a mix of win9[58] and NT clients using
-    <pkg>net/samba</pkg> and <pkg>www/apache,</pkg> with pretty heavy
+    <pkg>net/samba</pkg> and <pkg>www/apache</pkg>, with pretty heavy
     use. I've never had any downtime on the machines (the netbsd
     boxen, that is ;) aside from power failures."