From owner-svn-doc-all@FreeBSD.ORG Mon Jul 22 20:27:55 2013 Return-Path: Delivered-To: svn-doc-all@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 0641CD06; Mon, 22 Jul 2013 20:27:55 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id EBA0922F0; Mon, 22 Jul 2013 20:27:54 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r6MKRs1a007508; Mon, 22 Jul 2013 20:27:54 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r6MKRsiY007507; Mon, 22 Jul 2013 20:27:54 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201307222027.r6MKRsiY007507@svn.freebsd.org> From: Warren Block Date: Mon, 22 Jul 2013 20:27:54 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42382 - head/en_US.ISO8859-1/books/fdp-primer/writing-style 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: Mon, 22 Jul 2013 20:27:55 -0000 Author: wblock Date: Mon Jul 22 20:27:54 2013 New Revision: 42382 URL: http://svnweb.freebsd.org/changeset/doc/42382 Log: Clarify the indentation section, replace the Emacs and Vim configuration mentions with an xref to the new editor config chapter. Modified: head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml 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 Mon Jul 22 19:55:25 2013 (r42381) +++ head/en_US.ISO8859-1/books/fdp-primer/writing-style/chapter.xml Mon Jul 22 20:27:54 2013 (r42382) @@ -299,9 +299,9 @@ Indentation - Each file starts with indentation set at column 0, + The first line in each file starts with no indentation, regardless of the indentation level of - the file which might contain this one. + the file which might contain the current file. Opening tags increase the indentation level by 2 spaces. Closing tags decrease the indentation level by 2 spaces. @@ -314,44 +314,27 @@ For example, the source for this section looks something like: - - ... + chapter + title...title - - ... + sect1 + title...title - - Indentation + sect2 + titleIndentationtitle - Each file starts with indentation set at column 0, - regardless of the indentation level of the file - which might contain this one. + paraThe first line in each file starts with no indentation, + emphasisregardlessemphasis of the indentation level of + the file which might contain the current file.para ... - - -]]> - - Emacs or - XEmacs should load - sgml-mode automatically, - and the Emacs local variables at - the bottom of each file should enforce these styles. - - Vim users might want to - configure their editor with: - - augroup sgmledit - autocmd FileType sgml set formatoptions=cq2l " Special formatting options - autocmd FileType sgml set textwidth=70 " Wrap lines at 70 columns - autocmd FileType sgml set shiftwidth=2 " Automatically indent - autocmd FileType sgml set softtabstop=2 " Tab key indents 2 spaces - autocmd FileType sgml set tabstop=8 " Replace 8 spaces with a tab - autocmd FileType sgml set autoindent " Automatic indentation -augroup END - + sect2 + sect1 +chapter + + Configurations to help various text editors conform to + these guidelines can be found in + .