Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document use of Org Cite citations #555

Merged
merged 2 commits into from Feb 10, 2022
Merged

Document use of Org Cite citations #555

merged 2 commits into from Feb 10, 2022

Conversation

kaushalmodi
Copy link
Owner

@kaushalmodi kaushalmodi commented Feb 10, 2022

  • Document how to use the inbuilt Org Cite (oc.el) feature from Org 9.5.
  • Remove old Org Ref documentation as it referenced a now-deprecated package.

Remove "Org-ref Citations" page from the manual because it suggested
installing https://github.com/andras-simonyi/citeproc-org. But that
package was discontinued since oc.el (Org Cite) got added to Org 9.5.

From the citeproc-org repo:

> !! Important note, read this first (last updated on 2021-12-18) !!
>
> As native support for citations including CSL-based export is now part
> of Org (see the announcement[1] and the relevant manual section[2]),
> and the most recent org-ref version also supports CSL-formatting (see
> this video[3]), citeproc-org is obsolete and will be in maintenance
> mode (reported bugs will be fixed), with only occasional backports
> from the Org-native CSL infrastructure, which is under active
> development. The recommended way of getting CSL-rendering of Org
> citations is therefore using native Org cites with the CSL export
> processor or using org-ref 3[4].
>
> [1]: https://orgmode.org/list/87o8bcnfk9.fsf@nicolasgoaziou.fr/
>
> [2]: https://orgmode.org/manual/Citation-handling.html
>
> [3]: https://www.youtube.com/watch?v=Xs59PGTfDC0
>
> [4]: https://github.com/jkitchin/org-ref
@kaushalmodi kaushalmodi changed the title Add org cite test Document use of Org Cite citations Feb 10, 2022
@kaushalmodi kaushalmodi merged commit 5ef9866 into main Feb 10, 2022
@kaushalmodi
Copy link
Owner Author

Note to self

Make sure that the ox-hugo doc site built using Netlify is using the latest Org mode from Elpa (which would be 9.5+ as of writing this on 2022/02/10).

Earlier I had the OX_HUGO_DEFAULT_ORG set in Netlify and that caused Org 9.4 to be used as that was the default Org version shipped with the latest Emacs release 27.2 as of today.

(defvar ox-hugo-install-org-from-elpa (or (null (getenv "OX_HUGO_DEFAULT_ORG"))
(version< emacs-version "26.0"))

Doc site Netlify Environment Variables config after removing that env var:

image

@kaushalmodi kaushalmodi deleted the add-org-cite-test branch February 10, 2022 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant