Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1332144

Re: [RFC] A first shot at asciidoc-based formatted docs

From Keith Packard <keithp@keithp.com>
Newsgroups linux.kernel
Subject Re: [RFC] A first shot at asciidoc-based formatted docs
Date 2016-02-11 16:20 +0100
Message-ID <r11cf-26P-27@gated-at.bofh.it> (permalink)
References (1 earlier) <qVaBA-3Uj-3@gated-at.bofh.it> <r0qw2-2Yx-3@gated-at.bofh.it> <r0y0x-82P-1@gated-at.bofh.it> <r0DCX-3cV-27@gated-at.bofh.it> <r0K1H-7gs-3@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


[Multipart message — attachments visible in raw view] - view raw

Jonathan Corbet <corbet@lwn.net> writes:

> asciidoc->HTML on its own isn't viable, I think; we do have people wanting
> other formats.  Though one might well ask when somebody last successfully
> generated PDF...maybe it's not worth the trouble.  I would like epub
> someday...

I'm hopeful that I can hack up asciidoc to generate usable HTML
directly. Once we've got HTML, we've got epub.

If we don't want to use docbook for pdf, asciidoc has a native latex
backend. That's in about the same shape as the html backend. Would that
be better than docbook?

> There's also people who actually use the man-page output.  I don't think
> that should require the xml step; getting rid of that might make it
> possible to do "make mandocs" and have it finish before the next merge
> window opens...

Adding a troff backend to asciidoc would be simple enough; I'm not sure
what other method you'd suggest here.

> We talked about that a bit in Geelong; the short-term idea was to generate
> a TOC and use CSS to place it correctly.  Daniel, if I heard you correctly,
> you thought that would be a fine solution that would remove the need for
> chunked output.  Keith seemed interested in looking into this too.

Here's an example that takes the docbook output with some simple CSS
hacks to place the TOC alongside the document in a separate scrolling
list. With a small bit of javascript, I'm pretty sure that could have
collapsible entries.

-- 
-keith

Back to linux.kernel | Previous | NextPrevious in thread | Next in thread | Find similar | Unroll thread


Thread

Re: [RFC] A first shot at asciidoc-based formatted docs Jonathan Corbet <corbet@lwn.net> - 2016-02-10 01:10 +0100
  Re: [RFC] A first shot at asciidoc-based formatted docs Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-02-10 09:10 +0100
    Re: [RFC] A first shot at asciidoc-based formatted docs Jani Nikula <jani.nikula@intel.com> - 2016-02-10 15:10 +0100
      Re: [RFC] A first shot at asciidoc-based formatted docs Jani Nikula <jani.nikula@intel.com> - 2016-02-10 17:20 +0100
      Re: [RFC] A first shot at asciidoc-based formatted docs Jonathan Corbet <corbet@lwn.net> - 2016-02-10 22:00 +0100
        Re: [RFC] A first shot at asciidoc-based formatted docs Keith Packard <keithp@keithp.com> - 2016-02-11 16:20 +0100
    Re: [RFC] A first shot at asciidoc-based formatted docs Jonathan Corbet <corbet@lwn.net> - 2016-02-10 21:50 +0100
  Re: [RFC] A first shot at asciidoc-based formatted docs Keith Packard <keithp@keithp.com> - 2016-02-11 00:10 +0100
    Re: [RFC] A first shot at asciidoc-based formatted docs Jani Nikula <jani.nikula@intel.com> - 2016-02-11 14:50 +0100
      Re: [RFC] A first shot at asciidoc-based formatted docs Keith Packard <keithp@keithp.com> - 2016-02-11 16:30 +0100
    Re: [RFC] A first shot at asciidoc-based formatted docs Keith Packard <keithp@keithp.com> - 2016-02-13 04:30 +0100

csiph-web