From mboxrd@z Thu Jan 1 00:00:00 1970 X-Msuck: nntp://news.gmane.io/gmane.text.pandoc/29611 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Martin Hepp Newsgroups: gmane.text.pandoc Subject: Coordination / Registry: Pandoc-related Naming Date: Wed, 24 Nov 2021 19:50:07 +0100 Message-ID: Reply-To: pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org Mime-Version: 1.0 (Mac OS X Mail 14.0 \(3654.120.0.1.13\)) Content-Type: text/plain; charset="UTF-8" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="39685"; mail-complaints-to="usenet@ciao.gmane.io" To: pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org Original-X-From: pandoc-discuss+bncBDDMFSFCYUDBBYMS7KGAMGQEPNXBGLA-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org Wed Nov 24 19:50:11 2021 Return-path: Envelope-to: gtp-pandoc-discuss@m.gmane-mx.org Original-Received: from mail-wr1-f61.google.com ([209.85.221.61]) by ciao.gmane.io with esmtps (TLS1.3:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.92) (envelope-from ) id 1mpxLP-000A4b-DM for gtp-pandoc-discuss@m.gmane-mx.org; Wed, 24 Nov 2021 19:50:11 +0100 Original-Received: by mail-wr1-f61.google.com with SMTP id q7-20020adff507000000b0017d160d35a8sf717715wro.4 for ; Wed, 24 Nov 2021 10:50:11 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1637779810; cv=pass; d=google.com; s=arc-20160816; b=VUOolpMxzMmvpIyIcKwrQxN8vGL+2pyqah1+V56zrFv15e13PQB+/0o7vn0ctOpmyT vURvr8rqLOvCJ+GZ2ZiEXLKwHpZ4RxeIbcUiLzPdNUEstnibGXMWc8nlJGuKe2qaQUZT salykACw7t30OsJh4FXP0hWTb6GFGx+D71RwmCLEnm6LuXScUIV9OBh6RtufE2uh8lkz H8lZ3KqQObsh9JJAUlzy1yfMxLkOvzdHL7BkOcbV0eJyO+n2gmito69m7wLFDLKCfIvq t6xuMdsfnYE8aPkXTb22qZEPuyOP6f81oJBxhERn4ij7e+zQpxrVoxYqvNsZHOx7i7dL xV0g== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-unsubscribe:list-subscribe:list-archive:list-help:list-post :list-id:mailing-list:precedence:reply-to:to:date:message-id:subject :mime-version:from:sender:dkim-signature:dkim-signature; bh=RO6kQp4XnAKnbakxwaWEVEACYRzs59ttp6UNqgcAo3w=; b=bc2ZzhgSbZFlHeGzrGfS4qZAtGiLSfC1GIsdZvjer239DI9d71QJwM7jJm5vbuhnnY 1owMByXBTJUxm2PNKDCwI78NF7JzBhOpdMMX0dljBwB8mQzpa91eYrQ2seQ4U0Ohz8Jf yJWpbNZqHmNUloAR11oF+0dFhT3XYBvNIYD+P0U6q/elSSoJcKd3wUvp+XttcRtDQfBx m3lnquvrObWOwncJV5PF08vnzpZN/WShOISD4O5drPKi4QoZ+dN8Rx4+bscVFKNwxYKQ Z3U1OfOc4759E2wSy4VL4ir60VCkbA53e1bavqXxcdEOx/a3WnZ85oQkPjcFYx3FLjth HhDw== ARC-Authentication-Results: i=2; gmr-mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=jPABuDNE; spf=pass (google.com: domain of mfhepp-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org designates 2a00:1450:4864:20::434 as permitted sender) smtp.mailfrom=mfhepp-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=googlegroups.com; s=20210112; h=sender:from:mime-version:subject:message-id:date:to :x-original-sender:x-original-authentication-results:reply-to :precedence:mailing-list:list-id:list-post:list-help:list-archive :list-subscribe:list-unsubscribe; bh=RO6kQp4XnAKnbakxwaWEVEACYRzs59ttp6UNqgcAo3w=; b=N+lhKMvZQQfCJejwR0HX5ApNdu0t5gfAgNMRlPbiwCzPBwzWooficR2H9bVl+/wNbu MHjy0Hs2AcblBjBha7JRHjXkHjOFQw0GScTeyc4ntbBq29SCBMgbguBytHncVWK/HdtC pWuNpOv9EAgazlnlE4bVLywYdSA4B8L5Rx1VB+nZM/nyrwlKLK1JfaazlPjMiAAki1vl HLAQEgxagxjSm2hrGXuu41H4o7j2PFSLlBJ7CAnNR9x19Us1gig2YamQ+EG/3APOIkYh MsoJWyrAMF4U+LphRL44+hnWmFgKNmjdLYBKdLQj7c3EXLFfhsroR+8oRUrh1svmmZAJ Qaog== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:mime-version:subject:message-id:date:to:x-original-sender :x-original-authentication-results:reply-to:precedence:mailing-list :list-id:list-post:list-help:list-archive:list-subscribe :list-unsubscribe; bh=RO6kQp4XnAKnbakxwaWEVEACYRzs59ttp6UNqgcAo3w=; b=jlVGg5GcNkoMsMPWrvJIFTDfiHFuscWv0gk87HoVvfxWjt5wkk9AP3WIbdXWt9hH+Y w5xCYJdvxJNDPHbddwBCSnsA2iwKj4QgX1GoHCfAwZrS9xm+eQUJgsn0+cdMPA1oj8fa n1WOSacrsYQ5QajTISesV5D2HAVe+kI0TNzBMIaxq6mlsdtTEXPA9HySqtXmWZyYI9RC WjvyHnA9YhrQ8Qkrn+MI6TXhlSO9R06fNQW8W/QWJOKCqYlJ+FsFh362+9UaBISJLlJo QZGDEveB/3WjBqdAYYi0JKGafil5BXxbjQ/PyAdIzuul0KR2nKaBaoU/E+ujnjtDlEsB dghg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=sender:x-gm-message-state:from:mime-version:subject:message-id:date :to:x-original-sender:x-original-authentication-results:reply-to :precedence:mailing-list:list-id:x-spam-checked-in-group:list-post :list-help:list-archive:list-subscribe:list-unsubscribe; bh=RO6kQp4XnAKnbakxwaWEVEACYRzs59ttp6UNqgcAo3w=; b=JDL2KMReKjOjZz4aH+SpzlV2BVFzI+6cJMbMiB03vqLY5+6ua9LHnhlZ3e7lj02P4J ezwPe7UYldLxPvSsaV9lmMVIiRVowWblLfg5iVge2TIekHNL8H8mWUne2fSYJiYW8zx1 ged7ulG7DMiJZal3HKAVdNXzJb7XBjvWKkM9fKdb1zAl4sNvSt5MjF1MsptQOAn8B7I4 rN9+j2J6trR88CrpAIK1aV5PyvQb90YNW4oVZwRv+SmXqMnWon6eHZbjJsYLxqAZNYkX zdNHeICtM1FPvfyPHGWNURGcLmePiS2TeWcNW5nNcKgKfHbw1J8a8D69VLG6LJIUWAuu 7noQ== Original-Sender: pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org X-Gm-Message-State: AOAM532YIZTH44QiFsZbo4fJGznud+SkthZo+7aEVuYr7K7POKe75VNa 0RAs6U00g/c+WJ0XU+3mzQc= X-Google-Smtp-Source: ABdhPJwbHUddMA0G/ZoAndM/elS4R5OgXjpsh15byjVeaqy76aXS4ARsKZhDGTots6IqixE/QmNkJw== X-Received: by 2002:a7b:c153:: with SMTP id z19mr17879272wmi.171.1637779810709; Wed, 24 Nov 2021 10:50:10 -0800 (PST) X-BeenThere: pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org Original-Received: by 2002:a5d:4092:: with SMTP id o18ls383659wrp.1.gmail; Wed, 24 Nov 2021 10:50:08 -0800 (PST) X-Received: by 2002:a5d:604b:: with SMTP id j11mr22587703wrt.22.1637779808465; Wed, 24 Nov 2021 10:50:08 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1637779808; cv=none; d=google.com; s=arc-20160816; b=XImihrwmuzo5o1K1TueSNxMkK7NNFOgxOmKnUDI8ohCdwhIOGjWxFU589q5qQLuU48 AOFbltTec7Ltk4Mntq4zy0AZ4uPos/QR9HNwmIQFh9SEA3GrTaZxLf8zvTZMhmTL/3Tt SoikJX5XCfpdqpb0xjim0A71nqvQtZ1jVq9Wz67YU5HpnLNbA8CPEqpuhIvA4O1sNHD+ FyXHTTq5ve2FJ7r6945N7690wcrfqfPevZ7vu7cjR5rDU2vV1OnEDogFjOh30bW+6IaI vI+8XUw/SuNacUcu88936VdPjN9ldI/Cfnecn0DOpOKgRIPomLTqmOaJnSZ4R+s+ZaEq XjQA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=to:date:message-id:subject:mime-version:content-transfer-encoding :from:dkim-signature; bh=12GcjuwZOvaRcGeObwG8b488ZbuwpMhZwyFzm/7CfA0=; b=PbiD3YgMZjSs1cunMJOO3qsKj0geTfBeTbCvdF4nST4O1jY7FevGKol5ZmJWc2h6P/ tYYQLAmimFxfw8Z4lYTGo2wX03FBJ66XOykkysxE80/1biH60jmFw9fsLMcPd9v533ex sIJfoiiLvV2LN9oltRvILE7qfuNFsRm5Y7xVvje7xVk9RHoJ0C2156FdpCCKeogr95lH NRTMwCkLHKzWA82eA4kFCaPUxf4eNjzl8IVnKvhmG/UNJG5dEj+vVKFLX+jlgarPSZQ3 tHSqOh4BQJnFcY2PZoeJ8HBD6ctwQZ9hIqN/AAUHLq9oT7QVSXNLLWH4WSwv1BHedlHL gTIw== ARC-Authentication-Results: i=1; gmr-mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=jPABuDNE; spf=pass (google.com: domain of mfhepp-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org designates 2a00:1450:4864:20::434 as permitted sender) smtp.mailfrom=mfhepp-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Original-Received: from mail-wr1-x434.google.com (mail-wr1-x434.google.com. [2a00:1450:4864:20::434]) by gmr-mx.google.com with ESMTPS id c2si545834wmq.2.2021.11.24.10.50.08 for (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Wed, 24 Nov 2021 10:50:08 -0800 (PST) Received-SPF: pass (google.com: domain of mfhepp-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org designates 2a00:1450:4864:20::434 as permitted sender) client-ip=2a00:1450:4864:20::434; Original-Received: by mail-wr1-x434.google.com with SMTP id j3so6068184wrp.1 for ; Wed, 24 Nov 2021 10:50:08 -0800 (PST) X-Received: by 2002:adf:cf0a:: with SMTP id o10mr21797675wrj.84.1637779808251; Wed, 24 Nov 2021 10:50:08 -0800 (PST) Original-Received: from smtpclient.apple (dynamic-077-002-147-191.77.2.pool.telefonica.de. [77.2.147.191]) by smtp.gmail.com with ESMTPSA id o5sm566982wrx.83.2021.11.24.10.50.07 for (version=TLS1_2 cipher=ECDHE-ECDSA-AES128-GCM-SHA256 bits=128/128); Wed, 24 Nov 2021 10:50:08 -0800 (PST) X-Mailer: Apple Mail (2.3654.120.0.1.13) X-Original-Sender: mfhepp-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org X-Original-Authentication-Results: gmr-mx.google.com; dkim=pass header.i=@gmail.com header.s=20210112 header.b=jPABuDNE; spf=pass (google.com: domain of mfhepp-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org designates 2a00:1450:4864:20::434 as permitted sender) smtp.mailfrom=mfhepp-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org; dmarc=pass (p=NONE sp=QUARANTINE dis=NONE) header.from=gmail.com Precedence: list Mailing-list: list pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org; contact pandoc-discuss+owners-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org List-ID: X-Google-Group-Id: 1007024079513 List-Post: , List-Help: , List-Archive: , List-Unsubscribe: , Xref: news.gmane.io gmane.text.pandoc:29611 Archived-At: Dear all: In the Pandoc eco-system, we use class and attribute names in many places for many different purposes. As more and more - filters, - extensions, and - applications (like RStudio and Quarto) define and use meta-data conventions, it would be great to agree upon a lightweight mechanism for coordinating the naming and minimizing the risk of collisions. A helpful first step would be to advocate the use of prefixes for names that are used in and shared by the core Pandoc ecosystem. Panflute is already a good example with the use of "panflute-" as a prefix: --- panflute-filters: [remove-tables, include] panflute-path: 'panflute/docs/source' ... Codebraid is also consistently using a "cb" prefix in class names (like .cb.run) that control behavior, but not for attributes: `1 + "a"`{.python .cb.run session=inline_error example=true} Lack of coordination can mean that 1. the same name may trigger conflicting things (like the logo property for Eisvogel vs. the logo property for Beamer, see https://github.com/Wandmalfarbe/pandoc-latex-template/issues/265) or 2. multiple tools require different names for the same data. Both will make maintaining consistent Markdown documents and workflows difficult. Hence, I think it would be really good to start coordinating the naming of classes and properties in the Pandoc ecosystem. Coordinating can mean standardizing, but it could also be limited to helping avoid collisions by e.g. advocating prefixes. Is there anything like a prefix naming scheme registry for Pandoc? The WWW for instance uses such mechanisms for many parts of the ecosystem, like - https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml - https://www.iana.org/assignments/http-parameters/http-parameters.xhtml - https://www.iana.org/assignments/media-types/media-types.xhtml This does not have to be a big effort; it would be sufficient to - create and maintain a simple Markdown file in the Pandoc repository, - define a few ground rules like - prefixes for popular components, - a process to follow for new names in the core namespace, - the use of a prefix like "x" for names that are proprietary, ...), and to - try to track popular components, their property names, and prefixes in the Markdown file. What do you think? Best wishes Martin