From owner-svn-doc-head@freebsd.org Fri Aug 17 14:44:54 2018 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id E47041070EED; Fri, 17 Aug 2018 14:44:53 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 8DC7A80FD4; Fri, 17 Aug 2018 14:44:53 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 681781C78; Fri, 17 Aug 2018 14:44:53 +0000 (UTC) (envelope-from bcr@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id w7HEir0q068686; Fri, 17 Aug 2018 14:44:53 GMT (envelope-from bcr@FreeBSD.org) Received: (from bcr@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id w7HEippU068675; Fri, 17 Aug 2018 14:44:51 GMT (envelope-from bcr@FreeBSD.org) Message-Id: <201808171444.w7HEippU068675@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: bcr set sender to bcr@FreeBSD.org using -f From: Benedict Reuschling Date: Fri, 17 Aug 2018 14:44:51 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r52151 - in head/en_US.ISO8859-1/books/fdp-primer: docbook-markup stylesheets the-website tools working-copy writing-style xhtml-markup xml-primer X-SVN-Group: doc-head X-SVN-Commit-Author: bcr X-SVN-Commit-Paths: in head/en_US.ISO8859-1/books/fdp-primer: docbook-markup stylesheets the-website tools working-copy writing-style xhtml-markup xml-primer X-SVN-Commit-Revision: 52151 X-SVN-Commit-Repository: doc 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.27 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: Fri, 17 Aug 2018 14:44:54 -0000 Author: bcr Date: Fri Aug 17 14:44:51 2018 New Revision: 52151 URL: https://svnweb.freebsd.org/changeset/doc/52151 Log: Wrap long lines, properly indent tags, capitalizations, and other fixes for issues that textproc/igor reported. Modified: head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml head/en_US.ISO8859-1/books/fdp-primer/xml-primer/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 Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -417,10 +417,10 @@ The &os; tutorials are all marked up as articles, while this document, the FAQ, - and the Handbook are all marked up as books, for - example. + xlink:href="&url.books.faq;/index.html">FAQ, and the + Handbook + are all marked up as books, for example. Starting a Book @@ -1000,11 +1000,10 @@ - A procedure shows a series of - steps, which may in turn - consist of more steps or - substeps. Each step - contains block elements and may include an optional title. + A procedure shows a series of steps, + which may in turn consist of more steps or + substeps. Each step contains block + elements and may include an optional title. Sometimes, steps are not sequential, but present a choice: do this or do that, @@ -1309,7 +1308,8 @@ main(void) informaltable frame="none". - Table with <literal>frame="none"</literal> Example + Table with <literal>frame="none"</literal> + Example Appearance: @@ -1962,7 +1962,7 @@ This is the file called 'foo2' Occasionally it is useful to show a Uniform Resource Identifier (URI) without - making it an active hyperlink. The uri element + making it an active hyperlink. The uri element makes this possible: @@ -2641,18 +2641,18 @@ IMAGES= chapter1/fig1.png Web The link element described here allows the writer to - define the link text. When link text is used, it is very important to be descriptive - to give the reader an idea of where the link goes. - Remember that DocBook can be rendered to multiple - types of media. The reader might be looking at a printed book - or other form of media where there are no links. If the link - text is not descriptive enough, the reader might not be able to - locate the linked section. + define the link text. When link text is used, it is very + important to be descriptive to give the reader an idea of + where the link goes. Remember that DocBook can be rendered to + multiple types of media. The reader might be looking at a + printed book or other form of media where there are no links. + If the link text is not descriptive enough, the reader might + not be able to locate the linked section. - The xlink:href attribute - is the URL of the page, - and the content of the element is the text that - will be displayed for the user to activate. + The xlink:href attribute is the + URL of the page, and the content of the + element is the text that will be displayed for the user to + activate. In many situations, it is preferable to show the actual URL rather than text. This can be done by Modified: head/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/stylesheets/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + Style Sheets XML is concerned with content, and says Modified: head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/the-website/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + The Website The &os; web site is part of the &os; documents. Files for @@ -129,11 +131,12 @@ Having obtained the documentation and web site source files, the web site can be built. - An actual installation of the web site is run as the root - user because the permissions on the web server directory will - not allow files to be installed by an unprivileged user. - For testing, it can be useful to install the files as a normal - user to a temporary directory. + An actual installation of the web site is run as the + root user because the + permissions on the web server directory will not allow files to + be installed by an unprivileged user. For testing, it can be + useful to install the files as a normal user to a temporary + directory. In these examples, the web site files are built by user jru in their home @@ -143,9 +146,10 @@ The web site build uses the INDEX from the Ports Collection and might fail if that file or - /usr/ports is not - present. The simplest approach is to install the Ports - Collection. + /usr/ports is not present. The simplest + approach is to install the Ports + Collection. @@ -241,10 +245,10 @@ Include etc/apache24/Includes/*.conf &prompt.root; service apache24 onestart - The web site can be viewed at - . Be aware that many - links refer to the real &os; site by name, and those links - will still go to the external site instead of the local test + The web site can be viewed at . Be aware that many links + refer to the real &os; site by name, and those links will + still go to the external site instead of the local test version. Fully testing the local site will require temporarily setting DNS so www.FreeBSD.org resolves to Modified: head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/tools/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + Tools Several software tools are used to manage the FreeBSD @@ -72,7 +74,8 @@ - DocBook DTD (textproc/docbook-xml) + DocBook DTD + (textproc/docbook-xml) DocBook is designed for marking up technical Modified: head/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/working-copy/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -26,7 +26,9 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. --> - + The Working Copy The working copy is a copy of the &os; @@ -40,8 +42,11 @@ for temporary files and test versions of various output formats. - Subversion - is used to manage the &os; documentation files. It is obtained by installing the Subversion package: + Subversion + is used to manage the &os; documentation files. It is obtained by + installing the Subversion + package: &prompt.root; pkg install subversion @@ -148,8 +153,9 @@ documentation tree. If the diff file is to be submitted with the web - Submit a &os; - problem report interface, add a + Submit + a &os; problem report interface, add a .txt extension to give the earnest and simple-minded web form a clue that the contents are plain text. @@ -169,8 +175,10 @@ These examples show very basic usage of Subversion. More detail is available - in the Subversion Book - and the Subversion + in the Subversion + Book and the Subversion documentation. Modified: head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + Writing Style @@ -59,7 +61,7 @@ Avoid empty phrases like in order to, which usually just means to. Avoid potentially patronizing words like basically. Avoid Latin - terms like i.e. or cf., which + terms like i.e., or cf., which may be unknown outside of academic or scientific groups. @@ -248,7 +250,8 @@ - For more information about writing style, see Elements of + For more information about writing style, see Elements of Style, by William Strunk. @@ -504,12 +507,16 @@ GB. Hardware compression … CD-ROM - acronymCD-ROMacronym + acronymCD-ROMacronym DoS (Denial of Service) - acronymDoSacronym + acronymDoSacronym @@ -573,7 +580,9 @@ GB. Hardware compression … applicationSubversionapplication Do not refer to the Subversion application as SVN in upper case. To refer to the - command, use commandsvncommand. + command, use commandsvncommand. Modified: head/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/xhtml-markup/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + <acronym>XHTML</acronym> Markup @@ -41,7 +43,8 @@ XHTML is the XML version of the HyperText Markup Language, the markup language of choice on the World Wide Web. More information can be found at - http://www.w3.org/. + http://www.w3.org/. XHTML is used to mark up pages on the &os; web site. It is usually not used to mark up other @@ -59,8 +62,9 @@ The XHTML DTDs are available from the Ports Collection in - textproc/xhtml. They are - automatically installed by the textproc/docproj port. + textproc/xhtml. They are automatically + installed by the textproc/docproj + port. This is not an exhaustive list of @@ -460,7 +464,8 @@ In-line Elements - + Emphasizing Information Two levels of emphasis are available in Modified: head/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml Fri Aug 17 14:17:16 2018 (r52150) +++ head/en_US.ISO8859-1/books/fdp-primer/xml-primer/chapter.xml Fri Aug 17 14:44:51 2018 (r52151) @@ -29,7 +29,9 @@ POSSIBILITY OF SUCH DAMAGE. --> - + XML Primer Most FDP documentation is written with @@ -38,8 +40,8 @@ documentation source, and the XML techniques used. - Portions of this section were inspired by Mark Galassi's - Get + Portions of this section were inspired by Mark Galassi's Get Going With DocBook. @@ -219,8 +221,10 @@ For an element called element-name the start tag will - normally look like element-name. - The corresponding closing tag for this element is element-name. + normally look like element-name. + The corresponding closing tag for this element is element-name. Using an Element (Start and End Tags) @@ -360,14 +364,13 @@ To Do… Before running the examples in this document, install - textproc/docproj from - the &os; Ports Collection. This is a - meta-port that downloads and installs - the standard programs and supporting files needed by the - Documentation Project. &man.csh.1; users must use - rehash for the shell to recognize new - programs after they have been installed, or log out - and then log back in again. + textproc/docproj from the &os; Ports + Collection. This is a meta-port that + downloads and installs the standard programs and supporting + files needed by the Documentation Project. &man.csh.1; users + must use rehash for the shell to recognize + new programs after they have been installed, or log out and + then log back in again. @@ -486,7 +489,8 @@ example.xml:5: element head: validity error : Element - PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + PUBLIC "-//W3C//DTD XHTML 1.0 + Transitional//EN" Lists the Formal Public Identifier @@ -505,7 +509,8 @@ example.xml:5: element head: validity error : Element DTD referenced in the FPI. Other ways of telling the XML parser how to find the - DTD are shown later. + DTD are shown later. @@ -539,7 +544,7 @@ example.xml:5: element head: validity error : Element It is not necessary to know this, but it is useful background, and might help debug problems when the - XML processor can not locate the + XML processor cannot locate the DTD.