Pandoc friendly tufte document class

Pandoc friendly tufte document class

[Luis Fernado Silva Castro de Araújo]

[-- Attachment #1.1: Type: text/plain, Size: 865 bytes --]

Hi all,

chiming in to say that I noticed no tufte package works fine with pandoc 
atm, so I started a github repo to start working towards a good tufte 
template for pandoc. Any help would be greatly appreciated.

Here is the link to it:

https://github.com/lf-araujo/tufte-pandoc

Best,

lf

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/7879f6eb-6853-4890-b843-c69356b280d6%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 1309 bytes --]

Re: Pandoc friendly tufte document class

[Václav Haisman]

On 23 January 2017 at 11:50, Luis Fernado Silva Castro de Araújo
<luis.nando-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> Hi all,
>
> chiming in to say that I noticed no tufte package works fine with pandoc
> atm, so I started a github repo to start working towards a good tufte
> template for pandoc. Any help would be greatly appreciated.
>
> Here is the link to it:
>
> https://github.com/lf-araujo/tufte-pandoc
>
> Best,
>
> lf

I do not understand why is it necessary to create a new document class
for Pandoc to use it? Wouldn't it be better to just create a different
Pandoc LaTeX template for Tufte style book/document?

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/CAKw7uVikt-q9hBi0N-DAZaJT5yc_fGo7HXWHC%2B1HdfvhpYiiNg%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

Re: Pandoc friendly tufte document class

[Luis Fernado Silva Castro de Araújo]

[-- Attachment #1.1: Type: text/plain, Size: 861 bytes --]

That is what I first tried. There are actually a couple of templates 
online, but I couldn't find ways of exploring fullwidth environments or the 
sidenotes with templates. 

The class is simply too complex, I was thinking in simplifying it to work 
smoothly with pandoc yaml variables.



-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/e382c039-e854-428e-89d4-52aa04f26cf0%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 1294 bytes --]

Re: Pandoc friendly tufte document class

[Chris MacKay]

[-- Attachment #1.1: Type: text/plain, Size: 1557 bytes --]

The approach I tried was to use a custom LaTeX writer written in Lua, and 
then a tufte-latex template. I ended up using custom attributes in the 
figure markup to denote their placement:

![this is a caption](path/to/fig.jpg){type=margin}

And "type" could also be full-width or text-width. 

I abandoned this effort mid way, though. Instead I started using the LaTeX 
floatrow package directly to create a larger margin. I found the small 
margin in the tufte-handout style too small to be useful in the data 
presentation handouts I was making.

On Tuesday, January 24, 2017 at 4:10:05 AM UTC-5, Luis Fernado Silva Castro 
de Araújo wrote:
>
> That is what I first tried. There are actually a couple of templates 
> online, but I couldn't find ways of exploring fullwidth environments or the 
> sidenotes with templates. 
>
> The class is simply too complex, I was thinking in simplifying it to work 
> smoothly with pandoc yaml variables.
>
>
>
>

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/a3c76c99-3541-4f1d-8e15-58ff465c55a4%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 2242 bytes --]

Re: Pandoc friendly tufte document class

[Luis Fernado Silva Castro de Araújo]

[-- Attachment #1.1: Type: text/plain, Size: 768 bytes --]

Thanks for the answer, Chris. 

I also  recently found the floatrow package  and I think to follow this 
path. Do you have a template example using it with pandoc that you could 
share? 

Thanks.

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/af50ba79-321c-4d4a-b35b-b8939c5e0ee9%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 1192 bytes --]

Re: Pandoc friendly tufte document class

[Chris MacKay]

[-- Attachment #1.1: Type: text/plain, Size: 1011 bytes --]

here's what I got: it's sort of a mess...

https://gist.github.com/crmackay/f134fcea218076f8a7542418f292d6b7

On Tuesday, January 24, 2017 at 3:48:50 PM UTC-5, Luis Fernado Silva Castro 
de Araújo wrote:
>
> Thanks for the answer, Chris. 
>
> I also  recently found the floatrow package  and I think to follow this 
> path. Do you have a template example using it with pandoc that you could 
> share? 
>
> Thanks.
>

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/a44af459-fe8b-4b25-a1cd-ae4e16314814%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 1583 bytes --]

Re: Pandoc friendly tufte document class

[Luis Fernado Silva Castro de Araújo]

[-- Attachment #1.1: Type: text/plain, Size: 2670 bytes --]

Thanks for the writer Chris,

I reached the conclusion that the easiest solution would be not to mess 
with the tufte class. Its main advantage seems to be the rational use of 
space. Tufte's design allows for packing information in a clever way, which 
is to say that whenever tables and figures exists in the document, they 
will take less space, whereas the amount of words per page is about the 
same of a tall (regular) latex article page. In my non-scientific tests, 
the difference was of about 15% space saved in heavily image or table 
packed documents. The difference is not big, if that would be the sole 
reason to use that design. I totally see why the R-team is insisting on 
that, as it is actually super useful to present graphs and tables.

Why would one need to save space? Some organizations in certain 
circumstances require a limited number of pages (talking about funders, 
sponsorships, which are the type of org that I deal with), sometimes the 
15% more material can help you convey your findings better. The confort of 
reading a pdf in tufte's design is about the same as a well rendered latex 
document, as it keeps the number of words per line in the 60-80 mark 
depending on the font size.

Another strenght of tufte's design is that fullwidth figures allows for 
complex images to take more space than the actual text. The reader will be 
presented with a larger image to inspect, that could help in seeing the 
details, and so on.

So in the end, the true advantage of tufte's design is not in the fonts, or 
the fancy headings, or titling. The strength is on the larger margin where 
you can put notes and figure captions; and in the fullwidth environment.

These might be easy to achieve w/o even messing with the document class; 
floatrow package seems a great candidate to help achieving the aim of a 
"tuftesque" document in the sense described above. I will investigate 
whether it can mimic some of the design aspects mentioned, and started by 
this 
<http://tex.stackexchange.com/questions/350310/tufte-margin-caption-effect-with-floatrow> 
question at SO.


-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/88eca349-1b74-485f-ae42-a50958a077d1%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 3136 bytes --]

Re: Pandoc friendly tufte document class

[Chris MacKay]

[-- Attachment #1.1: Type: text/plain, Size: 3973 bytes --]

You can check out the sidenotes package 
(https://www.ctan.org/pkg/sidenotes), which is fairly new (wasn't 1.0 when 
I started looking into this). That might do what you want. 

I agree, the strength of Tufte-ian design is in the intelligent use of the 
margin (though tufte credits Feyman for this layout style). For my case I 
found my captions required much more space in order to fully explain the 
methods involved in generating the data in each figure, so I actually 
needed a larger margin for many figures. Whenever I have full-page-wide 
figures the caption is also just several full-page wide lines of text, 
since i have detailed captions. Since I really don't put too much 
"interstitial text" between figures in my handouts, I decided to just 
designating the caption position and figure width on a figure by figure 
basis. The resulting handouts work great for small group discussions about 
primary data - big clear plots, explanatory legends, numbered figures, 
numbered pages, a date and title at the front and nothing else. 

good luck!

On Wednesday, January 25, 2017 at 12:11:16 AM UTC-5, Luis Fernado Silva 
Castro de Araújo wrote:
>
> Thanks for the writer Chris,
>
> I reached the conclusion that the easiest solution would be not to mess 
> with the tufte class. Its main advantage seems to be the rational use of 
> space. Tufte's design allows for packing information in a clever way, which 
> is to say that whenever tables and figures exists in the document, they 
> will take less space, whereas the amount of words per page is about the 
> same of a tall (regular) latex article page. In my non-scientific tests, 
> the difference was of about 15% space saved in heavily image or table 
> packed documents. The difference is not big, if that would be the sole 
> reason to use that design. I totally see why the R-team is insisting on 
> that, as it is actually super useful to present graphs and tables.
>
> Why would one need to save space? Some organizations in certain 
> circumstances require a limited number of pages (talking about funders, 
> sponsorships, which are the type of org that I deal with), sometimes the 
> 15% more material can help you convey your findings better. The confort of 
> reading a pdf in tufte's design is about the same as a well rendered latex 
> document, as it keeps the number of words per line in the 60-80 mark 
> depending on the font size.
>
> Another strenght of tufte's design is that fullwidth figures allows for 
> complex images to take more space than the actual text. The reader will be 
> presented with a larger image to inspect, that could help in seeing the 
> details, and so on.
>
> So in the end, the true advantage of tufte's design is not in the fonts, 
> or the fancy headings, or titling. The strength is on the larger margin 
> where you can put notes and figure captions; and in the fullwidth 
> environment.
>
> These might be easy to achieve w/o even messing with the document class; 
> floatrow package seems a great candidate to help achieving the aim of a 
> "tuftesque" document in the sense described above. I will investigate 
> whether it can mimic some of the design aspects mentioned, and started by 
> this 
> <http://tex.stackexchange.com/questions/350310/tufte-margin-caption-effect-with-floatrow> 
> question at SO.
>
>
>

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/da6bd44f-1996-4f7f-a32c-3ce94e3051e5%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 5079 bytes --]

Re: Pandoc friendly tufte document class

[Luis Fernado Silva Castro de Araújo]

[-- Attachment #1.1: Type: text/plain, Size: 1378 bytes --]

Thanks for pointing it out,


It seems the sidenote package is able to deal with all the characteristics 
I mentioned before. So I would suppose that adding a macro to 
header-includes would be enough to convert all regular captions to side 
captions.

If I add something like: 

---
title: Teste
papersize: a4
bibliography: library.bib
header-includes:
    - \usepackage{sidenotes}
    - \renewcommand{\footnote}{\sidenote}
---

Works perfectly and all the footnotes becomes sidenotes. But if I try to 
convert captions to sidecaptions like below:

---
title: Teste
papersize: a4
bibliography: library.bib
header-includes:
    - \usepackage{sidenotes}
    - \renewcommand{\caption}{\sidecaption}
---


It compiles fine, but the captions does not change to the margin space.  
What I might be doing wrong?

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/98b2a8fd-c42f-4768-bc92-b6be6c35551e%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 1890 bytes --]

Re: Pandoc friendly tufte document class

[Chris MacKay]

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

I don’t think you can just rename all `\caption` commands, since that command is used many times within the sidenotes package macros themselves. 

Here’s a smallish working example of the LaTeX markup… getting from markdown to this is what’s tricky.

https://www.overleaf.com/read/czfmznxznhnp



> On Jan 25, 2017, at 8:47 PM, Luis Fernado Silva Castro de Araújo <luis.nando-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> 
> Thanks for pointing it out,
> 
> 
> It seems the sidenote package is able to deal with all the characteristics I mentioned before. So I would suppose that adding a macro to header-includes would be enough to convert all regular captions to side captions.
> 
> If I add something like: 
> 
> ---
> title: Teste
> papersize: a4
> bibliography: library.bib
> header-includes:
>     - \usepackage{sidenotes}
>     - \renewcommand{\footnote}{\sidenote}
> ---
> 
> Works perfectly and all the footnotes becomes sidenotes. But if I try to convert captions to sidecaptions like below:
> 
> ---
> title: Teste
> papersize: a4
> bibliography: library.bib
> header-includes:
>     - \usepackage{sidenotes}
>     - \renewcommand{\caption}{\sidecaption}
> ---
> 
> 
> It compiles fine, but the captions does not change to the margin space.  What I might be doing wrong?
> 
> 
> -- 
> You received this message because you are subscribed to a topic in the Google Groups "pandoc-discuss" group.
> To unsubscribe from this topic, visit https://groups.google.com/d/topic/pandoc-discuss/leL_TGuOs_Y/unsubscribe <https://groups.google.com/d/topic/pandoc-discuss/leL_TGuOs_Y/unsubscribe>.
> To unsubscribe from this group and all its topics, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org <mailto:pandoc-discuss+unsubscribe@googlegroups.com>.
> To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org <mailto:pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org>.
> To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/98b2a8fd-c42f-4768-bc92-b6be6c35551e%40googlegroups.com <https://groups.google.com/d/msgid/pandoc-discuss/98b2a8fd-c42f-4768-bc92-b6be6c35551e%40googlegroups.com?utm_medium=email&utm_source=footer>.
> For more options, visit https://groups.google.com/d/optout <https://groups.google.com/d/optout>.

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/27D812EC-9384-4E8D-B38B-15F2225CCA9B%40gmail.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #2: Type: text/html, Size: 4670 bytes --]

Re: Pandoc friendly tufte document class

[lf-araujo]

[-- Attachment #1.1: Type: text/plain, Size: 1099 bytes --]



Sorry for reviving this thread. I managed to achieve a tufte-like style for 
use with pandoc. It uses the memoir class, the pp preprocessor and it is 
heavily inspired by the work from duzyn 
<https://github.com/duzyn/tufte-markdown> at Github. 

The strongest point, I guess, is that it supports running R code within 
your pandoc document, thanks for pp‘s developper, who was nice enough to 
add support for R in his tool.

You can find the theme here: https://github.com/lf-araujo/tuftish-pandoc
​

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/978251ae-0a1e-443a-b348-6830a3d2a046%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 3321 bytes --]

Re: Pandoc friendly tufte document class

[John Muccigrosso]

[-- Attachment #1.1: Type: text/plain, Size: 1079 bytes --]

On Monday, January 23, 2017 at 5:50:59 AM UTC-5, Luis Fernado Silva Castro 
de Araújo wrote:
>
> Hi all,
>
> chiming in to say that I noticed no tufte package works fine with pandoc 
> atm, so I started a github repo to start working towards a good tufte 
> template for pandoc. Any help would be greatly appreciated.
>
> Here is the link to it:
>
> https://github.com/lf-araujo/tufte-pandoc
>
> Best,
>
> lf
>

Not sure I'll be able to help, but I'm glad to see you doing this. 

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To unsubscribe from this group and stop receiving emails from it, send an email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/632b2ed2-0a7d-4de7-b81b-c0dd840dde9e%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[-- Attachment #1.2: Type: text/html, Size: 2141 bytes --]