From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms13.migadu.com with LMTPS id 4JKyJcibWGciAgAAe85BDQ:P1 (envelope-from ) for ; Tue, 10 Dec 2024 19:51:36 +0000 Received: from aspmx1.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id 4JKyJcibWGciAgAAe85BDQ (envelope-from ) for ; Tue, 10 Dec 2024 20:51:36 +0100 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=PxX9tDkp; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=posteo.net ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1733860295; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=E71QGkj1UUJoGJhqYpuoappNrta6bELuNxASdn107xA=; b=IQDNxQxWyjm4L85d385RsHBMoz2Ef0uQR/BzKgObvV0bVREzX3fwNBf10FzA5LIUCcm4iE TPiHy0QRdD0o9hEhNscG77JcYXQHuUi6VF3bAICjHAz9ZwOiSmQpxk+30WxoSVtNlChDOl Hiq3sBH+yb8YH12SZo66n4O605FudPXRexMWQ6TG0KSepNa8YAf6EhsCR01oMYBQFhcbgK u05pZePFLl5o4Soke5d1yRDMGrtrNhyu2aB6N/j+r8lVnb8CgOohv9CicSGaWaAl7wlqH7 Dubn7ERhb+LMpDIaRg7lP3RkbMMX6lKzBB8xZRYvl0znuT5h4DuUkhSAgbHEWg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=PxX9tDkp; spf=pass (aspmx1.migadu.com: domain of "emacs-orgmode-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="emacs-orgmode-bounces+larch=yhetil.org@gnu.org"; dmarc=pass (policy=none) header.from=posteo.net ARC-Seal: i=1; s=key1; d=yhetil.org; t=1733860295; a=rsa-sha256; cv=none; b=peDDRrW1JUwgBMLyFj24GY8IY8dxjnOKvtvDdfhuTgYzrf653ZbqJndHMyxqPLyAMy2BOS g0JkEh0fTfNsh/a4Um2XgKiIt/fxb3u/X0w6b+eBgWimTBpTWz0yL52zWTbCW4/3dT7Axw 8+8AjWDN5HK9qYT5Msv8w2c1t0gHhTewTFmetlxLsMfePiQUdTijidclex5cIWuKZwnkTs oxaI86OWOwQwUFcHg2iSJ84+6oleb+qwY6DZS0zoIbrD6/L6IU8XCutJY+kTmpKLIQGCBX SoAY1ArsCX5V1FKs36s9y7tw3cuhyUoPMq29GqjMl1gqq0Vhzg8efztFsVi5ZQ== Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 69FBF447E6 for ; Tue, 10 Dec 2024 20:51:35 +0100 (CET) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tL6GE-0005oS-Sx; Tue, 10 Dec 2024 14:51:10 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tL6GA-0005nq-9H for emacs-orgmode@gnu.org; Tue, 10 Dec 2024 14:51:06 -0500 Received: from mout01.posteo.de ([185.67.36.65]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tL6G8-00050K-9q for emacs-orgmode@gnu.org; Tue, 10 Dec 2024 14:51:06 -0500 Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id BE559240027 for ; Tue, 10 Dec 2024 20:51:01 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1733860261; bh=3Imly6XzZZ4bi+ZTdSbaeF6hDwhzkQMInQFLVczcnWE=; h=From:To:Subject:Date:Message-ID:MIME-Version:Content-Type:From; b=PxX9tDkpTgtAJwdfrKB+YImb7IAz0eVKiyuh4AuVsnAUcIwYKAkEf9UfJkHjehoU4 0gJ/X+DWj+hC84SmzLantJrOkc4biIcPHoTA9gTP0qQjcRe2Za3HFZJibBioTIHhJ6 fvlJ3UcMvaRhtUJnv1lHkTtueh+mWLFKpwduHRvrIeXMPwYCYVO1BtzM6Iqoja/v7B K1o/f/0Au+tClefHR0+jwVyCzJfHIu1MhGtobka5AzX3oLWhZofZXYT2zAskXxIyM8 QyQQFNhw3RQtGxJzXaWKpeJiPhzjUrH1ANV++3g+rTwCuNRJ7g3Y4ehGX45EOkoR0v Zj4dbQJXxARoA== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4Y78VY2yhhz6tx1 for ; Tue, 10 Dec 2024 20:51:01 +0100 (CET) From: Ihor Radchenko To: emacs-orgmode@gnu.org Subject: [TASK] Move babel backend docs from WORG to Org manual Date: Tue, 10 Dec 2024 19:52:32 +0000 Message-ID: <87zfl3uxhb.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain Received-SPF: pass client-ip=185.67.36.65; envelope-from=yantar92@posteo.net; helo=mout01.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-orgmode@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+larch=yhetil.org@gnu.org Sender: emacs-orgmode-bounces+larch=yhetil.org@gnu.org X-Migadu-Country: US X-Migadu-Flow: FLOW_IN X-Migadu-Scanner: mx11.migadu.com X-Migadu-Spam-Score: -1.88 X-Spam-Score: -1.88 X-Migadu-Queue-Id: 69FBF447E6 X-TUID: LyTmOuldyZoc Dear all, In my talk https://emacsconf.org/2024/talks/org-update, one of the tasks I announced was moving babel documentation from WORG to Org manual. Here, I would like to details what should be done for that task. This is a big task, but we can split it into much smaller and simpler tasks. I recommend taking documentation from a single language to get started. Multiple volunteers (if any) may work on other languages in parallel. Please tell us which language you are working on to avoid conflicts. Also, feel free to ask anything here or in any other communication channel (IRC, Matrix, OrgMeetup) if there are difficulties. The general idea is to port files from https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel into Org manual. At the end, we should have all the ob- files from https://git.savannah.gnu.org/cgit/emacs/org-mode.git/tree/lisp documented in the manual. The documentation at various stages of completeness is listed in https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel/languages (ob-doc-.org). For each built-in language, we will need to: 1. Find ob-doc-.org file, if any 2. Make sure that the documentation conforms to https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel/languages/ob-doc-template.org 3. If it does not, we at least need to indicate undocumented sections 4. If possible, may also document the missing parts 4.1. Sometimes, the language implementations in lisp/ob- miss features from the checklist. Such problems should be reported as bugs for easier tracking. 5. The cleaned up documentation should be ported to Org manual. Tentatively, we can follow the structure of export backends as in https://orgmode.org/manual/Exporting.html 6. If there is no documentation at all, it should be written Once we are done with individual languages, we will need to: 1. Review, update, and double check https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel/languages/lang-compat.org 2. Write documentation about writing a new backend as in https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel/languages/ob-doc-template.org and https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel/ob-template.el 3. Refer to (or move) this documentation from Org manual 4. Review https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel/header-args.org and possibly merge it with Org manual 5. There will be some non-builtin language docs available at the end. We will need to move this documentation to relevant packages (is there are), to org-contrib, or obsolete 6. Review the remaining files in https://git.sr.ht/~bzg/worg/tree/master/item/org-contrib/babel List of built-in languages: - [ ] ob-C - [ ] ob-R - [ ] ob-awk - [ ] ob-calc - [ ] ob-clojure - [ ] ob-css Note: This is a stub. We might later discuss if it can be generalized. - [ ] ob-ditaa - [ ] ob-dot - [ ] ob-emacs-lisp - [ ] ob-eshell - [ ] ob-forth - [ ] ob-fortran - [ ] ob-gnuplot - [ ] ob-groovy - [ ] ob-haskell - [ ] ob-java - [ ] ob-js - [ ] ob-julia - [ ] ob-latex - [ ] ob-lilypond - [ ] ob-lisp - [ ] ob-lua - [ ] ob-makefile - [ ] ob-matlab - [ ] ob-maxima - [ ] ob-ocaml - [ ] ob-octave - [ ] ob-org - [ ] ob-perl - [ ] ob-plantuml - [ ] ob-processing - [ ] ob-python - [ ] ob-ruby - [ ] ob-sass - [ ] ob-scheme - [ ] ob-screen - [ ] ob-sed - [ ] ob-shell - [ ] ob-sql - [ ] ob-sqlite -- Ihor Radchenko // yantar92, Org mode maintainer, Learn more about Org mode at . Support Org development at , or support my work at