Re: [docbook-apps] Show off what you've done with Docbook

2015-09-12 Thread Nils Cordes 
The OpenStack Documetation uses the Apache Maven CloudDocs Plugin (a fork
of Docbkx Tools).

Apache Maven CloudDocs Plugin
https://github.com/rackerlabs/clouddocs-maven-plugin
http://mvnrepository.com/artifact/com.rackspace.cloud.api/clouddocs-maven-plugin/2.1.4

OpenStack API Writers Guide
http://docs.rackspace.com/writers-guide/content/index.html

OpenStack Wiki Documentation HowTo
https://wiki.openstack.org/wiki/Documentation/HowTo



2015-09-12 6:03 GMT+02:00 Gerard Nicol <gerard.ni...@gazillabyte.com>:

> Nils,
>
>
>
> What stylesheets were used to generate the documentation at
> http://docs.openstack.org/ with the table of contents on the right and
> the search box etc at the top?
>
>
>
> It would be great if there was a cookbook for producing documentation that
> looked that good.
>
>
>
> Gerard
>
>
>
> *From:* cordb...@gmail.com [mailto:cordb...@gmail.com] *On Behalf Of *Nils
> Cordes
> *Sent:* Friday, September 11, 2015 12:33 PM
> *To:* Katie Welles <ka...@inkwelle.com>
> *Cc:* docbook-apps@lists.oasis-open.org
> *Subject:* Re: [docbook-apps] Show off what you've done with Docbook
>
>
>
> Example projects using DocBook for documentation:
>
>
>
> OpenStack Documentation: http://docs.openstack.org/
>
>
>
> DAPS (OpenSuse): http://opensuse.github.io/daps/doc/index.html
>
>
>
> PHP Documentation: http://php.net/manual/en/
>
>
>
> Eclipse Jetty: http://www.eclipse.org/jetty/documentation/
>
>
>
> XÖV-STANDARDS UND -VORHABEN:
> http://www.xoev.de/sixcms/detail.php?gsid=bremen83.c.11430.de
>

Re: [docbook-apps] Show off what you've done with Docbook

2015-09-11 Thread Nils Cordes 
Example projects using DocBook for documentation:

OpenStack Documentation: http://docs.openstack.org/

DAPS (OpenSuse): http://opensuse.github.io/daps/doc/index.html

PHP Documentation: http://php.net/manual/en/

Eclipse Jetty: http://www.eclipse.org/jetty/documentation/

XÖV-STANDARDS UND -VORHABEN:
http://www.xoev.de/sixcms/detail.php?gsid=bremen83.c.11430.de



2015-09-11 18:56 GMT+02:00 Katie Welles :

> It’s been a while since I’ve used Docbook or participated in this forum.
>
> I used Docbook a number of years ago to put together a web-based API
> reference system. To be frank, I found it to be a pretty painful project,
> but mainly because I thought it was downright foolish to jump through all
> those Docbook hoops just to output simple HTML. It seems to me that the
> power of Docbook is when your single XML source is used for multiple
> outputs.
>
> I support a consortium that manages 12+ open APIs, and we’ve been
> re-examining the tools we use to output published specs. We know we want
> **all** our API specs to be available as PDF and also HTML, but are not
> sure which tool to bank on. So far we’ve been looking at asciidoc, which I
> find pretty underwhelming.
>
> Have any of you PDF + HTML output with Docbook? If anyone has such a
> project and will be willing to show it off, send some URLs!
>
> As an aside: Have any of you used asciidoc?
>
> (BTW — I use MadCap Flare for another of my clients. The output is
> stunningly beautiful, but the tool is far too unwieldy and expensive for me
> to be able to recommend it to my API client.)
> -
> To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org
> For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org
>
>

Re: [docbook-apps] Docbook to epub - Extra field length for first filename must be 0, but was ..

2014-02-18 Thread Nils Cordes 
Hi,

I'm running Ant inside Eclipse and don't get the validation error.
Maybe the cause for the issue is the filesystem used to create the
zip-file, because filesystems other than EFS add the additional metadata,
which raises the validation error Extra field length for first filename
must be 0, but was 20.

Nils



2014-02-18 8:24 GMT+01:00 Michael Wiedmann m...@miwie.in-berlin.de:

 Lars Vogel wrote o 2014-02-17:
 ...
  I read in Bobs description for epub3 (
  http://sourceforge.net/projects/docbook/files/epub3/) that I need to
  specify -X for the Ant task to avoid this error. Is this something I can
 do
  with the Apache Ant task?

 I could not find any way to use the ant zip task to generate a valid
 epub file due to the missing -X option (if anybody knows how to do it
 coorrect please let us know).

 Workaround might be to use ant's exec task :-(

 Michael



 -
 To unsubscribe, e-mail: docbook-apps-unsubscr...@lists.oasis-open.org
 For additional commands, e-mail: docbook-apps-h...@lists.oasis-open.org

Re: [docbook-apps] Docbook to epub - Extra field length for first filename must be 0, but was ..

2014-02-17 Thread Nils Cordes 
Hey Lars,

I think there is an error in the zip part of your Ant buildfile. Try to
change temp.mimetype to mimetype.zip.

zip destfile=${output.dir}/mimetype.zip ...
zipfileset src=${output.dir}/mimetype.zip ...

Best regards

Nils



2014-02-17 16:32 GMT+01:00 Lars Vogel lars.vo...@gmail.com:

 Hi,

 I'm generating epub from Docbook via Apache Ant and I'm getting the
 following error during the validation with Epubcheck.

  [java] Epubcheck Version 3.0ERROR:
 /home/vogella/workspace/docu/de.vogella.publishing/../output/epub/book.epub:
 Extra field length for first filename must be 0, but was 20

 Any suggestion what might be causing the error.

 I generate the epub via the following snippet (see below).

 Thanks for any help, Lars

  target name=build-epub_eclipsercp description=Generates EPUB files
 from DocBook XML
 xslt style=${epub.stylesheet} extension=.html
 basedir=${output.dir}/tmp2 destdir=${output.dir}/tmp
  include name=*80_Book_Eclipse_RCP*/*book.xml /
 param name=epub.stylesheet expression=style.css /
  param name=html.stylesheet expression=${stylesheet} /
 param name=section.autolabel expression=1 /
  param name=chapter.autolabel expression=1 /
 param name=show.comments expression=0 /
  param name=section.autolabel.max.depth expression=1 /
 param name=toc.section.depth expression=1 /
  param name=section.label.includes.component.label expression=1 /
 param name=make.valid.html expression=1 /
  param name=html.cleanup expression=1 /
 param name=chunker.output.encoding expression=UTF-8 /
  param name=ignore.image.scaling expression=1 /
 outputproperty name=indent value=yes /
  classpath refid=saxon.class.path /
 /xslt

 copy todir=${output.dir}/tmp/OEBPS
  fileset dir=OEBPS
 /fileset
 /copy

 copy todir=${output.dir}/tmp/META-INF
 fileset dir=META-INF
  /fileset
 /copy

 !-- Don't know how to avoid genereation of ${destfilename}.html by
 Saxon --
  delete file=${output.dir}/tmp/book.html /

 echo message=Generating book.epub level=info /

 !-- We create temporary zips so that minetype is the first one in the
 final zip  --
 zip destfile=${output.dir}/temp.mimetype basedir=${output.dir}/tmp
 compress=false includes=mimetype /
  zip destfile=${output.dir}/temp.zip basedir=${output.dir}/tmp/
 level=9 compress=true excludes=mimetype includes=OEBPS/**
 META-INF/** /
  zip destfile=${output.dir}/book.epub update=true
 keepcompression=true encoding=UTF-8 excludes=*.html
  zipfileset src=${output.dir}/temp.mimetype /
 zipfileset src=${output.dir}/temp.zip /
  /zip

 !-- Have to delete these directories would be nicer to place then in tmp
 output dir
  delete dir=./OEBPS /
 delete dir=./META-INF /
 --

 !-- Make sure the epubcheck lib has a subfolder lib with saxon.jar and
 jing.jar in it
 --
  epub.check epub=book /

 /target

Re: [docbook-apps] Docbook to epub - Extra field length for first filename must be 0, but was ..

2014-02-17 Thread Nils Cordes 
Hi Lars,

I had the same issue and fixed it that way.

See the comment of Matt Garrish at http://idpf.org/comment/370#comment-370
When you zip your EPUB, the mimetype file must be the first one you add
(mimetype == 8 characters).

Ciao

Nils


Nils Cordes
Plesser Str. 11
12435 Berlin
Deutschland
Telefon: +49 176 10091551
E-Mail: i...@nilscordes.de
Web: http://nilscordes.de



2014-02-17 17:33 GMT+01:00 Lars Vogel lars.vo...@gmail.com:

 Hi Nils,

 This is IMHI correct, I create it in the first step. Also this seems to be
 unrelated to the error message.

 Best regards, Lars
 Am 17.02.2014 17:28 schrieb Nils Cordes i...@nilscordes.de:

 Hey Lars,

 I think there is an error in the zip part of your Ant buildfile. Try to
 change temp.mimetype to mimetype.zip.

 zip destfile=${output.dir}/mimetype.zip ...
 zipfileset src=${output.dir}/mimetype.zip ...

 Best regards

 Nils



 2014-02-17 16:32 GMT+01:00 Lars Vogel lars.vo...@gmail.com:

 Hi,

 I'm generating epub from Docbook via Apache Ant and I'm getting the
 following error during the validation with Epubcheck.

  [java] Epubcheck Version 3.0ERROR:
 /home/vogella/workspace/docu/de.vogella.publishing/../output/epub/book.epub:
 Extra field length for first filename must be 0, but was 20

 Any suggestion what might be causing the error.

 I generate the epub via the following snippet (see below).

 Thanks for any help, Lars

  target name=build-epub_eclipsercp description=Generates EPUB files
 from DocBook XML
 xslt style=${epub.stylesheet} extension=.html
 basedir=${output.dir}/tmp2 destdir=${output.dir}/tmp
  include name=*80_Book_Eclipse_RCP*/*book.xml /
 param name=epub.stylesheet expression=style.css /
  param name=html.stylesheet expression=${stylesheet} /
 param name=section.autolabel expression=1 /
  param name=chapter.autolabel expression=1 /
 param name=show.comments expression=0 /
  param name=section.autolabel.max.depth expression=1 /
 param name=toc.section.depth expression=1 /
  param name=section.label.includes.component.label expression=1 /
 param name=make.valid.html expression=1 /
  param name=html.cleanup expression=1 /
 param name=chunker.output.encoding expression=UTF-8 /
  param name=ignore.image.scaling expression=1 /
 outputproperty name=indent value=yes /
  classpath refid=saxon.class.path /
 /xslt

 copy todir=${output.dir}/tmp/OEBPS
  fileset dir=OEBPS
 /fileset
 /copy

 copy todir=${output.dir}/tmp/META-INF
 fileset dir=META-INF
  /fileset
 /copy

 !-- Don't know how to avoid genereation of ${destfilename}.html by
 Saxon --
  delete file=${output.dir}/tmp/book.html /

 echo message=Generating book.epub level=info /

 !-- We create temporary zips so that minetype is the first one in the
 final zip  --
 zip destfile=${output.dir}/temp.mimetype basedir=${output.dir}/tmp
 compress=false includes=mimetype /
  zip destfile=${output.dir}/temp.zip basedir=${output.dir}/tmp/
 level=9 compress=true excludes=mimetype includes=OEBPS/**
 META-INF/** /
  zip destfile=${output.dir}/book.epub update=true
 keepcompression=true encoding=UTF-8 excludes=*.html
  zipfileset src=${output.dir}/temp.mimetype /
 zipfileset src=${output.dir}/temp.zip /
  /zip

 !-- Have to delete these directories would be nicer to place then in
 tmp output dir
  delete dir=./OEBPS /
 delete dir=./META-INF /
 --

 !-- Make sure the epubcheck lib has a subfolder lib with saxon.jar and
 jing.jar in it
 --
  epub.check epub=book /

 /target