From: Fritz Fritzy <emile.valjean-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
To: pandoc-discuss <pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
Subject: Re: Markdown: simple syntax for arbitrary nesting
Date: Wed, 25 Oct 2023 23:36:37 -0700 (PDT) [thread overview]
Message-ID: <80b20bbf-1f3f-4473-9d0d-5017ce7a1baen@googlegroups.com> (raw)
In-Reply-To: <297BE1CF-4874-44E3-B6AA-9B9B87378A6B-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
[-- Attachment #1.1: Type: text/plain, Size: 4060 bytes --]
Thanks for the answer!
RE nesting:
I mean things like the use of asterisk inside emphasis/bold spans, or the
different ways paragraphs/lists/quotes/pre blocks work together wrt
indentation and newlines.
I understand that when one knows the parsing rules, it's probably always
doable to make them do what one wants, but personally I often get them
wrong.
RE markdown's design:
As far as I can tell, markdown has grown way farther than those initial
goals, and is now used for more than simple email-like content.
Looking at all the different extensions defined and e.g. provided by
pandoc, I believ that ease of readability has been already left out: one
has to know the semantics of footnotes, custom spans, custom divs,
attribute blocks already to know how to read them.
Obviously, adding yet another new syntax construct can be seen as just
adding to the already present overhead, but it seems to me like:
1. It's easy to reason about, in that nesting is natural to understand,
and its parsing rules being (close to?) context free makes figuring out how
to make it work easier.
2. It would be enough to replace/cover quite a few of the already
present constructs (e.g. all the divs and spans, and maybe also attribute
blocks for titles?), thus reducing the cognitive cost both for writing and
reading markdown.
3. On a similar note, it would mean that e.g. when writing things like
1. emphasized text containing asterisks, one could just start with
*{}*, and not have to fear that the emphasis gets dropped.
2. any kind of block, say a list item, or a quote block, one could
use braces again to reset the indentation to any value we like.
In short, it seems to me that it's a simple enough, orthogonal and rather
powerful syntax that doesn't _have_ to be used, but makes writing complex
documents that much easier.
I understand that you and many people have probably spent way more time
thinking about this than I have, and won't try to push my point further if
it hasn't been in any way convincing so far :)
Thanks for your time, and for pandoc, which has already proven incredibly
useful to me!
On Wednesday, October 25, 2023 at 2:58:32 PM UTC John MacFarlane wrote:
>
>
> > On Oct 24, 2023, at 11:06 PM, Fritz Fritzy <emile....-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> >
> > Hi,
> >
> > Using markdown, I've often been frustrated by
> >
> > • Its flat/non-recursive/non-nested nature, by which I mean that you
> mostly cannot write "arbitrary" markdown inside most elements, and if you
> can, you have to be very careful with whitespaces/indentation/etc.
>
>
> I'm not sure what you mean: generally you can nest things, you just have
> to pay attention to the syntax. Examples?
>
>
> > • The impossibility to easily interlink to arbitrary parts of the
> document.
> > To solve both issues, I'd like to propose an extension that allows
> "simply" using braces (or some other punctuation pair) to allow nesting,
> with an option to tag/add attributes to the contents like that.
>
>
> I think this goes against the spirit of Markdown, which prioritizes source
> readability rather than easy writeability.
>
> "The overriding design goal for Markdown’s formatting syntax is to make it
> as readable as possible. The idea is that a Markdown- formatted document
> should be publishable as-is, as plain text, without looking like it’s been
> marked up with tags or formatting instructions." (
> http://daringfireball.net/projects/markdown/)
>
>
>
--
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/80b20bbf-1f3f-4473-9d0d-5017ce7a1baen%40googlegroups.com.
[-- Attachment #1.2: Type: text/html, Size: 5112 bytes --]
next prev parent reply other threads:[~2023-10-26 6:36 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <AQHaB9/7r8aPUiuLQEGm4swQ3KsBQrBbs2QQ>
2023-10-25 6:06 ` Fritz Fritzy
[not found] ` <5573f042-48a4-4115-8b1d-a86c13eb319an-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2023-10-25 14:58 ` John MacFarlane
[not found] ` <297BE1CF-4874-44E3-B6AA-9B9B87378A6B-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2023-10-26 6:36 ` Fritz Fritzy [this message]
[not found] ` <80b20bbf-1f3f-4473-9d0d-5017ce7a1baen-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>
2023-10-26 7:41 ` Guillaume Dehaene
[not found] ` <CAKOoOVWTtzokYLhLNdd5C67_FVor2RREFebCTA73s4jb76_Zwg-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2023-10-26 7:57 ` AW: " denis.maier-NSENcxR/0n0
[not found] ` <GV0P278MB021102C19E4D996E3773D91283DDA-WJyuHYKDu6H9IsystIVlkKYLGPO4stheiGd9ebBGJoev3QGu/rdwKA@public.gmane.org>
2023-10-26 9:24 ` Fritz Fritzy
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=80b20bbf-1f3f-4473-9d0d-5017ce7a1baen@googlegroups.com \
--to=emile.valjean-re5jqeeqqe8avxtiumwx3w@public.gmane.org \
--cc=pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).