docbook-apps

Hello all:

I saw a brief thread about this topic in the list here, but I still don't understand how this can be easily accomplished.

I am trying to get a persistent TOC to output on every page of my Chunked DocBook HTML output. Preferably as a DIV alongside a div of the relevant content.
I guess it would be somewhat like the page header or footer generated with the standard stylesheets when creating chunked HTML. Only instead of being at the top or bottom of each page I am looking for it to appear along the left side, like a navigation bar showing the contents and of course linking to them.
It seems to me like this is not a unique request, and someone could be doing this without excessive customization.
Is there any way to accomplish this using the standard docbook tools?? (stock stylesheets, xsltproc)
If so I would greatly appreciate a pointer in the right direction - even if only to some further documentation.
I would really appreciate it!
Thanks in advance!

/Gregorio

You mean something like this?
http://www.thingbag.net/docbook/gsoc2010/doc/content/ch01.html

That happens to be a GSOC project that Kasun Gajasinghe is working on
right now :-) (Note: I'm his gsoc mentor)

Each page in the webhelp is a single html page. The toc and search tabs
are divs. There are some interesting problems Kasun had to address. For
example, when you go from page to page using the Next button or
crossreferences, you want the toc to preserve its state. So Kasun stores
the state of the toc in a cookie and restores it when you get to the
next page. Likewise with the search. If you did a search and click on a
link in the results, you still want to see the same results on a new
page. With all that going on, performance is an issue for large docs.
We're using the Definitive Guide as our test case for that and have
gotten things working pretty well considering the size of the document:
http://www.thingbag.net/docbook/gsoc2010/defguideout/content/ch01.html

The code is in subversion on the webhelp branch if you want to play with
it.

Currently, Kasun is working on adding stemming and Chinese and Japanese
support to the search. This is a very challenging portion of the
project, so wish him luck! If anyone has expertise in the stemming or in
tokenizing CJKV, we'd love to hear from you :-)

Btw., you may also be interested in the website customization, which is
also a gsoc project and similarly uses a

David:
Yes this is exactly what I am looking to do! Well the collapsable TOC and the Search menu there are extras above the scope of what I am looking for - but I am sure that would more than welcome if I could get that to happen.

It sure looks good, and I am sure Kasun put a heck of a lot of effort into that.... and yes I looked at the source and it is exactly what I would like (no frames/iframes).... only thing I still haven't a clue how to do that. I have messed around with putting the toc in frames, and I really don't want that - nor do I like it.
I can only guess it was extensive customizations, and nothing in the standard stylesheets.
Is there anyway I can get a nudge in the direction of how I could go about generating something similar with my docbook XML?

It really is outstanding work!

Thanks,
/Gregorio







Original Message-----
From: David Cramer <dcramer@motive.com>
To: gpevaco@aol.com; docbook-apps@lists.oasis-open.org
Sent: Wed, Jul 7, 2010 3:14 pm
Subject: RE: [docbook-apps] TOC on every page of DocBook HTML Chunked output


You mean something like this? http://www.thingbag.net/docbook/gsoc2010/doc/content/ch01.html

That happens to be a GSOC project that Kasun Gajasinghe is working on right now :-) (Note: I'm his gsoc mentor)

Each page in the webhelp is a single html page. The toc and search tabs are divs. There are some interesting problems Kasun had to address. For example, when you go from page to page using the Next button or crossreferences, you want the toc to preserve its state. So Kasun stores the state of the toc in a cookie and restores it when you get to the next page. Likewise with the search. If you did a search and click on a link in the results, you still want to see the same results on a new page. With all that going on, performance is an issue for large docs. We're using the Definitive Guide as our test case for that and have gotten things working pretty well considering the size of the document: http://www.thingbag.net/docbook/gsoc2010/defguideout/content/ch01.html

The code is in subversion on the webhelp branch if you want to play with it.

Currently, Kasun is working on adding stemming and Chinese and Japanese support to the search. This is a very challenging portion of the project, so wish him luck! If anyone has expertise in the stemming or in tokenizing CJKV, we'd love to hear from you :-)

Btw., you may also be interested in the website customization, which is also a gsoc project and similarly uses a

to produce a table of contents. In the case of website, however, you're content is an instance of a customized version of the DocBook schema that is optimized for creating websites.

David


From: gpevaco@aol.com [mailto:gpevaco@aol.com]
Sent: Wednesday, July 07, 2010 1:40 PM
To: docbook-apps@lists.oasis-open.org
Subject: [docbook-apps] TOC on every page of DocBook HTML Chunked output



Hello all:

I saw a brief thread about this topic in the list here, but I still don't understand how this can be easily accomplished.

I am trying to get a persistent TOC to output on every page of my Chunked DocBook HTML output. Preferably as a DIV alongside a div of the relevant content.
I guess it would be somewhat like the page header or footer generated with the standard stylesheets when creating chunked HTML. Only instead of being at the top or bottom of each page I am looking for it to appear along the left side, like a navigation bar showing the contents and of course linking to them.
It seems to me like this is not a unique request, and someone could be doing this without excessive customization.
Is there any way to accomplish this using the standard docbook tools?? (stock stylesheets, xsltproc)
If so I would greatly appreciate a pointer in the right direction - even if only to some further documentation.
I would really appreciate it!
Thanks in advance!

/Gregorio

Sure, and welcome to the GSOC2010 Webhelp project test team! ;-)

Your first task will be to test the installation instructions:

http://www.thingbag.net/docbook/gsoc2010/doc/content/ch02s01.html

For step 3 "Download the package", you'll have to get the code from
subversion. Use a subversion client to check out the following:

svn co
https://docbook.svn.sourceforge.net/svnroot/docbook/branches/webhelp/xsl
/webhelp

Email Kasun and me with any questions.

Thanks,
David


________________________________

From: gpevaco@aol.com [mailto:gpevaco@aol.com]
Sent: Wednesday, July 07, 2010 2:49 PM
To: David Cramer; docbook-apps@lists.oasis-open.org
Subject: Re: [docbook-apps] TOC on every page of DocBook HTML
Chunked output



David:
Yes this is exactly what I am looking to do! Well the
collapsable TOC and the Search menu there are extras above the scope of
what I am looking for - but I am sure that would more than welcome if I
could get that to happen.

It sure looks good, and I am sure Kasun put a heck of a lot of
effort into that.... and yes I looked at the source and it is exactly
what I would like (no frames/iframes).... only thing I still haven't a
clue how to do that. I have messed around with putting the toc in
frames, and I really don't want that - nor do I like it.
I can only guess it was extensive customizations, and nothing in
the standard stylesheets.
Is there anyway I can get a nudge in the direction of how I
could go about generating something similar with my docbook XML?

It really is outstanding work!

Thanks,
/Gregorio






Original Message-----
From: David Cramer <dcramer@motive.com>
To: gpevaco@aol.com; docbook-apps@lists.oasis-open.org
Sent: Wed, Jul 7, 2010 3:14 pm
Subject: RE: [docbook-apps] TOC on every page of DocBook HTML
Chunked output


You mean something like this?
http://www.thingbag.net/docbook/gsoc2010/doc/content/ch01.html

That happens to be a GSOC project that Kasun Gajasinghe is
working on right now :-) (Note: I'm his gsoc mentor)

Each page in the webhelp is a single html page. The toc and
search tabs are divs. There are some interesting problems Kasun had to
address. For example, when you go from page to page using the Next
button or crossreferences, you want the toc to preserve its state. So
Kasun stores the state of the toc in a cookie and restores it when you
get to the next page. Likewise with the search. If you did a search and
click on a link in the results, you still want to see the same results
on a new page. With all that going on, performance is an issue for large
docs. We're using the Definitive Guide as our test case for that and
have gotten things working pretty well considering the size of the
document:
http://www.thingbag.net/docbook/gsoc2010/defguideout/content/ch01.html

The code is in subversion on the webhelp branch if you want to
play with it.

Currently, Kasun is working on adding stemming and Chinese and
Japanese support to the search. This is a very challenging portion of
the project, so wish him luck! If anyone has expertise in the stemming
or in tokenizing CJKV, we'd love to hear from you :-)

Btw., you may also be interested in the website customization,
which is also a gsoc project and similarly uses a

to produce a
table of contents. In the case of website, however, you're content is an
instance of a customized version of the DocBook schema that is optimized
for creating websites.

David


________________________________

From: gpevaco@aol.com [mailto:gpevaco@aol.com]
Sent: Wednesday, July 07, 2010 1:40 PM
To: docbook-apps@lists.oasis-open.org
Subject: [docbook-apps] TOC on every page of DocBook
HTML Chunked output



Hello all:

I saw a brief thread about this topic in the list here,
but I still don't understand how this can be easily accomplished.

I am trying to get a persistent TOC to output on every
page of my Chunked DocBook HTML output. Preferably as a DIV alongside a
div of the relevant content.
I guess it would be somewhat like the page header or
footer generated with the standard stylesheets when creating chunked
HTML. Only instead of being at the top or bottom of each page I am
looking for it to appear along the left side, like a navigation bar
showing the contents and of course linking to them.
It seems to me like this is not a unique request, and
someone could be doing this without excessive customization.
Is there any way to accomplish this using the standard
docbook tools?? (stock stylesheets, xsltproc)
If so I would greatly appreciate a pointer in the right
direction - even if only to some further documentation.
I would really appreciate it!
Thanks in advance!

/Gregorio

David:

This is great. I will try it out and let you know.
Thank you very much for the nudge!

/Gregorio







Original Message-----
From: David Cramer <dcramer@motive.com>
To: gpevaco@aol.com; docbook-apps@lists.oasis-open.org
Cc: Kasun Gajasinghe <kasun.gajasinghe@gmail.com>
Sent: Wed, Jul 7, 2010 4:07 pm
Subject: RE: [docbook-apps] TOC on every page of DocBook HTML Chunked output


Sure, and welcome to the GSOC2010 Webhelp project test team! ;-)

Your first task will be to test the installation instructions:

http://www.thingbag.net/docbook/gsoc2010/doc/content/ch02s01.html

For step 3 "Download the package", you'll have to get the code from subversion. Use a subversion client to check out the following:

svn co https://docbook.svn.sourceforge.net/svnroot/docbook/branches/webhelp/xsl/webhelp

Email Kasun and me with any questions.

Thanks,
David


From: gpevaco@aol.com [mailto:gpevaco@aol.com]
Sent: Wednesday, July 07, 2010 2:49 PM
To: David Cramer; docbook-apps@lists.oasis-open.org
Subject: Re: [docbook-apps] TOC on every page of DocBook HTML Chunked output



David:
Yes this is exactly what I am looking to do! Well the collapsable TOC and the Search menu there are extras above the scope of what I am looking for - but I am sure that would more than welcome if I could get that to happen.

It sure looks good, and I am sure Kasun put a heck of a lot of effort into that.... and yes I looked at the source and it is exactly what I would like (no frames/iframes).... only thing I still haven't a clue how to do that. I have messed around with putting the toc in frames, and I really don't want that - nor do I like it.
I can only guess it was extensive customizations, and nothing in the standard stylesheets.
Is there anyway I can get a nudge in the direction of how I could go about generating something similar with my docbook XML?

It really is outstanding work!

Thanks,
/Gregorio







Original Message-----
From: David Cramer <dcramer@motive.com>
To: gpevaco@aol.com; docbook-apps@lists.oasis-open.org
Sent: Wed, Jul 7, 2010 3:14 pm
Subject: RE: [docbook-apps] TOC on every page of DocBook HTML Chunked output


You mean something like this? http://www.thingbag.net/docbook/gsoc2010/doc/content/ch01.html

That happens to be a GSOC project that Kasun Gajasinghe is working on right now :-) (Note: I'm his gsoc mentor)

Each page in the webhelp is a single html page. The toc and search tabs are divs. There are some interesting problems Kasun had to address. For example, when you go from page to page using the Next button or crossreferences, you want the toc to preserve its state. So Kasun stores the state of the toc in a cookie and restores it when you get to the next page. Likewise with the search. If you did a search and click on a link in the results, you still want to see the same results on a new page. With all that going on, performance is an issue for large docs. We're using the Definitive Guide as our test case for that and have gotten things working pretty well considering the size of the document: http://www.thingbag.net/docbook/gsoc2010/defguideout/content/ch01.html

The code is in subversion on the webhelp branch if you want to play with it.

Currently, Kasun is working on adding stemming and Chinese and Japanese support to the search. This is a very challenging portion of the project, so wish him luck! If anyone has expertise in the stemming or in tokenizing CJKV, we'd love to hear from you :-)

Btw., you may also be interested in the website customization, which is also a gsoc project and similarly uses a

to produce a table of contents. In the case of website, however, you're content is an instance of a customized version of the DocBook schema that is optimized for creating websites.

David


From: gpevaco@aol.com [mailto:gpevaco@aol.com]
Sent: Wednesday, July 07, 2010 1:40 PM
To: docbook-apps@lists.oasis-open.org
Subject: [docbook-apps] TOC on every page of DocBook HTML Chunked output



Hello all:

I saw a brief thread about this topic in the list here, but I still don't understand how this can be easily accomplished.

I am trying to get a persistent TOC to output on every page of my Chunked DocBook HTML output. Preferably as a DIV alongside a div of the relevant content.
I guess it would be somewhat like the page header or footer generated with the standard stylesheets when creating chunked HTML. Only instead of being at the top or bottom of each page I am looking for it to appear along the left side, like a navigation bar showing the contents and of course linking to them.
It seems to me like this is not a unique request, and someone could be doing this without excessive customization.
Is there any way to accomplish this using the standard docbook tools?? (stock stylesheets, xsltproc)
If so I would greatly appreciate a pointer in the right direction - even if only to some further documentation.
I would really appreciate it!
Thanks in advance!

/Gregorio

On Thu, Jul 8, 2010 at 1:59 AM, <gpevaco@aol.com> wrote:

> David:
>
> This is great. I will try it out and let you know.
> Thank you very much for the nudge!
>
> /Gregorio
>
>
>
>
Original Message-----
> From: David Cramer <dcramer@motive.com>
> To: gpevaco@aol.com; docbook-apps@lists.oasis-open.org
> Cc: Kasun Gajasinghe <kasun.gajasinghe@gmail.com>
> Sent: Wed, Jul 7, 2010 4:07 pm
> Subject: RE: [docbook-apps] TOC on every page of DocBook HTML Chunked
> output
>
> Sure, and welcome to the GSOC2010 Webhelp project test team! ;-)
>
> Your first task will be to test the installation instructions:
>
> http://www.thingbag.net/docbook/gsoc2010/doc/content/ch02s01.html
>
> For step 3 "Download the package", you'll have to get the code from
> subversion. Use a subversion client to check out the following:
>
> svn co
> https://docbook.svn.sourceforge.net/svnroot/docbook/branches/webhelp/xsl/webhelp
>
>
> Email Kasun and me with any questions.
>
> Thanks,
> David
>
> ------------------------------
> *From:* gpevaco@aol.com [mailto:gpevaco@aol.com <gpevaco@aol.com?>]
> *Sent:* Wednesday, July 07, 2010 2:49 PM
> *To:* David Cramer; docbook-apps@lists.oasis-open.org
> *Subject:* Re: [docbook-apps] TOC on every page of DocBook HTML Chunked
> output
>
> David:
> Yes this is exactly what I am looking to do! Well the collapsable TOC and
> the Search menu there are extras above the scope of what I am looking for -
> but I am sure that would more than welcome if I could get that to happen.
>
> It sure looks good, and I am sure Kasun put a heck of a lot of effort into
> that.... and yes I looked at the source and it is exactly what I would like
> (no frames/iframes).... only thing I still haven't a clue how to do that. I
> have messed around with putting the toc in frames, and I really don't want
> that - nor do I like it.
> I can only guess it was extensive customizations, and nothing in the
> standard stylesheets.
> Is there anyway I can get a nudge in the direction of how I could go about
> generating something similar with my docbook XML?
>
> It really is outstanding work!
>
>
Hello Gregorio,
Thanks and welcome to the team. You'd be the first user of WebHelp! :-)

WebHelp can get to work with few further modifications that will allow all
users to use it out-of-the-box like other DocBook StyleSheets, but we have
to do further testing on what works and what needs to be improved. We will
be working hard to get things done as quickly as we can. You are more than
welcome if you plan to contribute to it, such as fixes you could do or
feature additions (code is at docbook svn branch which David mentioned).
The planned time schedule can be found here:
http://wiki.docbook.org/topic/WebHelpGsoc2010


regards,
/KasunBG

~~~*******'''''''''''''*******~~~
Kasun Gajasinghe,
University of Moratuwa,
Sri Lanka.
Blog: http://kasunbg.blogspot.com
Twitter: http://twitter.com/kasunbg



>
> Thanks,
> /Gregorio
>
>
>
>
Original Message-----
> From: David Cramer <dcramer@motive.com>
> To: gpevaco@aol.com; docbook-apps@lists.oasis-open.org
> Sent: Wed, Jul 7, 2010 3:14 pm
> Subject: RE: [docbook-apps] TOC on every page of DocBook HTML Chunked
> output
>
> You mean something like this?
> http://www.thingbag.net/docbook/gsoc2010/doc/content/ch01.html
>
> That happens to be a GSOC project that Kasun Gajasinghe is working on right
> now :-) (Note: I'm his gsoc mentor)
>
> Each page in the webhelp is a single html page. The toc and search tabs are
> divs. There are some interesting problems Kasun had to address. For
> example, when you go from page to page using the Next button or
> crossreferences, you want the toc to preserve its state. So Kasun stores the
> state of the toc in a cookie and restores it when you get to the next page.
> Likewise with the search. If you did a search and click on a link in the
> results, you still want to see the same results on a new page. With all that
> going on, performance is an issue for large docs. We're using the Definitive
> Guide as our test case for that and have gotten things working pretty well
> considering the size of the document:
> http://www.thingbag.net/docbook/gsoc2010/defguideout/content/ch01.html
>
> The code is in subversion on the webhelp branch if you want to play with
> it.
>
> Currently, Kasun is working on adding stemming and Chinese and Japanese
> support to the search. This is a very challenging portion of the project, so
> wish him luck! If anyone has expertise in the stemming or in tokenizing
> CJKV, we'd love to hear from you :-)
>
> Btw., you may also be interested in the website customization, which is
> also a gsoc project and similarly uses a

to produce a table of
> contents. In the case of website, however, you're content is an instance of
> a customized version of the DocBook schema that is optimized for creating
> websites.
>
> David
>
> ------------------------------
> *From:* gpevaco@aol.com [mailto:gpevaco@aol.com]
> *Sent:* Wednesday, July 07, 2010 1:40 PM
> *To:* docbook-apps@lists.oasis-open.org
> *Subject:* [docbook-apps] TOC on every page of DocBook HTML Chunked output
>
> Hello all:
>
> I saw a brief thread about this topic in the list here, but I still
> don't understand how this can be easily accomplished.
>
> I am trying to get a persistent TOC to output on every page of my Chunked
> DocBook HTML output. Preferably as a DIV alongside a div of the relevant
> content.
> I guess it would be somewhat like the page header or footer generated with
> the standard stylesheets when creating chunked HTML. Only instead of being
> at the top or bottom of each page I am looking for it to appear along the
> left side, like a navigation bar showing the contents and of course linking
> to them.
> It seems to me like this is not a unique request, and someone could be
> doing this without excessive customization.
> Is there any way to accomplish this using the standard docbook tools??
> (stock stylesheets, xsltproc)
> If so I would greatly appreciate a pointer in the right direction - even if
> only to some further documentation.
> I would really appreciate it!
> Thanks in advance!
>
> /Gregorio
>
>
>