From owner-freebsd-doc@freebsd.org Sat Jul 7 19:16:50 2018 Return-Path: Delivered-To: freebsd-doc@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 417FD1043CD2 for ; Sat, 7 Jul 2018 19:16:50 +0000 (UTC) (envelope-from sid@bsdmail.com) Received: from mout.gmx.com (mout.gmx.com [74.208.4.200]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (Client CN "mail.gmx.com", Issuer "thawte SSL CA - G2" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id C538286B7F for ; Sat, 7 Jul 2018 19:16:49 +0000 (UTC) (envelope-from sid@bsdmail.com) Received: from [108.70.50.7] ([108.70.50.7]) by web-mail.mail.com (3c-app-mailcom-lxa02.server.lan [10.76.45.3]) (via HTTP); Sat, 7 Jul 2018 21:16:37 +0200 MIME-Version: 1.0 Message-ID: From: Sid To: "Eitan Adler" Cc: "freebsd-doc@freebsd.org" Subject: Re: Documentation should rely on stylesheets for XML not txt tools Content-Type: text/plain; charset=UTF-8 Date: Sat, 7 Jul 2018 21:16:37 +0200 Importance: normal Sensitivity: Normal In-Reply-To: References: X-UI-Message-Type: mail X-Priority: 3 X-Provags-ID: V03:K1:LQsWsR8gVMJQn6ixYGl25DXZDL8hfE9UacnsH9GGWajYeJlWsVZyn/4sCaKjA51ExaTf4 dEJgtOJ446+Vw4OOvvFMf7LRHtBn/FdZm21hU0eBENxcv2cXsGNMKOfPhgmjzPU5pXomBqcSuVaH YTVUIUUuJfdiSEONHfhtJDpXOBtrHtzA1yHGksDeWsSFABKB+cFZJdjFyDoqo48wx79OZHHiGjn+ YMLvTuVlEOp1m43RjEv8XMGMEuuxT2O6YgNk7ejZI9po3vu+UTJupwFxb49pta0TkWJ3wFlZEFL7 RA= X-UI-Out-Filterresults: notjunk:1;V01:K0:tl3oh9VyuuU=:x1moEGyxerzBdj0IRd7xo+ ehIf6yvNdHabUWOeqKj3rIP7QTTqjduR0ECtWb4mShhwwqT92RhZa39ymGQ6xG8nn5ZyxX67f Z0/i90e0CL6GcPGUnyA/yjoq2zmqMO92U2GCTZoutf7hIElcGWg0ES8UYApMvGgebpXlHns1S mxB0DjyuGvt9BVtB97I02TLjrDySyd0iWB7/J+gbxEMVAqk4MdAscbuiJK4Q6bxz09E/OEqab ji3kQx2xPLTZuwuvooohqzjPfManfOAvtL040eZIBaXM8BTl0oV4vDrgL4ov2O8X62c0jyZmt 9ieoD1JDK4R7dDLGQbpwMqvqcW0lrgfaE20WqRB+/SLMUbtMwdXNjgPMeyKU7DWqDuxiw9eaS rLTbOT+r31XrKuoXsFzlnRf4NBfxChxpVTKah9pK9F6qIGVQfglbmGrh0LHJvZedsnfCMJAmy R4iGK3vH6c16UgUgfl8OJtjs3hMMr6rG4XeeZRO8SC6OqHxgnCKibEHMiSKwa7cPjU3F3+T79 43IJQ4SEcHt8n0QESEclDvnhvoHNhUFC92UWLkaORbG X-BeenThere: freebsd-doc@freebsd.org X-Mailman-Version: 2.1.27 Precedence: list List-Id: Documentation project List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sat, 07 Jul 2018 19:16:50 -0000 Thank you for your response. The tools I'm referring to are igor and xmllint. Mention of igor is here, https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/overview.html . (the other link had the mistake of including the sentence punctuation) Mention of xmllint is in chapter 7.2. Other tools used are text editors in Chapter 15: Vim, Emacs, Nano The problem is not the text editors, because any and more should be allowed. Each one of these three text editors must have configuration set up, which is good, except when the program misbehaves. The set up for tabs is great, but to include them in checking for errors make it difficult. Earlier what I should have said is, there needs to be a parser that uses the FreeBSD stylesheet to fix the spacing and tabbing outside of XML elements, once or after it is submitted. Instead of igor, all that should be checked is the XML/Docbook syntax, and maybe spelling errors and FreeBSD jargon. I've tried editing on my pc, but once I edit an indent or spacing, I can't get it back, without getting rid of spacing errors on igor. I know I lack understanding of something for that to happen, but it is complex beyond necessity, and I get errors popping up in chapters I didn't touch. I think simplifying the process so that only Docbook needs to be learned well for edit proposals will make it easier for those submitting bug reports, and especially for committers. Simplifying it wouldn't hurt with retaining contributors. Also, I would like to see the ability for edits to be made based from inside elements of the id attribute of a chapter or part. For example (not a Docbook example) .... In other words, the line numbering would start from an id attribute within a part or chapter, and the submission would be based on the opening and closing elements from that id in that part or chapter. > Saturday, July 07, 2018 at 10:56 AM, > > Fri, 6 Jul 2018 at 17:41, > > > > I'm aware of FreeBSD's XSLT and DSSSL stylesheets, mentioned at https://www.freebsd.org/doc/en_US.ISO8859-1/books/fdp-primer/stylesheets.html but they should be used exclusively for its Docbook XML. > > > > XSLT's stylesheet needs to be a part of automating of tabbing and stripping of spacing outside of element tags for .txt and other formats. > > Can you give me an example of a text tool we use? I'm not sure of what you mean. > > Eitan Adler