UP | HOME

Support via Liberapay

Org mailing list

The Org mailing list is an English language forum for discussing Org and related topics. The list requires a subscription from a confirmed email address to post.

It is used by the diverse community of Org developers, maintainers, contributors, experienced users, and new and prospective users both for discussion and as a repository of information. It was established by the creator of Org-mode, Carsten Dominik, who enjoys the different perspectives and range of interests expressed there.

The list is less formal and more diverse than a site like stackoverflow, which has an org-mode section. Subscribers' messages to the list aren't moderated and there is no formal mechanism to rate questions, answers, or reputations.

Consider joining Org IRC for real time help, simple questions, and to chat with other Org users.

List archives

You can browse the mailing list archives and search the message history at:

public-inbox archive
https://list.orgmode.org/
Mailman list archive
https://lists.gnu.org/archive/html/emacs-orgmode/

Subscribe to the Org mailing list

The Org mailing list is a members only mailing list to prevent spam. Membership is freely available and only requires that you subscribe to the list and confirm your email address. Messages from non-subscribers will be delayed pending moderator review.

You may subscribe to the list from this webpage.

Fill in your email address and provide a password. A confirmation email will be sent to you. When you reply to the confirmation mail, you will be able to send messages to the mailing list and receive messages from the list.

Alternatively you can send an email to emacs-orgmode-request@gnu.org with a subject of "subscribe". A confirmation email will follow. When you reply to the confirmation email you will be added to the mailing list.

I you find email frequency from the list too high, consider enabling "digest" in your subscription settings.

"I don't want to subscribe"

Fine. Simply send your first message to emacs-orgmode@gnu.org and a moderator will let it through. You will be added to a whitelist so that your next messages don't need to go through moderation. Because you won't be a proper subscriber, people need to CC you to let you follow the conversations.

Non-subscribers should expect delays before their first messages reach the mailing list. After passing moderation future messages will go through immediately.

Posting to the Org mailing list

If you are already a list subscriber, you may post directly to the list by sending an email to: emacs-orgmode@gnu.org

You may also reply to messages you are receiving from the list.

List Etiquette

Posters are encouraged to be precise, concise, and friendly. Top-posting is discouraged. Lengthy excerpts of quoted material are probably redundant and they clog certain distribution channels. Posters should include enough quoted material to establish the context for their comments and cut away the rest.

Use of plain text email is strongly preferred.

Feature Requests

Please label feature requests in the subject, perhaps with "[FR] Please add X".

It's good to have a separate email thread per request, then everyone can discuss the merits of the suggestion.

Bug Reports

Bug reports may be submitted to the mailing list. Please label them appropriately with a tag "[BUG]" and include detailed information on how to reproduce the bug.

Consider including the output of M-x report-emacs-bug in your message.

Please attached a Minimum Working Example that can be used. See these links for additional ideas regarding MWEs.

Be patient with bug reports. Maintainer time is limited and it is likely your issue will benefit from discussion in the overall community.

The list and tracker.orgmode.org

tracker.orgmode.org makes it easier to keep track of important Org announcements such as new releases, confirmed bugs, help requests and user-significant changes.

The information on this page only comes from interacting with the Org mailing list.

To confirm a bug, just reply to the list with Confirmed. at the beginning of a line.

See https://tracker.orgmode.org/docs.html for more usage explanations.

What to do before posting a question

What to do if you don't receive an answer

If your email is referenced on tracker.orgmode.org, it will get the attention of the maintainers when they have enough time. (Remember they work on a volunteer basis.)

If your email is not referenced there and you think it deserves more attention, you can do this:

  • If it is a bug report, check that you provided enough information, especially the Org and Emacs versions and a step-by-step recipe to reproduce the bug.
  • If it is a question, give more information on what you tried, why you still have the question and why the answer may be of interest for other subscribers.

If you have nothing special to add to your first message and just want to "bump" the thread, please wait at least one month before doing so.

See As a contributor, what can I expect? for more.

Advanced local public-inbox setup

It is possible to download and interact with mailing list locally on your computer using public-inbox.

This uses the program "public-inbox" which when installed should provide all the executables mentioned (public-inbox-clone, public-inbox-index, lei).

Setup public-inbox

First we want to use public-inbox to grab and index the mailing list:

mkdir ~/.local/share/public-inbox
public-inbox-clone https://list.orgmode.org/orgmode ~/.local/share/public-inbox/orgmode
public-inbox-index ~/.local/share/public-inbox/orgmode

This is the one-time setup. If you'd like to update an existing public-inbox do this:

set -e # error on error
public-inbox-fetch --exit-code -C ~/.local/share/public-inbox/orgmode
public-inbox-index -C ~/.local/share/public-inbox/orgmode

Setup lei

Now we want to use the "lei" tool to view and query the mailing list. First we need to do a one-time setup:

lei add-external ~/.local/share/public-inbox/orgmode

Now we can test lei by doing a simple query. Too see the full query syntax run "man lei-q".

lei q --format=text t:"emacs-orgmode@gnu.org" s:"Fix a docstring typo"

Export open bug reports

It could be handy to have a directory full of open bug report threads as listed on https://tracker.orgmode.org. This would allows us to use grep and other standard tools to find open reports.

To do this we will parse the json file located at https://tracker.orgmode.org/reports/all-open.json. We will pull out all MESSAGE-IDS and then use "lei lcat" to print out the threads.

Since we will sometimes end up printing out the same thread multiple times (one thread can contain multiple bug reports), we will do some minor de-duplication by making the file-name be a content hash.

(let ((output-directory (expand-file-name "~/output-dir"))
      ;; wget https://tracker.orgmode.org/reports/all-open.json
      (tracker-json (expand-file-name "~/downloads/all-open.json")))
  (mkdir output-directory t)
  (cl-flet*
      ((get-message-id-list ()
         (with-current-buffer (or (find-buffer-visiting tracker-json)
                                  (find-file-noselect tracker-json t t))
           (goto-char (point-min))
           (seq-map
            (lambda (report)
              (alist-get 'message-id report))
            (alist-get
             'reports
             (json-parse-buffer
              :object-type 'alist)))))
       (output-thread-to-file (message-id)
         (unless (eq 0 (call-process "lei" nil '(:file "tmp.txt") nil
                       "lcat" "--no-color" "--threads" message-id))
           (error "lei did not return success"))
         ;; File name is hash of content so we don't have duplicate files
         (let ((file-hash
                (car (string-split
                      (shell-command-to-string "md5sum tmp.txt")))))
           (rename-file "tmp.txt" (concat file-hash ".txt") t))))
    (let ((default-directory output-directory))
      (dolist-with-progress-reporter (message-id (get-message-id-list))
          "Outputting threads to files: "
        (output-thread-to-file message-id)))))

Now you should have a directory full of open bug reports that you can grep! Then whenever you see something you want to interact with you can open using a message-id you find in the file. You might want a helper function like this:

(defun my-orglist-open (message-id)
  "Open MESSAGE-ID orglist mail."
  (interactive "smessage-id: \n")
  (browse-url (concat "orgmode.org/list/"
                      (string-trim message-id "<" ">"))))

Hosting Mail for you mail reader

We can serve the public-inbox mailbox locally for a mail reader to use. HTTP, IMAP, NNTP, and POP3 are supported but I've only tried NNTP so that's what we'll setup here.

We're going to need a config file for public-inbox now. Here is a minimal one that needs to be placed at "~/.public-inbox/config". Do note that you'll have to replace "USERNAME" with your own username.

[publicinbox "orgmode"]
        inboxdir = /home/USERNAME/.local/share/public-inbox/orgmode
        address = emacs-orgmode@gnu.org
        infourl = https://www.orgmode.org/
    listid = emacs-orgmode.gnu.org
        newsgroup = emacs.orgmode

Now we can serve the mailing list locally over nntp like this:

public-inbox-nntpd -l localhost:9012

gnus setup

Now let's connect to it using gnus.

(setopt
 gnus-secondary-select-methods
 (list
  ...
  '(nntp "nntp"
         (nntp-address "localhost")
         (nntp-port-number 9012)
         (nntp-open-connection-function nntp-open-plain-stream))))

And now let's tell browse-url to open links using gnus:

(setopt browse-url-handlers
        `((,(rx (or "list.orgmode.org/" "orgmode.org/list/")) .
           ,(lambda (host-or-url &rest _)
              (org-gnus-follow-link "nntp+nntp:emacs.orgmode"
                                    (string-trim
                                     host-or-url
                                     (rx (* anychar) (or (and "list.orgmode.org/" (? "orgmode/"))
                                                         "orgmode.org/list/"))
                                     "/.*"))))))

Documentation from the orgmode.org/worg/ website (either in its HTML format or in its Org format) is licensed under the GNU Free Documentation License version 1.3 or later. The code examples and css stylesheets are licensed under the GNU General Public License v3 or later.