Citation syntax description in manual

Citation syntax description in manual

[Joseph Reagle]

I was reviewing the citation syntax documentation in light of the new curly-bracket syntax [1] and wonder if the description has gotten crufty? It does reflect the evolution of the citation syntax: simple bracket citations, then no bracket "in-text" citations, then curly brackets enclosing complex pagination, and now curly brackets to enclose complex identifiers.

[1]: https://github.com/jgm/pandoc/commit/3f09f53459b877f53072efbf57dec21fa37280b5

If this were to be re-written, should the start of the documentation focus be on "@" and not square brackets?

-- 
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/28110ceb-e6ca-a40f-48ab-6e9a6d0137fd%40reagle.org.

Re: Citation syntax description in manual

[John MacFarlane]

You're right I think.  If you want to propose a structure for
rewriting this, I'd consider it!

Joseph Reagle <joseph.2011-T1oY19WcHSwdnm+yROfE0A@public.gmane.org> writes:

> I was reviewing the citation syntax documentation in light of the new curly-bracket syntax [1] and wonder if the description has gotten crufty? It does reflect the evolution of the citation syntax: simple bracket citations, then no bracket "in-text" citations, then curly brackets enclosing complex pagination, and now curly brackets to enclose complex identifiers.
>
> [1]: https://github.com/jgm/pandoc/commit/3f09f53459b877f53072efbf57dec21fa37280b5
>
> If this were to be re-written, should the start of the documentation focus be on "@" and not square brackets?
>
> -- 
> 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/28110ceb-e6ca-a40f-48ab-6e9a6d0137fd%40reagle.org.

-- 
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/m28s4blvnx.fsf%40MacBook-Pro.hsd1.ca.comcast.net.

Re: Citation syntax description in manual

[Joseph Reagle]

On 21-05-18 14:54, John MacFarlane wrote:
> You're right I think.  If you want to propose a structure for
> rewriting this, I'd consider it!

I tried, but stopped short because I don't know the parsing logic that well. I had something like this:

- Markdown citations begin with an "@" followed by an identifier; a
   sequence of citations are separated by semi-colons. (Does this ever
   conflict with numbered examples? I've never used the latter.)
- A citation may be followed by optional pagination.
- When citations appear within square brackets:
	- They are taken as in-text or a note citation, depending on the
	  style.
	- Each citation within the semi-colon delimited list may have a
	  prefix, locator, and suffix.
- Citations that appear without brackets always render the names of the
   authors in-text.
	- pagination and a suffix may still follow within brackets.
- complex identifiers and locators may be protected by inclusion within
   curly brackets.
... ?

Re: Citation syntax description in manual

[John MacFarlane]

I gave it a try here:

https://github.com/jgm/pandoc/commit/d452155bcf158b790b0087d6d5c02cc3212c921c



Joseph Reagle <joseph.2011-T1oY19WcHSwdnm+yROfE0A@public.gmane.org> writes:

> On 21-05-18 14:54, John MacFarlane wrote:
>> You're right I think.  If you want to propose a structure for
>> rewriting this, I'd consider it!
>
> I tried, but stopped short because I don't know the parsing logic that well. I had something like this:
>
> - Markdown citations begin with an "@" followed by an identifier; a
>    sequence of citations are separated by semi-colons. (Does this ever
>    conflict with numbered examples? I've never used the latter.)
> - A citation may be followed by optional pagination.
> - When citations appear within square brackets:
> 	- They are taken as in-text or a note citation, depending on the
> 	  style.
> 	- Each citation within the semi-colon delimited list may have a
> 	  prefix, locator, and suffix.
> - Citations that appear without brackets always render the names of the
>    authors in-text.
> 	- pagination and a suffix may still follow within brackets.
> - complex identifiers and locators may be protected by inclusion within
>    curly brackets.
> ... ?

Re: Citation syntax description in manual

[Joseph Reagle]

On 21-05-19 13:21, John MacFarlane wrote:
> I gave it a try here:
> 
> https://github.com/jgm/pandoc/commit/d452155bcf158b790b0087d6d5c02cc3212c921c

Looks goods. I left two comments (lines 4979 and 4980; never did that on github before) for subject singular agreement.