RE: [docbook-apps] Pure JS WebHelp

[Wood Nick]

Hi Jan,

Thanks for the update.

Regards

Nick

-Original Message-
From: Jan Tosovsky [mailto:j.tosov...@email.cz] 
Sent: 05 July 2017 22:03
To: docbook-apps@lists.oasis-open.org
Subject: RE: [docbook-apps] Pure JS WebHelp 

On 2017-07-05 Wood Nick wrote:
> 
> I followed your demo on the above subject through docbook-apps and was 
> really impressed with what you have done, there were some calls for 
> you to put your customization on GitHub, I know at the time you were 
> busy, have you been able to upload the stylesheets, if so, could you 
> let me know where to find them.

I was busy with more urgent projects, but I believe in two weeks I could 
publish something.

Btw, the original link is not available any more, that beta version is now in 
production:
https://www.bilyujezd.cz/strucna-historie.html

This site is not a typical use case, but it is something I can show to the 
public.

Regards,

Jan


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


-
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] Pure JS WebHelp

[Jan Tosovsky]

On 2017-07-05 Wood Nick wrote:
> 
> I followed your demo on the above subject through docbook-apps and was
> really impressed with what you have done, there were some calls for you
> to put your customization on GitHub, I know at the time you were busy,
> have you been able to upload the stylesheets, if so, could you let me
> know where to find them.

I was busy with more urgent projects, but I believe in two weeks I could
publish something.

Btw, the original link is not available any more, that beta version is now
in production:
https://www.bilyujezd.cz/strucna-historie.html

This site is not a typical use case, but it is something I can show to the
public.

Regards,

Jan


-
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] Pure JS WebHelp

[Jan Tosovsky]

Thank you all for your positive feedback!

It is the best motivation for me. I am quite busy with other activities, but 
I'll try to move this further later next month.
 
Some answers:

> I notice you're using . Have you tried your XSL with  
> structuring?

Sure, the section element is the first class citizen.

> I'm especially interested to see if this could be adapted 
> to provide features (search, side navigation, etc) to 
> other tools that can only output HTML out of box.

Not sure what is meant by other tools. To enable this functionality (using 
provided scripts) your HTML structure should match the original one (mine). Do 
those tools support generating outputs in a customized structure?

> I'm curious on how you achieved not embedding ToC on every page.

Indeed, there is no XInclude analogy in HTML :-(

On top of that, you cannot access/manipulate local files via JavaScript (i.e. 
read HTML snippet in one file and put it into a dedicated DIV in your file).

However, if your content is static and structured, it can be provided in the 
form of JavaScript object (JSON) and thus linked (e.g. in the HTML header) like 
other JavaScript files. Once loaded, that object is accessible like any other 
global variable. In my customization the nested object structure is 
iterated/converted into HTML's  elements with proper CSS classes. The 
JSON is same for all pages. The current menu item is highlighted dynamically 
via script.

In one huge document (2000 PDF pages) the embedded ToC itself represented ca 2 
MB! In every page. The rest of file size was between 10-600 kB, the total 
package size was ca 150 MB. Loading pages was so sloow.

While the browser has to load the similar size now (just split into two parts), 
it is much faster as that separate ToC (JSON) can be cached and reused for 
other pages.

Jan



-
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] Pure JS WebHelp

[David Cramer]

On 4/16/17 9:46 AM, Jan Tosovsky wrote:
> as promised, I've published a demo output
> https://www.bilyujezd.cz/beta/strucna-historie.html 

Wow, that looks great! It was in need of a refresh. Frontend stuff grows
stale quickly.

> Weaknesses:
> - only modern browsers are supported (Chrome, FF, Edge, IE10+)

That's not a weakness ;-)

...

> - no out-of-the-box scripts for copying dependencies to the target
> destination

It was always tricky to maintain those. Everybody needs something
different and there's no clean "customization layer" mechanism like with
xslt. It is nice to provide something that 'just works out of the box',
and at least something that builds sample output as a test for each
build though.

> Should I put related XSL files and resources to my GitHub account or
> directly to some DocBook sandbox?

I'm sure if you do a PR, others will jump in and help you finish the
integration. It sounds like the format still meets a need for several users.

Regards,
David

-
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] Pure JS WebHelp

[Camille Bégnis]

Hi Jan and all,

that looks really nice and more modern than what we have recently, and
should be more flexible too from what I read.

Hope to see it soon on github.

Cheers,

Camille

Le 16/04/2017 à 16:46, Jan Tosovsky a écrit :
> Dear All,
>
> as promised, I've published a demo output
> https://www.bilyujezd.cz/beta/strucna-historie.html
>
> Core changes against the current WebHelp:
> - responsive design (Mobile First)
> - breadcrumb 
> - improved ToC processing (ToC is linked, not embedded in every HTML file)
> - enhanced search related code (cleaning up the code for better maintenance)
> - enhanced translation support (all messages are stored in standard l10n XML
> files)
> - storing client state even on file system or localhost (utilizing HTML5
> Local Storage)
> - removing jQuery and jQueryUI dependency
>
> Further features:
> - ability to enlarge downsized images (aka lightbox, especially useful for
> SVG images)
> - ability to copy links to specific anchors
> - SASS styling (interpreted into CSS)
>
> Weaknesses:
> - only modern browsers are supported (Chrome, FF, Edge, IE10+)
> - no custom params to override current bahavior
> - no out-of-the-box scripts for copying dependencies to the target
> destination
>
>
> Should I put related XSL files and resources to my GitHub account or
> directly to some DocBook sandbox?
>
> Thanks,
>
> Jan
>
>
> -
> 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] Pure JS WebHelp

[Fekete , Róbert]

Hi Jan,

Many thanks for the examples.

The feature set looks very impressive, like the others, I'd love to see the
XSL files on GitHub.

Thanks a lot!

Robert

On Sun, Apr 16, 2017 at 4:46 PM, Jan Tosovsky  wrote:

> Dear All,
>
> as promised, I've published a demo output
> https://www.bilyujezd.cz/beta/strucna-historie.html
>
> Core changes against the current WebHelp:
> - responsive design (Mobile First)
> - breadcrumb
> - improved ToC processing (ToC is linked, not embedded in every HTML file)
> - enhanced search related code (cleaning up the code for better
> maintenance)
> - enhanced translation support (all messages are stored in standard l10n
> XML
> files)
> - storing client state even on file system or localhost (utilizing HTML5
> Local Storage)
> - removing jQuery and jQueryUI dependency
>
> Further features:
> - ability to enlarge downsized images (aka lightbox, especially useful for
> SVG images)
> - ability to copy links to specific anchors
> - SASS styling (interpreted into CSS)
>
> Weaknesses:
> - only modern browsers are supported (Chrome, FF, Edge, IE10+)
> - no custom params to override current bahavior
> - no out-of-the-box scripts for copying dependencies to the target
> destination
>
>
> Should I put related XSL files and resources to my GitHub account or
> directly to some DocBook sandbox?
>
> Thanks,
>
> Jan
>
>
> -
> 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] Pure JS WebHelp

[David Goss]

It'd be great if you added this to Github.

I'm especially interested to see if this could be adapted to provide features 
(search, side navigation, etc) to other tools that can only output HTML out of 
box.


David Goss, Business Analyst
Frontier Science (www.frontierscience.org)
LDMS (www.ldms.org)

- Original Message -
From: "Barton Wright" <ordin...@gmail.com>
To: "Jan Tosovsky" <j.tosov...@email.cz>
Cc: "docbook-apps" <docbook-apps@lists.oasis-open.org>
Sent: Sunday, April 16, 2017 11:47:50 AM
Subject: Re: [docbook-apps] Pure JS WebHelp

Hi Jan,

Thank you a thousand times for posting this work. 

I vote for an initial upload to GitHub.

I notice you're using . Have you tried your XSL with  
structuring?

Thanks!


On Apr 16, 2017, at 10:46 AM, Jan Tosovsky <j.tosov...@email.cz> wrote:

Dear All,

as promised, I've published a demo output
https://www.bilyujezd.cz/beta/strucna-historie.html

Core changes against the current WebHelp:
- responsive design (Mobile First)
- breadcrumb 
- improved ToC processing (ToC is linked, not embedded in every HTML file)
- enhanced search related code (cleaning up the code for better maintenance)
- enhanced translation support (all messages are stored in standard l10n XML
files)
- storing client state even on file system or localhost (utilizing HTML5
Local Storage)
- removing jQuery and jQueryUI dependency

Further features:
- ability to enlarge downsized images (aka lightbox, especially useful for
SVG images)
- ability to copy links to specific anchors
- SASS styling (interpreted into CSS)

Weaknesses:
- only modern browsers are supported (Chrome, FF, Edge, IE10+)
- no custom params to override current bahavior
- no out-of-the-box scripts for copying dependencies to the target
destination


Should I put related XSL files and resources to my GitHub account or
directly to some DocBook sandbox?

Thanks,

Jan


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



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





-
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] Pure JS WebHelp

[Barton Wright]

Hi Jan,

Thank you a thousand times for posting this work. 

I vote for an initial upload to GitHub.

I notice you're using . Have you tried your XSL with  
structuring?

Thanks!


On Apr 16, 2017, at 10:46 AM, Jan Tosovsky  wrote:

Dear All,

as promised, I've published a demo output
https://www.bilyujezd.cz/beta/strucna-historie.html

Core changes against the current WebHelp:
- responsive design (Mobile First)
- breadcrumb 
- improved ToC processing (ToC is linked, not embedded in every HTML file)
- enhanced search related code (cleaning up the code for better maintenance)
- enhanced translation support (all messages are stored in standard l10n XML
files)
- storing client state even on file system or localhost (utilizing HTML5
Local Storage)
- removing jQuery and jQueryUI dependency

Further features:
- ability to enlarge downsized images (aka lightbox, especially useful for
SVG images)
- ability to copy links to specific anchors
- SASS styling (interpreted into CSS)

Weaknesses:
- only modern browsers are supported (Chrome, FF, Edge, IE10+)
- no custom params to override current bahavior
- no out-of-the-box scripts for copying dependencies to the target
destination


Should I put related XSL files and resources to my GitHub account or
directly to some DocBook sandbox?

Thanks,

Jan


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



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