From owner-freebsd-doc  Sun Feb 10  2: 6: 0 2002
Delivered-To: freebsd-doc@freebsd.org
Received: from bazooka.trit.org (bazooka.trit.org [63.198.170.138])
	by hub.freebsd.org (Postfix) with ESMTP id 7071E37B404
	for <doc@freebsd.org>; Sun, 10 Feb 2002 02:05:55 -0800 (PST)
Received: by bazooka.trit.org (Postfix, from userid 1000)
	id 9A7DB3E35; Sun, 10 Feb 2002 10:05:54 +0000 (UTC)
Received: from bazooka (localhost [127.0.0.1])
	by bazooka.trit.org (Postfix) with ESMTP id 840C93C12E
	for <doc@freebsd.org>; Sun, 10 Feb 2002 10:05:54 +0000 (UTC)
To: doc@freebsd.org
Subject: <port> replacement
Date: Sun, 10 Feb 2002 10:05:49 +0000
From: Dima Dorfman <dima@trit.org>
Message-Id: <20020210100554.9A7DB3E35@bazooka.trit.org>
Sender: owner-freebsd-doc@FreeBSD.ORG
Precedence: bulk
List-ID: <freebsd-doc.FreeBSD.ORG>
List-Archive: <http://docs.freebsd.org/mail/> (Web Archive)
List-Help: <mailto:majordomo@FreeBSD.ORG?subject=help> (List Instructions)
List-Subscribe: <mailto:majordomo@FreeBSD.ORG?subject=subscribe%20freebsd-doc>
List-Unsubscribe: <mailto:majordomo@FreeBSD.ORG?subject=unsubscribe%20freebsd-doc>
X-Loop: FreeBSD.org

I propose to replace the <port> tag with <filename> and a "role"
attribute as follows:

	<filename role="package">

There have been some discussions about this in the past, and I think
everyone agrees that <port> should be taken out and shot.  Some people
wanted to do weird (to me, at least) things instead, but I believe the
above is what most people felt comfortable with.

The attached patch makes the above valid and removes <port>.  I've
only tested it with HTML output, so if someone could test it with
other output formats I'd appreciate it.  The following patches replace
all instances of <port> with the new construct for the doc tree,
relnotes in -current, and relnotes in -stable, respectively:

	http://www.trit.org/~dima/home/p/docport.doc.diff
	http://www.trit.org/~dima/home/p/docport.rc.diff
	http://www.trit.org/~dima/home/p/docport.r4.diff

They were generated by applying the following to all SGML files:

	s:<port>(.*?)</port>:<filename role="package">\1</filename>:g

(Since the new construct is longer, many of the lines now go over 80
characters, but that can't be helped.)

If nobody objects, I'd like to commit this soon-ish to avoid having to
regenerate and retest everything due to other, unrelated, changes.

Thanks.

Index: freebsd.dsl
===================================================================
RCS file: /ref/cvsf/doc/share/sgml/freebsd.dsl,v
retrieving revision 1.63
diff -u -r1.63 freebsd.dsl
--- freebsd.dsl	10 Jan 2002 22:09:44 -0000	1.63
+++ freebsd.dsl	10 Feb 2002 08:55:01 -0000
@@ -141,13 +141,16 @@
                 ($italic-seq$)
                 ($charseq$)))))
 
-	(element port
-	  (let* ((urlurl	"http://www.FreeBSD.org/cgi/url.cgi")
-		 (href		(string-append urlurl "?ports/"
+	(element filename
+	  (let*	((class		(attribute-string (normalize "role"))))
+	    (cond
+	     ((equal? class "package")
+	      (let* ((urlurl	"http://www.FreeBSD.org/cgi/url.cgi")
+		     (href	(string-append urlurl "?ports/"
 					       (data (current-node))
 					       "/pkg-descr")))
-	    (create-link (list (list "HREF" href))
-			 ($mono-seq$))))
+		(create-link (list (list "HREF" href)) ($mono-seq$))))
+	     (else ($mono-seq$)))))
       ]]>
 
       <!-- HTML with images  ............................................ -->
@@ -394,9 +397,6 @@
 ;            (urlwrap)
 ;            (literal ">")))
 
-        (element port
-	    (pathwrap))
-          
         (element filename
 	    (pathwrap))
 
Index: freebsd41.dtd
===================================================================
RCS file: /ref/cvsf/doc/share/sgml/freebsd41.dtd,v
retrieving revision 1.3
diff -u -r1.3 freebsd41.dtd
--- freebsd41.dtd	24 Jul 2001 11:07:59 -0000	1.3
+++ freebsd41.dtd	10 Feb 2002 09:01:14 -0000
@@ -26,7 +26,7 @@
 <!-- Entities for element classes and mixtures ........................... -->
 
 <!-- Character level classes -->
-<!ENTITY % local.tech.char.class "|HostID|Username|Groupname|Devicename|MakeTarget|MakeVar|Port">
+<!ENTITY % local.tech.char.class "|HostID|Username|Groupname|Devicename|MakeTarget|MakeVar">
 
 <!ENTITY % local.cptr.char.mix "|CO">
 
@@ -113,11 +113,6 @@
 
 <!ELEMENT MakeVar - - ((%cptr.char.mix;)+)>
 <!ATTLIST MakeVar
-                %common.attrib;
->
-
-<!ELEMENT Port - - ((%cptr.char.mix;)+)>
-<!ATTLIST Port
                 %common.attrib;
 >
 

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message