From mboxrd@z Thu Jan 1 00:00:00 1970 From: Rafael Laboissiere Subject: [PATCH] Improve documentation + fix typos Date: Tue, 11 Oct 2011 05:07:08 +0000 Message-ID: <20111011050708.GB16403@laboissiere.net> Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="tThc/1wpZn/ma/RB" Content-Transfer-Encoding: 8bit Return-path: Received: from eggs.gnu.org ([140.186.70.92]:38452) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RDVGs-0006Nm-Dl for emacs-orgmode@gnu.org; Tue, 11 Oct 2011 01:52:59 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1RDVGq-0000xL-VI for emacs-orgmode@gnu.org; Tue, 11 Oct 2011 01:52:58 -0400 Received: from xvm-168-252.ghst.net ([95.142.168.252]:49556 helo=laboissiere.net) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1RDVGq-0000wL-LZ for emacs-orgmode@gnu.org; Tue, 11 Oct 2011 01:52:56 -0400 Content-Disposition: inline List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: emacs-orgmode@gnu.org --tThc/1wpZn/ma/RB Content-Type: text/plain; charset=iso-8859-1 Content-Disposition: inline Content-Transfer-Encoding: 8bit Dear Org-mode developpers, You will find here attached three patches for org-mode. Two of them improve the "External links" node of the info documentation. The other one just fixes minor typos. Best regards, Rafael Laboissière --tThc/1wpZn/ma/RB Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="0001-Fix-typos-in-variable-description.patch" >From b6aac367829af8b6507d04c3f820e3cdbd33853a Mon Sep 17 00:00:00 2001 From: Rafael Laboissiere Date: Tue, 11 Oct 2011 00:22:09 +0200 Subject: [PATCH 1/3] Fix typos in variable description * lisp/org.el (org-link-search-must-match-exact-headline): fix typos --- lisp/org.el | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lisp/org.el b/lisp/org.el index b26e1a3..3446ce2 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -1493,9 +1493,9 @@ When nil, the link search tries to match a phrase with all words in the search text." :group 'org-link-follow :type '(choice - (const :tag "Use fuzy text search" nil) + (const :tag "Use fuzzy text search" nil) (const :tag "Match only exact headline" t) - (const :tag "Match extact headline or query to create it" + (const :tag "Match exact headline or query to create it" query-to-create))) (defcustom org-link-frame-setup -- 1.7.6.3 --tThc/1wpZn/ma/RB Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="0002-Add-footnote-on-how-the-hyperlink-text-is-searched-i.patch" >From f9b109a147cc5dac6016e46773da11f7dee4dbe3 Mon Sep 17 00:00:00 2001 From: Rafael Laboissiere Date: Tue, 11 Oct 2011 00:58:36 +0200 Subject: [PATCH 2/3] Add footnote on how the hyperlink text is searched in Org files * org.texi (External links): Add footnote on how the behavior of the text search in Org files are controled by the variable org-link-search-must-match-exact-headline. This change is necessary in order to avoid misleading the user as regards of the behavior of the search, in particular because the default value of org-link-search-must-match-exact-headline is 'query-to-create. --- doc/org.texi | 8 +++++++- 1 files changed, 7 insertions(+), 1 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index 957b393..eb6941f 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -3172,7 +3172,13 @@ file:/myself@@some.where:papers/last.pdf @r{file, path on remote machine} /myself@@some.where:papers/last.pdf @r{same as above} file:sometextfile::NNN @r{file with line number to jump to} file:projects.org @r{another Org file} -file:projects.org::some words @r{text search in Org file} +file:projects.org::some words @r{text search in Org file}@footnote{ +The actual behavior of the search will depend on the value of +the variable @code{org-link-search-must-match-exact-headline}. If its value +is nil, then a fuzzy text search will be done. If it is t, then only the +exact headline will be matched. If the value is @code{'query-to-create}, +then an exact headline will be searched; if it is not found, then the user +will be queried to create it.} file:projects.org::*task title @r{heading search in Org file} docview:papers/last.pdf::NNN @r{open file in doc-view mode at page NNN} id:B7423F4D-2E8A-471B-8810-C40F074717E9 @r{Link to heading by ID} -- 1.7.6.3 --tThc/1wpZn/ma/RB Content-Type: text/x-diff; charset=us-ascii Content-Disposition: attachment; filename="0003-Accurate-description-of-info-hyperlink-format.patch" >From 2cac1d22741efe90cdafa43f9f918647ee19a979 Mon Sep 17 00:00:00 2001 From: Rafael Laboissiere Date: Tue, 11 Oct 2011 01:15:37 +0200 Subject: [PATCH 3/3] Accurate description of info hyperlink format Hyperlinks in the form "info:file#node" work with plain spaces in the "node" part and do not need to have spaces encoded as %20. This is the case for me, who is using the Debian emacs-snapshot package, version 20110926-1. --- doc/org.texi | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/doc/org.texi b/doc/org.texi index eb6941f..573cbc9 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -3197,7 +3197,7 @@ gnus:group @r{Gnus group link} gnus:group#id @r{Gnus article link} bbdb:R.*Stallman @r{BBDB link (with regexp)} irc:/irc.com/#emacs/bob @r{IRC link} -info:org#External%20links @r{Info node link (with encoded space)} +info:org#External links @r{Info node link} shell:ls *.org @r{A shell command} elisp:org-agenda @r{Interactive Elisp command} elisp:(find-file-other-frame "Elisp.org") @r{Elisp form to evaluate} -- 1.7.6.3 --tThc/1wpZn/ma/RB--