From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jean Louis Newsgroups: gmane.emacs.help Subject: Re: outline-minor-mode and org-mode capabilities for programming languages Date: Mon, 10 May 2021 20:05:37 +0300 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="17417"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/2.0.6 (2021-03-06) Cc: help-gnu-emacs@gnu.org To: Christopher Dimech Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Mon May 10 19:08:07 2021 Return-path: Envelope-to: geh-help-gnu-emacs@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 1lg9O3-0004Rb-3O for geh-help-gnu-emacs@m.gmane-mx.org; Mon, 10 May 2021 19:08:07 +0200 Original-Received: from localhost ([::1]:53772 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lg9O2-0002fu-3x for geh-help-gnu-emacs@m.gmane-mx.org; Mon, 10 May 2021 13:08:06 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:42342) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lg9Ms-0002em-9U for help-gnu-emacs@gnu.org; Mon, 10 May 2021 13:06:54 -0400 Original-Received: from stw1.rcdrun.com ([217.170.207.13]:41347) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lg9Mq-0004Ih-7v for help-gnu-emacs@gnu.org; Mon, 10 May 2021 13:06:54 -0400 Original-Received: from localhost ([::ffff:154.228.89.241]) (AUTH: PLAIN securesender, TLS: TLS1.3,256bits,ECDHE_RSA_AES_256_GCM_SHA384) by stw1.rcdrun.com with ESMTPSA id 00000000000ABF27.000000006099682A.00006094; Mon, 10 May 2021 10:06:49 -0700 Mail-Followup-To: Christopher Dimech , help-gnu-emacs@gnu.org Content-Disposition: inline In-Reply-To: Received-SPF: pass client-ip=217.170.207.13; envelope-from=bugs@gnu.support; helo=stw1.rcdrun.com X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.io gmane.emacs.help:129671 Archived-At: * Christopher Dimech [2021-05-10 15:53]: > > How about instead of embedding code in the text, to embed text in the > > code? > > Originally I had bought in the idea of Knuth and others, but did not > buy on their results with literate programming. What I find > valuable is the the development of protowriting that communicates > limited information. They maybe a parser that goes through the to > obtain a more literate translation. Simple Way to Document Code with Markdown, grep, and pandoc | Richard Zach https://people.ucalgary.ca/~rzach/blog/2014/05/simple-way-to-document-code-with-markdown-grep-and-pandoc.html Basically, few shell tools and a workflow may replace all the "literate programming" tools there are. Just write the markup in comments, and pre-process the file with `cut', `grep', etc. to generate output. > > That is where embedding text into the code comes in. There need not be > > visible text in the code, but one could click and get the same > > function elaborated with the markup source, markup result such as PDF, > > and one could jump back to the code. > > The strategy of hiding is good. But I promote the idea of having separate > files. Documentation in code will be limited, more elaborate schemes for > documunetation on a separate file. Most times the code is the place to check > things. That can be done by method using GNU Hyperbole or principle of it, just make each (defun ) or (defvar ) and maybe functions a button that points to something else, editable. Right now if I use M-RET with GNU Hyperbole it brings me to definition of a function, and often it works better than M-. that brings me also to definitions, but it will not find it at all times. > > In other words, don't make it too literate for illiterates. > > There has to be a background and foundation. For instance, > magnetism is one of those things that's just too difficult to > understand, except through an elaborate education in physics. In > computing, we have not arrived at that stage yet. Back in time we were making programs for schools that were very helpful for pupils to learn physics. We don't have much of it today. -- Jean Take action in Free Software Foundation campaigns: https://www.fsf.org/campaigns Sign an open letter in support of Richard M. Stallman https://stallmansupport.org/ https://rms-support-letter.github.io/