src/customization/README.md

0001 # Different stylesheets and how to use them
0002
0003 ## kde-chunk.xsl
0004
0005 The standard KDE stylesheet, as used to generate the content for
0006 KHelpCenter.  If you do not specify a stylesheet, this is the default.
0007
0008 This stylesheet includes `kde-navig.xsl`, which controls the
0009 presentation of the top and bottom of the page graphics, and is reused
0010 in other places.  You should probably not call `kde-navig.xsl` on it's own.
0011
0012 ## kde-nochunk.xsl
0013
0014 This is very similar to the standard KDE stylesheet, but it creates
0015 one single html file for the entire document.  This is one way to get
0016 print output, using `html2pdf` or `html2ps`.  It's also usable to create
0017 a "printable version" of a document to link to on a website.
0018
0019 ## kde-style.xsl
0020
0021 All KDE "look and feel" customizations (other than the navigation
0022 graphics in `kde-navig.xsl`) are here. This is where changes to how
0023 things render are placed.  In most cases, the actual rendering is
0024 controlled by the CSS files, and this file simply has the instructions
0025 to ensure class attributes are written into the HTML as necessary, for
0026 the CSS to display.
0027
0028 ## kde-ttlpg.xsl
0029
0030 The Title Page layout for the KDE documentation.  This one covers
0031 customizing the TOC, presentation of legal notices, and a slightly
0032 different navigation graphic.
0033
0034 ## kde-web.xsl
0035 (This stylesheet includes `kde-web-navig.xsl`, which should not be used
0036 directly on it's own)
0037
0038 Simplified version of the KDE stylesheet, aimed at websites.  Content
0039 is constrained to a 680px wide table.  You could use this for example,
0040 to generate web pages that will print nicely and display on older
0041 browsers nicely.
0042
0043 ## kde-chunk-online.xsl
0044 (This stylesheet includes `kde-web-navig-online.xsl`, which should not
0045 be used directly on it's own)
0046
0047 Slightly altered version of the KDE stylesheet, used to generate the
0048 docs.kde.org website, among others.
0049
0050 ## kde-man.xsl
0051
0052 A stylesheet for generating *roff output (for manpages) from DocBook
0053 files. It's virtually the same as the original manpages/docbook.xsl file
0054 from the DocBook XSL package, except that the output file's name is
0055 hardcoded to 'manpage.troff', and the 'Writing manpage.troff' message
0056 is suppressed.
0057