Cross-platform file generation

Cross-platform file generation

[Ivan Lazar Miljenovic]

In my SourceGraph [1] program, I use pandoc as a library to generate
HTML reports (well, this is technically done in another library and
there is support for generating LaTeX, etc. as well but I've never
bothered to write command-line options to specify output type).  As
part of this, the images are saved in a graphs/ sub-directory and
referenced relatively in the actual HTML file, with the referencing
being done with FilePath [2].

[1]: http://hackage.haskell.org/package/SourceGraph
[2]: http://hackage.haskell.org/package/filepath

A user has recently reported to me that when he generates the report
in Windows and then tries to upload the resulting report on the web,
the file references are all wrong: Windows-style path separators are
used, which isn't what is expected/wanted in an HTML file.

Is there any way of fixing/solving this issue?  I could always force
usage of forward-slashes rather than trying to be OS-independent, but
this will probably result in problems if I ever end up letting users
choose to generate a LaTeX document, etc.

-- 
Ivan Lazar Miljenovic
Ivan.Miljenovic-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
IvanMiljenovic.wordpress.com

Re: Cross-platform file generation

[John MacFarlane]

This doesn't sound like a pandoc problem; it sounds like a problem
with the library that generates the images and the corresponding
links...

If you think it's a pandoc problem, please give a minimal example
of how to reproduce it, using only pandoc.

John

+++ Ivan Lazar Miljenovic [Nov 22 10 17:13 ]:
> In my SourceGraph [1] program, I use pandoc as a library to generate
> HTML reports (well, this is technically done in another library and
> there is support for generating LaTeX, etc. as well but I've never
> bothered to write command-line options to specify output type).  As
> part of this, the images are saved in a graphs/ sub-directory and
> referenced relatively in the actual HTML file, with the referencing
> being done with FilePath [2].
> 
> [1]: http://hackage.haskell.org/package/SourceGraph
> [2]: http://hackage.haskell.org/package/filepath
> 
> A user has recently reported to me that when he generates the report
> in Windows and then tries to upload the resulting report on the web,
> the file references are all wrong: Windows-style path separators are
> used, which isn't what is expected/wanted in an HTML file.
> 
> Is there any way of fixing/solving this issue?  I could always force
> usage of forward-slashes rather than trying to be OS-independent, but
> this will probably result in problems if I ever end up letting users
> choose to generate a LaTeX document, etc.
> 
> -- 
> Ivan Lazar Miljenovic
> Ivan.Miljenovic-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
> IvanMiljenovic.wordpress.com
> 
> -- 
> You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
> To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> To unsubscribe from this group, send email to pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
> For more options, visit this group at http://groups.google.com/group/pandoc-discuss?hl=en.
> 

Re: Cross-platform file generation

[Ivan Lazar Miljenovic]

On 23 November 2010 03:29, John MacFarlane <fiddlosopher-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> This doesn't sound like a pandoc problem; it sounds like a problem
> with the library that generates the images and the corresponding
> links...
>
> If you think it's a pandoc problem, please give a minimal example
> of how to reproduce it, using only pandoc.

It's not really a pandoc problem per-se; I was just hoping for
suggestions on how to deal with this (and the libraries that generate
the images and links are mine, so there's a very real possibility that
the problem is indeed mine :p).

I think the issue here is that pandoc generates two different types of
files, making it difficult to link to images from another directory:
those that are fundamentally local-based (LaTeX, ODT, etc.) and those
intended for web publication (HTML, S5, etc.).  So I should probably
deal with the links differently depending on the output format (which
I just figured out as I was writing this :s).

-- 
Ivan Lazar Miljenovic
Ivan.Miljenovic-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
IvanMiljenovic.wordpress.com

Re: Cross-platform file generation

[John MacFarlane]

+++ Ivan Lazar Miljenovic [Nov 23 10 07:32 ]:
> On 23 November 2010 03:29, John MacFarlane <fiddlosopher-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> > This doesn't sound like a pandoc problem; it sounds like a problem
> > with the library that generates the images and the corresponding
> > links...
> >
> > If you think it's a pandoc problem, please give a minimal example
> > of how to reproduce it, using only pandoc.
> 
> It's not really a pandoc problem per-se; I was just hoping for
> suggestions on how to deal with this (and the libraries that generate
> the images and links are mine, so there's a very real possibility that
> the problem is indeed mine :p).
> 
> I think the issue here is that pandoc generates two different types of
> files, making it difficult to link to images from another directory:
> those that are fundamentally local-based (LaTeX, ODT, etc.) and those
> intended for web publication (HTML, S5, etc.).  So I should probably
> deal with the links differently depending on the output format (which
> I just figured out as I was writing this :s).

I see.  Well, maybe a case could be made for handling this in pandoc.
If I understand correctly, you'd like to be able to write

![image](path/to/image.jpg)

and have this appear in HTML as

<img src="path/to/image.jpg" alt="image" />

and in LaTeX either as

\includegraphics{path\to\image.jpg}  [if on windows]

or as

\includegraphics{path/to/image.jpg}  [if on *nix]

Currently pandoc just uses the same path (with necessary escaping)
for all output formats.  But it might be possible to do something
fancier.

John

Re: Cross-platform file generation

[Ivan Lazar Miljenovic]

On 23 November 2010 08:07, John MacFarlane <fiddlosopher-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> I see.  Well, maybe a case could be made for handling this in pandoc.
> If I understand correctly, you'd like to be able to write
>
> ![image](path/to/image.jpg)
>
> and have this appear in HTML as
>
> <img src="path/to/image.jpg" alt="image" />
>
> and in LaTeX either as
>
> \includegraphics{path\to\image.jpg}  [if on windows]
>
> or as
>
> \includegraphics{path/to/image.jpg}  [if on *nix]
>
> Currently pandoc just uses the same path (with necessary escaping)
> for all output formats.  But it might be possible to do something
> fancier.

Right, that's the kind of thing I'm talking about.

-- 
Ivan Lazar Miljenovic
Ivan.Miljenovic-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
IvanMiljenovic.wordpress.com

-- 
You received this message because you are subscribed to the Google Groups "pandoc-discuss" group.
To post to this group, send email to pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
To unsubscribe from this group, send email to pandoc-discuss+unsubscribe@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/pandoc-discuss?hl=en.

Re: Cross-platform file generation

[Paul R]

Hi, 

John> and in LaTeX either as
John> \includegraphics{path\to\image.jpg} [if on windows]
John> or as
John> \includegraphics{path/to/image.jpg} [if on *nix]

Most latex compilers will understand unix paths even on windows, so
distinction should not be necessary.


-- 
  Paul

Re: Cross-platform file generation

[Ivan Lazar Miljenovic]

On 23 November 2010 19:49, Paul R <paul.r.ml-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:
> Hi,
>
> John> and in LaTeX either as
> John> \includegraphics{path\to\image.jpg} [if on windows]
> John> or as
> John> \includegraphics{path/to/image.jpg} [if on *nix]
>
> Most latex compilers will understand unix paths even on windows, so
> distinction should not be necessary.

How about the ODT and RTF writers?

-- 
Ivan Lazar Miljenovic
Ivan.Miljenovic-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org
IvanMiljenovic.wordpress.com