OASIS Mailing List ArchivesView the OASIS mailing list archive below
or browse/search using MarkMail.

 


Help: OASIS Mailing Lists Help | MarkMail Help

docbook-apps message

[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]


Subject: Re: [docbook-apps] Tripane output


Hi Barton,

Thanks for the additional hints, particularly the XMLMind Web Help Compiler! While I'd like to avoid a conversion chain DocBook => XHTML => WebHelp, we might use this as a fallback in case we run into fancy problems with some of our huge docs.

Cheers,

Stefan

On 24.01.2012 16:42, Barton Wright wrote:
Hi Stefan,

You are describing fairly standard Web Help format, except for the
fourth pane for legalese and the placement of the navigation buttons.
Perhaps you could start with one of the standard Web Help generators and
customize it to add those features.

The standard DocBook stylesheets can now generate Web Help output, and
the latest editions of both Oxygen and XXE provide Web Help
transformations, if you want to experiment.

XMLmind just released a free, open source Web Help Compiler
<http://www.xmlmind.com/whc.shtml> that converts any set of static
XHTML, DocBook-generated or not, into Web Help. Example
<http://www.xmlmind.com/xmleditor/_distrib/doc/help/wh/index.html>.

Also look at Eclipse Help running online as an Infocenter. Examples are
the Eclipse help system <http://help.eclipse.org/indigo/index.jsp> and
that of my company.

The advantage of the DocBook-generated Web Help, including XMLmind’s
implementation, is that the URL to the current text page appears in the
browser’s address bar, which allows your readers to bookmark and e-mail
URLs to exact pages. (This is not usually possible in a frames-based
system.) I see that this is also true of the Oracle help system you want
to emulate.

The example
<http://docbook.sourceforge.net/release/xsl/current/webhelp/docs/content/ch01.html>
that Jirka sent shows nav buttons in the top panel like you want. WHC
moves those buttons to the top of the TOC panel.

The advantages of an Eclipse Infocenter are the built-in search and
separate search-in-current-topic features, plus collapsible frames, all
generated for you. Infocenters have the disadvantages that the address
bar does not contain the URL to the current text frame (but there is an
alternate way to generate a URL that opens to an exact page or section
of a page), and that there are no sequential page-by-page nav buttons.
(The yellow arrows are browser-like Back and Next buttons, not
in-sequence-only nav buttons.)

Best of luck!

*From:*Stefan Hinz [mailto:stefan.hinz@oracle.com]
*Sent:* Tuesday, January 24, 2012 9:23 AM
*To:* DocBook Apps
*Subject:* [docbook-apps] Tripane output

Has anyone on this list created a tripane (X)HTML output from DocBook
XML? Something like this (the "live version" is here
<http://docs.oracle.com/cd/E19351-01/821-1927/z40008479112.html>):

Tripane example

That would be:

  * Book title and navigation buttons (prev/next) in top pane
  * TOC in left pane
  * Contents in right pane (chunked XHTML)
  * Legalese in bottom right pane

Bob's fine book explains how to create similar output with frames
(http://www.sagehill.net/docbookxsl/OtherOutputForms.html#Xhtml), but I
need to use something more modern (<div>s). With the DocBook style
sheets, the XHTML created via xsltproc contains lots of <div>
containers. Those <div>s don't have IDs, but that's a fairly
straightforward fix using a customization layer. Once they have IDs, the
respective portions of the XHMTL can be displayed in the appropriate
<div> containers.

The tough thing is to display the TOC in the left <div> at all times. In
our current XHTML output, the TOC is just on the start page.

Has anyone done something similar already? Any pointers appreciated!

--

Cheers,



Stefan Hinz<stefan.hinz@oracle.com>  <mailto:stefan.hinz@oracle.com>, MySQL Documentation Manager



Phone:+49-30-82702940, Fax:+49-30-82702941,http://dev.mysql.com/doc



ORACLE Deutschland B.V.&    Co. KG

Registered Office: Riesstr. 25, 80992 Muenchen, Germany

Commercial Register: Local Court Of Munich, HRA 95603

Managing Director: Jürgen Kunz



General Partner: ORACLE Deutschland Verwaltung B.V.

Hertogswetering 163/167, 3543 AS Utrecht, Niederlande

Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697

Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher



--
Cheers,

Stefan Hinz <stefan.hinz@oracle.com>, MySQL Documentation Manager

Phone: +49-30-82702940, Fax: +49-30-82702941, http://dev.mysql.com/doc

ORACLE Deutschland B.V.&  Co. KG
Registered Office: Riesstr. 25, 80992 Muenchen, Germany
Commercial Register: Local Court Of Munich, HRA 95603
Managing Director: Jürgen Kunz

General Partner: ORACLE Deutschland Verwaltung B.V.
Hertogswetering 163/167, 3543 AS Utrecht, Niederlande
Register Of Chamber Of Commerce: Midden-Niederlande, No. 30143697
Managing Directors: Alexander van der Ven, Astrid Kepper, Val Maher


[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]