From owner-svn-doc-all@FreeBSD.ORG Wed Jun 26 15:40:24 2013 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) by hub.freebsd.org (Postfix) with ESMTP id B9F23143; Wed, 26 Jun 2013 15:40:24 +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 9B98C1CFB; Wed, 26 Jun 2013 15:40:24 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r5QFeOOj070305; Wed, 26 Jun 2013 15:40:24 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r5QFeOm5070302; Wed, 26 Jun 2013 15:40:24 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201306261540.r5QFeOm5070302@svn.freebsd.org> From: Warren Block Date: Wed, 26 Jun 2013 15:40:23 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42065 - in head/en_US.ISO8859-1/books/fdp-primer: . overview X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 26 Jun 2013 15:40:24 -0000 Author: wblock Date: Wed Jun 26 15:40:23 2013 New Revision: 42065 URL: http://svnweb.freebsd.org/changeset/doc/42065 Log: Whitespace-only fixes. Translators, please ignore. Modified: head/en_US.ISO8859-1/books/fdp-primer/book.xml head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Modified: head/en_US.ISO8859-1/books/fdp-primer/book.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/book.xml Wed Jun 26 15:29:14 2013 (r42064) +++ head/en_US.ISO8859-1/books/fdp-primer/book.xml Wed Jun 26 15:40:23 2013 (r42065) @@ -72,7 +72,8 @@ Thank you for becoming a part of the FreeBSD Documentation - Project. Your contribution is extremely valuable, and we appreciate it. + Project. Your contribution is extremely valuable, and we + appreciate it. This primer covers details needed to start contributing to the FreeBSD Documentation @@ -172,13 +173,16 @@ The time is 09:18 Emphasis. - The user must do this. + The user must do + this. Text that the user is expected to replace with the actual text. - To search for a keyword in the manual pages, type man -k + + To search for a keyword in the manual pages, type + man -k keyword @@ -220,9 +224,9 @@ The time is 09:18 Warnings are represented like this, and contain information warning about possible damage if the - instructions are not followed. This damage may be physical, to - the hardware or the user, or it may be non-physical, such as - the inadvertent deletion of important files. + instructions are not followed. This damage may be physical, + to the hardware or the user, or it may be non-physical, such + as the inadvertent deletion of important files. Modified: head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Wed Jun 26 15:29:14 2013 (r42064) +++ head/en_US.ISO8859-1/books/fdp-primer/overview/chapter.xml Wed Jun 26 15:40:23 2013 (r42065) @@ -39,16 +39,15 @@ to the success of &os;, and we value your contributions very highly. - This document describes how the - FDP is organized, how to write and submit - documentation, and how to effectively use the available - tools. + This document describes how the FDP is + organized, how to write and submit documentation, and how to + effectively use the available tools. Everyone is welcome to contribute to the - FDP. Willingness to contribute is the only membership requirement. + FDP. Willingness to contribute is the only + membership requirement. - This Primer shows the reader how - to: + This Primer shows the reader how to: @@ -77,7 +76,6 @@ categories of &os; documentation. - Handbook: The Handbook is the comprehensive online resource and reference for &os; @@ -110,9 +108,9 @@ - Translation teams are responsible for translating - the Handbook and web site into different languages. Manual - pages are not translated. + Translation teams are responsible for translating the + Handbook and web site into different languages. Manual pages + are not translated. Documentation source for the &os; web site, Handbook, and FAQ is available in the Subversion @@ -123,31 +121,30 @@ Subversion repository located at https://svn.FreeBSD.org/base/. - Documentation commit messages - are visible with svn. - Commit messages are also archived at . + Documentation commit messages are visible with + svn. Commit messages are also + archived at . In addition, many people have written tutorials or how-to articles about &os;. Some are stored as part of the - FDP files. In other cases, the author has decided - to keep the documentation separate. - The FDP endeavors to - provide links to as much of this external documentation as - possible. + FDP files. In other cases, the author has + decided to keep the documentation separate. The + FDP endeavors to provide links to as much of + this external documentation as possible. Quick Start - Here we describe the steps contributors must - follow before they can make changes to the - FDP. New contributors will interact with - other members of the &os; Documentation Team, which can assist in - learning to use XML and the suggestions in . If a new user contributes - regularly, a Documentation Team member may be assigned as a - mentor to guide the user through the process from contributor - to documentation committer. + Here we describe the steps contributors must follow before + they can make changes to the FDP. New + contributors will interact with other members of the &os; + Documentation Team, which can assist in learning to use + XML and the suggestions in + . If a new user + contributes regularly, a Documentation Team member may be + assigned as a mentor to guide the user through the process from + contributor to documentation committer. @@ -182,13 +179,16 @@ How to do so varies by editor. Some editor configurations are listed in . The editor should be configured as follows: + Word wrap set to 70 characters. + Tab stops set to 2. + Replace each group of 8 leading spaces with a single tab. @@ -198,10 +198,10 @@ Locate the file to edit. Run - svn up within the local working copy - to make sure that it is up to date. Before making major - changes to a file, discuss the proposed changes with - the &a.doc;. + svn up within the local working copy to + make sure that it is up to date. Before making major + changes to a file, discuss the proposed changes with the + &a.doc;. When making edits, determine which tags and entities are needed to achieve the desired formatting. One way to @@ -220,13 +220,12 @@ &prompt.user; igor -R filename.xml | less -RS - Review the output and edit the file to fix any - listed tab errors, spelling mistakes, and improper - grammar. Save the changes and rerun this command to find - any remaining problems. Repeat until all of the errors - that you deem fixable are resolved. If you get stuck - trying to fix errors, ask for assistance on the - &a.doc;. + Review the output and edit the file to fix any listed + tab errors, spelling mistakes, and improper grammar. Save + the changes and rerun this command to find any remaining + problems. Repeat until all of the errors that you deem + fixable are resolved. If you get stuck trying to fix + errors, ask for assistance on the &a.doc;. @@ -255,13 +254,14 @@ &prompt.user; make FORMATS="html txt" - Once these steps are successfully completed, generate a - diff file of the changes. While in /usr/doc, run this command, - replacing bsdinstall with the - name of the directory containing the edits: + Once these steps are successfully completed, generate + a diff file of the changes. While in + /usr/doc, run this + command, replacing bsdinstall + with the name of the directory containing the + edits: - &prompt.user; svn diff > bsdinstall.diff.txt + &prompt.user; svn diff > bsdinstall.diff.txt