From owner-freebsd-doc  Thu Jul 19  7:57:31 2001
Delivered-To: freebsd-doc@freebsd.org
Received: from bazooka.unixfreak.org (bazooka.unixfreak.org [63.198.170.138])
	by hub.freebsd.org (Postfix) with ESMTP id 719FE37B403
	for <doc@freebsd.org>; Thu, 19 Jul 2001 07:57:28 -0700 (PDT)
	(envelope-from dima@unixfreak.org)
Received: from hornet.unixfreak.org (hornet [63.198.170.140])
	by bazooka.unixfreak.org (Postfix) with ESMTP id 177563E2F
	for <doc@freebsd.org>; Thu, 19 Jul 2001 07:57:28 -0700 (PDT)
To: doc@freebsd.org
Subject: Markup for ports
Date: Thu, 19 Jul 2001 07:57:28 -0700
From: Dima Dorfman <dima@unixfreak.org>
Message-Id: <20010719145728.177563E2F@bazooka.unixfreak.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

Right now, when a port is mentioned in a document, the markup varies
between <filename> and <literal>.  I think both are unsatisfactory;
ideally, the tag would make it clear that what's being marked up is a
port, and would make a hyperlink (in case of HTML output) to the
port's description.

I propose to introduce a new <port> tag to do this.  Attached below is
a patch which implements it.  Here's how it would be used:

        <para>Other interfaces, like <port>databases/tkgnats</port>,
          should also work
          nicely.</para>

Comments?  Suggestions?

Thanks.

Index: freebsd.dsl
===================================================================
RCS file: /stl/src/FreeBSD/doc/share/sgml/freebsd.dsl,v
retrieving revision 1.37
diff -u -r1.37 freebsd.dsl
--- freebsd.dsl	2001/07/17 02:22:29	1.37
+++ freebsd.dsl	2001/07/19 14:55:41
@@ -132,6 +132,13 @@
               (if %refentry-xref-italic%
                 ($italic-seq$)
                 ($charseq$)))))
+
+	(element port
+	  (let* ((urlurl	"http://www.FreeBSD.org/cgi/url.cgi")
+		 (href		(string-append urlurl "?ports/"
+					       (data (current-node)))))
+	    (create-link (list (list "HREF" href))
+			 ($mono-seq$))))
       ]]>
 
       <!-- HTML with images  ............................................ -->
Index: freebsd41.dtd
===================================================================
RCS file: /stl/src/FreeBSD/doc/share/sgml/freebsd41.dtd,v
retrieving revision 1.2
diff -u -r1.2 freebsd41.dtd
--- freebsd41.dtd	2001/05/22 03:32:17	1.2
+++ freebsd41.dtd	2001/07/19 14:55:41
@@ -26,7 +26,7 @@
 <!-- Entities for element classes and mixtures ........................... -->
 
 <!-- Character level classes -->
-<!ENTITY % local.tech.char.class "|HostID|Username|Groupname|Devicename|MakeTarget|MakeVar">
+<!ENTITY % local.tech.char.class "|HostID|Username|Groupname|Devicename|MakeTarget|MakeVar|Port">
 
 <!ENTITY % local.cptr.char.mix "|CO">
 
@@ -113,6 +113,11 @@
 
 <!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