Commit Graph

1493 Commits

Author SHA1 Message Date
Achim Gratz 6c9a6ae8d1 Merge branch 'maint' 2012-08-26 20:02:59 +02:00
Achim Gratz ac0667b841 Makefile: add description of ORG_ADD_CONTRIB to info documentation
* doc/org.texi: Add description of ORG_ADD_CONTRIB to info
  documentation.  Add link to Worg for more details.
2012-08-26 20:01:24 +02:00
Achim Gratz 57c4a4aa07 Merge branch 'maint' 2012-08-26 19:06:39 +02:00
Achim Gratz c32d456f72 Makefile: Improve documentation.
* doc/org.texi: Clarify installation procedure.  Provide link to the
  build system description on Worg.
2012-08-26 17:50:10 +02:00
Achim Gratz db0e306658 Merge branch 'maint' 2012-08-26 15:28:47 +02:00
Achim Gratz bf352eceda Rename utils/ to mk/, move some files to mk/ and make the requisite changes throughout
* Makefile: Include default.mk and targets.mk from mk/ where they've
  been moved to.

* README_maintainer: Rename utils to make throughout.

* doc/Makefile: Rename utils to make throughout.

* doc/org.texi: Remove reference to utils/, x11idle.c is now in
  contrib/scripts.

* mk/make_emacs_changelog: Add mk/ to list of directories not to be
  reported in Emacs' ChangeLog.  Also retain utils/ and re-add
  UTILITIES; add a comment explaining why these need to stay.

* mk/default.mk: Rename utils to make throughout.  Include version.mk
  from mk/ where it's been moved to.

* mk/targets.mk: Rename utils to make throughout.

* mk/server.mk: Rename utils to make throughout.  Only put those files
  from mk/ into the archives that are needed outside the server:
  default.mk targets.mk version.mk and org-fixup.el.

* lisp/org-compat.el: Rename utils to make throughout.

* .gitignore:  Rename utils to make throughout.
2012-08-26 15:27:19 +02:00
Yann Hodique e48d77aa98 org-taskjuggler.el: Update doc to reflect latest changes 2012-08-26 09:54:57 +02:00
Achim Gratz 4ca67b8164 Merge branch 'maint' 2012-08-26 09:28:08 +02:00
Achim Gratz f8cc3189f5 Makefile: deactivate perl scripts unless server configuration is active
* doc/Makefile: Do not use perl scripts in util/ unless the server
  configuration $(SERVERMK) is set.
2012-08-26 09:25:34 +02:00
Bastien Guerry d09a6b3db5 Merge branch 'maint' 2012-08-25 10:29:09 +02:00
Bastien Guerry eaa1dee2d0 Fix version in README_DIST and doc/orgcard.tex 2012-08-25 10:28:59 +02:00
Michael Brand efab563317 org.texi: Mention when a table header is mandatory
* org.texi (Column formulas): Add a sentence to be more explicit about
when a table header is mandatory.
2012-08-24 19:53:04 +02:00
Bastien Guerry 10dbdf5fc2 Update the handling of agenda/capture keys contextualization.
* org.el (org-contextualize-keys): Rename from
`org-contextualize-agenda-or-capture'.  Fix normalization to
handle empty key replacement string.
(org-contextualize-validate-key): Rename from
`org-contexts-validate'.  Allow checking against a custom
function.

* org-agenda.el (org-agenda-custom-commands-contexts): Update.
(org-agenda): Use `org-contextualize-keys'.

* org-capture.el (org-capture-templates-contexts): Ditto.

* org.texi (Templates in contexts, Setting Options): Update to
reflect changes in how contexts options are processed.
2012-08-24 12:18:05 +02:00
Bastien Guerry 6c94ea0518 Implement key replacement depending on the contexts.
* org.el (org-contextualize-agenda-or-capture): Handle key
replacement depending on the contexts.

* org-capture.el (org-capture-templates-contexts): Allow to
use the context as a way to replace one capture template by
another one.

* org-agenda.el (org-agenda-custom-commands-contexts): Allow
to use the context as a way to replace one agenda custom
command by another one.

* org.texi (Templates in contexts): Document the new structure
of the variables `org-agenda-custom-commands-contexts' and
`org-capture-templates-contexts'.

In the setup below, X is not a real capture template, it is just
an alias to templates A and B in .txt and .el files.  A and B are
deactivated by default in all files.

(setq org-capture-templates
      '(("X" "Nothing but an alias")
	("A" "AAAA" entry (file+headline [...]))
	("B" "BBBB" entry (file+headline [...]))))

(setq org-capture-templates-contexts
      '(("A" "A" ((not-in-file . ".*")))
	("B" "B" ((not-in-file . ".*")))
	("X" "A" ((in-file . "\\.txt")))
	("X" "B" ((in-file . "\\.el")))))

Thanks to Carsten for suggesting this "key-replacement" idea!
2012-08-24 12:17:58 +02:00
Bastien Guerry 0c8e87b8d2 Rename UTILITIES/ to utils/ 2012-08-23 12:47:10 +02:00
Bastien Guerry d378c7b41b Implement context filtering for agenda commands and capture templates.
* org.el (org-contextualize-agenda-or-capture)
(org-rule-validate): New functions, implement context
filtering for agenda commands and capture templates.

* org-agenda.el (org-agenda-custom-commands-contexts): New
option.
(org-agenda): Use it.

* org-capture.el (org-capture-templates-contexts): New option.
(org-capture-select-template): Use it.

* org.texi (Templates in contexts): Document the new option
`org-capture-templates-contexts'.
(Storing searches): Document the new option
`org-agenda-custom-commands-contexts'.

This idea comes from Sylvain Rousseau, who implemented a similar
feature with org-context.el: https://github.com/thisirs/org-context

This implementation is a bit simpler and more general.  Simpler
because it relies on existing templates, no need to define other
contextual ones.  More general because contexts can be defined
wrt files and modes.

Thanks *very much* to Sylvain for paving the way -- certainly a
great addition to Org.
2012-08-23 11:08:47 +02:00
Charles b0dc7ec164 org.texi (Advanced features): Fix error in table
* org.texi (Advanced features): Fix error in table.

TINYCHANGE
2012-08-22 00:12:21 +02:00
Bastien Guerry cd5fa2396c org.texi (Formula syntax for Lisp): Reformat
* org.texi (Formula syntax for Lisp): Reformat.
2012-08-21 18:28:35 +02:00
Nicolas Goaziou 9b4f5a2fc2 org.texi: Fix reference to an unknown variable
* doc/org.texi (Literal examples): Remove reference to unknown
  `org-export-latex-minted' variable. Also simplify footnote since
  `org-export-latex-listings' documentation is exhaustive already.
2012-08-20 16:53:21 +02:00
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
Achim Gratz 0db8233460 replace the remaining occurences of sed with emacs scripts, implement mkdir with install
* UTILITIES/org-fixup.el (org-make-local-mk): New function to create a
  local.mk template from default.mk.

* UTILITIES/org-fixup.el (org-make-letterformat): New function to
  replace the format string for A4 with one for Letter.

* default.mk: Few cosmetic changes to the template section.  Add
  definition MAKE_LOCAL_MK for call to org-make-local-mk.  Remove
  definition for SED, which is not used anymore.  Implement MKDIR with
  'install -d' by default.  Since both CP and MKDIR are now
  implemented with install, this reduces the number of external
  dependencies.  Add mode settings to both invocations of install to
  keep the modes of installed files sane even if umask is set to a
  strange value.

* targets.mk: Remove sed script and use $(MAKE_LOCAL_MK) instead.

* doc/Makefile: Remove sed script and replace with emacs script.  This
  script can not be placed into a variable since it would expand $<
  and $@ in the context of the "card" target rather than the pattern
  rule.
2012-05-30 12:30:21 +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
Bastien Guerry 747d71675c Merge branch 'maint'
Conflicts:
	doc/org.texi
	doc/orgguide.texi
	lisp/org.el
2012-05-25 09:42:02 +02:00
Bastien Guerry 60587ea91c Bump to version 7.8.11. 2012-05-25 09:36:15 +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
Achim Gratz a0a344bff1 inject version strings into orgguide
* doc/orgguide.texi: Include version strings from "org-version.inc".

* doc/Makefile: Make "org-version.inc" a dependency of "guide".
2012-05-18 07:45:46 +02:00
Achim Gratz b4693de937 clean up server targets in doc/Makefile and make sure they are working
* doc/Makefile: ignore errors from removing directory (may not exist),
  manual depends on 'org-version.inc'.
2012-05-18 07:45:46 +02:00
Achim Gratz bcced6a51d Makefile: avoid spurious recompilations of documentation
* doc/Makefile: org-version.inc is again dependent on org.texi.  This
  avoids recompilation when nothing has been changed; target "clean"
  still removes orgversion.texi to produce a consistent set of
  documentation and code after a "make clean" on toplevel

* targets.mk: add "doc" as prerequisite to "all" and "compile" to have
  it call "clean" in the doc subdir.
2012-05-18 07:45:45 +02:00