docbook.webhelp.docs.ch02s02.html Maven / Gradle / Ivy
Using and customizing the output - - README: Web-based Help from DocBook XML 
README: Web-based Help from DocBook XML
Using the package
To deep link to a topic inside the help set, simply link directly to the page. This help
system uses no frameset, so nothing further is necessary.
Tip
See Chunking into
multiple HTML files in Bob Stayton's DocBook XSL: The Complete
Guide for information on controlling output file names and which files are
chunked in DocBook.
When you perform a search, the results can include brief summaries. These are populated
in one of two ways:
-
By adding role="summary" to a para or
phrase in the chapter or
section.
-
By adding an abstract to the chapterinfo or
sectioninfo element.
To customize the look and feel of the help, study the following css files:
-
docs/common/css/positioning.css: This handles the Positioning
of DIVs in appropriate positions. For example, it causes the
leftnavigation div to appear on the left, the header on top, and so on.
Use this if you need to change the relative positions or need to change the
width/height etc.
-
docs/common/jquery/theme-redmond/jquery-ui-1.8.2.custom.css:
This is the theming part which adds colors and stuff. This is a default theme comes
with jqueryui unchanged. You can get
any theme based your interest from this. (Themes are on right navigation bar.) Then
replace the css theme folder (theme-redmond) with it, and change the xsl to point to
the new css.
-
docs/common/jquery/treeview/jquery.treeview.css: This styles
the toc Tree. Generally, you don't have to edit this file.
