EPUB OCF structure

EPUB OCF structure

[Ian Smith]

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

I would like to control the OCF structure produced through the EPUB writer. 
It would seem that I could modify the existing EPUB writer, but I'm 
wondering if there would be need to be code modifications elsewhere. I 
realize this could be done in various ways through post-processing scripts, 
but that would defeat the use of pandoc since nearly all the internal files 
would have to be updated due to the restructuring of the package.

There is nothing wrong with OCF structure being produced today, but I need 
to provide a configurable way to accommodate a custom structure when 
desired.

Looking forward to guidance from the pandoc masters.

Thanks,
Ian

-- 
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/4501c363-9f99-4275-85c2-8a5aebf50f92%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

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

Re: EPUB OCF structure

[Ian Smith]

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

As I mentioned earlier, there is nothing wrong with the OCF structure being 
produced today. It works and meets the defined requirements of the EPUB 
standard. 

Here is the existing structure:

mimetype
META-INF/
     com.apple.ibooks.display-options.xml
     container.xml
media/
    cover.jpg
    fig1.jpg
font.otf
stylesheet.css
content.opf
toc.ncx
ch001.xhtml


I'm looking to achieve the below:


mimetype
META-INF/
     com.apple.ibooks.display-options.xml
     container.xml
EPUB/
     fonts/
         font.otf
     images/
         cover.jpg
         fig1.jpg
     styles/
         stylesheet.css
     content.opf
     toc.ncx
     xhtml/
         ch001.xhtml

-- 
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/5057f41e-2f66-4c84-8750-6f287454871c%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

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

Re: EPUB OCF structure

[John MacFarlane]

Changes would be needed both to
src/Text/Pandoc/Writers/EPUB.hs and to data/odt tree, from
which the reference.odt is constructed.

Just curious why you favor this other arrangement.  If there
are good reasons to do things this way, we could always
change the writer.

+++ Ian Smith [May 10 17 20:47 ]:
>   As I mentioned earlier, there is nothing wrong with the OCF structure
>   being produced today. It works and meets the defined requirements of
>   the EPUB standard.
>   Here is the existing structure:
>
>   mimetype
>
>   META-INF/
>
>        com.apple.ibooks.display-options.xml
>
>        container.xml
>
>   media/
>
>       cover.jpg
>
>       fig1.jpg
>
>   font.otf
>
>   stylesheet.css
>
>   content.opf
>
>   toc.ncx
>
>   ch001.xhtml
>
>   I'm looking to achieve the below:
>
>   mimetype
>
>   META-INF/
>
>        com.apple.ibooks.display-options.xml
>
>        container.xml
>
>   EPUB/
>
>        fonts/
>
>            font.otf
>
>        images/
>
>            cover.jpg
>
>            fig1.jpg
>
>        styles/
>
>            stylesheet.css
>
>        content.opf
>
>        toc.ncx
>
>        xhtml/
>
>            ch001.xhtml
>
>   --
>   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 [1]pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
>   To post to this group, send email to
>   [2]pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
>   To view this discussion on the web visit
>   [3]https://groups.google.com/d/msgid/pandoc-discuss/5057f41e-2f66-4c84-
>   8750-6f287454871c%40googlegroups.com.
>   For more options, visit [4]https://groups.google.com/d/optout.
>
>References
>
>   1. mailto:pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
>   2. mailto:pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
>   3. https://groups.google.com/d/msgid/pandoc-discuss/5057f41e-2f66-4c84-8750-6f287454871c-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org?utm_medium=email&utm_source=footer
>   4. https://groups.google.com/d/optout

Re: EPUB OCF structure

[Ian Smith]

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

The main reason is due to retail channel and IDPF *recommendation*. It is 
strongly recommended by most of the retail channels, that are accepting 
EPUB, to contain all content related files in an organized subdirectory. It 
is also a more organized structure to deal with if anyone has to work on 
the EPUB after it is produced by pandoc.

It's really just a organizational preference, but I think it could be a 
valuable addition to pandoc if the resulting arrangement could be 
configurable. I say configurable, because some recommend "OEBPS", some 
recommend "OPS" and some recommend "EPUB" as the content subdirectory. 
Again, I understand these are all recommendations only and the existing 
output is fully valid and functional against the IDPF specification.

That said, I'd be curious to hear your thoughts.


On Thursday, May 11, 2017 at 2:10:54 PM UTC+5:30, John MacFarlane wrote:
>
> Changes would be needed both to 
> src/Text/Pandoc/Writers/EPUB.hs and to data/odt tree, from 
> which the reference.odt is constructed. 
>
> Just curious why you favor this other arrangement.  If there 
> are good reasons to do things this way, we could always 
> change the writer. 
>
> +++ Ian Smith [May 10 17 20:47 ]: 
> >   As I mentioned earlier, there is nothing wrong with the OCF structure 
> >   being produced today. It works and meets the defined requirements of 
> >   the EPUB standard. 
> >   Here is the existing structure: 
> > 
> >   mimetype 
> > 
> >   META-INF/ 
> > 
> >        com.apple.ibooks.display-options.xml 
> > 
> >        container.xml 
> > 
> >   media/ 
> > 
> >       cover.jpg 
> > 
> >       fig1.jpg 
> > 
> >   font.otf 
> > 
> >   stylesheet.css 
> > 
> >   content.opf 
> > 
> >   toc.ncx 
> > 
> >   ch001.xhtml 
> > 
> >   I'm looking to achieve the below: 
> > 
> >   mimetype 
> > 
> >   META-INF/ 
> > 
> >        com.apple.ibooks.display-options.xml 
> > 
> >        container.xml 
> > 
> >   EPUB/ 
> > 
> >        fonts/ 
> > 
> >            font.otf 
> > 
> >        images/ 
> > 
> >            cover.jpg 
> > 
> >            fig1.jpg 
> > 
> >        styles/ 
> > 
> >            stylesheet.css 
> > 
> >        content.opf 
> > 
> >        toc.ncx 
> > 
> >        xhtml/ 
> > 
> >            ch001.xhtml 
> > 
> >   -- 
>
>

-- 
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/0bd87f12-738f-4220-96fd-ad42b8f17068%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

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

Re: EPUB OCF structure

[Ian Smith]

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

Any thoughts?


On Monday, May 15, 2017 at 5:40:55 PM UTC+5:30, Ian Smith wrote:
>
> The main reason is due to retail channel and IDPF *recommendation*. It is 
> strongly recommended by most of the retail channels, that are accepting 
> EPUB, to contain all content related files in an organized subdirectory. It 
> is also a more organized structure to deal with if anyone has to work on 
> the EPUB after it is produced by pandoc.
>
> It's really just a organizational preference, but I think it could be a 
> valuable addition to pandoc if the resulting arrangement could be 
> configurable. I say configurable, because some recommend "OEBPS", some 
> recommend "OPS" and some recommend "EPUB" as the content subdirectory. 
> Again, I understand these are all recommendations only and the existing 
> output is fully valid and functional against the IDPF specification.
>
> That said, I'd be curious to hear your thoughts.
>
>
> On Thursday, May 11, 2017 at 2:10:54 PM UTC+5:30, John MacFarlane wrote:
>>
>> Changes would be needed both to 
>> src/Text/Pandoc/Writers/EPUB.hs and to data/odt tree, from 
>> which the reference.odt is constructed. 
>>
>> Just curious why you favor this other arrangement.  If there 
>> are good reasons to do things this way, we could always 
>> change the writer. 
>>
>> +++ Ian Smith [May 10 17 20:47 ]: 
>> >   As I mentioned earlier, there is nothing wrong with the OCF structure 
>> >   being produced today. It works and meets the defined requirements of 
>> >   the EPUB standard. 
>> >   Here is the existing structure: 
>> > 
>> >   mimetype 
>> > 
>> >   META-INF/ 
>> > 
>> >        com.apple.ibooks.display-options.xml 
>> > 
>> >        container.xml 
>> > 
>> >   media/ 
>> > 
>> >       cover.jpg 
>> > 
>> >       fig1.jpg 
>> > 
>> >   font.otf 
>> > 
>> >   stylesheet.css 
>> > 
>> >   content.opf 
>> > 
>> >   toc.ncx 
>> > 
>> >   ch001.xhtml 
>> > 
>> >   I'm looking to achieve the below: 
>> > 
>> >   mimetype 
>> > 
>> >   META-INF/ 
>> > 
>> >        com.apple.ibooks.display-options.xml 
>> > 
>> >        container.xml 
>> > 
>> >   EPUB/ 
>> > 
>> >        fonts/ 
>> > 
>> >            font.otf 
>> > 
>> >        images/ 
>> > 
>> >            cover.jpg 
>> > 
>> >            fig1.jpg 
>> > 
>> >        styles/ 
>> > 
>> >            stylesheet.css 
>> > 
>> >        content.opf 
>> > 
>> >        toc.ncx 
>> > 
>> >        xhtml/ 
>> > 
>> >            ch001.xhtml 
>> > 
>> >   -- 
>>
>>

-- 
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/3a041c1f-6389-4e29-a90a-28e5f32baded%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

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

Re: EPUB OCF structure

[John MacFarlane]

Is any configurability needed beyond the ability to specify
a name for the content directory?

+++ Ian Smith [May 31 17 04:25 ]:
>   Any thoughts?
>   On Monday, May 15, 2017 at 5:40:55 PM UTC+5:30, Ian Smith wrote:
>
>   The main reason is due to retail channel and IDPF recommendation. It is
>   strongly recommended by most of the retail channels, that are accepting
>   EPUB, to contain all content related files in an organized
>   subdirectory. It is also a more organized structure to deal with if
>   anyone has to work on the EPUB after it is produced by pandoc.
>   It's really just a organizational preference, but I think it could be a
>   valuable addition to pandoc if the resulting arrangement could be
>   configurable. I say configurable, because some recommend "OEBPS", some
>   recommend "OPS" and some recommend "EPUB" as the content subdirectory.
>   Again, I understand these are all recommendations only and the existing
>   output is fully valid and functional against the IDPF specification.
>   That said, I'd be curious to hear your thoughts.
>   On Thursday, May 11, 2017 at 2:10:54 PM UTC+5:30, John MacFarlane
>   wrote:
>
>     Changes would be needed both to
>     src/Text/Pandoc/Writers/EPUB.hs and to data/odt tree, from
>     which the reference.odt is constructed.
>     Just curious why you favor this other arrangement.  If there
>     are good reasons to do things this way, we could always
>     change the writer.
>     +++ Ian Smith [May 10 17 20:47 ]:
>     >   As I mentioned earlier, there is nothing wrong with the OCF
>     structure
>     >   being produced today. It works and meets the defined
>     requirements of
>     >   the EPUB standard.
>     >   Here is the existing structure:
>     >
>     >   mimetype
>     >
>     >   META-INF/
>     >
>     >        com.apple.ibooks.display-options.xml
>     >
>     >        container.xml
>     >
>     >   media/
>     >
>     >       cover.jpg
>     >
>     >       fig1.jpg
>     >
>     >   font.otf
>     >
>     >   stylesheet.css
>     >
>     >   content.opf
>     >
>     >   toc.ncx
>     >
>     >   ch001.xhtml
>     >
>     >   I'm looking to achieve the below:
>     >
>     >   mimetype
>     >
>     >   META-INF/
>     >
>     >        com.apple.ibooks.display-options.xml
>     >
>     >        container.xml
>     >
>     >   EPUB/
>     >
>     >        fonts/
>     >
>     >            font.otf
>     >
>     >        images/
>     >
>     >            cover.jpg
>     >
>     >            fig1.jpg
>     >
>     >        styles/
>     >
>     >            stylesheet.css
>     >
>     >        content.opf
>     >
>     >        toc.ncx
>     >
>     >        xhtml/
>     >
>     >            ch001.xhtml
>     >
>     >   --
>
>   --
>   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 [1]pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
>   To post to this group, send email to
>   [2]pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
>   To view this discussion on the web visit
>   [3]https://groups.google.com/d/msgid/pandoc-discuss/3a041c1f-6389-4e29-
>   a90a-28e5f32baded%40googlegroups.com.
>   For more options, visit [4]https://groups.google.com/d/optout.
>
>References
>
>   1. mailto:pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
>   2. mailto:pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
>   3. https://groups.google.com/d/msgid/pandoc-discuss/3a041c1f-6389-4e29-a90a-28e5f32baded-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org?utm_medium=email&utm_source=footer
>   4. https://groups.google.com/d/optout

Re: EPUB OCF structure

[Ian Smith]

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

No, I think it is enough to have the content directory name as a 
configurable option.

I see one required change to what I posted earlier in my proposed structure 
that should be made. We should not use 'xhtml' as a subdirectory name 
within the content directory, but rather it should just be 'text'.

mimetype
META-INF/
     com.apple.ibooks.display-options.xml
     container.xml
EPUB/   <<configurable>>
     fonts/
         font.otf
     images/
         cover.jpg
         fig1.jpg
     styles/
         stylesheet.css
     content.opf
     toc.ncx
     text/
         ch001.xhtml

>
>

-- 
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/f6898545-41f6-45ff-bd16-1e8161979e66%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

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

Re: EPUB OCF structure

[John MacFarlane]

I have no objection to changing things along these lines,
if it's useful for some purposes.  Submit an issue to the
github tracker?

+++ Ian Smith [Jun 02 17 00:43 ]:
>   No, I think it is enough to have the content directory name as a
>   configurable option.
>   I see one required change to what I posted earlier in my proposed
>   structure that should be made. We should not use 'xhtml' as a
>   subdirectory name within the content directory, but rather it should
>   just be 'text'.
>   mimetype
>   META-INF/
>        com.apple.ibooks.display-options.xml
>        container.xml
>   EPUB/   <<configurable>>
>        fonts/
>            font.otf
>        images/
>            cover.jpg
>            fig1.jpg
>        styles/
>            stylesheet.css
>        content.opf
>        toc.ncx
>        text/
>            ch001.xhtml
>
>   --
>   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 [1]pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
>   To post to this group, send email to
>   [2]pandoc-discuss-/JYPxA39Uh5TLH3MbocFF+G/Ez6ZCGd0@public.gmane.org
>   To view this discussion on the web visit
>   [3]https://groups.google.com/d/msgid/pandoc-discuss/f6898545-41f6-45ff-
>   bd16-1e8161979e66%40googlegroups.com.
>   For more options, visit [4]https://groups.google.com/d/optout.
>
>References
>
>   1. mailto:pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
>   2. mailto:pandoc-discuss-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org
>   3. https://groups.google.com/d/msgid/pandoc-discuss/f6898545-41f6-45ff-bd16-1e8161979e66-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org?utm_medium=email&utm_source=footer
>   4. https://groups.google.com/d/optout

Re: EPUB OCF structure

[Ian Smith]

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

Sure. Same subject and description enough for you?

On Friday, June 2, 2017 at 2:48:16 PM UTC+5:30, John MacFarlane wrote:
>
> I have no objection to changing things along these lines, 
> if it's useful for some purposes.  Submit an issue to the 
> github tracker? 
>
> +++ Ian Smith [Jun 02 17 00:43 ]: 
> >   No, I think it is enough to have the content directory name as a 
> >   configurable option. 
> >   I see one required change to what I posted earlier in my proposed 
> >   structure that should be made. We should not use 'xhtml' as a 
> >   subdirectory name within the content directory, but rather it should 
> >   just be 'text'. 
> >   mimetype 
> >   META-INF/ 
> >        com.apple.ibooks.display-options.xml 
> >        container.xml 
> >   EPUB/   <<configurable>> 
> >        fonts/ 
> >            font.otf 
> >        images/ 
> >            cover.jpg 
> >            fig1.jpg 
> >        styles/ 
> >            stylesheet.css 
> >        content.opf 
> >        toc.ncx 
> >        text/ 
> >            ch001.xhtml 
> > 
> >   -- 
> >   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 [1]pandoc-discus...-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org <javascript:>. 
> >   To post to this group, send email to 
> >   [2]pandoc-...-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org <javascript:>. 
> >   To view this discussion on the web visit 
> >   [3]
> https://groups.google.com/d/msgid/pandoc-discuss/f6898545-41f6-45ff- 
> >   bd16-1e8161979e66%40googlegroups.com. 
> >   For more options, visit [4]https://groups.google.com/d/optout. 
> > 
> >References 
> > 
> >   1. mailto:pandoc-discuss+unsubscribe-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org <javascript:> 
> >   2. mailto:pandoc-...-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org <javascript:> 
> >   3. 
> https://groups.google.com/d/msgid/pandoc-discuss/f6898545-41f6-45ff-bd16-1e8161979e66-/JYPxA39Uh5TLH3MbocFFw@public.gmane.org?utm_medium=email&utm_source=footer 
> >   4. 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/e1667f53-dcae-4a99-a159-a716c9ca31f7%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

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