From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms9.migadu.com with LMTPS id cFuUHQpcnWRXWwAASxT56A (envelope-from ) for ; Thu, 29 Jun 2023 12:25:14 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id iJmJHQpcnWRnAQEA9RJhRA (envelope-from ) for ; Thu, 29 Jun 2023 12:25:14 +0200 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 D988E38525 for ; Thu, 29 Jun 2023 12:25:13 +0200 (CEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qEop9-0005vU-NI; Thu, 29 Jun 2023 06:24:27 -0400 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 1qEop6-0005tE-Kh for emacs-orgmode@gnu.org; Thu, 29 Jun 2023 06:24:25 -0400 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 1qEop4-0006kW-DE for emacs-orgmode@gnu.org; Thu, 29 Jun 2023 06:24:24 -0400 Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 771CE24002A for ; Thu, 29 Jun 2023 12:24:19 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017; t=1688034259; bh=nvQqWkH92tXAc8stt1FYdHegDRysBcjjQRkzeUemQbg=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version: Content-Transfer-Encoding:From; b=MJn6+ijEaPMoNSzIseu4wsqIMnMPltjblQg9NSj5G6sEomwcskCbW1LXC2BZt6Rfx iIHCeJtZa6tTxbmVHeYjH8Msf+lPwjGMbHO0E+MaYcacW/NB4OQhfnfePGcPe6/ueC RDxNV0xNKeWaxLIQ+fayYoB73NnqF7jCx0sH6V+MUslEQ9XaWbc+WvCO8xYX3xjySU KtP3TV7koWzWjYWWoolCnGLpONIzh1VzaWBzU8iqMv9vMiKX1EKlH7mBHYjnknqah2 BJmZNQM47Uq+7i+XPa2iHE+RevCFtBs2ZPNvXfKhyxnD40XDkc7ZE8DIFD07W9h1XC F2T6dCAP0Za9w== Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4QsF1G26Vnz9rxR; Thu, 29 Jun 2023 12:24:18 +0200 (CEST) From: Ihor Radchenko To: Matt Cc: emacs-orgmode Subject: Re: Export Documentation Confusions In-Reply-To: <1890389c8ff.c8d13885752260.8791711332615822478@excalamus.com> References: <1890389c8ff.c8d13885752260.8791711332615822478@excalamus.com> Date: Thu, 29 Jun 2023 10:24:12 +0000 Message-ID: <87pm5ewoqb.fsf@localhost> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable 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_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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 ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1688034314; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-unsubscribe:list-subscribe:list-post:dkim-signature; bh=ALkhdloWYB3FpNLMfsqz3FpRrQyas/NtdV+eZBIoxHI=; b=Ut1tHT3LQ3erHxDFoVdqQdXwGGrov20Kh4k75H2WOROXYMV0HaX0QJ0Qp+NRV+Vi08YdmY H9azolnS7FUgi0lj2/vOMImiP/0CYyYxw3elcFy1dBjEX1XrSbae+OregDSXWiiK0gjTOQ s7+C2M/P6s7N4JtWa0tdxVaOLEXukMsMdN8jo+4PgijxZ5/sl0pbPtQxiCDKzBYWlBzzqi 8nmlH3PiIeUGQzeAuv48LisX5cKiy0dz5eIUHn0KjQIkcbAXPT9MsyEsrFY9uqkQ8s6SF+ hJmweH8GAVJHR0huSml4cPpSuncsLVYDTzAxKJlH6z4T/G3hEjeoyVjF597XRg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=MJn6+ijE; dmarc=pass (policy=none) header.from=posteo.net; 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" ARC-Seal: i=1; s=key1; d=yhetil.org; t=1688034314; a=rsa-sha256; cv=none; b=pwHcbgYla35dANoOiryS5b4P6QrISLMVZzHezbaNDg07BcpobzePzpSsXFM/UWye4wCL/U RVHLGgS34CgCB3YMtefCrA9TO9iJ+sVj8V5L1JEyZQb3M4TREOJCKl0/pHNNq8xKXk/xOp 7OJu++Kk30H4+fOyRSTcCvcXMksHRItjyXcdmtDmQ35FaaSWM+UXx9rrxlUUl3rdFZIqaW CLzvRi8ypHCr/0A0u07/Xn6fOILQQuOITtiGlLB0r0dg+QIQQZHPVv1XmT5RrK5LSG9v8X HY3oDaffiNcXUvAqIgAZjnlbQMK2UzZ4F0vb5VLbjVoflnmG/L6vE78V4lfAkQ== X-Migadu-Scanner: scn1.migadu.com X-Migadu-Spam-Score: -6.23 Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=posteo.net header.s=2017 header.b=MJn6+ijE; dmarc=pass (policy=none) header.from=posteo.net; 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" X-Migadu-Queue-Id: D988E38525 X-Spam-Score: -6.23 X-TUID: FJV30LI8DmDR Matt writes: > - Section 13.18. 1: Bare HTML may be better placed under Section 13.9 HTM= L Export. The information in this section appears unrelated to Exporting i= n non-Org buffers. In fact, the settings given for a minimal HTML export = do not apply when converting a region. For example, when converting a regi= on containing an Org table to HTML, a preamble is not inserted even when th= e variable `org-html-preamble` is t. > > https://orgmode.org/manual/Bare-HTML.html > > Proposed solution: Move Section 13.18.1 nearer the sections on HTML expor= t. Approved. > - Section 13.18: Export in Foreign Buffers > > The section uses the term "foreign buffer" without providing a definition= . It appears to mean a buffer without "org-mode" enabled. The section des= cribes functions which allow users to write Org mode syntax in non-Org buff= ers and use various functions to convert the Org syntax to other syntaxes, = like HTML, Markdown, etc. > > https://orgmode.org/manual/Export-in-Foreign-Buffers.html > > Proposed solution: Change wording from "foreign buffers" to "Convert Regi= on" and "non-Org" buffer. The functionality is really about conversion ra= ther than anything to do with non-Org buffers. If fact, Org respects users= ' freedom to run the program as they wish=E2=80=93it does not prevent them = from converting Org formatted text within an Org buffer to a non-Org format= , no matter how absurd it may appear :) "Convert region" may be still confusing. Maybe something like "Convert Org region to other markup syntax"? > - Section 13.18: Export in Foreign Buffers > > There was confusion caused by the function names. Specifically, the "nam= espace" (such as "org-ascii-" or "org-texinfo-") is confusing to users who = are not familiar with Org function naming conventions. For example, one par= ticipant thought `org-ascii-convert-region-to-utf8` might convert non-utf8 = ascii to utf8 and was confused why `org-texinfo-convert-region-to-texinfo` = would convert texinfo to texinfo. Of course, this is not a correct underst= anding of the function behavior. > > https://orgmode.org/manual/Export-in-Foreign-Buffers.html > > Proposed solution: ... We can also create more intuitive function aliases. > -The export backends in Org often include commands to convert selected > -regions. A convenient feature of this in-place conversion is that the > -exported output replaces the original source. Here are such > -functions: > +Some export backends include commands to convert a region of Org > +formatted text to another format, such as HTML or LaTeX. The > +conversion replaces the original source. Here are such functions: While we are at it, "Here are such *commands*:" --=20 Ihor Radchenko // yantar92, Org mode contributor, Learn more about Org mode at . Support Org development at , or support my work at