From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <emacs-orgmode-bounces+larch=yhetil.org@gnu.org>
Received: from mp0.migadu.com ([2001:41d0:303:e16b::])
	(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits))
	by ms8.migadu.com with LMTPS
	id GLCqMvJtAGbPVAEAqHPOHw:P1
	(envelope-from <emacs-orgmode-bounces+larch=yhetil.org@gnu.org>)
	for <larch@yhetil.org>; Sun, 24 Mar 2024 19:16:19 +0100
Received: from aspmx1.migadu.com ([2001:41d0:303:e16b::])
	(using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits))
	by mp0.migadu.com with LMTPS
	id GLCqMvJtAGbPVAEAqHPOHw
	(envelope-from <emacs-orgmode-bounces+larch=yhetil.org@gnu.org>)
	for <larch@yhetil.org>; Sun, 24 Mar 2024 19:16:18 +0100
X-Envelope-To: larch@yhetil.org
Authentication-Results: aspmx1.migadu.com;
	dkim=pass header.d=posteo.net header.s=2017 header.b=XjNH4SS9;
	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=1711304178;
	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:in-reply-to:in-reply-to:
	 references:references:list-id:list-help:list-unsubscribe:
	 list-subscribe:list-post:dkim-signature;
	bh=bbYBMsiLRIY5KuWWAIDA9URAYMfl0/i1hCIO9OP/4gM=;
	b=bXIhGhEyW1sCXz7zUiXZ26F2EJjivrdCZO5zow5AC24Sz7YxYJ9j0HoPVh79lk6B9RJ5KJ
	TriRV08OGxLqPyCpJV2O4aqXGZCiesJGTz3WBE3ZMbWQRFfkjWgWbr3FncPSq2KczLcAp4
	2xDbch1E9VWcPTSMZZWR1b/ObGMaj+SQ8XEF2HNmxcIat3XKNOaBe9+HDhJtsQiM+ERCc1
	cq4zuyX71h6xqQKZYMEonoKxfcUV6/O3Q63txQMBW5KTABD/Z5lvpLhfuFc0COmt9odgOv
	QvZ7F44G6AA9vd/I/Rtk+pAFOp3isPTOAb3323p6s8Qfkum85YwsUfR0HbCNvQ==
ARC-Authentication-Results: i=1;
	aspmx1.migadu.com;
	dkim=pass header.d=posteo.net header.s=2017 header.b=XjNH4SS9;
	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=1711304178; a=rsa-sha256; cv=none;
	b=p0jTsFmjSeveKkE4PLRuCknCxMzafkLLPDgn7NBYIbLAFOlpPza+sVLu/hv1pZK0ngoT+w
	zSxv9oDP2OzHM7TC4NswhfRvzeN57X6tU0o8YBV+L+l2+KdecmiSRUETubHUiMsf1LbNwe
	Sxs8VLTEdG3Rbs+G+Dv/+hmmcQillvLhq1B2e2x0tfBeywfo+BIA8SUU5E/V1+PW70E6oT
	HM95fxQf7niTVWSvrBLluKMcWEhq9Nzeqc6sJ2gvNqooODdBheSoyh+hUF2+i1D6x2yVYi
	xCIWLrWotQVNkWqfCtfUw5uGlGc3Ii2SlfLMTJnkqAAVtvoXvGtIKGqLyk1Fcw==
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 6DA5044701
	for <larch@yhetil.org>; Sun, 24 Mar 2024 19:16:18 +0100 (CET)
Received: from localhost ([::1] helo=lists1p.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.90_1)
	(envelope-from <emacs-orgmode-bounces@gnu.org>)
	id 1roSNU-0003mZ-86; Sun, 24 Mar 2024 14:15:28 -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 <yantar92@posteo.net>)
 id 1roSNR-0003mB-Vg
 for Emacs-orgmode@gnu.org; Sun, 24 Mar 2024 14:15: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 <yantar92@posteo.net>)
 id 1roSNP-0002Xf-Qa
 for Emacs-orgmode@gnu.org; Sun, 24 Mar 2024 14:15:25 -0400
Received: from submission (posteo.de [185.67.36.169]) 
 by mout01.posteo.de (Postfix) with ESMTPS id 88327240029
 for <Emacs-orgmode@gnu.org>; Sun, 24 Mar 2024 19:15:21 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.net; s=2017;
 t=1711304121; bh=EM/LobcLUIcoh2e5ugM9TpgSxWDKE/SQLFUI0MidEnQ=;
 h=From:To:Cc:Subject:Date:Message-ID:MIME-Version:Content-Type:
 From;
 b=XjNH4SS9eSLUIvK9NQkDyQArPJyuLw5WpKFVMsUFwIZngyJ/9OA4YiDbsY6bO3mRl
 eG7uDi62nVyAibfSBT2PjhsCWw5NNNEZFMNqQSE1ryqymDkK1AOx7ZKcUt/ufXjEEd
 kiHYATM8PfjMzscBUOT5RraGPDyH6YHdG12G2obKhftK0mZW0OIhZ4jvcLoJN6eWfs
 wrIIUxvE3bJFInbgw2jzoAe9vttSJbJwz/UdH4LxTqr+NTRTWydm/SECUPvrffNRar
 Uk+Db+2xJWwfmOCxyTK8VCb4Us0eIGxH2FX81V48b7XM/G3+/OJXLOqyXleztdo2Fl
 VocfiQW197KaA==
Received: from customer (localhost [127.0.0.1])
 by submission (posteo.de) with ESMTPSA id 4V2kkc70Jmz9rxG;
 Sun, 24 Mar 2024 19:15:20 +0100 (CET)
From: Ihor Radchenko <yantar92@posteo.net>
To: c.buhtz@posteo.jp
Cc: Emacs orgmode <Emacs-orgmode@gnu.org>
Subject: Re: Presenting Hyperorg version 0.1.0: The Org to HTML Converter
In-Reply-To: <4V2j2p2Pf9z9rxS@submission02.posteo.de>
References: <f2f7352603b1d7daac31db2704fc84d1@posteo.de>
 <87sf0lrqw2.fsf@localhost> <4V20vC3RwXz6twc@submission01.posteo.de>
 <875xxd6oeo.fsf@localhost> <4V28mv5Q3rz6tyS@submission01.posteo.de>
 <87h6gvbvt8.fsf@localhost> <9e466e7e9d9de12103df770ace706d21@posteo.de>
 <878r27bslj.fsf@localhost> <4V2j2p2Pf9z9rxS@submission02.posteo.de>
Date: Sun, 24 Mar 2024 18:15:28 +0000
Message-ID: <87v85ba43j.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.01, RCVD_IN_MSPIKE_WL=-0.01,
 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." <emacs-orgmode.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-orgmode>,
 <mailto:emacs-orgmode-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/emacs-orgmode>
List-Post: <mailto:emacs-orgmode@gnu.org>
List-Help: <mailto:emacs-orgmode-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-orgmode>,
 <mailto:emacs-orgmode-request@gnu.org?subject=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-Spam-Score: -9.52
X-Migadu-Queue-Id: 6DA5044701
X-Migadu-Scanner: mx13.migadu.com
X-Migadu-Spam-Score: -9.52
X-TUID: wq8fk1o870+J

<c.buhtz@posteo.jp> writes:

> I will consider your points and take them into account.

Thanks!

> On 2024-03-24 14:40 Ihor Radchenko <yantar92@posteo.net> wrote:
>> If it is an option, it would be nice if you upstreamed your additions
>> to orgparse. This way, we can get a better Python-based Org parser for
>> everyone's benefit.
>
> The code is free. The orgparse maintainer is free to re-use it of
> course. On the other hand in the long run I will consider to separate
> my parsing code into an extra package. But currently it is to unstable
> and do support only a small subset of all org(roam) features.

It would help if you notify orgparse maintainer once your code gets more
stable ;)

>> I see. FYI, it is a bug to throw an error when parsing Org document.
>> Any kind of text file is a valid Org document. There is no notion of
>> invalid syntax in Org markup.
>
> You mean throw an error is a bug because it is not possible to
> write invalid org documents?

Yup.

> I am not convinced yet. But I am open to it and willing to learn.
>
> Even org-html-export* itself do throw errors and stop processing when
> there are unknown orgids.

This has nothing to do with the parser.
Erring on unknown ids/paths is a special _feature_ of Org exporter
controlled by `org-export-with-broken-links' variable.
`org-export-with-broken-links' is nil by default simply because (1) Org
export has no sensible way to export links that point to nowhere; (2)
Such links are generally unwanted and need to be corrected by the user
in many use cases.

> What is about an inconsistent block?
>
> #begin_src
> foobar
> #end_example

With your example, the following AST will be produced by Org parser
(`org-element-parse-buffer'):

(org-data
 (section
  (paragraph
   "#+begin" (subscript "src")
   "\nfoobar\n#+end" (subscript "example")
   "\n"))

>> > Other things are "invalid" links, e.g. unknown orgids, unknown roam 
>> > links, unsupported "link kinds" ("protocols" in org syntax?; e.g. 
>> > "inkscape:").
>> 
>> In Org terminology, we call these "broken" links.
>> "link kinds" are link "types".
>
> The term "types" is to broad and conflicts with Pythons in build
> functions. ;) That is the main reason why I used "kind". On the other
> hand the org syntax reference IMHO also use the term "protocol".

Syntax reference says the following:

PROTOCOL
A string which is one of the link type strings in org-link-parameters
                             ^^^^^^^^^

We also always say "link type" in the manual.

I just made things more explicit, replacing PROTOCOL with LINKTYPE:
https://git.sr.ht/~bzg/worg/commit/0634eed3

>> Generally, part of the "Benefits" section is a bit hand-wavy. I
>> recommend using more clear statements. Otherwise, it is not clear what
>> exactly the benefits are.
>
> Again. It is also not "clear" for me. There are benefits just for
> myself as an low-level-Emacs-and-org-user, someone who get headaches
> reading Lisp code and feeling very comfortable using Python. In short:
> My opinion is very subjective. And I don't have enough experience to
> compare my tool to others.
> I tried to make this point clear in my benefits section. And this is
> also the reason why there was no benefits section in the first place
> because I wasn't clear enough about what to write in there.
>
> Maybe I should rephrase the section to "Benefits and design goals".

Maybe something like "Motivation"; to emphasize that the listed points
are your subjective reasons to write the exporter.

Still, it would be useful to have an objective comparison; if you want
to get others to use your package. Having a clear list of reasons why
your package is better is important then. (I implicitly assumed that you
are interested to attract users after you announced the package in
public)

>> 1. Drop "Fairly resilient when dealing with parser issues."
>
> Why? The "design goal" is to process all nodes no matter how
> bad/invalid they are.

Simply because Org mode has no notion of invalid nodes.
So, this kind of goal sounds very strange for me.

>> 2. Reword "Fairly resilient managing dead and problematic links which
>> are a common phenomenon when working with a constantly evolving
>> Zettelkasten or personal wiki." And instead clearly explain how broken
>> links are exported.
>
> I don't want to blow up the text. Not sure what you expect here. The
> node is exported as HTML but the link is colorful highlighted and a
> tooltip explaining the problem is added.

Is it something akin when `org-export-with-broken-links' is set to 'mark?

>> 4. Drop "Adhers to World Wide Web Consortium (W3C) standards for HTML5
>>    and CSS (<!DOCTYPE html>)." Most other blog exporters for Org mode
>>    adhere to standards. And those that are not are probably out of
>>    interest for the purposes of comparison.
>
> Why?

If Org export does not adhere to standards, it is a bug, it should, and
it will be fixed. And some other blog generators that do not use Org
export (like Hugo) do conform to the standards, AFAIK.

> Btw: Even code generated by org-html-export* (XHTML 1.0 Strict) give
> errors on W3C. e.g. "type" attribute is missing in <style> tag.

May you please provide an example? I cannot reproduce.

>> 5. Maybe mention the "tag cloud" visible in the example screenshot
>> (btw, the screenshot is not very sexy; compare it with something like
>>    https://one.tonyaldon.com/).
>
> There nothing fancy as a "tag cloud". ;) btw: There is no cloud on the
> link you provided.

I was referring to top line listing tags.

> About the "sexy"ness of Hyperorg output: There is a specific label for
> that issues:
>
>     <https://codeberg.org/buhtz/hyperorg/issues?labels=180551>
>
> But as you can see on the "milestone" the priority is low.

Fair. Do note that "sexyness" is what attracts users :)

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>