From 802da9dd5d4bc18f46a916eedc0c5c1980a15e59 Mon Sep 17 00:00:00 2001 From: Lorry Tar Creator Date: Sun, 17 Mar 2013 20:07:05 +0000 Subject: Imported from /home/lorry/working-area/delta_docbook-xsl/docbook-xsl-1.78.1.tar.bz2. --- webhelp/docs/ch03s01.html | 155 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 155 insertions(+) create mode 100644 webhelp/docs/ch03s01.html (limited to 'webhelp/docs/ch03s01.html') diff --git a/webhelp/docs/ch03s01.html b/webhelp/docs/ch03s01.html new file mode 100644 index 0000000..5ee1ecc --- /dev/null +++ b/webhelp/docs/ch03s01.html @@ -0,0 +1,155 @@ + + + + +Design - - README: Web-based Help from DocBook XML

Design

+

An overview of webhelp page structure.

DocBook WebHelp page structure is fully built on css-based design abandoning frameset + structure. Overall page structure can be divided in to three main sections

  • Header: Header is a separate Div which include company logo, navigation + button(prev, next etc.), page title and heading of parent topic.

  • Content: This includes the content of the documentation. The processing of this + part is done by DocBook + XSL Chunking customization. Few further css-styling applied from + positioning.css.

  • Left Navigation: This includes the table of contents and search tab. This is + customized using jquery-ui styling.

    • Tabbed Navigation: The navigation pane is organized in to two tabs. Contents + tab, and Search tab. Tabbed output is achieved using JQuery Tabs plugin.

    • Table of Contents (TOC) tree: When building the chunked html from the docbook + file, Table of Contents is generated as an Unordered List (a list made from + <ul> <li> tags). When page loads in the browser, we apply + styling to it to achieve the nice look that you see. Styling for TOC tree is done + by a JQuery UI plugin called + TreeView. We can generate the tree easily by following javascript code: + 

      +//Generate the tree
+$("#tree").treeview({
+collapsed: true,
+animated: "medium",
+control: "#sidetreecontrol",
+persist: "cookie"
+});
+

      +

    • Search Tab: This includes the search feature.

+

Prev Up Next
 Home 
-- cgit v1.2.1