emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Expanding how the new cite syntax is used to include cross-references - thoughts?
@ 2021-08-11  0:58 John Kitchin
  2021-08-11  1:19 ` Bruce D'Arcus
  0 siblings, 1 reply; 22+ messages in thread
From: John Kitchin @ 2021-08-11  0:58 UTC (permalink / raw)
  To: org-mode-email

[-- Attachment #1: Type: text/plain, Size: 2730 bytes --]

To preface this, let me note that I am looking for a way to replace org-ref
with a complete and orthogonal package for writing scientific papers with
citations and cross-references. (I can probably live without the glossary
and acronym support). The cross-references in org-ref were handled with
org-links, and I think it would be a mistake to try to do that again
because the links will be defined by the last package loaded which will
lead to issues. So, I would like what I call an orthogonal approach for
cross-references, orthogonal in the sense that it can coexist with org-ref,
but not require org-ref if you don't use it. The built in internal links
like [[label]] lack the flexibility I need (I think), e.g. to differentiate
a typical reference from an equation reference (these map to \ref{label}
and \eqref{label} in latex for example), and there are other references
that are relevant in latex also like \pageref{label}, \cref{label} etc.

While working on org-ref-cite, it occurred to me that we can use the new
org-cite syntax for cross-references, without any changes to the syntax, we
can just use a different style. This would enable a near complete and
orthogonal replacement of org-ref. These cross-references are like a
citation IMO, but to a separate set of targets, i.e. not to bibliography
entries but rather to locations within the document, and possibly even to
other documents.

e.g. [cite/ref:@label] would be a cross-reference to "label" defined in a
CUSTOM_ID on a heading, a NAME keyword, or in raw latex like \label{label}.

You could use substyles for equations, or page refs, etc. e.g.
[cite/ref/eq:@label] for an equation.

You could also use a prefix to indicate a figure, table, equation, e.g.
[cite/ref/eq:Equation @label].

This does add a bit of complexity to the processors, which have to do
different things for the different kinds of cites (for activation,
insertion, following and exporting), and that is based only on the style. I
would not expect these styles to be fully supported by all the processors.
For LaTeX though, it would make for a near total and orthogonal replacement
of org-ref.

You can see what this would look like at
https://github.com/jkitchin/org-ref-cite/issues/16. I use style-dependent
fontification to differentiate bibliographic citations from
cross-references. They also have different follow behaviors.

Anyway, I am curious what you all think. Is it a good idea? Worth waiting
for or thinking of a better solution?


John

-----------------------------------
Professor John Kitchin (he/him/his)
Doherty Hall A207F
Department of Chemical Engineering
Carnegie Mellon University
Pittsburgh, PA 15213
412-268-7803
@johnkitchin
http://kitchingroup.cheme.cmu.edu

[-- Attachment #2: Type: text/html, Size: 3261 bytes --]

^ permalink raw reply	[flat|nested] 22+ messages in thread

end of thread, other threads:[~2021-10-13  0:09 UTC | newest]

Thread overview: 22+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-08-11  0:58 Expanding how the new cite syntax is used to include cross-references - thoughts? John Kitchin
2021-08-11  1:19 ` Bruce D'Arcus
2021-08-11  5:28   ` Tom Gillespie
2021-08-11 11:13     ` Bruce D'Arcus
2021-08-11 11:54       ` Bruce D'Arcus
2021-08-11 13:43         ` John Kitchin
2021-08-11 14:32           ` Bruce D'Arcus
2021-08-11 14:56             ` John Kitchin
2021-08-11 15:41               ` Bruce D'Arcus
2021-08-11 16:08                 ` Timothy
2021-08-11 16:26                   ` Bruce D'Arcus
2021-08-11 14:13       ` John Kitchin
2021-08-12 15:23         ` Bruce D'Arcus
2021-08-12 17:19           ` John Kitchin
2021-08-12 18:06             ` Bruce D'Arcus
2021-08-13 15:22             ` Eric S Fraga
2021-10-10 13:30               ` Bruce D'Arcus
2021-10-12 21:16                 ` John Kitchin
2021-10-12 21:58                   ` Bruce D'Arcus
2021-10-12 23:27                     ` John Kitchin
2021-10-13  0:08                       ` Bruce D'Arcus
2021-08-11 13:23   ` John Kitchin

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).