Documentation and tutorials
87 views
Skip to first unread message
Andreas Jung
Nov 9, 2015, 8:26:02 AM11/9/15
to Vivliostyle Project
Hi there,
the Vivliostyle project is very significant and important...it could be disruptive.
However there is currently a gap between you developers and (us) consumers.
Documentation is king for a successful project.
As I understand the key functionality that must be understood (besides CSS) is
It is possible to learn from these specs and the sample files but this is make Vivliostyle
hard approachable. What is your take on this issue?
For CSS Paged Media I created a small tutorial with some easy and compact samples
that demonstrate a particular aspect of CSS Paged Media (counters, page breaks etc.) instead
of using huge all-in-one examples. We need simple code examples showing how apply EPUB
adaptive layout specs for certain layout aspects in terms of "how can I do a multi-col layout, how
can I place an image inside a page with text flowing around...". In addition we need to document
what CSS and CSS Paged Media rules are supposed to working with Vivliostyle.
In my understanding Vivliostyle does not support and CSS Paged Media rules at all. So we must
document and explain how to do simple things like controlling page breaks etc. ...something in
the sense of a translation of CSS Paged Media rules to EPUB adaptive layout rules.
What do you think?
I would be happy to help here.
Andreas
KAWAKUBO Toru
Nov 9, 2015, 10:05:34 PM11/9/15
to vivli...@googlegroups.com
Hi, thank you for your comments.
> On 2015/11/09, at 22:26, Andreas Jung <zopyx...@gmail.com> wrote:
>
> However there is currently a gap between you developers and (us) consumers.
>
> Documentation is king for a successful project.
We think we should provide some documents from which users can learn how to create documents with (print-related) CSS, but we do not have enough time for it now, prioritizing development.
Sorry for your inconvenience.
> As I understand the key functionality that must be understood (besides CSS) is
>
> http://www.idpf.org/epub/pgt/
>
> It is possible to learn from these specs and the sample files but this is make Vivliostyle
> hard approachable. What is your take on this issue?
>
> For CSS Paged Media I created a small tutorial with some easy and compact samples
> that demonstrate a particular aspect of CSS Paged Media (counters, page breaks etc.) instead
> of using huge all-in-one examples. We need simple code examples showing how apply EPUB
> adaptive layout specs for certain layout aspects in terms of "how can I do a multi-col layout, how
> can I place an image inside a page with text flowing around...". In addition we need to document
> what CSS and CSS Paged Media rules are supposed to working with Vivliostyle.
>
> In my understanding Vivliostyle does not support and CSS Paged Media rules at all. So we must
> document and explain how to do simple things like controlling page breaks etc. ...something in
> the sense of a translation of CSS Paged Media rules to EPUB adaptive layout rules.
>
> What do you think?
Vivliostyle supports CSS Paged Media spec (some features are currently not supported, though) and we recommend users to use it to create documents.
Vivliostyle is based on EPUB Adaptive Layout implementation (by Peter Sorotokin) and supports its features, but it is not on a CSS standards track.
Our primary goal is to make document authoring with standard CSS technology available to everyone, achieved by developing CSS standards and implementing them on our products.
We don’t have documents describing supported CSS Paged Media features yet, though we are planning to create such ones.
For now, we have a list of features implemented (on top of the original Adaptive Layout implementation) on Vivliostyle.js’ Change Log:
https://github.com/vivliostyle/vivliostyle.js/blob/master/CHANGELOG.md
Please look at it to figure out what is available with Vivliostyle currently.
> I would be happy to help here.
We want to provide users good documentations (how to create paged documents with CSS, how to use Vivliostyle as consumers/developers, etc.) in near future.
At the same time, it would be great if you could help us by providing such documents.
For example, your tutorial for CSS Paged Media should be applicable to Vivliostyle without any modification.
(If something does not work, that would be a bug of Vivliostyle, or simply not implemented yet.)
We want to have a list of CSS typesetting references on our web site, and if you don’t mind, we would want to include a link to your tutorial.
It would also be possible to incorporate your documents to ours if you want to.
Since we haven’t started creating documentations yet, any suggestion or proposal would be highly appreciated.
--
Toru Kawakubo （川久保 亮）
Vivliostyle Inc.
http://vivliostyle.com
> On 2015/11/09, at 22:26, Andreas Jung <zopyx...@gmail.com> wrote:
>
> However there is currently a gap between you developers and (us) consumers.
>
> Documentation is king for a successful project.
Sorry for your inconvenience.
> As I understand the key functionality that must be understood (besides CSS) is
>
> http://www.idpf.org/epub/pgt/
>
> It is possible to learn from these specs and the sample files but this is make Vivliostyle
> hard approachable. What is your take on this issue?
>
> For CSS Paged Media I created a small tutorial with some easy and compact samples
> that demonstrate a particular aspect of CSS Paged Media (counters, page breaks etc.) instead
> of using huge all-in-one examples. We need simple code examples showing how apply EPUB
> adaptive layout specs for certain layout aspects in terms of "how can I do a multi-col layout, how
> can I place an image inside a page with text flowing around...". In addition we need to document
> what CSS and CSS Paged Media rules are supposed to working with Vivliostyle.
>
> In my understanding Vivliostyle does not support and CSS Paged Media rules at all. So we must
> document and explain how to do simple things like controlling page breaks etc. ...something in
> the sense of a translation of CSS Paged Media rules to EPUB adaptive layout rules.
>
> What do you think?
Vivliostyle is based on EPUB Adaptive Layout implementation (by Peter Sorotokin) and supports its features, but it is not on a CSS standards track.
Our primary goal is to make document authoring with standard CSS technology available to everyone, achieved by developing CSS standards and implementing them on our products.
We don’t have documents describing supported CSS Paged Media features yet, though we are planning to create such ones.
For now, we have a list of features implemented (on top of the original Adaptive Layout implementation) on Vivliostyle.js’ Change Log:
https://github.com/vivliostyle/vivliostyle.js/blob/master/CHANGELOG.md
Please look at it to figure out what is available with Vivliostyle currently.
> I would be happy to help here.
At the same time, it would be great if you could help us by providing such documents.
For example, your tutorial for CSS Paged Media should be applicable to Vivliostyle without any modification.
(If something does not work, that would be a bug of Vivliostyle, or simply not implemented yet.)
We want to have a list of CSS typesetting references on our web site, and if you don’t mind, we would want to include a link to your tutorial.
It would also be possible to incorporate your documents to ours if you want to.
Since we haven’t started creating documentations yet, any suggestion or proposal would be highly appreciated.
--
Toru Kawakubo （川久保 亮）
Vivliostyle Inc.
http://vivliostyle.com
Andreas Jung
Jan 12, 2016, 7:26:57 AM1/12/16
to Vivliostyle Project
Hi there,
just to let you know:
I am currently preparing a CSS Paged Media workshop at XML Prague and I heavily updated my
tutorial
Although Vivliostyle does not claim to be a full CSS Paged Media converter I included
Vivliostyle Formatter in my comparisons in order to see how it behaves in comparison
to PDFreactor and PrinceXML. Perhaps I will also adding Antennahouse CSS Formatter.
Andreas
Reply all
Reply to author
Forward
0 new messages