emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: "Bruce D'Arcus" <bdarcus@gmail.com>
To: Emmanuel Charpentier <emm.charpentier@free.fr>
Cc: Bastien <bzg@gnu.org>, emacs-orgmode <emacs-orgmode@gnu.org>
Subject: Re: Chiming in [Re: org-cite not mentioned in ORG-NEWS for 9.5]
Date: Mon, 27 Sep 2021 10:24:25 -0400	[thread overview]
Message-ID: <CAF-FPGNmF7BG685phVH8gtFbs=zOuvCG2yQHK5siyDhd45DEAg@mail.gmail.com> (raw)
In-Reply-To: <0cef6da366da15181dd304cabe1832bbf785a109.camel@free.fr>

Great start!

A few quick comments:

1. I'm not sure we should call them "citation links", since they
aren't really links.

2. "four bibliograhic backends are available": a) note typo (which I
think I saw elsewhere; there are a number of spelling errors
throughout), b) "available" -> "included" (in org)

More generally, it has also occurred to me that some of what Timothy
wrote for this might be repurposed for here:

https://blog.tecosaur.com/tmio/2021-07-31-citations.html

Finally, a question: what's the best way to do complex-ish
documentation like this collaboratively? Is there an alternative to
email + patches for the create, comment, revise cycle of refining
this?

And related: if the goal is to finish this week (?), do we have time
to do comprehensive documentation? I'm a little skeptical.


On Mon, Sep 27, 2021 at 10:04 AM Emmanuel Charpentier
<emm.charpentier@free.fr> wrote:
>
> As reported by Bastien, I started a documentation for the current state of the citation engine(s). I intended to complete it, but got "a little" sidetracked.
>
> Enclosed is a patch of where I was in August.
>
> Bastien made the following remarks, which I mostly intended to follow :
>
> ===========================================
>
> Je pense qu'à ce stade, le mieux est de soumettre ce document sur la
> liste de diffusion.
>
> En attendant, j'ai quelques remarques, en vrac :
>
> - Je pense que le titre "Working with…" n'est pas assez explicite. Par
>   ailleurs, le chapitre précédent commence aussi par "Working with…".
>   Par conséquent, je propose d'intervertir la description et le titre :
>
>     * Citations and references
>     :PROPERTIES:
>     :DESCRIPTION: Working with other people's work
>     :END:
>
> - Il faut penser à mettre deux espaces entre deux phrases.
>
> - =Org= -> Org
>
> - J'enlèverais la partie introductive expliquant pourquoi il est utile
>   de citer le travail d'autrui. Ceci dit, il vaut mieux attendre l'avis
>   d'autres personnes concernées par la fonctionnalité.
>
> [ Emmanuel Charpentier : I think that this justification may be helpful to a lot of non-scholar org users, who could benefit from org-cite. Advice sollicited... ]
>
> - Je pense qu'il faut éviter de parler ce "citation link", car cela peut
>   engendrer de la confusion avec "link" qui est une structure proche,
>   mais différent. Peut-être faut-il parler de "citation object".
>
> - Dans Texinfo, les phrases doivent être séparées par deux espaces.
>
> ===========================================
>
> What still lacks :
>
> an explanation of the four possible functions of an engine ;
> current functionalities of the currently available engines ;
> an org-guide sized summary.
>
>
> Anyone is welcome to propose modifications. Someone should take the task of collating the propositions and consolidate a final text ; I am reluctant to take this task, given my RL tasks...
>
> Comments, remarks, criticisms, lazzi, etc... all welcome.
>
> --
> Emmanuel Charpentier


  reply	other threads:[~2021-09-27 14:25 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-09-27 14:01 Chiming in [Re: org-cite not mentioned in ORG-NEWS for 9.5] Emmanuel Charpentier
2021-09-27 14:24 ` Bruce D'Arcus [this message]
2021-09-27 14:49   ` Bastien Guerry
  -- strict thread matches above, loose matches on Subject: below --
2021-09-27 13:59 CHARPENTIER Emmanuel via General discussions about Org-mode.

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

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAF-FPGNmF7BG685phVH8gtFbs=zOuvCG2yQHK5siyDhd45DEAg@mail.gmail.com' \
    --to=bdarcus@gmail.com \
    --cc=bzg@gnu.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=emm.charpentier@free.fr \
    /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.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

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 read-only IMAP folder(s) and NNTP newsgroup(s).