org-mode/contrib
Stefan Monnier 129c33dddf * lisp/org-agenda.el: Use lexical-binding
- Removed the global (defvar date) and (defvar entry) so as not to
  conflict with function arguments of that name.  Instead I added such
  `defvar`s in the body of each of the functions where it
  seemed needed.
- I added some FIXMEs for some issues I found along the way.
- Added an `org-dlet` macro, just like I had done for `calendar-dlet`,
  but I also use `defvar` "manually" at some places, when splitting an
  existing `let` into a mix of `let`s and `dlet`s seemed too much trouble.
- Removed uses of `org-let and `org-let2` not only because I consider
  them offensive to my sense of aesthetics but also because they're
  basically incompatible with lexical scoping.
  I replaced them with uses of `cl-progv` which are a bit more verbose.
  Maybe we should define some `org-progv` macro on top of `cl-progv` to
  make the code less verbose, but I didn't do that because I like the
  fact that the current code makes uses of `eval` a bit more obvious
  (since these behave differently with lexical scoping than with
  lexical binding, it seemed worthwhile).
- Removed the use of `eval` in `org-store-agenda-views` which was only
  placed there in order to use a macro before it's defined (it would
  have been simpler/cleaner to just move that functions *after* the
  macro, but with the new code the problem doesn't occur any more anyway).
- Replaced a few `(lambda...) with actual closures.

Detailed changes follow:

(date, entry): Don't declare as being globally dynbound.
(org-agenda-format-date-aligned): Remove unused var `weekyear`.
(org-agenda-mode): `run-mode-hooks` is always available nowadays.
(org-agenda-undo): Remove unused var `last-undo-buffer`.
(org-agenda): Rename arg to `keys` and then dyn-bind it as `org-keys`.
Remove unused vars `buf` and `key`.
(org-agenda): Use `pcase` and `cl-progv` instead of `org-let`.
(org-let, org-let2): Mark as obsolete.
(org-agenda-run-series): Use `cl-progv` instead of `org-let` and `org-let2`.
(org-agenda-run-series): New function.
(org--batch-agenda): New function extracted from `org-batch-agenda`.
(org-batch-agenda): Use it.
(org--batch-agenda-csv): New function extracted from `org-batch-agenda-csv`.
(org-batch-agenda-csv): Use it.
(org--batch-store-agenda-views): New function, extracted from
`org-batch-store-agenda-views`.
(org-store-agenda-views, org-batch-store-agenda-views): Use it.
(org--batch-store-agenda-views): Use `cl-progv` instead of
`org-eval-in-environment`.
(org-agenda-write): Use `cl-progv` instead of `org-let`.
Use `with-current-buffer`.
(org-agenda-filter-any): Use `cl-some` instead of `eval`.
(org-agenda-list): Remove unused var `e`.
(org-search-view): η-reduce.
(crm-separator): Declare var.
(org-agenda-skip-if): Remove unused var `beg`.
(org-agenda-list-stuck-projects): Use a closure rather than `(lambda..).
(diary-modify-entry-list-string-function, diary-file-name-prefix)
(diary-display-function): Declare vars.
(org-diary): Declare `date` and `entry` as dynbound.
(org-agenda-get-day-entries): Use `org-dlet`.
(org-agenda-get-timestamps, org-agenda-get-progress)
(org-agenda-get-deadlines, org-agenda-get-scheduled, org-agenda-get-blocks):
Declare `date` as dynbound.
(org-agenda-get-sexps, org-class): Declare `date` and `entry` as dynbound.
(org-agenda-format-item): Declare the vars mentioned in
`org-compile-prefix-format` as dyn-bound.
Also binding `extra`, suggested by Kyle Meyer <kyle@kyleam.com>.
(org-compile-prefix-format): Remove unused var `e`.
Use `member` rather than or+equal.
(org-set-sorting-strategy): Minor simplification.
(org-entries-lessp): Use `org-dlet`.
(org-agenda-redo): Declare var `org-agenda-tag-filter-while-redo`.
(org-agenda-redo): Use `cl-progv` rather than `org-let`.
(org-agenda-filter): Remove unused var `rpl-fn`.
Use `org-pushnew-to-end` to replace `add-to-list` on lexical var.
(org-agenda-filter-by-tag): Remove unused var `n`.
(org-agenda-filter-apply): Use `org-dlet`.
(org-agenda-compute-starting-span): Remove unused var `dg`.
(org-agenda-forward-block): Remove unused var `pos`.
(org-archive-from-agenda): Declare var.
(org-agenda-refile): Remove unused var `pos`.
(org-agenda-headline-snapshot-before-repeat): Declare var.
(org-agenda-todo): Remove redundant use of `bound-and-true-p`.
(org-agenda-add-note): Remove unused var `hdmarker` and unused `arg`.
(org-agenda-change-all-lines): Remove unused var `pl`.
(org-agenda-priority): Remove unused var `marker`.
(org-agenda-set-effort): Remove unused var `newhead`.
(org-agenda-schedule): Remove unused var `type`.
(org-agenda-clock-cancel): Remove unused `arg`.
(org-agenda-execute-calendar-command): Use `org-dlet`.
(org-agenda-bulk-action): Use closures instead of `(lambda ...).
(org-agenda-show-the-flagging-note): Remove unused vars `heading` and
`newhead`.
(org-agenda-remove-flag): Avoid `setq`.

* testing/org-test.el (org--compile-when): New macro.
(org-test-jump): Use it so compilation doesn't fail or generate broken
code when `jump` is not available.

* testing/lisp/test-org-src.el:
* testing/lisp/test-org-attach.el:
* testing/lisp/test-org-agenda.el:
* testing/lisp/test-ob-java.el: Pass explicit filename to `require`
so as not to rely on ".../testing" being in `load-path` during compilation.

* lisp/org-num.el: Require` org`.

* lisp/org-macs.el (org-eval-in-environment): Declare obsolete.
(org-dlet, org-pushnew-to-end): New macros.

* doc/Makefile (org.texi, orgguide.texi, %_letter.tex): Simplify quoting.

* contrib/lisp/ob-sclang.el: Don't crash compilation when `sclang`
is not available.

* contrib/lisp/ob-clojure-literate.el: Don't crash compilation when `cider`
is not available.

* contrib/lisp/ob-arduino.el: Don't crash compilation when `arduino-mode`
is not available.

* .gitignore: Add files generated during `make packages/org`.
2021-03-09 22:56:33 -05:00
..
lisp * lisp/org-agenda.el: Use lexical-binding 2021-03-09 22:56:33 -05:00
scripts x11idle: Make installation a little smoother 2020-10-28 23:40:40 -04:00
README contrib: Remove Org Drill 2019-07-11 22:55:02 +02:00

README

This directory contains add-ons to Org-mode.

These contributions are not part of GNU Emacs or of the official
Org-mode package.  But the git repository for Org-mode is glad to
provide useful way to distribute and develop them as long as they
are distributed under a free software license.

Please put your contribution in one of these directories:

LISP (Emacs Lisp)
=================

Org utils
~~~~~~~~~
org-annotate-file.el     --- Annotate a file with org syntax
org-bibtex-extras.el     --- Extras for working with org-bibtex entries
org-bookmark.el          --- Links to bookmarks
org-checklist.el         --- org functions for checklist handling
org-choose.el            --- Use TODO keywords to mark decision states
org-collector.el         --- Collect properties into tables
org-colview-xemacs.el	 --- Column View in Org-mode, XEmacs-specific version
org-contacts.el          --- Contacts management
org-contribdir.el        --- Dummy file to mark the org contrib Lisp directory
org-depend.el            --- TODO dependencies for Org-mode
org-effectiveness.el     --- Measuring your personal effectiveness
org-element.el           --- Parser and applications for Org syntax
org-eldoc.el             --- Eldoc documentation for SRC blocks
org-elisp-symbol.el      --- Org links to emacs-lisp symbols
org-eval-light.el        --- Evaluate in-buffer code on demand
org-eval.el              --- The <lisp> tag, adapted from Muse
org-expiry.el            --- Expiry mechanism for Org entries
org-export-generic.el    --- Export framework for configurable backends
org-git-link.el          --- Provide org links to specific file version
org-interactive-query.el --- Interactive modification of tags query
org-invoice.el           --- Help manage client invoices in OrgMode
org-learn.el             --- SuperMemo's incremental learning algorithm
org-license.el		 --- Insert free licenses to your org documents
org-link-edit.el	 --- Slurp and barf with Org links
org-mac-iCal.el          --- Imports events from iCal.app to the Emacs diary
org-mac-link.el          --- Grab links and URLs from various Mac applications
org-mairix.el 	         --- Hook mairix search into Org for different MUAs
org-man.el 	         --- Support for links to manpages in Org-mode
org-mew.el		 --- Support for links to Mew messages
org-mime.el              --- org html export for text/html MIME emails
org-mtags.el 	         --- Support for some Muse-like tags in Org-mode
org-notify.el            --- Notifications for Org-mode
org-notmuch.el           --- Support for links to notmuch messages
org-panel.el 	         --- Simple routines for us with bad memory
org-registry.el          --- A registry for Org links
org-screen.el            --- Visit screen sessions through Org-mode links
org-screenshot.el        --- Take and manage screenshots in Org-mode files
org-secretary.el         --- Team management with org-mode
org-static-mathjax.el    --- Muse-like tags in Org-mode
org-sudoku.el            --- Create and solve SUDOKU puzzles in Org tables
org-toc.el 	         --- Table of contents for Org-mode buffer
org-track.el             --- Keep up with Org development
org-velocity.el          --- something like Notational Velocity for Org
org-vm.el		 --- Support for links to VM messages
org-w3m.el		 --- Support link/copy/paste from w3m to Org-mode
org-wikinodes.el         --- CamelCase wiki-like links for Org
org-wl.el		 --- Support for links to Wanderlust messages
orgtbl-sqlinsert.el      --- Convert Org-mode tables to SQL insertions

Org exporters
~~~~~~~~~~~~~
ox-confluence.el         --- Confluence Wiki exporter
ox-deck.el               --- deck.js presentations exporter
ox-groff.el              --- Groff exporter
ox-koma-letter.el        --- KOMA Scrlttr2 exporter
ox-rss.el		 --- RSS 2.0 exporter
ox-s5.el                 --- S5 presentations exporter
ox-taskjuggler.el        --- TaskJuggler exporter

Org Babel languages
~~~~~~~~~~~~~~~~~~~
ob-eukleides.el    	 --- Org-babel functions for eukleides evaluation
ob-fomus.el        	 --- Org-babel functions for fomus evaluation
ob-julia.el  	 	 --- Org-babel functions for julia evaluation
ob-mathomatic.el   	 --- Org-babel functions for mathomatic evaluation
ob-oz.el           	 --- Org-babel functions for Oz evaluation
ob-stata.el              --- Org-babel functions for Stata evaluation
ob-tcl.el 		 --- Org-babel functions for tcl evaluation

External libraries
~~~~~~~~~~~~~~~~~~
htmlize.el               --- Convert buffer text and decorations to HTML


SCRIPTS (shell, bash, etc.)
===========================
StartOzServer.oz     	 --- implements the Oz-side of the Org-babel Oz interface
dir2org.zsh              --- Org compatible fs structure output
ditaa.jar            	 --- ASCII to PNG converter by Stathis Sideris, GPL
org-docco.org        	 --- docco side-by-side annotated code export to HTML
org2hpda             	 --- Generate hipster pda style printouts from Org-mode
staticmathjax        	 --- XULRunner application to process MathJax statically
x11idle.c            	 --- get the idle time of your X session

This directory also contains supporting files for the following
packages: ob-oz.el, org-docco.org, and org-static-mathjax.el.