From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id GDLxAClTGmOvoAAAbAwnHQ (envelope-from ) for ; Thu, 08 Sep 2022 22:40:09 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id QFoFASlTGmNM4AAA9RJhRA (envelope-from ) for ; Thu, 08 Sep 2022 22:40:09 +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 70E45286D1 for ; Thu, 8 Sep 2022 22:40:08 +0200 (CEST) Received: from localhost ([::1]:46032 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oWOJi-0003PJ-U1 for larch@yhetil.org; Thu, 08 Sep 2022 16:40:06 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:32994) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oWOIQ-0003Ot-Cj for emacs-orgmode@gnu.org; Thu, 08 Sep 2022 16:38:47 -0400 Received: from cyan.elm.relay.mailchannels.net ([23.83.212.47]:39601) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oWOIN-0007qE-NE for emacs-orgmode@gnu.org; Thu, 08 Sep 2022 16:38:45 -0400 X-Sender-Id: a2hosting|x-authuser|pedz+easesoftware.com@mi3-ss4.a2hosting.com Received: from relay.mailchannels.net (localhost [127.0.0.1]) by relay.mailchannels.net (Postfix) with ESMTP id 2322A501BC4 for ; Thu, 8 Sep 2022 20:38:41 +0000 (UTC) Received: from mi3-ss4.a2hosting.com (unknown [127.0.0.6]) (Authenticated sender: a2hosting) by relay.mailchannels.net (Postfix) with ESMTPA id 8CF51501639 for ; Thu, 8 Sep 2022 20:38:40 +0000 (UTC) ARC-Seal: i=1; s=arc-2022; d=mailchannels.net; t=1662669520; a=rsa-sha256; cv=none; b=yAYibUcMv6JW9WFxYB3iozDuZFGSW1LwheIqfdK8zAlsNgHw9hw5maPAOUbMaOXNDpqNqk Bx8BPSjjWVtv371pkKWS5WppdfjlUtSSB863WBTRAJrerkL5QeftiB2sWsWKPpciO6M+dN nnpEuYeImmfJGefgEKBMHVvTAPvwvXKN+MiCHxaqv6oLzFIZThlZ7SqZZbfV1YTJqEOiIC bMxdqZBPp5CMC9PkjEz1c7kvrPfJ2nFnPzhwdclpJg3f/sSCPQWP/cupFR33jw9Tp0vgly 9SDjKRW7mai7a27B8hJFJF9rmRaVRU6qWjOhH44jSs0yL9R99qj9KU0arqS7Rg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=mailchannels.net; s=arc-2022; t=1662669520; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references:dkim-signature; bh=KyaAxj/WKuySLIf0QY8mAsFNAskqRSJDU2pr40oERnU=; b=jPcQ+GyWYqBJhWgQQXDKGaRTR9P27oa8ehki+BQHoqIBH6MuYQLft+R0ayRXDY4Yixi0PS gJItfouTvFAsWf5R30B3IBdtCnp12RTp7rBtVzLmd8XNCzfd4wDY0NdqHgnxSC6Uogb/to sHKQGKALdsNO7qpBg7SXhGraA7K0MuYea5a7pCiOucckzYqAutanwt0pg+ltLQQrr4XNbZ 66sQwZQhszBShu6Sauso2ZMU8R43uJpCofYRbqFv5WCWDh7euP7Siqb6M9JG2ISZm6QVOZ cqdieHf+F10iD+KcyRhOR14X1tHO5u01dkI6q88jOEA+ZA2wx0Ojv9fqybCuaA== ARC-Authentication-Results: i=1; rspamd-f776c45b8-bftt8; auth=pass smtp.auth=a2hosting smtp.mailfrom=pedz@easesoftware.com X-Sender-Id: a2hosting|x-authuser|pedz+easesoftware.com@mi3-ss4.a2hosting.com X-MC-Relay: Neutral X-MailChannels-SenderId: a2hosting|x-authuser|pedz+easesoftware.com@mi3-ss4.a2hosting.com X-MailChannels-Auth-Id: a2hosting X-Left-Eyes: 542bf01c313eb07a_1662669520958_778328171 X-MC-Loop-Signature: 1662669520958:3530691770 X-MC-Ingress-Time: 1662669520957 Received: from mi3-ss4.a2hosting.com (mi3-ss4.a2hosting.com [68.66.200.199]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384) by 100.109.219.78 (trex/6.7.1); Thu, 08 Sep 2022 20:38:40 +0000 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=easesoftware.com; s=default; h=Message-Id:In-Reply-To:To:References:Date: Subject:Mime-Version:Content-Type:From:Sender:Reply-To:Cc: Content-Transfer-Encoding:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id: List-Help:List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=KyaAxj/WKuySLIf0QY8mAsFNAskqRSJDU2pr40oERnU=; b=Vd4cbZ/vzGAUWfxXkqn0iGU535 LWCSHXYC/2trzSIuYYZxbZc+i+2/IpWTewzyaaKEgDLA9vWQq9MUGpGovsGhns1pqBPWN4GIK14hQ WVYTKhyaXSqDsPYZscRrDMJM/G4xpHhUKTJMaAGBkBBFnvBu3fReJvubV+XmiravUb0BJlJBM4/3C 47amrzbJ8iZrhoy3gLWKwSdorBohQPlONbH8hNF9kGSlRRY3rv1qEkiNzHmhkLwOeQP1420WOrihU NvuH68ChWW8blC7T0nroUTeRfcjEVMfk5Rsgo2ZewcArena7zgXja7keFKM9mi8q5gxSAVPmXc3k7 FAy26Dtg==; Received: from cpe-70-94-128-193.satx.res.rr.com ([70.94.128.193]:56816 helo=smtpclient.apple) by mi3-ss4.a2hosting.com with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.95) (envelope-from ) id 1oWOIJ-0003VI-0Y for emacs-orgmode@gnu.org; Thu, 08 Sep 2022 16:38:39 -0400 From: Perry Smith Content-Type: multipart/signed; boundary="Apple-Mail=_B0C927E5-0EB5-401A-A358-A2E26B6432F5"; protocol="application/pgp-signature"; micalg=pgp-sha256 Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3696.120.41.1.1\)) Subject: Re: Org mode "style sheet" for software documentation Date: Thu, 8 Sep 2022 15:38:38 -0500 References: <1EFEFC5A-24EE-43FC-9C4A-14F02CB8B0FD@easesoftware.com> To: emacs-orgmode@gnu.org In-Reply-To: <1EFEFC5A-24EE-43FC-9C4A-14F02CB8B0FD@easesoftware.com> Message-Id: X-Mailer: Apple Mail (2.3696.120.41.1.1) X-AuthUser: pedz+easesoftware.com@mi3-ss4.a2hosting.com Received-SPF: pass client-ip=23.83.212.47; envelope-from=pedz@easesoftware.com; helo=cyan.elm.relay.mailchannels.net X-Spam_score_int: -7 X-Spam_score: -0.8 X-Spam_bar: / X-Spam_report: (-0.8 / 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, HTML_MESSAGE=0.001, RCVD_IN_BL_SPAMCOP_NET=1.347, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H2=-0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=no 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" X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: US ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1662669608; 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:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=KyaAxj/WKuySLIf0QY8mAsFNAskqRSJDU2pr40oERnU=; b=QwrrcBs/CbfueOGL9+/ysyW2dJKIPOKM5E66o6mJGXKFRMuQLnIZMDdbsJcpw7Lci0X1E1 RIjvxy9pyKXXxLYss6ryMHagDsGgN0dVWdlbQwCkIyKUwhuPa8TTkWoI/lUWayauIv2YA3 p0aVNMuy9Et9THxEUgmQUYeqtJZw2kW5bomxEzy72nvX6eL89Pe90Pv4iyPrE4XoarNzlG W3coyfQgmiT7BzGIbfdkX0pO9HvLm5xdbNxpexP5IR6yGX6jjXhrvdzXHWc5PU5Dr/btWV vGJAtA2jzEEUWcycPmmpc6LWeVaGhuTb+zFJhxRg4kmvuTchNoaJzaBOb2pgrQ== ARC-Seal: i=2; s=key1; d=yhetil.org; t=1662669608; a=rsa-sha256; cv=pass; b=V0zpplGeWTsJwICnX3DBCuaaFA0Unfa65ACcdwvZ2y9u+qJ+grYB5DkMn3ra3Ijit37dlm BJlRQrJydWYCGkMWLe68KLOgNDltN/5N2wNmBQVT1HcGbDh6vfq/AIJ7/ohY7WqieN3O1p lIa+wzPszhqz6eAe1jNnzJGWW8Pg2E0viLH/KGcVVeMR5qH4xTX0pDn6u3+HAWdtq/z6z6 MxKrDVzDAM+q7ayrQ2q0IrBkh32DtvN2kO3wY7PJ4ofhyTUwq9KsE1gIDe6zocHfSpwkcF 7iGEf9WrTKl32ia/GkKtFhon1mkexbA4QZe3rv8TOuMDAtVvwgX34GfpAEy3uA== ARC-Authentication-Results: i=2; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=easesoftware.com header.s=default header.b="Vd4cbZ/v"; arc=pass ("mailchannels.net:s=arc-2022:i=1"); dmarc=none; 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-Spam-Score: -1.69 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=easesoftware.com header.s=default header.b="Vd4cbZ/v"; arc=pass ("mailchannels.net:s=arc-2022:i=1"); dmarc=none; 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: 70E45286D1 X-Spam-Score: -1.69 X-Migadu-Scanner: scn1.migadu.com X-TUID: Cbe2Ef+nPd2b --Apple-Mail=_B0C927E5-0EB5-401A-A358-A2E26B6432F5 Content-Type: multipart/alternative; boundary="Apple-Mail=_F7EFFA66-D9E8-4ECF-A511-7B32907850FD" --Apple-Mail=_F7EFFA66-D9E8-4ECF-A511-7B32907850FD Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=utf-8 > On Sep 8, 2022, at 11:20, Perry Smith wrote: >=20 > I don=E2=80=99t understand this page: = https://orgmode.org/worg/dev/org-syntax.html#Emphasis_Markers = >=20 > In particular, the BORDER BODY BORDER part. Note that this is the = CONTENT which is already between MARKERS. >=20 > What I *think* I want is the ability to effectively create what I=E2=80=99= ll call =E2=80=9Cmacros=E2=80=9D. I=E2=80=99d like to be able to = separate out things like file paths, code samples (both in line and = block), keywords, environment variables, code variables, etc. So, as I = write, I would do (as a total pretend example) [var]foo_dog[var] to = denote foo_dog as a code variable. I=E2=80=99m wondering if that = isn=E2=80=99t what the =E2=80=9CBORDER=E2=80=9D character is. =46rom = the way the section is written, I would assume the leading border = character must be the same as the trailing border character so I could = do ~vfoo_docv~ where the =E2=80=9Cv=E2=80=9D would be the border = character? >=20 > OR=E2=80=A6 perhaps what this is trying to tell me is the first = character after the leading marker and the last character before the = trailing marker must not be whitespace characters since that is how it = appears from all of the examples. >=20 > My logic is if I take the time to separate out all of the elements as = I write the document, then I can later decide to format, for example, = code snippets the same as variables. It would also help me to be more = consistent while I write because I=E2=80=99m (currently) having to = remember =E2=80=9COk=E2=80=A6 how did I format variables? Was that = =E2=80=98code' or =E2=80=98italics'? =E2=80=A6 Hmm=E2=80=A6=E2=80=9D >=20 > If I=E2=80=99ve misunderstood this page, then perhaps to save a follow = up email, can someone tell me if I can create =E2=80=9Cmacros=E2=80=9D = within Org mode to do what I mentioned OR tell me that I really don=E2=80=99= t want to go down that path for some reason. =46rom the code: Terminology: In an emphasis string like " *strong word* ", we call the initial space PREMATCH, the final space POSTMATCH, the stars MARKERS, "s" and "d" are BORDER characters and "trong wor" is the body. The code has clearer documentation than the documentation :-) So=E2=80=A6 it seems I didn=E2=80=99t the two BORDER characters do not = need to match. So I=E2=80=99m off trying to figure out a way to create = more emphasis MARKERS. In the old days, we had only about 43 = non-alphanumeric characters to play with but now with Emacs being 8 bit = clean for countless years we have another 128 characters and with UTF-8 = we have bazillians more! So I=E2=80=99m gently poking around in the code to see how hard it would = be to define more. pedz --Apple-Mail=_F7EFFA66-D9E8-4ECF-A511-7B32907850FD Content-Transfer-Encoding: quoted-printable Content-Type: text/html; charset=utf-8

On Sep 8, 2022, at 11:20, Perry Smith <pedz@easesoftware.com> wrote:

I don=E2=80=99t understand this page: https://orgmode.org/worg/dev/org-syntax.html#Emphasis_Markers

In = particular, the BORDER BODY BORDER part.  Note that this is = the CONTENT which is already between MARKERS.

What I *think* I want is the ability to = effectively create what I=E2=80=99ll call =E2=80=9Cmacros=E2=80=9D. =  I=E2=80=99d like to be able to separate out things like file = paths, code samples (both in line and block), keywords, environment = variables, code variables, etc.  So, as I write, I would do (as a = total pretend example) [var]foo_dog[var] to denote foo_dog as a code = variable.  I=E2=80=99m wondering if that isn=E2=80=99t what the = =E2=80=9CBORDER=E2=80=9D character is.  =46rom the way the section = is written, I would assume the leading border character must be the same = as the trailing border character so I could do ~vfoo_docv~  where = the =E2=80=9Cv=E2=80=9D would be the border character?

OR=E2=80=A6 perhaps what = this is trying to tell me is the first character after the leading = marker and the last character before the trailing marker must not be = whitespace characters since that is how it appears from all of the = examples.

My = logic is if I take the time to separate out all of the elements as I = write the document, then I can later decide to format, for example, code = snippets the same as variables.  It would also help me to be more = consistent while I write because I=E2=80=99m (currently) having to = remember =E2=80=9COk=E2=80=A6 how did I format variables?  Was that = =E2=80=98code' or =E2=80=98italics'? =E2=80=A6 Hmm=E2=80=A6=E2=80=9D
=

If I=E2=80=99ve = misunderstood this page, then perhaps to save a follow up email, can = someone tell me if I can create =E2=80=9Cmacros=E2=80=9D within Org mode = to do what I mentioned OR tell me that I really don=E2=80=99t want to go = down that path for some reason.


The code has clearer documentation than = the documentation :-)

So=E2=80=A6 it seems I didn=E2=80=99t the two BORDER = characters do not need to match.  So I=E2=80=99m off trying to = figure out a way to create more emphasis MARKERS.  In the old days, = we had only about 43 non-alphanumeric characters to play with but now = with Emacs being 8 bit clean for countless years we have another 128 = characters and with UTF-8 we have bazillians more!

So I=E2=80=99m gently = poking around in the code to see how hard it would be to define = more.

pedz

= --Apple-Mail=_F7EFFA66-D9E8-4ECF-A511-7B32907850FD-- --Apple-Mail=_B0C927E5-0EB5-401A-A358-A2E26B6432F5 Content-Transfer-Encoding: 7bit Content-Disposition: attachment; filename=signature.asc Content-Type: application/pgp-signature; name=signature.asc Content-Description: Message signed with OpenPGP -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEE5yOa/gCtQpb3oCpljxzk9yzE+MAFAmMaUs4ACgkQjxzk9yzE +MA4XhAAiDLG2huNRgB1NL1NJ6Tm3BmuuRoJgTi3jxJ3w7dRHV+WJBusIj63CHXG tOyU5vrGkbfBBh33nNawky0OisnH1hWnbqhxbd0/jZjN/GiN8X3zsJfZRrbW4pOX gnHjo+WZS65pFHVHlB66eANSul6PVACqtoA6Tyb5VbEgY/9DuBYi0/McMphr50GN WBT6gHXLrL7RBXmwCXGQPRe+LW+zx7JmsSAxpEOnQ0oJWkf1YSfH7Tu8q5Cz/jRB rU28FDJ9J3oykcjRieLhwW17mzIYZOaELL2hLICbpSoOLPy8NCFaeP6ev5DbuFt8 oNDooKwNfooXzf4zBVuwk3WYoXcWLUnIEhux8LR//I1hfjSqcEcRbE0XgmEIPe/T s46jZohN8LNHJahTKnmm03oO8W4oGZSSF350iNCzbyKIDtkMvv9m0gB1xbfpU6Dt pNllxYWlvbe7Hu61PW1ZBIgpxBHdhnQLk+diaLkz5SmTdBfILR7MNdkCjeQLZimw 4q7Pjjwb4NL1MnRY5o5vfthmg6+Lo3b/9xmyf08U5RrxGpaN4EF1EhL2n58VW8Pa clzXIuBLS57oFfIo2iMecdafDzuhLqIyHgxQbwDQu+8CFgCHnW8UXN8IY5+M6Xsu UnDhZ18aJNETxd1c2AISDkSvB4WHrU1vhpVk7kqFOsxHUK2/Ekw= =H7RD -----END PGP SIGNATURE----- --Apple-Mail=_B0C927E5-0EB5-401A-A358-A2E26B6432F5--