Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
Z
zotxt-emacs
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Locked Files
Issues
2
Issues
2
List
Boards
Labels
Service Desk
Milestones
Merge Requests
1
Merge Requests
1
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Erik Hetzner
zotxt-emacs
Commits
b6e7db70
Commit
b6e7db70
authored
Jan 08, 2017
by
Erik Hetzner
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Convert README to md
parent
2faacf8b
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
67 additions
and
83 deletions
+67
-83
README
README
+67
-0
README.rst
README.rst
+0
-83
No files found.
README
0 → 100644
View file @
b6e7db70
# zotxt-emacs
Note: zotero-plain has been split into two parts: zotxt-emacs (this
repository) for working with org, and `zot4rst` (zotero reStructuredText
tools), which been moved to [zot4rst](http://gitlab.com/egh/zot4rst).
## Installation
zotxt-emacs can be installed via [MELPA](http://melpa.milkbox.net/);
please see the `zotxt` package.
## Requirements
zotxt-emacs requires GNU emacs >= 24.3, or any version of emacs 25,
including unreleased versions. It should work with a builtin org-mode or
with the latest org-mode installed via the org ELPA repository.
## Emacs integration
Emacs integration has 3 parts: a core library (`zotxt.el`),
[org-mode](http://orgmode.org/) integration (`org-zotxt.el`), and an
“easykey” mode (`zotxt-easykey.el`). Emacs integration depends on the
[zotxt](http://gitlab.com/egh/zotxt) Zotero extension.
## For pandoc markdown files
zoxtxt-easykey, in combination with pandoc-zotxt, can help you edit your
pandoc markdown files. Load the zotxt-easykey minor mode using
`M-x zotxt-easykey-mode` and get started by inserting an easykey using
`C-c " k`. This will prompt you for a search string, which will do a
quicksearch in your Zotero library. You will then be prompted to make a
selection from the results of that search. An easykey for your selection
will then be inserted into your document.
### zotxt + org-mode
To insert a citation into a [org-mode](http://orgmode.org/) document,
first enable the `org-zotxt` minor mode:
M-x org-zotxt-mode
Then select one or more items in [Zotero](http://www.zotero.org/) pane.
Finally, in [emacs](http://www.gnu.org/software/emacs/), use: `C-c " i`
to insert these items as citations. This inserts a zotero link with
descriptive link text.
To update the link text to reflect changed metadata from
[Zotero](http://www.zotero.org/), use `C-c " u` over the link.
## zotxt EasyKey integration
zotxt supports a feature known as “easy keys” for integration with
zotero and pandoc or zot4rst. These keys look like `@doe:2014title`
where Doe is the author’s last name, 2014 is the publication year, and
title is the first word of the title (excluding “stop words”, such as
“the” or “a”). The provided `zotxt-easykey-mode` supports completion of
these easykeys in a buffer using the command `completion-at-point`.
(This function is not bound in org-mode, but I replace the binding to
`pcomplete` using:
;; prefer completion-at-point to pcomplete
(define-key org-mode-map (kbd "C-M-i") 'completion-at-point)
Now, the user can `@doe` and then `C-M-i`. If the only matching easy key
is `@doe:2014title` this will be completed. If there are multiple
matches, the user will be presented with a buffer containing possible
completions.
README.rst
deleted
100644 → 0
View file @
2faacf8b
=============
zotxt-emacs
=============
Note: zotero-plain has been split into two parts: zotxt-emacs (this
repository) for working with org, and ``zot4rst`` (zotero
reStructuredText tools), which been moved to `zot4rst`_.
Installation
------------
zotxt-emacs can be installed via MELPA_; please see the ``zotxt``
package.
Requirements
------------
zotxt-emacs requires GNU emacs >= 24.3, or any version of emacs 25, including
unreleased versions. It should work with a builtin org-mode or with the latest
org-mode installed via the org ELPA repository.
Emacs integration
-----------------
Emacs integration has 3 parts: a core library (``zotxt.el``),
`org-mode`_ integration (``org-zotxt.el``), and an “easykey” mode
(``zotxt-easykey.el``). Emacs integration depends on the zotxt_ Zotero
extension.
For pandoc markdown files
-------------------------
zoxtxt-easykey, in combination with pandoc-zotxt, can help you edit
your pandoc markdown files. Load the zotxt-easykey minor mode using
``M-x zotxt-easykey-mode`` and get started by inserting an easykey
using ``C-c " k``. This will prompt you for a search string, which
will do a quicksearch in your Zotero library. You will then be
prompted to make a selection from the results of that search. An
easykey for your selection will then be inserted into your document.
zotxt + org-mode
~~~~~~~~~~~~~~~~
To insert a citation into a `org-mode`_ document, first enable the
``org-zotxt`` minor mode::
M-x org-zotxt-mode
Then select one or more items in Zotero_ pane. Finally, in emacs_,
use: ``C-c " i`` to insert these items as citations. This inserts a
zotero link with descriptive link text.
To update the link text to reflect changed metadata from Zotero_, use
``C-c " u`` over the link.
zotxt EasyKey integration
-------------------------
zotxt supports a feature known as “easy keys” for integration with
zotero and pandoc or zot4rst. These keys look like ``@doe:2014title``
where Doe is the author’s last name, 2014 is the publication year, and
title is the first word of the title (excluding “stop words”, such as
“the” or “a”). The provided ``zotxt-easykey-mode`` supports completion
of these easykeys in a buffer using the command
``completion-at-point``. (This function is not bound in org-mode, but
I replace the binding to ``pcomplete`` using::
;; prefer completion-at-point to pcomplete
(define-key org-mode-map (kbd "C-M-i") 'completion-at-point)
Now, the user can ``@doe`` and then ``C-M-i``. If the only matching
easy key is ``@doe:2014title`` this will be completed. If there are
multiple matches, the user will be presented with a buffer containing
possible completions.
.. _Zotero: http://www.zotero.org/
.. _emacs: http://www.gnu.org/software/emacs/
.. _`org-mode`: http://orgmode.org/
.. _`zot4rst`: http://gitlab.com/egh/zot4rst
.. _zotxt: http://gitlab.com/egh/zotxt
.. _MELPA: http://melpa.milkbox.net/
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment