From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Org mode and Emacs Date: Mon, 26 Sep 2022 19:16:21 +0300 Message-ID: <837d1qkt62.fsf@gnu.org> References: <87y1u8b1gj.fsf@gmail.com> <8735cgot9x.fsf@gnu.org> <87v8pag7nw.fsf@localhost> <87illaae79.fsf@yahoo.com> <8735cebqsm.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="8369"; mail-complaints-to="usenet@ciao.gmane.io" Cc: bzg@gnu.org, luangruo@yahoo.com, yantar92@gmail.com, relekarpayas@gmail.com, emacs-devel@gnu.org To: "T.V Raman" Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon Sep 26 18:53:43 2022 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1ocrMU-0001xJ-OY for ged-emacs-devel@m.gmane-mx.org; Mon, 26 Sep 2022 18:53:42 +0200 Original-Received: from localhost ([::1]:45032 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ocrMT-0007G1-8W for ged-emacs-devel@m.gmane-mx.org; Mon, 26 Sep 2022 12:53:41 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:38106) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ocqmk-0000xk-3P for emacs-devel@gnu.org; Mon, 26 Sep 2022 12:16:49 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:38678) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ocqmj-0004eA-Do; Mon, 26 Sep 2022 12:16:45 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=ae7wiNR42zn3jLXm1TGYiJ/NKjYMA5RjPWrZ9y38iI0=; b=r9Uh3mAZtjQ9 81CEg5DBHuB92RGNhUL6D8/cxjyjH594speiUUhOItl4sY/vmdHp/B7x/fDI2mDDjp+VWXEN5/waq +l52Jm73BPW1hvTpTm9udABsqmZpbU7WTaoXXqjq4uDRMvUjDLJ3CkH6Z1olfnUjnLaayPT1q2x7+ ySJ9r7vXjZLAnZbyR92HOnHAO1HNduoPBxWo6ShfXlmXqK5XigpJf+8EVaxYrlK7j98Yg9c2Uqg7n Wqb9rlvaFN0pQrl1Oycrbi2s3TdvTNg2jgtkW3RyPYBaEYd/u6ozSwlg2H193rPk68e/lnqPOvSrL nnT6GYkMGY/6ztQTF5nbww==; Original-Received: from [87.69.77.57] (port=1351 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ocqmg-0000XJ-C9; Mon, 26 Sep 2022 12:16:44 -0400 In-Reply-To: (raman@google.com) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:296289 Archived-At: > From: "T.V Raman" > Cc: Po Lu , Ihor Radchenko , Payas > Relekar , emacs-devel@gnu.org > Date: Mon, 26 Sep 2022 06:58:31 -0700 > > I think there are two (perhaps more) aspects to writing good > documentation and accepting / making contributions: > > 1. The basics -- write a paragraph or two describing some feature. > Orthogonal to that and here is where each format bites in different > ways: > > 2. Integrating that contribution into the main corpus of the work --- at > the write place, with the right surrounding context, generating the > right table-of-contents and menus (a running nightmare in Texinfo if > you dont set things up right at the beginning) and so on. > > I think (2) might likely contribute negatively to (1) happening more > often. I think the division you suggest is somewhat artificial. Unlike man pages, Info manuals are not a collection of loosely-couples articles; instead, the sections in a good Info manual are always connected and context-aware. Thus, writing the documentation for the manual should _always_ start by studying the "neighborhood" in which that new stuff will live. IOW, putting the new text in context is not an after-thought, it should be considered prior to writing. I don't know what you allude to as "running nightmare in Texinfo". Adding a new node to a manual is since long ago a very simple process: just add it and make sure the @menu of the parent node (if there is one) is updated to have the new node in its correct place. That's it. > So rather than arguing about formats (and it's been pointed out already > that there are tools for automatic conversion) we should perhaps: > > A. Create a simple content repository where contributors can check-in > their small to medium contributions in the format of their choice > (limited to a few open formats) along with the meta-data > B. A small group of more experienced volunteers take on the task of > incorporating those contributions into the main work. Most contributors to Emacs already write pretty good Texinfo; adding finishing touches to that and fixing a few style or markup mistakes is already being done in the background by those who spot those blunders. So I think we already have the above in place.