From owner-svn-doc-projects@FreeBSD.ORG Sun Jun 23 21:08:12 2013 Return-Path: Delivered-To: svn-doc-projects@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id BDA7569F; Sun, 23 Jun 2013 21:08:12 +0000 (UTC) (envelope-from gjb@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 9FB401DA5; Sun, 23 Jun 2013 21:08:12 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r5NL8CK8081437; Sun, 23 Jun 2013 21:08:12 GMT (envelope-from gjb@svn.freebsd.org) Received: (from gjb@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r5NL8BXk081430; Sun, 23 Jun 2013 21:08:11 GMT (envelope-from gjb@svn.freebsd.org) Message-Id: <201306232108.r5NL8BXk081430@svn.freebsd.org> From: Glen Barber Date: Sun, 23 Jun 2013 21:08:11 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-projects@freebsd.org Subject: svn commit: r42011 - in projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer: . docbook-markup overview sgml-markup writing-style xhtml-markup X-SVN-Group: doc-projects MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-projects@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: SVN commit messages for doc projects trees List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 23 Jun 2013 21:08:12 -0000 Author: gjb Date: Sun Jun 23 21:08:11 2013 New Revision: 42011 URL: http://svnweb.freebsd.org/changeset/doc/42011 Log: MFH: Merged /head/en_US.ISO8859-1:r42005-42010 Approved by: doceng (implicit) Added: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/docbook-markup/ - copied from r42010, head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/ - copied from r42010, head/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/ Deleted: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/sgml-markup/ Modified: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/Makefile projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/book.xml projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/chapters.ent projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Directory Properties: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/ (props changed) Modified: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/Makefile ============================================================================== --- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/Makefile Sun Jun 23 21:04:16 2013 (r42010) +++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/Makefile Sun Jun 23 21:08:11 2013 (r42011) @@ -23,7 +23,8 @@ SRCS= book.xml SRCS+= overview/chapter.xml SRCS+= psgml-mode/chapter.xml SRCS+= see-also/chapter.xml -SRCS+= sgml-markup/chapter.xml +SRCS+= xhtml-markup/chapter.xml +SRCS+= docbook-markup/chapter.xml SRCS+= sgml-primer/chapter.xml SRCS+= stylesheets/chapter.xml SRCS+= structure/chapter.xml Modified: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/book.xml ============================================================================== --- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/book.xml Sun Jun 23 21:04:16 2013 (r42010) +++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/book.xml Sun Jun 23 21:08:11 2013 (r42011) @@ -248,7 +248,8 @@ Password: &chap.overview; &chap.tools; &chap.xml-primer; - &chap.xml-markup; + &chap.xhtml-markup; + &chap.docbook-markup; &chap.stylesheets; &chap.structure; &chap.doc-build; Modified: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/chapters.ent ============================================================================== --- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/chapters.ent Sun Jun 23 21:04:16 2013 (r42010) +++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/chapters.ent Sun Jun 23 21:08:11 2013 (r42011) @@ -13,7 +13,8 @@ - + + Modified: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml ============================================================================== --- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Sun Jun 23 21:04:16 2013 (r42010) +++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Sun Jun 23 21:08:11 2013 (r42011) @@ -211,7 +211,8 @@ to the tags which surround the text or the entities that represent that text in the XML file. A reference to the commonly used tags and entities can be - found in . + found in and + . @@ -291,4 +292,4 @@ - \ No newline at end of file + Modified: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml ============================================================================== --- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Sun Jun 23 21:04:16 2013 (r42010) +++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Sun Jun 23 21:08:11 2013 (r42011) @@ -71,6 +71,15 @@ rather than you can copy the file to /tmp. + Give clear, correct examples. A trivial example is better + than no example, but a good example is better yet. Do not + give bad examples, identifiable by apologies or sentences like + but really it should never be done that way. + Bad examples are worse than no examples. Give good examples, + because even when warned not to use the example + as shown, the reader will usually just use the + example as shown. + Avoid weasel words like should, might, try, or could. These words @@ -89,7 +98,8 @@ skill level. Tell them what they need to know. Give links to other documents to provide background information without having to recreate it. Put yourself in the reader's place, - and answer the questions they will ask. + anticipate the questions they will ask, and answer + them.