Success story: Pandoc at NASA

Success story: Pandoc at NASA

[Ivan Perez]

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

Hi,

I'm sure this is very little in comparison with all the successes of 
pandoc, but I wanted to let you know what we used pandoc at NASA to create 
the documentation needed so that the projects Copilot 
(https://github.com/Copilot-Language/copilot/) and Ogma 
(https://github.com/nasa/ogma) could be used in more critical software and 
in flights.

The documentation is written in Markdown and the converted to PDF via latex 
using pandoc. Using Markdown has made it much easier to keep a clean 
document and also to compare documents across projects to search for 
meaningful differences.

I used a custom template for this based on pandoc's standard template, with 
lots of fields in the header that need to go in the first pages of the 
document (they are like form fields). I'm also using % as a comment in 
pandoc to separate sentences to make documents easier to read, and I'm 
pre-filtering the file removing all lines matching '^%$'.

Also, these two papers:
https://dl.acm.org/doi/10.1145/3609026.3609727
https://dl.acm.org/doi/10.1145/3609025.3609475
were written in pandoc. For those, I didn't use a custom template. Rather, 
I converted the core text of the paper to LaTeX with pandoc and then had a 
paper.tex file that imported the result.

I hope this is of interest to some people in the community.

Cheers,

Ivan

-- 
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 view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/b4fcfa36-71f6-45a1-b7f0-63d344976fb4n%40googlegroups.com.

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

Re: Success story: Pandoc at NASA

[Ivan Perez]

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

Clarification: 
> Also, these two papers: [links] were written in pandoc.

I mean they were written in Markdown and converted to latex with pandoc.

Sorry for the mixup.

Ivan
On Saturday, October 7, 2023 at 10:28:41 AM UTC-7 Ivan Perez wrote:

> Hi,
>
> I'm sure this is very little in comparison with all the successes of 
> pandoc, but I wanted to let you know what we used pandoc at NASA to create 
> the documentation needed so that the projects Copilot (
> https://github.com/Copilot-Language/copilot/) and Ogma (
> https://github.com/nasa/ogma) could be used in more critical software and 
> in flights.
>
> The documentation is written in Markdown and the converted to PDF via 
> latex using pandoc. Using Markdown has made it much easier to keep a clean 
> document and also to compare documents across projects to search for 
> meaningful differences.
>
> I used a custom template for this based on pandoc's standard template, 
> with lots of fields in the header that need to go in the first pages of the 
> document (they are like form fields). I'm also using % as a comment in 
> pandoc to separate sentences to make documents easier to read, and I'm 
> pre-filtering the file removing all lines matching '^%$'.
>
> Also, these two papers:
> https://dl.acm.org/doi/10.1145/3609026.3609727
> https://dl.acm.org/doi/10.1145/3609025.3609475
> were written in pandoc. For those, I didn't use a custom template. Rather, 
> I converted the core text of the paper to LaTeX with pandoc and then had a 
> paper.tex file that imported the result.
>
> I hope this is of interest to some people in the community.
>
> Cheers,
>
> Ivan
>

-- 
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 view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/f6023656-ae2d-42ef-94ac-284b7a97b191n%40googlegroups.com.

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

Re: Success story: Pandoc at NASA

[John MacFarlane]

When I was a kid I was obsessed with astronomy and space exploration, and naturally a gigantic fan of NASA. So it is gratifying to hear that pandoc contributes in some small way!

> On Oct 7, 2023, at 10:28 AM, Ivan Perez <ivanperezdominguez-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> 
> Hi,
> 
> I'm sure this is very little in comparison with all the successes of pandoc, but I wanted to let you know what we used pandoc at NASA to create the documentation needed so that the projects Copilot (https://github.com/Copilot-Language/copilot/) and Ogma (https://github.com/nasa/ogma) could be used in more critical software and in flights.
> 
> The documentation is written in Markdown and the converted to PDF via latex using pandoc. Using Markdown has made it much easier to keep a clean document and also to compare documents across projects to search for meaningful differences.
> 
> I used a custom template for this based on pandoc's standard template, with lots of fields in the header that need to go in the first pages of the document (they are like form fields). I'm also using % as a comment in pandoc to separate sentences to make documents easier to read, and I'm pre-filtering the file removing all lines matching '^%$'.
> 
> Also, these two papers:
> https://dl.acm.org/doi/10.1145/3609026.3609727
> https://dl.acm.org/doi/10.1145/3609025.3609475
> were written in pandoc. For those, I didn't use a custom template. Rather, I converted the core text of the paper to LaTeX with pandoc and then had a paper.tex file that imported the result.
> 
> I hope this is of interest to some people in the community.
> 
> Cheers,
> 
> Ivan
> 
> -- 
> 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 view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/b4fcfa36-71f6-45a1-b7f0-63d344976fb4n%40googlegroups.com.

-- 
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 view this discussion on the web visit https://groups.google.com/d/msgid/pandoc-discuss/6C8FD4DC-37A0-4A92-87E9-4DDC02DD1092%40gmail.com.