Commit Graph

1371 Commits

Author SHA1 Message Date
Nicolas Goaziou 445a90ceeb Update documentation with regards to lists
* doc/org.texi (Plain lists): Remove reference to now hard-coded
  `bullet' automatic rule.
2012-08-18 10:00:58 +02:00
François Allisson 97685b6b60 org.texi: Fix typo
* doc/org.texi: Remove extra curly bracket.

TINYCHANGE
2012-08-05 16:29:20 +02:00
Bastien Guerry de271e3751 Introduce a new special property CLOCKSUM_T for today's clocked time.
* org.el (org-special-properties): New special property
CLOCKSUM_T.
(org-entry-properties): Handle the new special property.

* org-colview.el (org-columns): Handle a new special property
CLOCKSUM_T.
(org-agenda-colview-summarize, org-agenda-colview-compute):
Ditto.

* org-clock.el (org-clock-sum-today): New function.
(org-clock-sum): New argument PROPNAME to set a custom text
property instead of :org-clock-minutes.

* org.texi (Special properties, Column attributes)
(Agenda column view): Document the new special property
CLOCKSUM_T.

Thanks to Brian Wood who asked a question wrt this.
2012-08-05 11:12:04 +02:00
Bastien Guerry 21ec0159b8 org-capture.el: New template %l to insert the literal link.
* org-capture.el (org-capture-templates): New template %l to
insert the literal link pointing at the current buffer.

* org.texi (Template expansion): Document the new %l template.

Thanks to Eric Abrahamsen for this idea.
2012-08-02 17:06:22 +02:00
Bastien Guerry aa490ffa04 Small doc fix.
* org.texi (Fast access to TODO states): Fix documentation
about allowed characters for fast todo selection.

* org.el (org-todo-keywords): Ditto.

This fixes this wrong change here:
http://orgmode.org/w/?p=org-mode.git;a=commit;h=b6cb72
2012-08-02 11:59:27 +02:00
Bastien Guerry a865abb5fe Let's a :APPT_WARNTIME: property override `appt-message-warning-time' in `org-agenda-to-appt'.
* org.el (org-speed-commands-default): New speedy command to
quickly add the :APPT_WARNTIME: property.

* org-agenda.el (org-agenda-to-appt): Use the :APPT_WARNTIME:
property to override `appt-message-warning-time' when adding
an appointment from an entry.

* org.texi (Weekly/daily agenda): Mention APPT_WARNTIME and
its use in `org-agenda-to-appt'.

This feature has been suggested, along with preliminary patches,
by Ivan Kanis.  Thanks!
2012-08-01 16:05:47 +02:00
Bastien Guerry 79ac009b58 Update the manual wrt comments.
* org.texi (Comment lines): Update wrt comments.

* orgguide.texi (Comment lines): Update wrt comments.
2012-08-01 14:35:13 +02:00
Bastien Guerry ba10c6a27e org.texi: Small documentation fix. 2012-07-30 09:35:37 +02:00
Bastien Guerry f250f6beba New keybinding `C-c C-x C-z' for `org-resolve-clocks'.
* org.el (org-mode-map): Bind `org-resolve-clocks' to `C-c C-x C-z'.

* org.texi (Resolving idle time): Document new keybinding.

Thanks to Joseph Thomas for suggesting this.
2012-07-28 01:23:37 +02:00
Bastien Guerry b86a6f6f34 S-M-<up/down> now adjusts previous/next clock when hit on clock timestamps.
* org.el (org-clock-history, org-clock-adjust-closest): New
variables.
(org-timestamp-change): Maybe adjust the next or previous
clock in `org-clock-history'.
(org-shiftmetaup, org-shiftmetadown): On clock logs, update
the timestamp at point and adjust the next or previous clock
in `org-clock-history', when possible.

* org.texi (Clocking commands): Document the use of
S-M-<up/down> on clock timestamps.

Thanks to Joseph Thomas who suggested this.
2012-07-27 17:29:29 +02:00
Giovanni Ridolfi 12a53c7161 org.texi: Update the key sequence for `org-clock-in-last' and `org-clock-cancel'.
* doc/org.texi (org-clock-in-last and org-clock-cancel): Update the
  defkeys.

TINYCHANGE

After commit fea1b82bef the manual has not been updated, let's do it now.
2012-07-24 17:05:16 +02:00
Bastien Guerry b6cb722377 Explicitely says only letters are supported as fast TODO selection keys.
* org.texi (Fast access to TODO states): Explicitely says only
letters are supported as fast TODO selection keys.

* org.el (org-todo-keywords): Ditto.

Thanks to Samuel Wales for pointing at this.
2012-07-14 09:15:50 +02:00
Bastien Guerry ef3d4b5965 org.el: Allow %(my-function) as a specifier in abbreviated links.
* org.el (org-link-expand-abbrev): Implement "%(my-function)"
as a new specifier.  Update the docstring.

* org.texi (Link abbreviations): Illustrate the use of the
"%h" specifier.  Document the new "%(my-function)" specifier.

Thanks to Takaaki ISHIKAWA who came all the way down from Tokyo
to Paris and raised a not-so-distant issue: "could we translate
emails from the mailing list and have a URI for each translated
email?"  See the update in the manual for an answer.
2012-07-13 18:22:45 +02:00
Bastien Guerry 3528fc6b42 Implement continuous clocking. Small other improvements. Update documentation.
* org.el (org-mode-map): Add `C-c C-x C-I' as a keybinding for
`org-clock-in-last'.

* org-clock.el (org-clock-continuously): New option.
(org-clock-in): Three universal prefix arguments set
`org-clock-continuously' to `t' temporarily.
(org-clock-in-last): Fix call to `org-clock-select-task' and
support continuous clocking.
(org-clock-out-time): New variable.
(org-clock-out): set `org-clock-out-time' when clocking out.
Small docstring rewriting.
(org-clock-remove-empty-clock-drawer): Fix "invalid search
bound" bug when trying to delete empty logbook drawer.
(org-clock-cancel): If the clock log is gone, send a warning
instead of deleting the region that is supposed to contain it.

* org.texi (Clocking commands): New cindex.
(Clocking commands): Update documentation for `org-clock-in'.
Document `org-clock-in-last'.  Mention `org-clock-out' and
`org-clock-in-last' as commands that can be globally bound.
(Resolving idle time): Document continuous clocking.
2012-07-12 14:04:54 +02:00
Bastien Guerry 7445ee7d04 org.texi: Small update.
* org.texi (Top, Introduction): Fix formatting.
(Activation): Add index entries.
(Conventions): Update section.
(Embedded @LaTeX{}): Fix formatting.

Mention that `C-c a' is assumed to be the keybinding for `org-capture'
in the whole manual.  Thanks to Vagn Johansen who triggered this.
2012-07-12 09:11:10 +02:00
Thomas S. Dye 69aa5ab26f Manual does not list :results output graphics as babel header arg
Aloha all,

The attached patch changes the link to the languages supported by babel
from a directory listing to the Worg page that uses a table to link to
the language-specific documentation pages.  It was suggested by John
Hendy.

All the best,
Tom
John Hendy <jw.hendy@gmail.com> writes:

> On Tue, Jul 10, 2012 at 10:19 AM, Thomas S. Dye <tsd@tsdye.com> wrote:
>> John Hendy <jw.hendy@gmail.com> writes:
>>
>>> On Mon, Jul 9, 2012 at 7:35 PM, Thomas S. Dye <tsd@tsdye.com> wrote:
>>>> John Hendy <jw.hendy@gmail.com> writes:
>>>>
>>>>> I have typically outputted graphics from R via tikzDevice manually,
>>>>> but gave my first whirl to just including things via the :file
>>>>> argument in my block header. In the process, I was trying to get this
>>>>> to work and found I needed to use:
>>>>>
>>>>> -----
>>>>> :results output graphics
>>>>> -----
>>>>>
>>>>> This is listed on Worg ob-R-doc:
>>>>> - http://orgmode.org/worg/org-contrib/babel/languages/ob-doc-R.html#sec-4-3
>>>>>
>>>>> But I didn't originally know about it, as it's not a listed header
>>>>> argument in the manual, which is where I check since they're all
>>>>> listed in one place:
>>>>> - http://orgmode.org/manual/results.html#results
>>>>>
>>>>> Does the manual only list universal babel header arguments and R is in
>>>>> a subset of ones using =:results output graphics= or should it be
>>>>> there?
>>>>>
>>>>
>>>> Hi John,
>>>>
>>>> The babel header arguments are implemented at two levels.
>>>>
>>>> There are general babel arguments that apply to all the supported
>>>> languages.  These are described in the manual.
>>>>
>>>> It is also possible for the individual language implementations to
>>>> define their own header arguments.  R is a good example, where the very
>>>> many arguments to the various R output devices are built into ob-R.el.
>>>> These language specific header arguments are not described in the
>>>> manual, but instead appear in the language specific documentation on
>>>> Worg.
>>>>
>>>> Re: your specific question about :results output graphics.  I believe
>>>> this is an R specific header argument and that it is described in the
>>>> appropriate place in the documentation on Worg (see lines 68 and 230
>>>> of ob-R.el).
>>>>
>>>> The manual is not a one-stop source for answers to all Babel questions.
>>>> Recourse to the language specific documentation is typically necessary,
>>>> which is why it would be great if someone could find time to work up
>>>> documentation for the 20 or so languages that still lack it :)
>>>
>>> Thanks for the clarification and that answers the question. This was a
>>> specific header argument for R. Perhaps the manual could link to this
>>> page?
>>> - http://orgmode.org/worg/org-contrib/babel/languages.html
>>>
>>> Maybe with a diddy: "Some languages feature their own unique header
>>> arguments. The above document only universal, system wide Babel header
>>> arguments and one should consult the specific language page on Worg
>>> for additional features."
>>>
>>> Just a thought.
>>
>> Hi John,
>>
>> Thanks for this thought, which is indeed reasonable.  I thought the
>> manual might lack this structure, but when I went back to the
>> manual I found that
>> http://orgmode.org/manual/Specific-header-arguments.html#Specific-header-arguments
>> has this at the bottom of the page: "Additional header arguments are
>> defined on a language-specific basis, see Languages", where "Languages"
>> is a link to another manual page, one with a table of supported
>> languages and a link to the Worg page you cite.
>>
>
> Wow. You see only what you look for. :embarrassed:
>
>> The language is a bit different than your proposal, but the path seems
>> clear enough to me.
>
> Technically the path points to
> http://orgmode.org/worg/org-contrib/babel/languages/; I'd point it to
> http://orgmode.org/worg/org-contrib/babel/languages.html as it looks
> cleaner vs. just looking at the directory of .html files. Either
> way... the manual totally does it's job and I missed it!
>
> Thanks for bearing with me!
> John
>
>>
>> Of course, there is still the issue of the languages that lack
>> language-specific documentation :)
>>
>> All the best,
>> Tom
>>
>> --
>> T.S. Dye & Colleagues, Archaeologists
>> 735 Bishop St, Suite 315, Honolulu, HI 96813
>> Tel: 808-529-0866, Fax: 808-529-0884
>> http://www.tsdye.com

>From 0438f0ae1e23321dbacd0666119205985959433e Mon Sep 17 00:00:00 2001
From: Thomas Dye <tsd@tsdye.com>
Date: Tue, 10 Jul 2012 07:12:13 -1000
Subject: [PATCH] Changed babel languages link following a suggestion by John
 Hendy
2012-07-10 21:34:03 +02:00
Jan Böcker 436b5a0ee9 fix typo in org.texi
The attached patch fixes a typo in the documentation.
I hope I got the format of the commit message right.

Best regards,
   Jan

>From 7daa1f794794d515624ab28310db81a0e4099ea5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jan=20B=C3=B6cker?= <jan.boecker@jboecker.de>
Date: Sat, 16 Jun 2012 15:04:43 +0200
Subject: [PATCH] org.texi: fix typo

* doc/org.texi (The spreadsheet): fix typo
2012-07-06 10:35:58 +02:00
Bastien Guerry 6fb93276ea org.texi (Visibility cycling): Document `show-children'.
* org.texi (Visibility cycling): Document `show-children'.

Thanks to Gustav Wikström for a preliminary patch for this.
2012-07-06 10:27:33 +02:00
Achim Gratz 80d4f778c7 Re-normalize to "Org mode" in manual
* doc/org.texi: Re-normalize to "Org mode" in manual.
2012-06-04 08:41:01 +02:00
Achim Gratz 45b7bb4bdf Adapt documentation to new build system
* doc/org.texi (Installation): Adapt documentation to new build
system.  Mention GNU ELPA (since it needs to be handled like Emacs
built-in Org).
2012-06-04 08:41:01 +02:00
Bastien Guerry 9eabcb899b Revert "Fix small typo in org.texi."
This reverts commit 4144c55ec7.
2012-06-01 09:37:06 +02:00
Bastien Guerry 4144c55ec7 Fix small typo in org.texi. 2012-05-31 12:14:44 +02:00
Bastien Guerry f71d45a913 New option `org-capture-bookmark' (mentioned in the manual.)
* org.texi (Using capture): Mention the
`org-capture-last-stored' bookmark as a way to jump to the
last stored capture.

* org-capture.el (org-capture-bookmark): New option.
(org-capture-finalize): Use it.
2012-05-25 23:45:31 +02:00
Adam Spiers b57e23694f Fix typo in manual index's description of the 'Hooks' section
* doc/org.texi: Fix typo in description of the 'Hooks' section
2012-05-18 08:30:00 +02:00
Adam Spiers 677a94a961 Document ID special property.
* doc/org.texi: add ID to the list of special properties.
2012-05-18 08:29:57 +02:00
Bastien Guerry cb23085ac2 Merge branch 'maint' 2012-05-16 19:08:48 +02:00
Bastien Guerry e6560f2528 Backport change in org.texi by Glenn Morris.
See http://git.savannah.gnu.org/cgit/emacs.git/commit/?id=d38a0a
2012-05-16 19:08:29 +02:00
Bastien Guerry e70068feed org.texi (Uploading files): Fix typo.
* org.texi (Uploading files): Fix typo.

Thanks to François Pinard for spotting this.
2012-05-06 00:53:42 +02:00
Jason Dunsmore 6a38c1fac3 Fixed indentation in capture template doc. 2012-05-04 14:57:34 -05:00
Jason Dunsmore 67f9bbb7fa Clarified to capture template expansion doc. 2012-05-04 14:47:40 -05:00
Bastien Guerry 1c4ac932f3 Merge branch 'maint' 2012-05-01 18:43:41 +02:00
Bastien Guerry 9fa0b5e794 org.texi (Durations and time values): Fix typo.
* org.texi (Durations and time values): Fix typo.
2012-05-01 18:43:28 +02:00
Bastien Guerry d6e56bce71 org.texi: Document `C-0' as a prefix argument for `org-capture'.
* org.texi (Using capture): Document `C-0' as a prefix
argument for `org-capture'.

Thanks to Charles for this.
2012-04-29 10:58:36 +02:00
Brian van den Broek a178bc9d84 Small grammar tweaks in export sections of org.texi
* org.texi The sections in the Exporting section of the manual left
out articles in the description of the org-export-as-* commands, among
other places. This patch adds them, adds a few missing prepositions,
and switches instances of "an HTML" to "a html" for internal
consistency.

TINYCHANGE
2012-04-24 23:27:59 +02:00
Bastien Guerry 5add9cdef0 org-agenda.el: Implement `org-agenda-persistent-marks' for bulk actions.
* org-agenda.el (org-agenda-persistent-marks): New option to
keep marks after a bulk action.  The option defaults to nil.
(org-agenda-bulk-action): Use the new option.

* org.texi (Agenda commands): Document persistent marks.
2012-04-24 18:10:55 +02:00
Bastien Guerry 1666b910fe org-capture.el: Use %\n instead of %n.
* org-capture.el (org-capture-fill-template): Use %\n instead of %n as a
template element to be replaced with the nth prompted string.
(org-capture-templates): Update docstring.

* org.texi (Template expansion): Update doc to reflect change.

Using %n triggers errors when the template contains escaped strings,
which happens a lot with links.
2012-04-24 11:54:16 +02:00
Bastien Guerry e9d34dcd72 org.texi: Fix insertion of {} chars.
Thanks to Richard Stanton for spotting this.
2012-04-23 19:24:04 +02:00
Toby S. Cubitt b7982a0024 org-capture.el: Fixed bug in org-capture-templates %<n> expandos
* lisp/org-capture.el (org-capture-fill-template): Fixed regexp for
  %<n> expandos to match any positive integer.
  (org-capture-templates): Updated docstring accordingly.

* doc/org.texi: Updated documentation accordingly.
2012-04-23 17:34:15 +02:00
Bastien Guerry b1618e2d69 Fix missing } in org.texi. 2012-04-23 12:59:32 +02:00
Toby Cubitt e13d182ce8 Allow %<num> escapes to capture templates, expanded to text entered in <num>'th prompt
* org-capture.el (org-capture-fill-template): Expand %<num>
escape sequences into text entered for <num>'th %^{PROMPT} escape.
2012-04-23 12:48:40 +02:00
Bastien Guerry e9dec29bb1 org-table.el: Escape some special characters when sending radio tables.
* org-table.el (orgtbl-send-table): Escape special characters.
Introduce a new parameter :no-escape to prevent escaping.

* org.texi (Radio tables): Document the :no-escape parameter.

Thanks to Alexander Willand for raising this issue.
2012-04-23 00:09:35 +02:00
Andrew Hyatt 44e7ed1a59 Allow archiving to a datetree.
* org-archive.el (org-archive-subtree): Allow archiving to a
datetree.

* org.el (org-archive-location): Ditto.

* org.texi (Moving subtrees): Document the ability to archive
to a datetree.

TINYCHANGE
2012-04-21 17:37:48 +02:00
Ippei FURUHASHI 32bd764573 org.texi: Fix typos of function names in Agenda commands
* org.texi (Agenda commands): Fix two typos by giving corresponding
function names, according to `org-agenda-view-mode-dispatch'.

TINYCHANGE
2012-04-21 12:13:25 +02:00
Bastien Guerry 08bd0b8892 Merge branch 'local-Makefile' into test-makefile-merge 2012-04-21 10:02:28 +02:00
Brian van den Broek 8f3dc945b2 Change example timestamps to not occur in headlines.
* org.texi: Alter several examples of headings with timestamps
in them to include the timestamps in the body instead of the heading.

* orgguide.texi: Alter the same examples in the same way as for
org.texi.

The Org-mode manual explicitly discourages the inclusion of timestamps
in headlines, yet examples do just that. These changes make the manual
consistent with its own advice.

TINYCHANGE
2012-04-21 00:43:24 +02:00
Feng Shu a9d3ce0bcd Allow to use imagemagick for previewing LaTeX fragements.
* org.el (org-latex-create-formula-image-program): New option
to use either dvipng or imagemagick to convert and preview
LaTeX fragments.
(org-preview-latex-fragment, org-format-latex): Handle the new
option.
(org-create-formula-image-with-dvipng): Rename from
`org-create-formula-image'.
(org-create-formula-image-with-imagemagick): New defun to
handle LaTeX preview with imagemagick.
(org-latex-color, org-latex-color-format): New defuns to
handle color conversions.

* org-latex.el (org-latex-to-pdf-process, org-export-as-pdf):
Allow to use imagemagick to convert LaTeX fragments.

* org-html.el (org-export-html-preprocess): Ditto.

* org-exp.el (org-export-with-LaTeX-fragments): Ditto.

* org.texi (@LaTeX{} fragments): Document imagemagick as an
alternative to dvipng.
2012-04-21 00:42:59 +02:00
Bastien Guerry ec921a2a68 Support hourly repeat cookies.
* org.el (org-repeat-re)
(org-clone-subtree-with-time-shift, org-auto-repeat-maybe)
(org-deadline, org-schedule, org-matcher-time)
(org-time-stamp, org-read-date, org-read-date-get-relative)
(org-display-custom-time, org-get-wdays)
(org-time-string-to-absolute, org-closest-date)
(org-timestamp-change): Allow to set hourly repeat cookie.
Send an error when an hourly repeat cookie is set and no hour
is specified in the timestamp.

* org.texi (Repeated tasks): Document repeat cookies for
years, months, weeks, days and hours.

* org-agenda.el (org-agenda-get-timestamps): Match hourly
repeat cookies.

* org-icalendar.el (org-print-icalendar-entries): Handle
hourly repeat cookies.

Thanks a lot to Takafumi Arakaki for this idea and for a preliminary
version of this patch.
2012-04-21 00:42:56 +02:00
Achim Gratz e102e411e4 doc/Makefile: rename/add auto-generated files to be compatible with Emacs
* doc/Makefile: rename auto-generated file "git-describe.texi" to
  "org-version.inc" to allow for easier inclusion into Emacs.

* doc/org.texi: include "org-version.inc" instead of
  "git-describe.texi".

* lisp/Makefile: new auto-generated file org-version.el with autoload
  cookies.  The version strings will be pulled during autoload
  extraction into org-install.el (standalone org-mode) or
  ../loaddefs.el (Emacs).
2012-04-20 21:04:14 +02:00
Achim Gratz 306c748f63 inject git-describe version and date into org manual
* doc/Makefile: introduce target for git-describe.texi, which is an
	  automatically generated file that records the output of git-describe
	  and date; remove this file during make clean
	* doc/org.texi: remove @set for VERSION and DATE and do an @include
	  git-describe.texi instead
2012-04-20 21:04:09 +02:00
Bastien Guerry d1f1c586d5 Fix merge conflict. 2012-04-20 11:43:27 +02:00