[PATCH] Optional \caption argument for LaTeX export

[PATCH] Optional \caption argument for LaTeX export

[Thomas S. Dye]

[-- Attachment #1: Type: text/plain, Size: 589 bytes --]

Aloha all,

The attached patch initializes the existing variable shortn, adds it to
two caption situations in addition to the one already coded, and adds
some description to the manual.

With this patch, #+CAPTION: [Short caption]{Long caption.} in the
Org-mode source exports to \caption[Short caption]{Long caption.} in the
LaTeX export, which is, I think, as it should be.

Many thanks to Nick Dokos who made me understand why earlier patches
hadn't shown up on the patchwork server (wrong mime type, evil mail
client).  This one sent with gnus and fingers crossed.

All the best,
Tom


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Patch for LaTeX export --]
[-- Type: text/x-patch, Size: 1993 bytes --]

From 9dc65f7e598dd171ebce9448cd39c4062f7cafff Mon Sep 17 00:00:00 2001
From: Tom Dye <tsd@tsdye.com>
Date: Sun, 8 May 2011 06:56:25 -1000
Subject: [PATCH] optional caption arguments in LaTeX export

---
 doc/org.texi      |    5 +++++
 lisp/org-exp.el   |    2 +-
 lisp/org-latex.el |    4 ++--
 3 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 844de6d..3988838 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -8817,6 +8817,11 @@ the object with @code{\ref@{tab:basic-data@}}:
    |-----|----|
 @end example
 
+Optionally, the caption can take the form:
+@example
+#+CAPTION: [Caption for list of figures]{Caption for table (or link).}
+@end example
+
 @cindex inlined images, markup rules
 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
 images into the exported document.  Org does this, if a link to an image
diff --git a/lisp/org-exp.el b/lisp/org-exp.el
index cda1f98..e840b6c 100644
--- a/lisp/org-exp.el
+++ b/lisp/org-exp.el
@@ -1871,7 +1871,7 @@ table line.  If it is a link, add it to the line containing the link."
 				   'org-label label))
 	(if label (push (cons label label) target-alist))
 	(goto-char end)
-	(setq cap nil attr nil label nil)))))
+	(setq cap nil shortn nil attr nil label nil)))))
   target-alist)
 
 (defun org-export-remove-comment-blocks-and-subtrees ()
diff --git a/lisp/org-latex.el b/lisp/org-latex.el
index bc9a3f3..516ee12 100644
--- a/lisp/org-latex.el
+++ b/lisp/org-latex.el
@@ -2199,12 +2199,12 @@ The conversion is made depending of STRING-BEFORE and STRING-AFTER."
 	   (multicolumnp "\\begin{figure*}%placement
 \\centering
 \\includegraphics[%attr]{%path}
-\\caption{%labelcmd%caption}
+\\caption%shortn{%labelcmd%caption}
 \\end{figure*}")
 	   (floatp "\\begin{figure}%placement
 \\centering
 \\includegraphics[%attr]{%path}
-\\caption{%labelcmd%caption}
+\\caption%shortn{%labelcmd%caption}
 \\end{figure}")
 	   (t "\\includegraphics[%attr]{%path}")))
 
-- 
1.7.1


[-- Attachment #3: Type: text/plain, Size: 41 bytes --]



-- 
Thomas S. Dye
http://www.tsdye.com

[Accepted] Optional \caption argument for LaTeX export

[Carsten Dominik]

Patch 794 (http://patchwork.newartisans.com/patch/794/) is now "Accepted".

Maintainer comment: No comment

This relates to the following submission:

http://mid.gmane.org/%3Cm1wri1c5qc.fsf%40tsdye.com%3E

Here is the original message containing the patch:

> Content-Type: text/plain; charset="utf-8"
> MIME-Version: 1.0
> Content-Transfer-Encoding: 7bit
> Subject: [O] Optional \caption argument for LaTeX export
> Date: Mon, 09 May 2011 01:11:39 -0000
> From: Thomas S. Dye <tsd@tsdye.com>
> X-Patchwork-Id: 794
> Message-Id: <m1wri1c5qc.fsf@tsdye.com>
> To: emacs-orgmode@gnu.org
> 
> Aloha all,
> 
> The attached patch initializes the existing variable shortn, adds it to
> two caption situations in addition to the one already coded, and adds
> some description to the manual.
> 
> With this patch, #+CAPTION: [Short caption]{Long caption.} in the
> Org-mode source exports to \caption[Short caption]{Long caption.} in the
> LaTeX export, which is, I think, as it should be.
> 
> Many thanks to Nick Dokos who made me understand why earlier patches
> hadn't shown up on the patchwork server (wrong mime type, evil mail
> client).  This one sent with gnus and fingers crossed.
> 
> All the best,
> Tom
> 
> 
> >From 9dc65f7e598dd171ebce9448cd39c4062f7cafff Mon Sep 17 00:00:00 2001
> From: Tom Dye <tsd@tsdye.com>
> Date: Sun, 8 May 2011 06:56:25 -1000
> Subject: [PATCH] optional caption arguments in LaTeX export
> 
> ---
>  doc/org.texi      |    5 +++++
>  lisp/org-exp.el   |    2 +-
>  lisp/org-latex.el |    4 ++--
>  3 files changed, 8 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/org.texi b/doc/org.texi
> index 844de6d..3988838 100644
> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -8817,6 +8817,11 @@ the object with @code{\ref@{tab:basic-data@}}:
>     |-----|----|
>  @end example
>  
> +Optionally, the caption can take the form:
> +@example
> +#+CAPTION: [Caption for list of figures]{Caption for table (or link).}
> +@end example
> +
>  @cindex inlined images, markup rules
>  Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
>  images into the exported document.  Org does this, if a link to an image
> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
> index cda1f98..e840b6c 100644
> --- a/lisp/org-exp.el
> +++ b/lisp/org-exp.el
> @@ -1871,7 +1871,7 @@ table line.  If it is a link, add it to the line containing the link."
>  				   'org-label label))
>  	(if label (push (cons label label) target-alist))
>  	(goto-char end)
> -	(setq cap nil attr nil label nil)))))
> +	(setq cap nil shortn nil attr nil label nil)))))
>    target-alist)
>  
>  (defun org-export-remove-comment-blocks-and-subtrees ()
> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
> index bc9a3f3..516ee12 100644
> --- a/lisp/org-latex.el
> +++ b/lisp/org-latex.el
> @@ -2199,12 +2199,12 @@ The conversion is made depending of STRING-BEFORE and STRING-AFTER."
>  	   (multicolumnp "\\begin{figure*}%placement
>  \\centering
>  \\includegraphics[%attr]{%path}
> -\\caption{%labelcmd%caption}
> +\\caption%shortn{%labelcmd%caption}
>  \\end{figure*}")
>  	   (floatp "\\begin{figure}%placement
>  \\centering
>  \\includegraphics[%attr]{%path}
> -\\caption{%labelcmd%caption}
> +\\caption%shortn{%labelcmd%caption}
>  \\end{figure}")
>  	   (t "\\includegraphics[%attr]{%path}")))
>  
> -- 
> 1.7.1
> 
> 

Re: [PATCH] Optional \caption argument for LaTeX export

[Bernt Hansen]

tsd@tsdye.com (Thomas S. Dye) writes:

> With this patch, #+CAPTION: [Short caption]{Long caption.} in the
> Org-mode source exports to \caption[Short caption]{Long caption.} in the
> LaTeX export, which is, I think, as it should be.

Hi Thomas,

Thanks for the patch!

Please add the above details (without the 'With this patch' and ', which
is, I think, as it should be') to body of the commit message (starting
on line 3).  This makes it possible to read just the commit log message
6 months from now and know what the patch is about without the necessity
of reading the code changes.

Regards,
Bernt

Re: [PATCH] Optional \caption argument for LaTeX export

[Thomas S. Dye]

[-- Attachment #1: Type: text/plain, Size: 788 bytes --]

Bernt Hansen <bernt@norang.ca> writes:

> tsd@tsdye.com (Thomas S. Dye) writes:
>
>> With this patch, #+CAPTION: [Short caption]{Long caption.} in the
>> Org-mode source exports to \caption[Short caption]{Long caption.} in the
>> LaTeX export, which is, I think, as it should be.
>
> Hi Thomas,
>
> Thanks for the patch!
>
> Please add the above details (without the 'With this patch' and ', which
> is, I think, as it should be') to body of the commit message (starting
> on line 3).  This makes it possible to read just the commit log message
> 6 months from now and know what the patch is about without the necessity
> of reading the code changes.
>
> Regards,
> Bernt
>

6 months ... yikes!

I think this is what you're asking for.  Let me know if it falls short.

All the best,
Tom


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Optional caption command patch --]
[-- Type: text/x-patch, Size: 2140 bytes --]

From 37eba27e80a84175e09b01e7125269154c40396d Mon Sep 17 00:00:00 2001
From: Tom Dye <tsd@tsdye.com>
Date: Sun, 8 May 2011 13:16:15 -1000
Subject: [PATCH] Activate optional argument to LaTeX caption command.
 CAPTION: [Short caption]{Long caption.} in the Org-mode source exports to \caption[Short caption]{Long caption.} in theLaTeX export.

---
 doc/org.texi      |    6 ++++++
 lisp/org-exp.el   |    2 +-
 lisp/org-latex.el |    4 ++--
 3 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 844de6d..8058288 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -8817,6 +8817,12 @@ the object with @code{\ref@{tab:basic-data@}}:
    |-----|----|
 @end example
 
+Optionally, the caption can take the form:
+@example
+#+CAPTION: [Caption for list of figures]{Caption for table (or link).}
+@end example
+
+
 @cindex inlined images, markup rules
 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
 images into the exported document.  Org does this, if a link to an image
diff --git a/lisp/org-exp.el b/lisp/org-exp.el
index cda1f98..e840b6c 100644
--- a/lisp/org-exp.el
+++ b/lisp/org-exp.el
@@ -1871,7 +1871,7 @@ table line.  If it is a link, add it to the line containing the link."
 				   'org-label label))
 	(if label (push (cons label label) target-alist))
 	(goto-char end)
-	(setq cap nil attr nil label nil)))))
+	(setq cap nil shortn nil attr nil label nil)))))
   target-alist)
 
 (defun org-export-remove-comment-blocks-and-subtrees ()
diff --git a/lisp/org-latex.el b/lisp/org-latex.el
index bc9a3f3..516ee12 100644
--- a/lisp/org-latex.el
+++ b/lisp/org-latex.el
@@ -2199,12 +2199,12 @@ The conversion is made depending of STRING-BEFORE and STRING-AFTER."
 	   (multicolumnp "\\begin{figure*}%placement
 \\centering
 \\includegraphics[%attr]{%path}
-\\caption{%labelcmd%caption}
+\\caption%shortn{%labelcmd%caption}
 \\end{figure*}")
 	   (floatp "\\begin{figure}%placement
 \\centering
 \\includegraphics[%attr]{%path}
-\\caption{%labelcmd%caption}
+\\caption%shortn{%labelcmd%caption}
 \\end{figure}")
 	   (t "\\includegraphics[%attr]{%path}")))
 
-- 
1.7.1


[-- Attachment #3: Type: text/plain, Size: 146 bytes --]


-- 
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

Re: [PATCH] Optional \caption argument for LaTeX export

[Bernt Hansen]

[-- Attachment #1: Type: text/plain, Size: 1759 bytes --]

tsd@tsdye.com (Thomas S. Dye) writes:

> Bernt Hansen <bernt@norang.ca> writes:
>
>> tsd@tsdye.com (Thomas S. Dye) writes:
>>
>>> With this patch, #+CAPTION: [Short caption]{Long caption.} in the
>>> Org-mode source exports to \caption[Short caption]{Long caption.} in the
>>> LaTeX export, which is, I think, as it should be.
>>
>> Hi Thomas,
>>
>> Thanks for the patch!
>>
>> Please add the above details (without the 'With this patch' and ', which
>> is, I think, as it should be') to body of the commit message (starting
>> on line 3).  This makes it possible to read just the commit log message
>> 6 months from now and know what the patch is about without the necessity
>> of reading the code changes.
>>
>> Regards,
>> Bernt
>>
>
> 6 months ... yikes!
>
> I think this is what you're asking for.  Let me know if it falls short.

Close :)

The attached patch would be better I think.  After applying it 
git log shows the following:

,----
| ~/git/org-mode$ git log -1
| commit cec944435abb688dd1e4b5acbe6d9bcc557c171b
| Author: Tom Dye <tsd@tsdye.com>
| Date:   Sun May 8 13:16:15 2011 -1000
| 
|     Activate optional argument to LaTeX caption command
|     
|     * doc/org.texi (Images and tables): Document optional #+CAPTION: form
|     * lisp/org-exp.el: Add support for optional caption form
|     * lisp/org-latex.el: Add support for optional caption form
|     
|     Captions of the form
|        #+CAPTION: [Short caption]{Long caption.}
|     export to
|        \caption[Short caption]{Long caption.} in the LaTeX export.
`----

git needs the blank line separating the subject from the body and I've
added the changelog entries (although you might want to reword them if
they are incorrect.

The updated patch is attached.

Regards,
Bernt


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: tsd.patch --]
[-- Type: text/x-diff, Size: 2331 bytes --]

From 37eba27e80a84175e09b01e7125269154c40396d Mon Sep 17 00:00:00 2001
From: Tom Dye <tsd@tsdye.com>
Date: Sun, 8 May 2011 13:16:15 -1000
Subject: [PATCH] Activate optional argument to LaTeX caption command

* doc/org.texi (Images and tables): Document optional #+CAPTION: form
* lisp/org-exp.el: Add support for optional caption form
* lisp/org-latex.el: Add support for optional caption form

Captions of the form
   #+CAPTION: [Short caption]{Long caption.}
export to
   \caption[Short caption]{Long caption.} in the LaTeX export.
---
 doc/org.texi      |    6 ++++++
 lisp/org-exp.el   |    2 +-
 lisp/org-latex.el |    4 ++--
 3 files changed, 9 insertions(+), 3 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 844de6d..8058288 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -8817,6 +8817,12 @@ the object with @code{\ref@{tab:basic-data@}}:
    |-----|----|
 @end example
 
+Optionally, the caption can take the form:
+@example
+#+CAPTION: [Caption for list of figures]{Caption for table (or link).}
+@end example
+
+
 @cindex inlined images, markup rules
 Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
 images into the exported document.  Org does this, if a link to an image
diff --git a/lisp/org-exp.el b/lisp/org-exp.el
index cda1f98..e840b6c 100644
--- a/lisp/org-exp.el
+++ b/lisp/org-exp.el
@@ -1871,7 +1871,7 @@ table line.  If it is a link, add it to the line containing the link."
 				   'org-label label))
 	(if label (push (cons label label) target-alist))
 	(goto-char end)
-	(setq cap nil attr nil label nil)))))
+	(setq cap nil shortn nil attr nil label nil)))))
   target-alist)
 
 (defun org-export-remove-comment-blocks-and-subtrees ()
diff --git a/lisp/org-latex.el b/lisp/org-latex.el
index bc9a3f3..516ee12 100644
--- a/lisp/org-latex.el
+++ b/lisp/org-latex.el
@@ -2199,12 +2199,12 @@ The conversion is made depending of STRING-BEFORE and STRING-AFTER."
 	   (multicolumnp "\\begin{figure*}%placement
 \\centering
 \\includegraphics[%attr]{%path}
-\\caption{%labelcmd%caption}
+\\caption%shortn{%labelcmd%caption}
 \\end{figure*}")
 	   (floatp "\\begin{figure}%placement
 \\centering
 \\includegraphics[%attr]{%path}
-\\caption{%labelcmd%caption}
+\\caption%shortn{%labelcmd%caption}
 \\end{figure}")
 	   (t "\\includegraphics[%attr]{%path}")))
 
-- 
1.7.1

Re: [PATCH] Optional \caption argument for LaTeX export

[Thomas S. Dye]

Bernt Hansen <bernt@norang.ca> writes:

> tsd@tsdye.com (Thomas S. Dye) writes:
>
>> Bernt Hansen <bernt@norang.ca> writes:
>>
>>> tsd@tsdye.com (Thomas S. Dye) writes:
>>>
>>>> With this patch, #+CAPTION: [Short caption]{Long caption.} in the
>>>> Org-mode source exports to \caption[Short caption]{Long caption.} in the
>>>> LaTeX export, which is, I think, as it should be.
>>>
>>> Hi Thomas,
>>>
>>> Thanks for the patch!
>>>
>>> Please add the above details (without the 'With this patch' and ', which
>>> is, I think, as it should be') to body of the commit message (starting
>>> on line 3).  This makes it possible to read just the commit log message
>>> 6 months from now and know what the patch is about without the necessity
>>> of reading the code changes.
>>>
>>> Regards,
>>> Bernt
>>>
>>
>> 6 months ... yikes!
>>
>> I think this is what you're asking for.  Let me know if it falls short.
>
> Close :)
>
> The attached patch would be better I think.  After applying it 
> git log shows the following:
>
> ,----
> | ~/git/org-mode$ git log -1
> | commit cec944435abb688dd1e4b5acbe6d9bcc557c171b
> | Author: Tom Dye <tsd@tsdye.com>
> | Date:   Sun May 8 13:16:15 2011 -1000
> | 
> |     Activate optional argument to LaTeX caption command
> |     
> |     * doc/org.texi (Images and tables): Document optional #+CAPTION: form
> |     * lisp/org-exp.el: Add support for optional caption form
> |     * lisp/org-latex.el: Add support for optional caption form
> |     
> |     Captions of the form
> |        #+CAPTION: [Short caption]{Long caption.}
> |     export to
> |        \caption[Short caption]{Long caption.} in the LaTeX export.
> `----
>
> git needs the blank line separating the subject from the body and I've
> added the changelog entries (although you might want to reword them if
> they are incorrect.
>
> The updated patch is attached.
>
> Regards,
> Bernt
>
>
> From 37eba27e80a84175e09b01e7125269154c40396d Mon Sep 17 00:00:00 2001
> From: Tom Dye <tsd@tsdye.com>
> Date: Sun, 8 May 2011 13:16:15 -1000
> Subject: [PATCH] Activate optional argument to LaTeX caption command
>
> * doc/org.texi (Images and tables): Document optional #+CAPTION: form
> * lisp/org-exp.el: Add support for optional caption form
> * lisp/org-latex.el: Add support for optional caption form
>
> Captions of the form
>    #+CAPTION: [Short caption]{Long caption.}
> export to
>    \caption[Short caption]{Long caption.} in the LaTeX export.
> ---
>  doc/org.texi      |    6 ++++++
>  lisp/org-exp.el   |    2 +-
>  lisp/org-latex.el |    4 ++--
>  3 files changed, 9 insertions(+), 3 deletions(-)
>
> diff --git a/doc/org.texi b/doc/org.texi
> index 844de6d..8058288 100644
> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -8817,6 +8817,12 @@ the object with @code{\ref@{tab:basic-data@}}:
>     |-----|----|
>  @end example
>  
> +Optionally, the caption can take the form:
> +@example
> +#+CAPTION: [Caption for list of figures]{Caption for table (or link).}
> +@end example
> +
> +
>  @cindex inlined images, markup rules
>  Some backends (HTML, @LaTeX{}, and DocBook) allow you to directly include
>  images into the exported document.  Org does this, if a link to an image
> diff --git a/lisp/org-exp.el b/lisp/org-exp.el
> index cda1f98..e840b6c 100644
> --- a/lisp/org-exp.el
> +++ b/lisp/org-exp.el
> @@ -1871,7 +1871,7 @@ table line.  If it is a link, add it to the line containing the link."
>  				   'org-label label))
>  	(if label (push (cons label label) target-alist))
>  	(goto-char end)
> -	(setq cap nil attr nil label nil)))))
> +	(setq cap nil shortn nil attr nil label nil)))))
>    target-alist)
>  
>  (defun org-export-remove-comment-blocks-and-subtrees ()
> diff --git a/lisp/org-latex.el b/lisp/org-latex.el
> index bc9a3f3..516ee12 100644
> --- a/lisp/org-latex.el
> +++ b/lisp/org-latex.el
> @@ -2199,12 +2199,12 @@ The conversion is made depending of STRING-BEFORE and STRING-AFTER."
>  	   (multicolumnp "\\begin{figure*}%placement
>  \\centering
>  \\includegraphics[%attr]{%path}
> -\\caption{%labelcmd%caption}
> +\\caption%shortn{%labelcmd%caption}
>  \\end{figure*}")
>  	   (floatp "\\begin{figure}%placement
>  \\centering
>  \\includegraphics[%attr]{%path}
> -\\caption{%labelcmd%caption}
> +\\caption%shortn{%labelcmd%caption}
>  \\end{figure}")
>  	   (t "\\includegraphics[%attr]{%path}")))

Thanks Bernt,

Anything left for me to do?

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

Re: [PATCH] Optional \caption argument for LaTeX export

[Bernt Hansen]

tsd@tsdye.com (Thomas S. Dye) writes:

> Thanks Bernt,
>
> Anything left for me to do?
>
> All the best,
> Tom

Not if you're happy with what I posted and it shows up correctly in
patchwork for someone to apply it.  I don't have commit access myself.

Regards,
Bernt