[Orgmode] Re: question about org-region-active-p
Hi Robert, I have added documentation in the places you suggested. Also, I added a remark in the Activation section. Thanks. - Carsten On Dec 18, 2008, at 5:48 PM, Robert Goldman wrote: Carsten Dominik wrote: Ah, so maybe Robert did not turn it off Anyway, in Emacs 23 the default will be ON. It was always my understanding that in order to use regions efficiently, you needed to turn on that mode. Anyway, Robert, could you please try to identify a location in the docs where I should put this information? Ask yourself: Where would I have seen this, had i been there. Attached please find a patch file that gives a proposed set of additions to the manual on this topic, for your review. Interestingly enough, there was already an index entry for transient mark mode at the html export commands page. Best, Robert diff --git a/doc/org.texi b/doc/org.texi index 39c94aa..f8a5ea2 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -7061,6 +7061,7 @@ is normal. @node Exporting, Publishing, Embedded LaTeX, Top @chapter Exporting @cindex exporting +...@cindex Transient mark mode Org mode documents can be exported into a variety of other formats. For printing and sharing of notes, ASCII export produces a readable and @@ -7073,6 +7074,10 @@ deadlines or appointments into a desktop calendar program like iCal, Org mode can also produce extracts in the iCalendar format. Currently Org mode only supports export, not import of these different formats. +Org supports export of selected regions when @code{transient mark mode} is +enabled. This should always be enabled in default emacs configurations. + + @menu * Markup rules::Which structures are recognized? * Selective export::Using tags to select and exclude trees @@ -7605,7 +7610,11 @@ file. Export as ASCII file. For an org file @file{myfile.org}, the ASCII file will be @file{myfile.txt}. The file will be overwritten without warning. If there is an active region, only the region will be -exported. If the selected region is a single t...@footnote{to select the +export...@footnote{exporting by active region will only work if @code{transient mark + mode} is enabled. This should almost always be enabled. However, if it is +not enabled, attempts to export a region will result in exporting the entire +org file. If this happens, check the setting of the variable +...@code{transient-mark-mode} in your emacs.} If the selected region is a single t...@footnote{to select the current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the @@ -7662,11 +7671,16 @@ language, but with additional support for tables. @item C-c C-e h Export as HTML file @file{myfile.html}. For an org file @file{myfile.org}, the ASCII file will be @file{myfile.html}. The file will be overwritten -without warning. If there is an active region, only the region will be +without warning. If there is an active region,@footnote{Exporting by active region will only work if @code{transient mark + mode} is enabled. This should almost always be enabled. However, if it is +not enabled, attempts to export a region will result in exporting the entire +org file. If this happens, check the setting of the variable +...@code{transient-mark-mode} in your emacs.} only the region will be exported. If the selected region is a single t...@footnote{to select the current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the export. + @kindex C-c C-e b @item C-c C-e b Export as HTML file and immediately open it with a browser. @@ -7911,8 +7925,12 @@ references, the PDF output file will be fully linked. Export as l...@tex{} file @file{myfile.tex}. For an org file @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will be overwritten without warning. If there is an active region, only the -region will be exported. If the selected region is a single t...@footnote{to -select the current subtree, use @kbd{C-c @@}.}, the tree head will become the +region will be export...@footnote{exporting by active region will only work if @code{transient mark + mode} is enabled. This should almost always be enabled. However, if it is +not enabled, attempts to export a region will result in exporting the entire +org file. If this happens, check the setting of the variable +...@code{transient-mark-mode} in your emacs.} If the selected region is a single tree,@footnote{To +select the current subtree, use @kbd{C-c @@}.} the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the export. @kindex C-c C-e L
[Orgmode] Re: question about org-region-active-p
Carsten Dominik wrote: Ah, so maybe Robert did not turn it off Anyway, in Emacs 23 the default will be ON. It was always my understanding that in order to use regions efficiently, you needed to turn on that mode. Anyway, Robert, could you please try to identify a location in the docs where I should put this information? Ask yourself: Where would I have seen this, had i been there. Attached please find a patch file that gives a proposed set of additions to the manual on this topic, for your review. Interestingly enough, there was already an index entry for transient mark mode at the html export commands page. Best, Robert diff --git a/doc/org.texi b/doc/org.texi index 39c94aa..f8a5ea2 100644 --- a/doc/org.texi +++ b/doc/org.texi @@ -7061,6 +7061,7 @@ is normal. @node Exporting, Publishing, Embedded LaTeX, Top @chapter Exporting @cindex exporting +...@cindex Transient mark mode Org mode documents can be exported into a variety of other formats. For printing and sharing of notes, ASCII export produces a readable and @@ -7073,6 +7074,10 @@ deadlines or appointments into a desktop calendar program like iCal, Org mode can also produce extracts in the iCalendar format. Currently Org mode only supports export, not import of these different formats. +Org supports export of selected regions when @code{transient mark mode} is +enabled. This should always be enabled in default emacs configurations. + + @menu * Markup rules::Which structures are recognized? * Selective export::Using tags to select and exclude trees @@ -7605,7 +7610,11 @@ file. Export as ASCII file. For an org file @file{myfile.org}, the ASCII file will be @file{myfile.txt}. The file will be overwritten without warning. If there is an active region, only the region will be -exported. If the selected region is a single t...@footnote{to select the +export...@footnote{exporting by active region will only work if @code{transient mark + mode} is enabled. This should almost always be enabled. However, if it is +not enabled, attempts to export a region will result in exporting the entire +org file. If this happens, check the setting of the variable +...@code{transient-mark-mode} in your emacs.} If the selected region is a single t...@footnote{to select the current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the @@ -7662,11 +7671,16 @@ language, but with additional support for tables. @item C-c C-e h Export as HTML file @file{myfile.html}. For an org file @file{myfile.org}, the ASCII file will be @file{myfile.html}. The file will be overwritten -without warning. If there is an active region, only the region will be +without warning. If there is an active region,@footnote{Exporting by active region will only work if @code{transient mark + mode} is enabled. This should almost always be enabled. However, if it is +not enabled, attempts to export a region will result in exporting the entire +org file. If this happens, check the setting of the variable +...@code{transient-mark-mode} in your emacs.} only the region will be exported. If the selected region is a single t...@footnote{to select the current subtree, use @kbd{C-c @@}.}, the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the export. + @kindex C-c C-e b @item C-c C-e b Export as HTML file and immediately open it with a browser. @@ -7911,8 +7925,12 @@ references, the PDF output file will be fully linked. Export as l...@tex{} file @file{myfile.tex}. For an org file @file{myfile.org}, the ASCII file will be @file{myfile.tex}. The file will be overwritten without warning. If there is an active region, only the -region will be exported. If the selected region is a single t...@footnote{to -select the current subtree, use @kbd{C-c @@}.}, the tree head will become the +region will be export...@footnote{exporting by active region will only work if @code{transient mark + mode} is enabled. This should almost always be enabled. However, if it is +not enabled, attempts to export a region will result in exporting the entire +org file. If this happens, check the setting of the variable +...@code{transient-mark-mode} in your emacs.} If the selected region is a single tree,@footnote{To +select the current subtree, use @kbd{C-c @@}.} the tree head will become the document title. If the tree head entry has or inherits an @code{EXPORT_FILE_NAME} property, that name will be used for the export. @kindex C-c C-e L ___ 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
[Orgmode] Re: question about org-region-active-p
Hi Carsten, Just to add to the discussion, transient-mark-mode is off for me in GNU Emacs 22.2.1 (i486-pc-linux-gnu, X toolkit, Xaw3d scroll bars) of 2008-11-09 on raven, modified by Debian. If I start with emacs -q transient-mark-mode is nil. I've explicitly set it on in my .emacs (as of the beginning of this discussion) and that makes things work better for me. ,[ end of my .emacs ] | (transient-mark-mode 1) ` Regards, Bernt Carsten Dominik domi...@science.uva.nl writes: Dear Robert, also region-active-p requires transient-mark-mode to be active, if you look at the definition of the region-active-p function, you will see that. transient-mark-mode is on by default in Emacs. Why did you turn it *off* in the first place? - Carsten On Dec 17, 2008, at 3:12 PM, Robert Goldman wrote: Carsten Dominik wrote: Hi Robert, no, I do not think this would make sense, to step out with an error, because all the commands that need a region will also work without one. This is how regions work in Emacs. If you find places in the documentation where this could be made clearer, let me know. Thank you Carsten for the response. I am still inclined to think that this case is one where the user should get some warning because it's in that bad class of bug-like situations where code quietly does something that the user does not expect and that contradicts the documentation. On the other hand, I can't see where one would raise an error. It's not an error to call org-region-active-p without transient-mark-mode; indeed some libraries turn this on and off, and the user is entitled not to use it. The call to export isn't right, because the export command does not give the system any opportunity to infer whether the user intended to operate on a region or on the whole. So there's no way to tell that the user's expectations are going to be violated. The loading of org-mode isn't the right place, either, since the vast majority of org-mode works just fine with t-m-m turned off. I'm inclined to think that the answer is simply that one shouldn't turn transient-mark-mode off, ever. This works for me, but I hate to think of the next person coming along to fall into this same trap, from which the only means of escape is to inspect the source code and use the debugger. I would suggest a modification to the manual and will submit one, but need clarification about one issue: the use of t-m-m seems to be a fallback for older emacsen that don't have region-active-p. I have such an emacs, so I don't know --- does this mean that on newer emacsen org-region-active-p will work even without transient-mark-mode? Best, Robert ___ 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 ___ 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
[Orgmode] Re: question about org-region-active-p
Ah, so maybe Robert did not turn it off Anyway, in Emacs 23 the default will be ON. It was always my understanding that in order to use regions efficiently, you needed to turn on that mode. Anyway, Robert, could you please try to identify a location in the docs where I should put this information? Ask yourself: Where would I have seen this, had i been there. - Carsten On Dec 17, 2008, at 5:44 PM, Bernt Hansen wrote: Hi Carsten, Just to add to the discussion, transient-mark-mode is off for me in GNU Emacs 22.2.1 (i486-pc-linux-gnu, X toolkit, Xaw3d scroll bars) of 2008-11-09 on raven, modified by Debian. If I start with emacs -q transient-mark-mode is nil. I've explicitly set it on in my .emacs (as of the beginning of this discussion) and that makes things work better for me. ,[ end of my .emacs ] | (transient-mark-mode 1) ` Regards, Bernt Carsten Dominik domi...@science.uva.nl writes: Dear Robert, also region-active-p requires transient-mark-mode to be active, if you look at the definition of the region-active-p function, you will see that. transient-mark-mode is on by default in Emacs. Why did you turn it *off* in the first place? - Carsten On Dec 17, 2008, at 3:12 PM, Robert Goldman wrote: Carsten Dominik wrote: Hi Robert, no, I do not think this would make sense, to step out with an error, because all the commands that need a region will also work without one. This is how regions work in Emacs. If you find places in the documentation where this could be made clearer, let me know. Thank you Carsten for the response. I am still inclined to think that this case is one where the user should get some warning because it's in that bad class of bug-like situations where code quietly does something that the user does not expect and that contradicts the documentation. On the other hand, I can't see where one would raise an error. It's not an error to call org-region-active-p without transient-mark-mode; indeed some libraries turn this on and off, and the user is entitled not to use it. The call to export isn't right, because the export command does not give the system any opportunity to infer whether the user intended to operate on a region or on the whole. So there's no way to tell that the user's expectations are going to be violated. The loading of org-mode isn't the right place, either, since the vast majority of org-mode works just fine with t-m-m turned off. I'm inclined to think that the answer is simply that one shouldn't turn transient-mark-mode off, ever. This works for me, but I hate to think of the next person coming along to fall into this same trap, from which the only means of escape is to inspect the source code and use the debugger. I would suggest a modification to the manual and will submit one, but need clarification about one issue: the use of t-m-m seems to be a fallback for older emacsen that don't have region-active-p. I have such an emacs, so I don't know --- does this mean that on newer emacsen org-region-active-p will work even without transient-mark-mode? Best, Robert ___ 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 ___ 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