Re: [O] Org, Org-mode, Orgmode, Org Mode
Thorsten Jolitz tjol...@googlemail.com writes: Achim Gratz strom...@nexgo.de writes: Looking at the documentation and also the website and Worg, I see that we still use all these monikers interchangeably in both capitalized and lowercase form throughout. I seem to remember that there was some discussion that only one of them should be used going forward, but I can't find it... Regards, Achim. look at: /org-mode/doc/Documentation_Standards.org in your Org-mode (?) distribution See below for an historical data point. I wrote that standards doc after an off-list discussion/agreement with Carsten and Bastien back in early 2008 and just before I made an effort to tidy up these sort of issues in the docs. Obviously Org development, awareness and use has exploded since those days and so it seems reasonable to check whether what we said back then remains relevant today. I don't really mind what the standard is but I certainly agree that having one is a good thing. Regards, Phil --- From: Carsten Dominik carsten.domi...@gmail.com Subject: Re: Documentation standards To: p...@yax.org.uk Cc: b...@altern.org Date: Wed, 26 Mar 2008 19:40:08 +0100 (4 years, 9 weeks, 5 days ago) Dear Phil, I am pretty much happy with all the proposed changes, below are some comments. [...snip...] 7) [...] Thus I have seen Org-mode, org-mode, org or Org referring to the mode itself, the function 'org-mode' and then a variety of 'org-mode-...' functions and variables. I would like to standardise on Org when referring to the mode (as a noun if you like) and org-... in all other instances. I think it will also work better with the way a number of other modes (eg Calc) are also already referenced. Likewise, I would also like to disambiguate Orgtbl the minor mode, and others, from references to that mode's functions and variables. I am all for it. I thought that I have used Org-mode very systematically throughout the manual, but maybe I am mistaken. If you choose Org, how about the following: Let Org refer to the system as a whole, not narrowed down to the mode. Because in fact, Org contains a number of different major modes. So use org-mode or Org-mode when you specifically mean the major mode in .org files and its properties. Use Org as the general term which then in places might be used instead of org- mode if there is not misconception possible. - Carsten
Re: [O] Bug: [Babel] sqlite if: End of file during parsing
Eric Schulte eric.schu...@gmx.com writes: Thanks for the detailed reproduction information in your original email, it made this issue much easier to solve. I've just pushed up a fix, please let me know if the problem continues. Eric, seems to work perfectly now. Thank you so much for your help. Phil
[O] Bug: [Babel] sqlite if: End of file during parsing
Remember to cover the basics, that is, what you expected to happen and
what in fact did happen. You don't know how to make a good report? See
http://orgmode.org/manual/Feedback.html#Feedback
Your bug report will be posted to the Org-mode mailing list.
(Warning, this is the first time I have tried to use org babel and so
there could be user error in the following. Sorry if that is the
case.)
Starting from emacs -Q evaluate the following code blocks in
succession. The #+results: blocks below are what I am seeing on my
system.
#+begin_src emacs-lisp :results silent
(require 'org)
(require 'org-install)
(org-babel-do-load-languages
'org-babel-load-languages
'((sqlite . t)
(sh . t)))
#+end_src
The next block will create a small 2k file, ob-bug.db, in the current
directory. You will probably want to delete later.
#+begin_src sqlite :db ob-bug.db :results silent
drop table if exists person;
create table person (f_name text, l_name text);
insert into person (f_name, l_name) values ('Joe', 'Bloggs');
#+end_src
Check this worked:
#+begin_src sqlite :db ob-bug.db :results output
select * from person;
#+end_src
#+results:
| Joe | Bloggs |
Formatting the name using the sqlite string concat operator ||
also works as expected:
#+begin_src sqlite :db ob-bug.db :results output
select f_name || || l_name from person;
#+end_src
#+results:
: Joe Bloggs
Add a second line of data:
#+begin_src sqlite :db ob-bug.db :results output silent
insert into person (f_name, l_name) values ('Fred', 'Smith');
#+end_src
Repeat the last two queries.
#+begin_src sqlite :db ob-bug.db :results output
select * from person;
#+end_src
#+results:
| Joe | Bloggs |
| Fred | Smith |
but...
#+begin_src sqlite :db ob-bug.db :results output
select f_name || || l_name from person;
#+end_src
errors with the unhelpful message if: End of file during parsing
Although the query works from a shell:
#+begin_src sh :results output
sqlite3 ob-bug.db 'select f_name || || l_name from person;'
#+end_src
#+results:
: Joe Bloggs
: Fred Smith
Remove the debug database file if you want:
#+begin_src sh :results silent
rm ob-bug.db
#+end_src
(toggle-debug-on-error) offers no information and so I have tried edebug
stepping through the code. It seems that the error is happening in the
function org-babel-read at line 2335 when it tries to evaluate
(read \Joe).
The query at first ran successfully when there was just one line of
data in the database and stepping through that query shows that the
string being passed through org-babel-read is Joe Bloggs rather than
\Joe and therefore follows a different code path at line 2334.
At this point I am stuck.
Phil
Emacs : GNU Emacs 24.0.92.1 (i386-apple-darwin10.8.0, NS apple-appkit-1038.36)
of 2012-01-28 on bo
Package: Org-mode version 7.8.03 (release_7.8.03.346.gf9c4)
current state:
==
(setq
org-export-preprocess-before-selecting-backend-code-hook
'(org-beamer-select-beamer-code)
org-tab-first-hook '(org-hide-block-toggle-maybe
org-src-native-tab-command-maybe org-babel-hide-result-toggle-maybe)
org-speed-command-hook '(org-speed-command-default-hook
org-babel-speed-command-hook)
org-occur-hook '(org-first-headline-recenter)
org-metaup-hook '(org-babel-load-in-session-maybe)
org-export-preprocess-before-normalizing-links-hook
'(org-remove-file-link-modifiers)
org-confirm-shell-link-function 'yes-or-no-p
org-export-latex-final-hook '(org-beamer-amend-header org-beamer-fix-toc
org-beamer-auto-fragile-frames org-beamer-place-default-actions-for-lists)
org-export-latex-after-initial-vars-hook '(org-beamer-after-initial-vars)
org-after-todo-state-change-hook '(org-clock-out-if-current)
org-src-mode-hook '(org-src-babel-configure-edit-buffer
org-src-mode-configure-edit-buffer)
org-agenda-before-write-hook '(org-agenda-add-entry-text)
org-babel-pre-tangle-hook '(save-buffer)
org-mode-hook '((lambda nil (org-add-hook (quote change-major-mode-hook)
(quote org-show-block-all) (quote append) (quote local)))
(lambda nil (org-add-hook (quote change-major-mode-hook)
(quote org-babel-show-result-all) (quote append) (quote local)))
org-babel-result-hide-spec org-babel-hide-all-hashes)
org-ctrl-c-ctrl-c-hook '(org-babel-hash-at-point
org-babel-execute-safely-maybe)
org-cycle-hook '(org-cycle-hide-archived-subtrees org-cycle-hide-drawers
org-cycle-show-empty-lines org-optimize-window-after-visibility-change)
org-export-latex-format-toc-function 'org-export-latex-format-toc-default
org-export-blocks '((src org-babel-exp-src-block nil) (export-comment
org-export-blocks-format-comment t) (ditaa org-export-blocks-format-ditaa nil)
(dot org-export-blocks-format-dot nil))
org-export-first-hook '(org-beamer-initialize-open-trackers)
org-export-interblocks '((src org-babel-exp-non-block-elements))
Re: [O] Bug: [Babel] sqlite if: End of file during parsing
Eric Schulte eric.schu...@gmx.com writes: Does the following work with the addition of :results scalar? Yes, there is no error although the format of the result is different to the one database line query or the equivalent shell command. This is what happens for me: #+begin_src sqlite :db ob-bug.db :results output scalar select f_name || || l_name from person; #+end_src #+results: : Joe Bloggs : Fred Smith Phil
Re: [O] [PATCH] New function org-find-timestamps
Marc-Oliver Ihm i...@online.de writes: By the way: There are surely official documentation standards, that I could adhere for this. However, at present I cannot find them. Could anyone provide me a pointer please ? Does the file doc/Documentation_Standards.org in the source distribution help at all? Failing that the Documentation node in the Elisp info manual has more general advice. There is also M-x checkdoc which can help check elisp doc strings. Phil
Re: [O] Bug: datetree capture from agenda [7.5 (release_7.5.135.g7021f.dirty)]
Carsten Dominik carsten.domi...@gmail.com writes: Thanks Carsten, I can see that it might be nice to simply add some text under the date headline in a date tree, in order to build up a long journal entry from little snippets. Yes, this is exactly what I do over the course of the day and I find it very useful. The trouble I run into is that, all too often, I forget or don't have time to add an entry on the day the noteworthy event happened. I use the agenda capture action (k c) in this situation since the date I am on in the agenda is picked up automatically by the template and the right date headline is created at the right place in the journal. Currently I have to then cut/paste the note, which is the bit I was trying to avoid. However, you are trying to *mix* headline entries and plain entries under the same date node in the tree, and this seems to be impossible. Sorry, my fault, the full version of journal template I currently use ends up creating entries like: *** 2011-04-06 Wednesday Try and clarify journal/note taking use case for Carsten [2011-04-06 Wed 10:03] Apologise for confusing Carsten as I don't actually use headline entries in the journal, plain only [2011-04-06 Wed 10:05] Wouldn't a better strategy be to have the plain section be started with a time, Well, as you see above I actually do like to have the time of the entry, but the only way I thought I could do that was using the %U keyword in the template (which is clumsy as it then duplicates the date/day). (the %%H:%M requires the current git release...) ... which, coincidently, seems to have appeared this morning :-) That means I can use something like: (setq org-capture-templates '((e Journal entry entry (file+datetree /tmp/journal.org) * %%H:%M\n %?) (l Journal late entry entry (file+datetree /tmp/journal.org) * Retrospectively added %%Y-%m-%d %H:%M\n %?))) Used from an agenda action the retrospective date headline/notes are created and filed in the right place, giving something like: * 2011 ** 2011-04 April *** 2011-04-05 Tuesday Retrospectively added 2011-04-06 11:35 Checked with Bastien about committing doc string changes *** 2011-04-06 Wednesday 11:33 Updated Org to latest version in order to get new capture keyword expansion capability 11:36 Problem solved. Brilliant, that works. Carsten never ceases to amaze... Thank you. Phil
[O] Bug: datetree capture from agenda [7.5 (release_7.5.135.g7021f.dirty)]
Remember to cover the basics, that is, what you expected to happen and what in fact did happen. You don't know how to make a good report? See http://orgmode.org/manual/Feedback.html#Feedback Your bug report will be posted to the Org-mode mailing list. Launch Emacs with no startup files $ emacs -Q ; evaluate these 2 forms in the *scratch* buffer (require 'org-install) (setq org-capture-templates '((h Journal headline entry (file+datetree /tmp/journal.org)) (n Journal note plain (file+datetree /tmp/journal.org ; follow this sequence M-x org-agenda a ; for current week or day agenda k c ; agenda action for capture h ; to add a headline entry in journal for today [...] ; add some text and C-c C-c to save k c n ; add a note in journal for today [...] ; add some text and save b ; back one week k c h ; add a headline entry in journal for one week ago [...] b ; go back one more week k c n ; add a note in journal for two weeks ago [...] Look at the journal file created. I would expect to see a date tree with a note entry under the date two weeks ago, a headline entry under the date one week ago and a note and headline entry under today's date. What I see is the date tree correctly constructed. The note and headline under today's date are correct filed. The headline entry from one week ago is correctly filed. The date headline from two weeks ago is correctly created but the text of the note entry itself is wrongly appended at the end of the file under today's date. That doesn't seem right to me. Thanks, Phil Emacs : GNU Emacs 24.0.50.3 (x86_64-apple-darwin10.6.0, NS apple-appkit-1038.35) of 2011-02-17 on bo Package: Org-mode version 7.5 (release_7.5.135.g7021f.dirty) current state: == (setq org-export-latex-after-initial-vars-hook '(org-beamer-after-initial-vars) org-speed-command-hook '(org-speed-command-default-hook org-babel-speed-command-hook) org-metaup-hook '(org-babel-load-in-session-maybe) org-capture-templates '((h Journal headline entry (file+datetree ~/tmp/journal.org)) (n Journal note plain (file+datetree ~/tmp/journal.org))) org-after-todo-state-change-hook '(org-clock-out-if-current) org-export-blocks-postblock-hook '(org-exp-res/src-name-cleanup) org-export-latex-format-toc-function 'org-export-latex-format-toc-default org-tab-first-hook '(org-hide-block-toggle-maybe org-src-native-tab-command-maybe org-babel-hide-result-toggle-maybe) org-src-mode-hook '(org-src-babel-configure-edit-buffer org-src-mode-configure-edit-buffer) org-confirm-shell-link-function 'yes-or-no-p org-export-first-hook '(org-beamer-initialize-open-trackers) org-agenda-before-write-hook '(org-agenda-add-entry-text) org-babel-pre-tangle-hook '(save-buffer) org-cycle-hook '(org-cycle-hide-archived-subtrees org-cycle-hide-drawers org-cycle-show-empty-lines org-optimize-window-after-visibility-change) org-export-preprocess-before-normalizing-links-hook '(org-remove-file-link-modifiers) org-mode-hook '((lambda nil (org-add-hook (quote change-major-mode-hook) (quote org-show-block-all) (quote append) (quote local))) (lambda nil (org-add-hook (quote change-major-mode-hook) (quote org-babel-show-result-all) (quote append) (quote local))) org-babel-result-hide-spec org-babel-hide-all-hashes) org-ctrl-c-ctrl-c-hook '(org-babel-hash-at-point org-babel-execute-safely-maybe) org-confirm-elisp-link-function 'yes-or-no-p org-export-interblocks '((lob org-babel-exp-lob-one-liners) (src org-babel-exp-inline-src-blocks)) org-occur-hook '(org-first-headline-recenter) org-from-is-user-regexp \\phil@bo\\.sak\\.lan|\\Philip Rooke\\ org-export-preprocess-before-selecting-backend-code-hook '(org-beamer-select-beamer-code) org-export-latex-final-hook '(org-beamer-amend-header org-beamer-fix-toc org-beamer-auto-fragile-frames org-beamer-place-default-actions-for-lists) org-metadown-hook '(org-babel-pop-to-session-maybe) org-export-blocks '((src org-babel-exp-src-block nil) (comment org-export-blocks-format-comment t) (ditaa org-export-blocks-format-ditaa nil) (dot org-export-blocks-format-dot nil)) )
Re: [Orgmode] bug in make info?
Andreas Röhler andreas.roeh...@easy-emacs.de writes: `make info' produces a texinfo-file `org' in directory `doc'. Shouldn't the ending be `info', i.e. the output be `org.info'? Not necessarily. The Makefile has the following target: doc/org: doc/org.texi (cd doc; $(MAKEINFO) --no-split org.texi -o org) where Carsten seems to have explicitly (-o option) set the output filename to be org. ___ Emacs-orgmode mailing list Please use `Reply All' to send replies to the list. Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode
[Orgmode] [PATCH] Docstring fixes
This is the sixth patch in a series that makes some straightforward
corrections to a number of docstrings. Each change is normally to:
- correct a typo, or
- fix up hyperlinks to function or variable names, or
- ensure slightly better conformance with the documentation guidelines
and tips given in the Elisp manual
No attempt is made to provide missing docstrings or document arguments.
---
I have just seen Bernt's very helpful email about formatting patches in
Git. Hopefully this will be easier to use for you. Please let me know
if I have messed this formatting up.
Phil
lisp/org-timer.el | 10 +++---
lisp/org-w3m.el |6 --
lisp/org-wl.el|6 +++---
lisp/org-xoxo.el |5 +++--
4 files changed, 17 insertions(+), 10 deletions(-)
diff --git a/lisp/org-timer.el b/lisp/org-timer.el
index e0817c8..d8e07d6 100644
--- a/lisp/org-timer.el
+++ b/lisp/org-timer.el
@@ -27,6 +27,8 @@
;; This file contains the relative timer code for Org-mode
+;;; Code:
+
(require 'org)
(declare-function org-show-notification org-clock (parameters))
@@ -110,7 +112,8 @@ the region 0:00:00.
(run-hooks 'org-timer-start-hook
(defun org-timer-pause-or-continue (optional stop)
- Pause or continue the relative timer. With prefix arg, stop it
entirely.
+ Pause or continue the relative timer.
+With prefix arg STOP, stop it entirely.
(interactive P)
(cond
(stop (org-timer-stop))
@@ -145,8 +148,9 @@ the region 0:00:00.
(defun org-timer (optional restart)
Insert a H:MM:SS string from the timer into the buffer.
The first time this command is used, the timer is started. When used with
-a `C-u' prefix, force restarting the timer.
-When used with a double prefix arg `C-u C-u', change all the timer string
+a \\[universal-argument] prefix, force restarting the timer.
+When used with a double prefix argument \
+\\[universal-argument] \\universal-argument], change all the timer string
in the region by a fixed amount. This can be used to recalibrate a timer
that was not started at the correct moment.
(interactive P)
diff --git a/lisp/org-w3m.el b/lisp/org-w3m.el
index 3f403c9..ce28729 100644
--- a/lisp/org-w3m.el
+++ b/lisp/org-w3m.el
@@ -28,11 +28,11 @@
;; This file implements copying HTML content from a w3m buffer and
;; transforming the text on the fly so that it can be pasted into
;; an org-mode buffer with hot links. It will also work for regions
-;; in gnus buffers that have ben washed with w3m.
+;; in gnus buffers that have been washed with w3m.
;
;;
-;;; Acknowledgements:
+;;; Acknowledgments:
;; Richard Riley rileyrgdev at googlemail dot com
;;
@@ -40,6 +40,8 @@
;; proposed by Richard, I'm just coding it.
;;
+;;; Code:
+
(require 'org)
(defun org-w3m-copy-for-org-mode ()
diff --git a/lisp/org-wl.el b/lisp/org-wl.el
index de6e919..9826a6f 100644
--- a/lisp/org-wl.el
+++ b/lisp/org-wl.el
@@ -105,7 +105,7 @@ googlegroups otherwise.
'((% . imap) (- . nntp) (+ . mh) (= . spool)
($ . archive) ( . pop) (@ . shimbun) ([ . search)
(* . multi) (/ . filter) (| . pipe) (' . internal))
- List of folder indicators. See Wanderlust manual, section 3.)
+ List of folder indicators. See Wanderlust manual, section 3.)
;; Install the link type
(org-add-link-type wl 'org-wl-open)
@@ -114,8 +114,8 @@ googlegroups otherwise.
;; Implementation
(defun org-wl-folder-type (folder)
- Return symbol that indicicates the type of FOLDER.
-FOLDER is the wanderlust folder name. The first character of the
+ Return symbol that indicates the type of FOLDER.
+FOLDER is the wanderlust folder name. The first character of the
folder name determines the the folder type.
(let* ((indicator (substring folder 0 1))
(type (cdr (assoc indicator org-wl-folder-types
diff --git a/lisp/org-xoxo.el b/lisp/org-xoxo.el
index 2ed5ff4..c065a8c 100644
--- a/lisp/org-xoxo.el
+++ b/lisp/org-xoxo.el
@@ -25,10 +25,11 @@
;
;;
;;; Commentary:
+;; XOXO export
-(require 'org-exp)
+;;; Code:
-;;; XOXO export
+(require 'org-exp)
(defvar org-export-xoxo-final-hook nil
Hook run after XOXO export, in the new buffer.)
--
1.7.1.1
___
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode
[Orgmode] [PATCH] Typo
Fix single typo --- doc/org.texi |3 ++- 1 files changed, 2 insertions(+), 1 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 3002772..ab5f10f 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -1,4 +1,5 @@ + \input texinfo @c %**start of header @setfilename info/org @@ -472,7 +473,7 @@ Interaction with other packages Hacking -* Hooks:: Who to reach into Org's internals +* Hooks:: How to reach into Org's internals * Add-on packages::Available extensions * Adding hyperlink types:: New custom link types * Context-sensitive commands:: How to add functionality to such commands -- 1.7.1.1 ___ Emacs-orgmode mailing list Please use `Reply All' to send replies to the list. Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode
[Orgmode] [PATCH] Correct some doc strings [part 5]
This is the fifth patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil -- diff --git a/lisp/org-src.el b/lisp/org-src.el index 0135ca4..bc32dda 100644 --- a/lisp/org-src.el +++ b/lisp/org-src.el @@ -87,10 +87,11 @@ These are the regions where each line starts with a colon. (function :tag Other (specify (defcustom org-src-preserve-indentation nil - If non-nil, leading whitespace characters in source code -blocks are preserved on export, and when switching between the -org buffer and the language mode edit buffer. If this variable -is nil then, after editing with \\[org-edit-src-code], the + If non-nil preserve leading whitespace characters on export. +If non-nil leading whitespace characters in source code blocks +are preserved on export, and when switching between the org +buffer and the language mode edit buffer. If this variable is nil +then, after editing with \\[org-edit-src-code], the minimum (across-lines) number of leading whitespace characters are removed from all lines, and the code block is uniformly indented according to the value of `org-edit-src-content-indentation'. @@ -101,7 +102,7 @@ indented according to the value of `org-edit-src-content-indentation'. Indentation for the content of a source code block. This should be the number of spaces added to the indentation of the #+begin line in order to compute the indentation of the block content after -editing it with \\[org-edit-src-code]. Has no effect if +editing it with \\[org-edit-src-code]. Has no effect if `org-src-preserve-indentation' is non-nil. :group 'org-edit-structure :type 'integer) @@ -326,7 +327,7 @@ the edited version. Optional argument CONTEXT is used by (switch-to-buffer buffer (defun org-src-construct-edit-buffer-name (org-buffer-name lang) - Construct the buffer name for a source editing buffer + Construct the buffer name for a source editing buffer. (concat *Org Src org-buffer-name [ lang ]*)) (defun org-edit-src-find-buffer (beg end) @@ -527,7 +528,7 @@ the language, a switch telling if the content should be in a single line. (match-string 1 s (defun org-edit-src-get-indentation (pos) - Count leading whitespace characters on line + Count leading whitespace characters on line. (save-match-data (goto-char pos) (org-get-indentation))) @@ -536,7 +537,7 @@ the language, a switch telling if the content should be in a single line. Exit special edit and protect problematic lines. (interactive) (unless (org-bound-and-true-p org-edit-src-from-org-mode) -(error This is not a sub-editing buffer, something is wrong...)) +(error This is not a sub-editing buffer, something is wrong)) (widen) (let* ((beg org-edit-src-beg-marker) (end org-edit-src-end-marker) diff --git a/lisp/org-table.el b/lisp/org-table.el index cd7642e..17a69a7 100644 --- a/lisp/org-table.el +++ b/lisp/org-table.el @@ -196,7 +196,7 @@ t: accept as input and present for editing calc-date-format ( - MM - DD Www ( hh : mm)) calc-display-working-message t ) - List with Calc mode settings for use in calc-eval for table formulas. + List with Calc mode settings for use in `calc-eval' for table formulas. The list must contain alternating symbols (Calc modes variables and values). Don't remove any of the default settings, just change the values. Org-mode relies on the variables to be present in the list. @@ -276,10 +276,11 @@ portability of tables. :group 'org-table) (defcustom org-table-export-default-format orgtbl-to-tsv - Default export parameters for org-table-export. These can be -overridden on for a specific table by setting the TABLE_EXPORT_FORMAT -property. See the manual section on orgtbl radio tables for the different -export transformations and available parameters. + Default export parameters for `org-table-export'. +These can be overridden for a specific table by setting the +TABLE_EXPORT_FORMAT property. See the manual section on orgtbl +radio tables for the different export transformations and +available parameters. :group 'org-table-import-export :type 'string) @@ -290,8 +291,7 @@ export transformations and available parameters. (defconst org-table-calculate-mark-regexp ^[ \t]*| *[!$^_#*] *\\(|\\|$\\) Detects a table line marked for automatic recalculation.) (defconst org-table-border-regexp ^[ \t]*[^| \t] - Searching from within a table (any type) this finds the first line -outside the table.) + Searching from within a table (any type) this finds the first line outside the table.) (defvar org-table-last-highlighted-reference nil) (defvar
[Orgmode] [PATCH] Correct some docstrings
This patch makes some straightforward corrections to a number of
docstrings. Each change is normally to:
- correct a typo, or
- fix up hyperlinks to function or variable names, or
- ensure slightly better conformance with the documentation guidelines
and tips given in the Elisp manual
No attempt is made to provide missing docstrings or document arguments.
Cheers,
Phil
--
lisp/org-agenda.el | 71 +--
lisp/org-ascii.el |5 ++-
lisp/org-bbdb.el |2 +-
lisp/org-beamer.el | 21 +++-
lisp/org-capture.el| 33 ++--
lisp/org-clock.el | 32 +++
lisp/org-colview-xemacs.el | 23 +++---
lisp/org-colview.el| 17 +-
lisp/org-compat.el |6 ++--
lisp/org-crypt.el | 18 ++-
lisp/org-ctags.el | 56 ++
11 files changed, 148 insertions(+), 136 deletions(-)
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 191ee52..1134558 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -142,8 +142,8 @@ specifies the maximum number of lines that will be added
for each entry
that is listed in the agenda view.
Note that this variable is not used during display, only when exporting
-the agenda. For agenda display, see org-agenda-entry-text-mode and the
-variable `org-agenda-entry-text-maxlines'.
+the agenda. For agenda display, see the variables `org-agenda-entry-text-mode'
+and `org-agenda-entry-text-maxlines'.
:group 'org-agenda
:type 'integer)
@@ -595,7 +595,7 @@ to make his option also apply to the tags-todo list.
There are different motivations for using different values, please think
carefully when configuring this variable.
-This applie when creating the global todo list.
+This applies when creating the global todo list.
Valid values are:
nearDon't show near deadline entries. A deadline is near when it is
@@ -762,7 +762,7 @@ Needs to be set before org.el is loaded.
:type 'boolean)
(defcustom org-agenda-start-with-follow-mode nil
- The initial value of follow-mode in a newly created agenda window.
+ The initial value of follow mode in a newly created agenda window.
:group 'org-agenda-startup
:type 'boolean)
@@ -1008,7 +1008,7 @@ When this is non-nil, the string will be split on
whitespace, and each
snippet will be searched individually, and all must match in order to
select an entry. A snippet is then a single string of non-white
characters, or a string in double quotes, or a regexp in {} braces.
-If a snippet is preceeded by \-\, the snippet must *not* match.
+If a snippet is preceded by \-\, the snippet must *not* match.
\+\ is syntactic sugar for positive selection. Each snippet may
be found as a full word or a partial word, but see the variable
`org-agenda-search-view-force-full-words'.
@@ -1018,7 +1018,7 @@ with each space character matching any amount of
whitespace, including
line breaks.
Even when this is nil, you can still switch to Boolean search dynamically
-by preceeding the first snippet with \+\ or \-\. If the first snippet
+by preceding the first snippet with \+\ or \-\. If the first snippet
is a regexp marked with braces like \{abc}\, this will also switch to
boolean search.
:group 'org-agenda-search-view
@@ -1029,8 +1029,7 @@ boolean search.
'org-agenda-search-view-always-boolean))
(defcustom org-agenda-search-view-force-full-words nil
- Non-nil me
-ans, search words must be matches as complete words.
+ Non-nil means, search words must be matches as complete words.
When nil, they may also match part of a word.
:group 'org-agenda-search-view
:type 'boolean)
@@ -1286,7 +1285,7 @@ range, respectively.
(function
(defcustom org-agenda-scheduled-leaders '(Scheduled: Sched.%2dx: )
- Text preceeding scheduled items in the agenda view.
+ Text preceding scheduled items in the agenda view.
This is a list with two strings. The first applies when the item is
scheduled on the current day. The second applies when it has been scheduled
previously, it may contain a %d indicating that this is the nth time that
@@ -1299,7 +1298,7 @@ that passed since this item was scheduled first.
(string :tag Scheduled previously)))
(defcustom org-agenda-inactive-leader [
- Text preceeding item pulled into the agenda by inactive time stamps.
+ Text preceding item pulled into the agenda by inactive time stamps.
These entries are added to the agenda when pressing \[\.
:group 'org-agenda-line-format
:type '(list
@@ -1307,7 +1306,7 @@ These entries are added to the agenda when pressing
\[\.
(string :tag Scheduled previously)))
(defcustom org-agenda-deadline-leaders '(Deadline: In %3d d.: )
- Text preceeding deadline items in the agenda view.
+ Text preceding deadline items in the agenda view.
This is a list with two strings. The
[Orgmode] [PATCH] Correct some docstrings [part 2]
This is a second patch in a series that makes some straightforward corrections to a number of docstrings. Each change is normally to: - correct a typo, or - fix up hyperlinks to function or variable names, or - ensure slightly better conformance with the documentation guidelines and tips given in the Elisp manual No attempt is made to provide missing docstrings or document arguments. Cheers, Phil -- lisp/org-docbook.el|8 +++--- lisp/org-docview.el| 11 ++-- lisp/org-entities.el |8 -- lisp/org-exp-blocks.el | 58 lisp/org-exp.el| 29 ++-- lisp/org-feed.el |4 +- lisp/org-freemind.el | 14 +- lisp/org-habit.el |3 ++ lisp/org-html.el | 56 + 9 files changed, 106 insertions(+), 85 deletions(-) diff --git a/lisp/org-docbook.el b/lisp/org-docbook.el index bbd0bed..c136d20 100644 --- a/lisp/org-docbook.el +++ b/lisp/org-docbook.el @@ -26,7 +26,7 @@ ;; You should have received a copy of the GNU General Public License ;; along with GNU Emacs. If not, see http://www.gnu.org/licenses/. -;; Commentary: +;;; Commentary: ;; ;; This library implements a DocBook exporter for org-mode. The basic ;; idea and design is very similar to what `org-export-as-html' has. @@ -142,8 +142,8 @@ people work on the same document. :type 'string) (defcustom org-export-docbook-footnote-id-prefix fn- - The prefix of footnote IDs used during exporting. Like -`org-export-docbook-section-id-prefix', this variable can help + The prefix of footnote IDs used during exporting. +Like `org-export-docbook-section-id-prefix', this variable can help avoid same set of footnote IDs being used multiple times. :group 'org-export-docbook :type 'string) @@ -155,7 +155,7 @@ avoid same set of footnote IDs being used multiple times. (= code /code) (~ literal /literal) (+ emphasis role=\strikethrough\ /emphasis)) - Alist of DocBook expressions to convert emphasis fontifiers. + A list of DocBook expressions to convert emphasis fontifiers. Each element of the list is a list of three elements. The first element is the character used as a marker for fontification. The second element is a formatting string to wrap fontified text with. diff --git a/lisp/org-docview.el b/lisp/org-docview.el index 5db6594..b3a5178 100644 --- a/lisp/org-docview.el +++ b/lisp/org-docview.el @@ -62,7 +62,7 @@ ))) (defun org-docview-store-link () - Store a link to a docview buffer + Store a link to a docview buffer. (when (eq major-mode 'doc-view-mode) ;; This buffer is in doc-view-mode (let* ((path buffer-file-name) @@ -75,11 +75,16 @@ :description path (defun org-docview-complete-link () - Use the existing file name completion for file: links to get the file name, - then ask the user for the page number and append it. + Use the existing file name completion for file. +Links to get the file name, then ask the user for the page number +and append it. (concat (replace-regexp-in-string ^file: docview: (org-file-complete-link)) :: (read-from-minibuffer Page: 1))) (provide 'org-docview) + +(provide 'org-docview) + +;;; org-docview.el ends here diff --git a/lisp/org-entities.el b/lisp/org-entities.el index 59734dc..501eb1c 100644 --- a/lisp/org-entities.el +++ b/lisp/org-entities.el @@ -26,6 +26,8 @@ ;; ;;; Commentary: +;;; Code: + (require 'org-macs) (declare-function org-table-align org-table ()) @@ -459,7 +461,7 @@ loaded, add these packages to `org-export-latex-packages-alist'. (Diamond \\diamond t diamond; [diamond] [diamond] ⋄) (loz \\diamond t loz; [lozenge] [lozenge] ◊) ) - Default entities used in Org-mode to preduce special characters. + Default entities used in Org-mode to produce special characters. For details see `org-entities-user'.) (defsubst org-entity-get (name) @@ -521,7 +523,7 @@ Kind can be any of `latex', `html', `ascii', `latin1', or `utf8'. (org-table-align))) (defun org-entities-help () - Create a Help buffer with all available entities + Create a Help buffer with all available entities. (interactive) (with-output-to-temp-buffer *Org Entity Help* (princ Org-mode entities\n=\n\n) @@ -555,7 +557,7 @@ Kind can be any of `latex', `html', `ascii', `latin1', or `utf8'. (defun replace-amp () - Postprocess HTML file to unescape the ampersant. + Postprocess HTML file to unescape the ampersand. (interactive) (while (re-search-forward tdamp;\\([^;]+;\\) nil t) (replace-match (concat td (match-string 1)) t t))) diff --git a/lisp/org-exp-blocks.el b/lisp/org-exp-blocks.el index 4bf5db6..bbe245c 100644 --- a/lisp/org-exp-blocks.el +++ b/lisp/org-exp-blocks.el @@ -68,6 +68,8 @@ ;; `org-export-blocks-add-block' to add your block type to ;; `org-export-blocks'. +;;; Code: +
Re: [Orgmode] Call for documentation of contributed packages
On Tue, Feb 10, 2009 at 08:55:09AM +0100, Carsten Dominik wrote: To start up this process, I am looking for a volunteer, with the following task: Go through the file commentaries of stuff in Org's contrib directory and extract information from the file commentaries to create a page for each of these packages. Making a start in this way would be great, and package authors and users could then improve on this with time. Anyone??? Hi Carsten, (Apologies for not finishing this before when you asked me...) I am back around for a bit and can volunteer if you would like. Regards, Phil -- Blessed are they who can laugh at themselves for they shall never cease to be amused. - Unknown ___ Emacs-orgmode mailing list Remember: use `Reply All' to send replies to the list. Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode
Re: [Orgmode] Strange bug, request for more info
Carsten Dominik [EMAIL PROTECTED] writes: John Wiegley is being haunted by a strange bug and I have so far not been able to reproduce and fix it. So I would like to know if anyone else sees the same bug and can contribute observations that may help us to track this down. I believe I had a similar report quite a while ago, but don't remember who reported it. The bug happens when being in the agenda and trying to goto or show the origin location of an agenda entry by pressing SPC or RET. John reports that sometimes (for him several times a day), the other window shows a completely different location. The most weird part of it is that going back to the agenda buffer and then trying the exact same command again, everything works fine! This is driving me crazy, and I'd love to find and fix this problem. Yes, I have this problem on a pretty regular basis. I haven't bothered too much about it (sorry...) as I find that toggling follow mode in the agenda tends to put things back in sync. If no-one beats me to it I will try and see if I can localise it any more. Phil ___ Emacs-orgmode mailing list Remember: use `Reply All' to send replies to the list. Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode
Re: [Orgmode] POLL: Volume of emacs-orgmode too high?
Carsten Dominik [EMAIL PROTECTED] writes: I am worried that this will scare away some members. Do we need to address this, or will people stick around and just wait until things cool off a bit? Doesn't worry me at all. I know I haven't posted anything for a long while but I am still happy watching the development of this great mode and love the energy that seems to be surrounding it at the moment. (It has certainly come a long way from v3.? or whatever might have been the first version I sent bug reports on...) Phil ___ Emacs-orgmode mailing list Remember: use `Reply All' to send replies to the list. Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode
Re: [Emacs-orgmode] Regressions in 4.42?
Christian Egli [EMAIL PROTECTED] writes: 1. org-agenda-redo marks all org buffers as modified: org-save-all-org-buffers works great but seems to expose a bug. When I hit 'r' (in the agenda buffer) to redo my agenda, all my org buffers seem to become modified and hence org-save-all-org-buffers always has to save all the buffers as the seem dirty. Reproduce by repeatedly typing 'r' and 's' in the org agenda buffer. As another data point I'm having a similar problem. This is since updating to a version of CVS GNU/Emacs last weekend. M-x org-version is showing 4.41. My observation is the problem is somewhat broader, as soon as I have run something like C-a a then all my agenda buffers are marked modified. Phil ___ Emacs-orgmode mailing list Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode
[Emacs-orgmode] remember problem in 4.33?
Carsten, I was going to report a GC/lock-up issue in 4.32 which happened when saving a template based remember item. That is, at the end of: M-x remember [edit a level 1 item] C-c C-c retret ...but you all are far too quick for me! I've just upgraded to 4.33. I do not seem to get the GC loop but now the temporary remember buffer is not killed. Run under debug-on-error I get: Debugger entered--Lisp error: (error Kill ring is empty) signal(error (Kill ring is empty)) error(Kill ring is empty) current-kill(0) (eq org-subtree-clip (current-kill 0)) (and (eq org-subtree-clip (current-kill 0)) org-subtree-clip-folded) (if (and (eq org-subtree-clip ...) org-subtree-clip-folded) (hide-subtree)) [snip some very long lines] org-remember-handler() run-hook-with-args-until-success(org-remember-handler) remember-region(1 52) remember-buffer() funcall(remember-buffer) [snip] org-ctrl-c-ctrl-c(nil) call-interactively(org-ctrl-c-ctrl-c) Phil ___ Emacs-orgmode mailing list Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode
[Emacs-orgmode] Some minor doc fixes (against 4.27)
*** _darcs/current/org.el 2006-05-10 10:35:32.0 +0100 --- ./org.el2006-05-10 11:38:39.0 +0100 *** *** 3669,3675 (defun org-renumber-ordered-list (arg) Renumber an ordered plain list. ! Cursor next to be in the first line of an item, the line that starts with something like \1.\ or \2)\. (interactive p) (unless (and (org-at-item-p) --- 3669,3675 (defun org-renumber-ordered-list (arg) Renumber an ordered plain list. ! Cursor needs to be in the first line of an item, the line that starts with something like \1.\ or \2)\. (interactive p) (unless (and (org-at-item-p) *** *** 5452,5458 (if (memq org-agenda-type types) t (if error ! (error Now allowed in %s-type agenda buffers org-agenda-type) nil))) (defun org-agenda-quit () --- 5452,5458 (if (memq org-agenda-type types) t (if error ! (error Not allowed in %s-type agenda buffers org-agenda-type) nil))) (defun org-agenda-quit () *** *** 6745,6753 (beginning-of-line 1))) (defun org-get-tags-at (optional pos) ! Get a list of all headline targs applicable at POS. POS defaults to point. If tags are inherited, the list contains ! the targets in the same sequence as the headlines appear, i.e. the tags of the current headline come last. (interactive) (let (tags) --- 6745,6753 (beginning-of-line 1))) (defun org-get-tags-at (optional pos) ! Get a list of all headline tags applicable at POS. POS defaults to point. If tags are inherited, the list contains ! the tags in the same sequence as the headlines appear, i.e. the tags of the current headline come last. (interactive) (let (tags) *** *** 8470,8476 ;;;###autoload (defun org-remember-apply-template () ! Initialize *remember* buffer with template, invode `org-mode'. This function should be placed into `remember-mode-hook' and in fact requires to be run from that hook to fucntion properly. (when org-remember-templates --- 8470,8476 ;;;###autoload (defun org-remember-apply-template () ! Initialize *remember* buffer with template, invoke `org-mode'. This function should be placed into `remember-mode-hook' and in fact requires to be run from that hook to fucntion properly. (when org-remember-templates *** *** 9354,9360 Please position cursor in a data line for column operations) (defun org-table-delete-column () ! Delete a column into the table. (interactive) (if (not (org-at-table-p)) (error Not at a table)) --- 9354,9360 Please position cursor in a data line for column operations) (defun org-table-delete-column () ! Delete a column from the table. (interactive) (if (not (org-at-table-p)) (error Not at a table)) *** *** 10078,10084 \n))) (defun org-table-get-stored-formulas () ! Return an alist with the t=stored formulas directly after current table. (interactive) (let (scol eq eq-alist strings string seen) (save-excursion --- 10078,10084 \n))) (defun org-table-get-stored-formulas () ! Return an alist with the stored formulas directly after current table. (interactive) (let (scol eq eq-alist strings string seen) (save-excursion ___ Emacs-orgmode mailing list Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode
Re: [Emacs-orgmode] MS Outlook fails to import iCal export file
Carsten Dominik [EMAIL PROTECTED] writes: Of course, I can simply say VERSION: 1.0. No, I wouldn't do that. Some more investigation shows that including a METHOD: line in the Org-mode export file (and leaving the VERSION at 2.0) also allows the import to succeed. This, together with some Googling on issues importing to Outlook 2000, seems to indicate that this workflow is unlikely to ever work - or, at the very least, it will be rather fragile. There are too many problems with the (fully patched) Outlook 2000 client I am using. Sorry to trouble you. Regards, Phil ___ Emacs-orgmode mailing list Emacs-orgmode@gnu.org http://lists.gnu.org/mailman/listinfo/emacs-orgmode
