From owner-svn-doc-head@FreeBSD.ORG Sat Jul 20 20:46:29 2013 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id 7925FBDB; Sat, 20 Jul 2013 20:46:29 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) by mx1.freebsd.org (Postfix) with ESMTP id 6AB2C326; Sat, 20 Jul 2013 20:46:29 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r6KKkTS2026880; Sat, 20 Jul 2013 20:46:29 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r6KKkTn3026879; Sat, 20 Jul 2013 20:46:29 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201307202046.r6KKkTn3026879@svn.freebsd.org> From: Warren Block Date: Sat, 20 Jul 2013 20:46:29 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42332 - head/en_US.ISO8859-1/books/fdp-primer/docbook-markup X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 20 Jul 2013 20:46:29 -0000 Author: wblock Date: Sat Jul 20 20:46:28 2013 New Revision: 42332 URL: http://svnweb.freebsd.org/changeset/doc/42332 Log: Add some tables showing common FreeBSD entities and their usage. Modified: head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Sat Jul 20 15:24:54 2013 (r42331) +++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Sat Jul 20 20:46:28 2013 (r42332) @@ -46,7 +46,7 @@ not answer to the &a.doc;. DocBook was originally developed by HaL Computer Systems and - O'Reilly & Associates to be a DTD for + O'Reilly & Associates to be a Document Type Definition (DTD) for writing technical documentation A short history can be found under @@ -92,31 +92,233 @@ &os; Extensions The &os; Documentation Project has extended the - DocBook DTD by adding some new elements. - These elements serve to make some of the markup more + DocBook DTD with additional elements and entities. + These additions serve to make some of the markup easier or more precise. - Where a &os;-specific element is listed below, it is - clearly marked. - Throughout the rest of this document, the term DocBook is used to mean the &os;-extended DocBook DTD. - There is nothing about these extensions that is &os; - specific, it was just felt that they were useful + Most of these extensions are not unique to &os;, + it was just felt that they were useful enhancements for this particular project. Should anyone from any of the other *nix camps (NetBSD, OpenBSD, Linux, …) be interested in collaborating on a standard - DocBook extension set, please get in touch with + DocBook extension set, please contact &a.doceng;. - The &os; extensions are not (currently) in the - Ports Collection. They are stored in the &os; Subversion - tree, as head/share/xml/freebsd.dtd. + + &os; Elements + + The additional &os; elements are not (currently) in the + Ports Collection. They are stored in the &os; Subversion + tree, as head/share/xml/freebsd.dtd. + + &os;-specific elements used in the examples below are + clearly marked. + + + + &os; Entities + + + &os; Name Entities + + + + + Name + Expands To + + + + + + &os; + &os; + + + + &os.stable; + &os.stable; + + + + &os.current; + &os.current; + + + +
+ + + &os; Mailing List Entities + + + + + Name + Expands To + Notes + + + + + + &a.doc; + &a.doc; + + Usage: A link to the &a.doc;. + + + + &a.questions; + &a.questions; + + Usage: A link to the &a.questions;. + + + + &a.listname; + link to + listname + Entities are defined for all the &os; mailing + lists. + + + +
+ + + &os; Document Links + + + + + Name + Expands To + Notes + + + + + + &url.books.handbook; + &url.books.handbook; + + Usage: A link to the ulink url="&url.books.handbook;/advanced-networking.html"Advanced + Networkingulink chapter of the Handbook. + + + + &url.books.bookname; + relative path to + bookname + Entities are defined for all the &os; + books. + + + + &url.articles.committers-guide; + &url.articles.committers-guide; + + Usage: A link to the ulink url="&url.articles.committers-guide;"Committer's Guideulink article. + + + + &url.articles.articlename; + relative path to + articlename + Entities are defined for all the &os; articles. + + + +
+ + + Other Operating System Name Entities + + + + + Name + Expands To + Notes + + + + + + &linux; + &linux; + The &linux; operating system. + + + + &unix; + &unix; + The &unix; operating system. + + + + &windows; + &windows; + The &windows; operating system. + + + +
+ + + Miscellaneous Entities + + + + + Name + Expands To + Notes + + + + + + &prompt.root; + &prompt.root; + The root user + prompt. + + + + &prompt.user; + &prompt.user; + A prompt for an unprivileged user. + + + + &postscript; + &postscript; + The trademarked term to refer to the + &postscript; programming language. + + + + &xorg; + &xorg; + The term to refer to the &xorg; open source X + Window System. + + + +
+ @@ -1635,8 +1837,8 @@ This is the file called 'foo2' exported by a Makefile that can be given as a parameter to make. makevar identifies a variable that can be - set (in the environment, on the make - command line, or within the Makefile) + set (in the environment, on the command line with make, + or within the Makefile) to influence the process.