os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
doc/share/sgml/freebsd.dsl

564 lines
21 KiB
Text
Raw Normal View History

Use DSSSL's (next-match) function to fall through to next most specific construction rule instead of duplicating code when we want to conditionally alter the stylsheets. Suggested by: Norman Walsh Referenced in: ISO/IEC 10179:1996(E) p180-181
2001-07-27 23:16:55 +02:00
<!-- $FreeBSD: doc/share/sgml/freebsd.dsl,v 1.42 2001/07/24 23:09:25 chern Exp $ -->
Add $FreeBSD$ comment. Submitted by: billf
1999-11-15 20:44:15 +01:00
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
Reorganise things a little bit. Redefine two functions in <[ %output.print; [ ... ]]> to support image handling.
2000-10-08 21:15:06 +02:00
<!ENTITY % output.html "IGNORE">
<!ENTITY % output.html.images "IGNORE">
<!ENTITY % output.print "IGNORE">
<!ENTITY % output.print.pdf "IGNORE">
Give each language and encoding it's own freebsd.dsl, to contain style sheet definitions for that language only. Each file reads in the defaults from the master share/sgml/freebsd.dsl file, and adds overrides, or new definitions, as necessary. Move the per-language hacks from share/sgml/freebsd.dsl in to <lang>/share/sgml/freebsd.dsl as necessary. Add links to the -questions and -doc mailing lists to the bottom of the generated HTML output for some languages. The -questions link will become a link to Greg's "Getting the most from questions" document when I bring that in, but I haven't done that yet, and I didn't want these patches hanging around my local tree. This was the real reason for making freebsd.dsl language local, as it makes it much easier to translate generated text, such as the text of the links, without polluting share/sgml/freebsd.dsl. Update doc.docbook.mk to use the new, per-language freebsd.dsl file when building the docs. While I'm here, update .pdb generation so that it creates a symlink to ${CURDIR:T}.pdb as well (e.g., the Handbook generates "book.pdb" and "handbook.pdb"). This makes it easier to install more than one document on a Palm, because two docs called "book.pdb" or "article.pdb" can not co-exist.
2000-03-23 10:00:17 +01:00
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
<![ %output.html; [
<!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook HTML Stylesheet//EN" CDATA DSSSL>
]]>
<![ %output.print; [
<!ENTITY docbook.dsl PUBLIC "-//Norman Walsh//DOCUMENT DocBook Print Stylesheet//EN" CDATA DSSSL>
Give each language and encoding it's own freebsd.dsl, to contain style sheet definitions for that language only. Each file reads in the defaults from the master share/sgml/freebsd.dsl file, and adds overrides, or new definitions, as necessary. Move the per-language hacks from share/sgml/freebsd.dsl in to <lang>/share/sgml/freebsd.dsl as necessary. Add links to the -questions and -doc mailing lists to the bottom of the generated HTML output for some languages. The -questions link will become a link to Greg's "Getting the most from questions" document when I bring that in, but I haven't done that yet, and I didn't want these patches hanging around my local tree. This was the real reason for making freebsd.dsl language local, as it makes it much easier to translate generated text, such as the text of the links, without polluting share/sgml/freebsd.dsl. Update doc.docbook.mk to use the new, per-language freebsd.dsl file when building the docs. While I'm here, update .pdb generation so that it creates a symlink to ${CURDIR:T}.pdb as well (e.g., the Handbook generates "book.pdb" and "handbook.pdb"). This makes it easier to install more than one document on a Palm, because two docs called "book.pdb" or "article.pdb" can not co-exist.
2000-03-23 10:00:17 +01:00
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
]]>
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
]>
<style-sheet>
<style-specification use="docbook">
<style-specification-body>
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
<!-- HTML only .................................................... -->
<![ %output.html; [
<!-- Configure the stylesheet using documented variables -->
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
(define %gentext-nav-use-tables%
;; Use tables to build the navigation headers and footers?
#t)
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
(define %html-ext%
;; Default extension for HTML output files
".html")
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
(define %shade-verbatim%
;; Should verbatim environments be shaded?
#f)
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
(define %use-id-as-filename%
;; Use ID attributes as name for component HTML files?
#t)
- Turn on the use of tables to build navigation headers/footers - Turn off the shading of verbatim environments. Replace with our own scheme which wraps these in <blockquote>, more in keeping with other documents. - Specify the root filename for the HTML version as 'index.html'
1998-11-04 23:41:50 +01:00
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
(define %root-filename%
;; Name for the root HTML document
"index")
Turned on the generation of the HTML.manifest file (this used to be on by default, looks like the default's changed with version 1.30 of the stylesheets).
1999-01-02 18:08:45 +01:00
(define html-manifest
;; Write a manifest?
Removed the reference to handbook.css, that shouldn't be in there yet. Turned html-manifest from #t to #f. This can be set to #t via an option to jade(1), but the reverse is not true.
1999-01-28 00:29:14 +01:00
#f)
Rudimentary support for <segmentedlist>. Just builds a table for the entries, and works for HTML output only.
1999-09-03 19:12:43 +02:00
Turn on %generate-legalnotice-link%. This makes the word "Copyright" in generated HTML link to the legalnotice, if the document has one. Requested by several people on -doc (all of whom probably thought this would be quite a lot of effort, heh heh heh).
2001-02-13 20:21:31 +01:00
(define %generate-legalnotice-link%
;; Should legal notices be a link to a separate file?
;;
;; Naturally, this has no effect if you're building one big
;; HTML file.
#t)
Fix a typo, and make sure that ISBN numbers in the front matter are included.
2001-04-09 22:35:47 +02:00
(define (book-titlepage-recto-elements)
(list (normalize "title")
(normalize "subtitle")
(normalize "graphic")
(normalize "mediaobject")
(normalize "corpauthor")
(normalize "authorgroup")
(normalize "author")
(normalize "editor")
(normalize "copyright")
(normalize "abstract")
(normalize "legalnotice")
(normalize "isbn")))
Give each language and encoding it's own freebsd.dsl, to contain style sheet definitions for that language only. Each file reads in the defaults from the master share/sgml/freebsd.dsl file, and adds overrides, or new definitions, as necessary. Move the per-language hacks from share/sgml/freebsd.dsl in to <lang>/share/sgml/freebsd.dsl as necessary. Add links to the -questions and -doc mailing lists to the bottom of the generated HTML output for some languages. The -questions link will become a link to Greg's "Getting the most from questions" document when I bring that in, but I haven't done that yet, and I didn't want these patches hanging around my local tree. This was the real reason for making freebsd.dsl language local, as it makes it much easier to translate generated text, such as the text of the links, without polluting share/sgml/freebsd.dsl. Update doc.docbook.mk to use the new, per-language freebsd.dsl file when building the docs. While I'm here, update .pdb generation so that it creates a symlink to ${CURDIR:T}.pdb as well (e.g., the Handbook generates "book.pdb" and "handbook.pdb"). This makes it easier to install more than one document on a Palm, because two docs called "book.pdb" or "article.pdb" can not co-exist.
2000-03-23 10:00:17 +01:00
<!-- This is the text to display at the bottom of each page.
Defaults to nothing. The individual stylesheets should
redefine this as necessary. -->
(define ($email-footer$)
(empty-sosofo))
Select the right .index file depending on whether the output is being chunked or not.
2001-06-16 23:30:11 +02:00
(define html-index-filename
(if nochunks
"html.index"
"html-split.index"))
Turn on the use of the stylesheet. Remove the code that caries out special formatting for questions, as the stylesheets now do this. Interested parties can look at http://people.freebsd.org/~nik/faq-css/ for an idea of how the new stylesheets render.
2001-06-18 16:29:16 +02:00
(define %stylesheet%
"docbook.css")
Give each language and encoding it's own freebsd.dsl, to contain style sheet definitions for that language only. Each file reads in the defaults from the master share/sgml/freebsd.dsl file, and adds overrides, or new definitions, as necessary. Move the per-language hacks from share/sgml/freebsd.dsl in to <lang>/share/sgml/freebsd.dsl as necessary. Add links to the -questions and -doc mailing lists to the bottom of the generated HTML output for some languages. The -questions link will become a link to Greg's "Getting the most from questions" document when I bring that in, but I haven't done that yet, and I didn't want these patches hanging around my local tree. This was the real reason for making freebsd.dsl language local, as it makes it much easier to translate generated text, such as the text of the links, without polluting share/sgml/freebsd.dsl. Update doc.docbook.mk to use the new, per-language freebsd.dsl file when building the docs. While I'm here, update .pdb generation so that it creates a symlink to ${CURDIR:T}.pdb as well (e.g., the Handbook generates "book.pdb" and "handbook.pdb"). This makes it easier to install more than one document on a Palm, because two docs called "book.pdb" or "article.pdb" can not co-exist.
2000-03-23 10:00:17 +01:00
<!-- This code handles displaying $email-footer$ at the bottom
of each page.
Fix a typo, and make sure that ISBN numbers in the front matter are included.
2001-04-09 22:35:47 +02:00
If "nochunks" is turned on then we make sure that an <hr>
Give each language and encoding it's own freebsd.dsl, to contain style sheet definitions for that language only. Each file reads in the defaults from the master share/sgml/freebsd.dsl file, and adds overrides, or new definitions, as necessary. Move the per-language hacks from share/sgml/freebsd.dsl in to <lang>/share/sgml/freebsd.dsl as necessary. Add links to the -questions and -doc mailing lists to the bottom of the generated HTML output for some languages. The -questions link will become a link to Greg's "Getting the most from questions" document when I bring that in, but I haven't done that yet, and I didn't want these patches hanging around my local tree. This was the real reason for making freebsd.dsl language local, as it makes it much easier to translate generated text, such as the text of the links, without polluting share/sgml/freebsd.dsl. Update doc.docbook.mk to use the new, per-language freebsd.dsl file when building the docs. While I'm here, update .pdb generation so that it creates a symlink to ${CURDIR:T}.pdb as well (e.g., the Handbook generates "book.pdb" and "handbook.pdb"). This makes it easier to install more than one document on a Palm, because two docs called "book.pdb" or "article.pdb" can not co-exist.
2000-03-23 10:00:17 +01:00
is shown first.
Then create a centered paragraph ("<p>"), and reduce the font
size ("<small>"). Then run $email-footer$, which should
create the text and links as necessary. -->
(define ($html-body-end$)
(if (equal? $email-footer$ (normalize ""))
(empty-sosofo)
(make sequence
(if nochunks
(make empty-element gi: "hr")
(empty-sosofo))
Turn off the 'heading level characteristic' option. It breaks the Handbook PDF build.
2001-02-20 20:17:26 +01:00
($email-footer$))))
Turn on callout graphics. Forgot this from about a week ago.
2000-07-25 12:31:35 +02:00
Add a new variable, %refentry-xref-link% which determines whether or not man page references (&man.ls.1;, etc) are converted in to links to the man->HTML CGI on freebsd.org. Defaults to off. Redefine the code for the <citerefentry> element to use this variable.
2001-03-24 10:40:24 +01:00
(define %refentry-xref-link%
;; REFENTRY refentry-xref-link
;; PURP Generate URL links when cross-referencing RefEntrys?
;; DESC
;; If true, a web link will be generated, presumably
;; to an online man->HTML gateway. The text of the link is
;; generated by the $create-refentry-xref-link$ function.
;; /DESC
;; AUTHOR N/A
;; /REFENTRY
#f)
Add a default $create-refentry-xref-link$ function.
2001-04-05 15:19:59 +02:00
; Empty function to quiet warnings
(define ($create-refentry-xref-link$ refentrytitle manvolnum)
(literal ""))
Add a new variable, %refentry-xref-link% which determines whether or not man page references (&man.ls.1;, etc) are converted in to links to the man->HTML CGI on freebsd.org. Defaults to off. Redefine the code for the <citerefentry> element to use this variable.
2001-03-24 10:40:24 +01:00
(element citerefentry
Turn on the use of the stylesheet. Remove the code that caries out special formatting for questions, as the stylesheets now do this. Interested parties can look at http://people.freebsd.org/~nik/faq-css/ for an idea of how the new stylesheets render.
2001-06-18 16:29:16 +02:00
(let* ((refentrytitle (select-elements (children (current-node))
Add a new variable, %refentry-xref-link% which determines whether or not man page references (&man.ls.1;, etc) are converted in to links to the man->HTML CGI on freebsd.org. Defaults to off. Redefine the code for the <citerefentry> element to use this variable.
2001-03-24 10:40:24 +01:00
(normalize "refentrytitle")))
Turn on the use of the stylesheet. Remove the code that caries out special formatting for questions, as the stylesheets now do this. Interested parties can look at http://people.freebsd.org/~nik/faq-css/ for an idea of how the new stylesheets render.
2001-06-18 16:29:16 +02:00
(manvolnum (select-elements (children (current-node))
Add a new variable, %refentry-xref-link% which determines whether or not man page references (&man.ls.1;, etc) are converted in to links to the man->HTML CGI on freebsd.org. Defaults to off. Redefine the code for the <citerefentry> element to use this variable.
2001-03-24 10:40:24 +01:00
(normalize "manvolnum")))
Turn on the use of the stylesheet. Remove the code that caries out special formatting for questions, as the stylesheets now do this. Interested parties can look at http://people.freebsd.org/~nik/faq-css/ for an idea of how the new stylesheets render.
2001-06-18 16:29:16 +02:00
(href ($create-refentry-xref-link$
Add a new variable, %refentry-xref-link% which determines whether or not man page references (&man.ls.1;, etc) are converted in to links to the man->HTML CGI on freebsd.org. Defaults to off. Redefine the code for the <citerefentry> element to use this variable.
2001-03-24 10:40:24 +01:00
(data refentrytitle)
(data manvolnum))))
Turn on the use of the stylesheet. Remove the code that caries out special formatting for questions, as the stylesheets now do this. Interested parties can look at http://people.freebsd.org/~nik/faq-css/ for an idea of how the new stylesheets render.
2001-06-18 16:29:16 +02:00
(if %refentry-xref-link%
(create-link (list (list "HREF" href))
Add a new variable, %refentry-xref-link% which determines whether or not man page references (&man.ls.1;, etc) are converted in to links to the man->HTML CGI on freebsd.org. Defaults to off. Redefine the code for the <citerefentry> element to use this variable.
2001-03-24 10:40:24 +01:00
(if %refentry-xref-italic%
($italic-seq$)
($charseq$)))
(if %refentry-xref-italic%
($italic-seq$)
($charseq$)))))
Introduce a <port> element that answers the question of how to mark up a port name. Right now, it renders as monospace, and with a hyperlink to the port's pkg-descr file if possible.
2001-07-24 13:07:59 +02:00
(element port
(let* ((urlurl "http://www.FreeBSD.org/cgi/url.cgi")
(href (string-append urlurl "?ports/"
(data (current-node)))))
(create-link (list (list "HREF" href))
($mono-seq$))))
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
]]>
Reorganise things a little bit. Redefine two functions in <[ %output.print; [ ... ]]> to support image handling.
2000-10-08 21:15:06 +02:00
<!-- HTML with images ............................................ -->
<![ %output.html.images [
Image support has been mangled since the move to docbook.css. This adds a new mediaobject handler to simplify the output HTML so that images no longer overlap the text and other nearby images. The output HTML used to look like this : <div class="MEDIAOBJECT"> <p><img src="fig2.png"></p> </div> The problem was that the image would be displayed on top of nearby text or image elements completely obscuring the previous contents rather than doing proper page layout. With this change, the above now simply looks like this : <img src="fig2.png"> An alternative solution would be to fix docbook.css, but I think that the problem stems from the way that different browsers implement CSS. It is easier to just fix it here at the DSSSL level.
2001-06-24 04:46:40 +02:00
; The new Cascading Style Sheets for the HTML output are very confused
; by our images when used with div class="mediaobject". We can
; clear up the confusion by ignoring the whole mess and just
; displaying the image.
(element mediaobject
(if (node-list-empty? (select-elements (children (current-node)) (normalize "imageobject")))
(process-children)
(process-node-list (select-elements (children (current-node)) (normalize "imageobject")))))
Reorganise things a little bit. Redefine two functions in <[ %output.print; [ ... ]]> to support image handling.
2000-10-08 21:15:06 +02:00
(define %graphic-default-extension%
"png")
(define %callout-graphics%
;; Use graphics in callouts?
#t)
(define %callout-graphics-ext%
;; The extension to use for callout images. This is an extension
;; to the stylesheets, they do not support this functionality
;; natively.
".png")
(define %callout-graphics-path%
;; Path to callout graphics
"./imagelib/callouts/")
;; Redefine $callout-bug$ to support the %callout-graphic-ext%
;; variable.
(define ($callout-bug$ conumber)
(let ((number (if conumber (format-number conumber "1") "0")))
(if conumber
(if %callout-graphics%
(if (<= conumber %callout-graphics-number-limit%)
(make empty-element gi: "IMG"
attributes: (list (list "SRC"
(root-rel-path
(string-append
%callout-graphics-path%
number
%callout-graphics-ext%)))
(list "HSPACE" "0")
(list "VSPACE" "0")
(list "BORDER" "0")
(list "ALT"
(string-append
"(" number ")"))))
(make element gi: "B"
(literal "(" (format-number conumber "1") ")")))
(make element gi: "B"
(literal "(" (format-number conumber "1") ")")))
(make element gi: "B"
(literal "(??)")))))
]]>
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
<!-- Print only ................................................... -->
<![ %output.print; [
Introduce a new handbook-specific knob ``WITH_PGPKEYS'' and add the relevant functions to the DSSSL stylesheet. The default behavior is for print output formats to just display PGP fingerprints unless you use `make WITH_PGPKEYS=1 FORMATS=ps'. This new default behavior reduces the size of Appendix E from 52 pages to 9 pages, and that could be trimmed down more with a more efficient layout for the fingerprints (does each entry really warrant a new section header?) Knob requested by: Chris Costello Discussed on: -doc
2001-07-12 03:40:31 +02:00
(define withpgpkeys
#f)
Correctly display local file links in the print stylesheet. Local-file URLs are encoded as file://localhost/path/file which is fine for HTML but this looks ugly when printed. Add a function to chop off the "file://localhost" so that the above URL would be printed as "/path/file" but still link to "file://localhost/path/file" for HTML output.
2001-07-20 06:59:28 +02:00
;; If a link is entered as "file://localhost/usr/ports" in the docs
;; then we only want to display "/usr/ports" in printed form.
(define (fix-url url)
(if (and (> (string-length url) 15)
(string=? (substring url 0 16) "file://localhost"))
(substring url 16 (string-length url))
url))
Last commit prevented <ulinks> in the index from showing up properly for printed output. This fixes indexterms so that page numbers are displayed following the indexed word/phrase.
2001-07-21 11:09:59 +02:00
(element (primaryie ulink)
(indexentry-link (current-node)))
(element (secondaryie ulink)
(indexentry-link (current-node)))
(element (tertiaryie ulink)
(indexentry-link (current-node)))
Correctly display local file links in the print stylesheet. Local-file URLs are encoded as file://localhost/path/file which is fine for HTML but this looks ugly when printed. Add a function to chop off the "file://localhost" so that the above URL would be printed as "/path/file" but still link to "file://localhost/path/file" for HTML output.
2001-07-20 06:59:28 +02:00
(element ulink
(make sequence
(if (node-list-empty? (children (current-node)))
(literal (fix-url (attribute-string (normalize "url"))))
(make sequence
($charseq$)
(if %footnote-ulinks%
($ss-seq$ + (literal (footnote-number (current-node))))
(if (and %show-ulinks%
(not (equal? (fix-url (attribute-string (normalize "url")))
(data-of (current-node)))))
(make sequence
(literal " (")
(literal (fix-url (attribute-string (normalize "url"))))
(literal ")"))
(empty-sosofo)))))))
In the print stylesheet, keep the ToC to 3 levels of depth or less, and don't indent body text. This reduces the size of the Handbook's PS file by about 1MB, and has similar (although less dramatic) effects on the other documents.
2001-03-04 19:05:19 +01:00
(define (toc-depth nd)
(if (string=? (gi nd) (normalize "book"))
3
1))
Introduce a 'NICE_HEADERS' tuneable knob that creates customized chapter headers that you may find more aesthetically pleasing than the rather spartan chapter headers in Norm's print stylesheets. This option only effects print output formats for English language books. Also move the local-en-label-title-sep customization from share/sgml to en_blah/share/sgml since the best values for this customization depend on the locale. This changes (make FORMATS=ps) : Chapter 7. Users and Basic Account Management 7.1. Synopsis into (make NICE_HEADERS=1 FORMATS=ps) : Chapter 7 /Users and Basic Account Management/ 7.1 Synopsis More work needs to be done for the NICE_HEADERS case to enhance the output, but I think its an improvement.
2001-07-16 07:00:21 +02:00
Introduce a new handbook-specific knob ``WITH_PGPKEYS'' and add the relevant functions to the DSSSL stylesheet. The default behavior is for print output formats to just display PGP fingerprints unless you use `make WITH_PGPKEYS=1 FORMATS=ps'. This new default behavior reduces the size of Appendix E from 52 pages to 9 pages, and that could be trimmed down more with a more efficient layout for the fingerprints (does each entry really warrant a new section header?) Knob requested by: Chris Costello Discussed on: -doc
2001-07-12 03:40:31 +02:00
(element programlisting
(if (and (equal? (attribute-string (normalize "role")) "pgpkey")
(not withpgpkeys))
(empty-sosofo)
Use DSSSL's (next-match) function to fall through to next most specific construction rule instead of duplicating code when we want to conditionally alter the stylsheets. Suggested by: Norman Walsh Referenced in: ISO/IEC 10179:1996(E) p180-181
2001-07-27 23:16:55 +02:00
(next-match)))
Introduce a new handbook-specific knob ``WITH_PGPKEYS'' and add the relevant functions to the DSSSL stylesheet. The default behavior is for print output formats to just display PGP fingerprints unless you use `make WITH_PGPKEYS=1 FORMATS=ps'. This new default behavior reduces the size of Appendix E from 52 pages to 9 pages, and that could be trimmed down more with a more efficient layout for the fingerprints (does each entry really warrant a new section header?) Knob requested by: Chris Costello Discussed on: -doc
2001-07-12 03:40:31 +02:00
In the print stylesheet, keep the ToC to 3 levels of depth or less, and don't indent body text. This reduces the size of the Handbook's PS file by about 1MB, and has similar (although less dramatic) effects on the other documents.
2001-03-04 19:05:19 +01:00
(define %body-start-indent%
0pi)
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
Fix a typo, and make sure that ISBN numbers in the front matter are included.
2001-04-09 22:35:47 +02:00
(define (book-titlepage-verso-elements)
(list (normalize "title")
(normalize "subtitle")
(normalize "corpauthor")
(normalize "authorgroup")
(normalize "author")
(normalize "editor")
(normalize "edition")
(normalize "pubdate")
(normalize "copyright")
(normalize "abstract")
(normalize "legalnotice")
(normalize "revhistory")
(normalize "isbn")))
Reorganise things a little bit. Redefine two functions in <[ %output.print; [ ... ]]> to support image handling.
2000-10-08 21:15:06 +02:00
;; Norm's stylesheets are smart about working out what sort of
;; object to display. But this bites us. Since we know that the
;; first item is going to be displayable, always use that.
(define (find-displayable-object objlist notlist extlist)
(let loop ((nl objlist))
(if (node-list-empty? nl)
(empty-node-list)
(let* ((objdata (node-list-filter-by-gi
(children (node-list-first nl))
(list (normalize "videodata")
(normalize "audiodata")
(normalize "imagedata"))))
(filename (data-filename objdata))
(extension (file-extension filename))
(notation (attribute-string (normalize "format") objdata)))
(node-list-first nl)))))
;; When selecting a filename to use, don't append the default
;; extension, instead, just use the bare filename, and let TeX
;; work it out. jadetex will use the .eps file, while pdfjadetex
;; will use the .png file automatically.
(define (graphic-file filename)
(let ((ext (file-extension filename)))
(if (or tex-backend ;; TeX can work this out itself
(not filename)
(not %graphic-default-extension%)
(member ext %graphic-extensions%))
filename
(string-append filename "." %graphic-default-extension%))))
Hack to select the right image scaling based on the 'format' attribute of the 'imagedata' element.
2001-02-20 20:09:50 +01:00
;; Including bitmaps in the PS and PDF output tends to scale them
;; horribly. The solution is to scale them down by 50%.
;;
;; You could do this with 'imagedata scale="50"' in the source,
;; but that will affect all the output formats that we use (because
;; there is only one 'imagedata' per image).
;;
;; Solution is to have the authors include the "FORMAT" attribute,
;; set to PNG or EPS as appropriate, but to omit the extension.
;; If we're using the tex-backend, and the FORMAT is PNG, and the
;; author hasn't already set a scale, then set scale to 0.5.
;; Otherwise, use the supplied scale, or 1, as appropriate.
(define ($graphic$ fileref
#!optional (display #f) (format #f)
(scale #f) (align #f))
(let* ((graphic-format (if format format ""))
(graphic-scale (if scale
(/ (string->number scale) 100)
(if (and tex-backend
(equal? graphic-format "PNG"))
0.5 1)))
(graphic-align (cond ((equal? align (normalize "center"))
'center)
((equal? align (normalize "right"))
'end)
(else
'start))))
(make external-graphic
entity-system-id: (graphic-file fileref)
notation-system-id: graphic-format
scale: graphic-scale
display?: display
display-alignment: graphic-align)))
Set the heading-level characteristic to '2' if we're generating PDF output. This has the useful side effect of generating bookmarks in the PDF file, which programs like Adobe Acrobat Reader can use to provide a navigable table of contents in a side window. This only seems to work with OpenJade, but the option doesn't cause Jade any problems.
2001-01-08 13:40:52 +01:00
]]>
<![ %output.print.pdf; [
Reorganise things a little bit. Redefine two functions in <[ %output.print; [ ... ]]> to support image handling.
2000-10-08 21:15:06 +02:00
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
]]>
Remove the comment about <FAQList>, that's been obsoleted by DocBook 3.1. Default to labelling questions with "Q:" and answers with "A:" when processing <qandaset>s. In the HTML output, render questions in a larger, bolder font than the answers. Requested by several people on -doc. Default to numbering sections. Requested by one person on -doc, who seemed somewhat confused that I hadn't read his mind and done this three months previously. cvs: ----------------------------------------------------------------------
1999-08-23 23:02:01 +02:00
<!-- Both sets of stylesheets ..................................... -->
(define %section-autolabel%
#t)
Remove old hack to indent verbatim environments, and use new, Norm Walsh sanctioned hack to indent verbatim environments :-) Explicitly turn off formatting a <variablelist> as a table, it's still buggy. Rename "usen-*" to "en-*", as the usage changed in the underlying stylesheets. The leader to a <warning> or <caution> should now have the ":" in the correct position.
1999-04-04 19:08:20 +02:00
(define %may-format-variablelist-as-table%
#f)
(define %indent-programlisting-lines%
" ")
(define %indent-screen-lines%
" ")
Add "legalnotice" to the list of elements that are included on the title page of articles. This necessitates duplicating the entire list in the customisation layer, which will need to be kept up to date as the master stylesheets change.
2000-02-14 02:29:17 +01:00
(define (article-titlepage-recto-elements)
(list (normalize "title")
(normalize "subtitle")
(normalize "corpauthor")
(normalize "authorgroup")
(normalize "author")
(normalize "releaseinfo")
(normalize "copyright")
(normalize "pubdate")
(normalize "revhistory")
(normalize "legalnotice")
(normalize "abstract")))
Reorganise things a little bit. Redefine two functions in <[ %output.print; [ ... ]]> to support image handling.
2000-10-08 21:15:06 +02:00
(define %admon-graphics%
;; Use graphics in admonitions?
#f)
(define %admon-graphics-path%
;; Path to admonition images
"./imagelib/admon/")
(define ($admon-graphic$ #!optional (nd (current-node)))
;; Admonition graphic file
(string-append %admon-graphics-path% (case-fold-down (gi nd)) ".png"))
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
<!-- Slightly deeper customisations -->
<!-- I want things marked up with 'sgmltag' eg.,
<para>You can use <sgmltag>para</sgmltag> to indicate
paragraphs.</para>
to automatically have the opening and closing braces inserted,
and it should be in a mono-spaced font. -->
Add handlers for <chapterinfo>. Also add a handler for <contrib> inside of <author> tags. This should allow us to more formally define contributors to the Handbook.
2001-07-17 04:22:29 +02:00
(element chapterinfo
(process-children))
Wrap author attributions in <sect1info> and <sect2info> as appropriate. I've specifically left JKH's attribution for the "FreeBSD History" section in tact, since this is a first person account of the history of FreeBSD and as such the author needs to be identified in place. This could probably be marked up differently, but its clear that this section is different from all of the other "contributed by XXX" in the Handbook. Also add support for <sect1info> and <sect2info> to the stylsheet so that these attributions get displayed as they have been.
2001-07-21 04:29:59 +02:00
(element sect1info
(process-children))
(element sect2info
(process-children))
Add handlers for <chapterinfo>. Also add a handler for <contrib> inside of <author> tags. This should allow us to more formally define contributors to the Handbook.
2001-07-17 04:22:29 +02:00
(element (chapterinfo authorgroup author)
(make sequence
(process-node-list (select-elements (descendants (current-node))
(normalize "contrib")))
(literal (author-list-string))))
Wrap author attributions in <sect1info> and <sect2info> as appropriate. I've specifically left JKH's attribution for the "FreeBSD History" section in tact, since this is a first person account of the history of FreeBSD and as such the author needs to be identified in place. This could probably be marked up differently, but its clear that this section is different from all of the other "contributed by XXX" in the Handbook. Also add support for <sect1info> and <sect2info> to the stylsheet so that these attributions get displayed as they have been.
2001-07-21 04:29:59 +02:00
(element (sect1info authorgroup author)
(make sequence
(process-node-list (select-elements (descendants (current-node))
(normalize "contrib")))
(literal (author-list-string))))
(element (sect2info authorgroup author)
(make sequence
(process-node-list (select-elements (descendants (current-node))
(normalize "contrib")))
(literal (author-list-string))))
(element (chapterinfo authorgroup)
(process-children))
(element (sect1info authorgroup)
(process-children))
(element (sect2info authorgroup)
(process-children))
Add handlers for <chapterinfo>. Also add a handler for <contrib> inside of <author> tags. This should allow us to more formally define contributors to the Handbook.
2001-07-17 04:22:29 +02:00
(element (author contrib)
(make sequence
(process-children)
(literal " by ")))
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
(element sgmltag ($mono-seq$
(make sequence
(literal "<")
(process-children)
(literal ">"))))
Add some magic which puts double quotes around <errorname> text. Submitted by: nik
2000-07-25 20:23:45 +02:00
<!-- Add double quotes around <errorname> text. -->
(element errorname
(make sequence
<![ %output.html; [ (literal "``") ]]>
($mono-seq$ (process-children))
<![ %output.html; [ (literal "''") ]]>
))
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
<!-- John Fieber's 'instant' translation specification had
'<command>' rendered in a mono-space font, and '<application>'
rendered in bold.
Norm's stylesheet doesn't do this (although '<command>' is
rendered in bold).
Configure the stylesheet to behave more like John's. -->
(element command ($mono-seq$))
Make <envar> show up as monospaced font in printed version. Reviewed by: murray
2001-07-25 01:09:25 +02:00
(element envar ($mono-seq$))
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
(element application ($bold-seq$))
Turn on the use of CSS stylesheets, reading from handbook.css (this will change shortly). Change the represenation of <warning> and <caution> to be similar to the representations for <note>, <tip>, and <important>.
1998-12-05 01:38:14 +01:00
<!-- Warnings and cautions are put in boxed tables to make them stand
out. The same effect can be better achieved using CSS or similar,
so have them treated the same as <important>, <note>, and <tip>
-->
(element warning ($admonition$))
(element (warning title) (empty-sosofo))
(element (warning para) ($admonpara$))
(element (warning simpara) ($admonpara$))
(element caution ($admonition$))
(element (caution title) (empty-sosofo))
(element (caution para) ($admonpara$))
(element (caution simpara) ($admonpara$))
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
<!-- Tell the stylesheet about our local customisations -->
(element hostid ($mono-seq$))
(element username ($mono-seq$))
Introduce a <groupname> tag similar to <username>. I don't forsee it being rendered any differently than <username>, but it's very confusing to write markup with both user and group names in close proximity, and both marked up with <username>.
2001-05-22 05:32:17 +02:00
(element groupname ($mono-seq$))
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
(element devicename ($mono-seq$))
(element maketarget ($mono-seq$))
(element makevar ($mono-seq$))
Put down the crack pipe long enough to revert back to labelling questions with a number, and not just a big "Q". No idea what the hell I was thinking when I did that. Override generate-anchor in the master stylesheets, so that the names (i.e., the <a name="...">) in the HTML output for questions is Qx.y., where x.y is the question number. This is much less likely to change than the AENxxxx format, which changes with every addition or deletion to the FAQ, so it's much easier for people to link to specific questions within the FAQ now. A few whitespace/indentation changes with existing code.
2000-10-28 23:14:44 +02:00
<!-- Override generate-anchor. This is used to generate a unique ID for
each element that can be linked to. The element-id function calls
this one if there's no ID attribute that it can use. Normally, we
would just use the current element number. However, if it's a
a question then use the question's number, as determined by the
question-answer-label function.
This generates anchors of the form "Qx.y.", where x.y is the
question label. This will probably break if question-answer-label
is changed to generate something that might be the same for two
different questions (for example, if question numbering restarts
for each qandaset. -->
(define (generate-anchor #!optional (nd (current-node)))
(cond
((equal? (gi nd) (normalize "question"))
(string-append "Q" (question-answer-label)))
(else
(string-append "AEN" (number->string (all-element-number nd))))))
Add the framework for using <bibliography>. Use the title of the Book in the text and let it be a link to the bibliography entry. Note: The functionality needs JADEFLAGS=-Vbiblio-xref-title in the Makefile Reviewed by: nik, freebsd-doc (original version) Original by: nik
2001-05-20 19:30:44 +02:00
(define (xref-biblioentry target)
(let* ((abbrev (node-list-first
(node-list-filter-out-pis (children target))))
(label (attribute-string (normalize "xreflabel") target)))
(if biblio-xref-title
(let* ((citetitles (select-elements (descendants target)
(normalize "citetitle")))
(titles (select-elements (descendants target)
(normalize "title")))
(isbn (select-elements (descendants target)
(normalize "isbn")))
(publisher (select-elements (descendants target)
(normalize "publishername")))
(title (if (node-list-empty? citetitles)
(node-list-first titles)
(node-list-first citetitles))))
(with-mode xref-title-mode
(make sequence
(process-node-list title))))
(if biblio-number
(make sequence
(literal "[" (number->string (bibentry-number target)) "]"))
(if label
(make sequence
(literal "[" label "]"))
(if (equal? (gi abbrev) (normalize "abbrev"))
(make sequence
(process-node-list abbrev))
(make sequence
(literal "[" (id target) "]"))))))))
The problem is with nested links; quite frankly, they don't work. This isn't normally an issue because no one in their right mind will stick a <link> inside another <link>. However, we have entities which create links, such as &man.*;, &a.*;, etc. It's nice to be able to use these inside links. To deal with this.. Introduce a create-link procedure which will be used to replace (make element gi: "A" ...) constructs. This procedure creates a link as specified only if the can-link-here procecure (described below) returns #t. If the latter returns #f, it will print the link text without the link. The (also new) can-link-here procedure returns #t if it determines that it's okay to make a link in the current context, and #f otherwise. Currently, it does its check by figuring out whether the current context is within a <title> or <question> tag. This is not ideal because it doesn't catch all cases, but it's a lot better than nothing. As the other cases are discovered, this procedure can be modified.
2001-06-03 01:02:13 +02:00
<!-- The (create-link) procedure should be used by all FreeBSD
stylesheets to create links. It calls (can-link-here) to
determine whether it's okay to make a link in the current
position.
This check is necessary because links aren't allowed in,
for example, <question> tags since the latter cause links
to be created by themselves. Obviously, nested links lead
to all kinds of evil. This normally wouldn't be a problem
since no one in their right mind will put a <ulink> or
<link> in a <question>, but it comes up when someone uses,
say, a man page entity (e.g., &man.ls.1;); the latter may
cause a link to be created, but its use inside a <question>
is perfectly legal.
The (can-link-here) routine isn't perfect; in fact, it's a
hack and an ugly one at that. Ideally, it would detect if
the currect output would wind up in an <a> tag and return
#f if that's the case. Slightly less ideally it would
check the current mode and return #f if, say, we're
currently in TOC mode. Right now, it makes a best guess
attempt at guessing which tags might cause links to be
generated. -->
(define (can-link-here)
(cond ((has-ancestor-member? (current-node)
'("TITLE" "QUESTION")) #f)
(#t #t)))
(define (create-link attrlist target)
(if (can-link-here)
(make element gi: "A"
attributes: attrlist
target)
target))
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
</style-specification-body>
</style-specification>
Add the framework for using <bibliography>. Use the title of the Book in the text and let it be a link to the bibliography entry. Note: The functionality needs JADEFLAGS=-Vbiblio-xref-title in the Makefile Reviewed by: nik, freebsd-doc (original version) Original by: nik
2001-05-20 19:30:44 +02:00
Added output.html and output.print as parameter entities to freebsd.dtd. Default to "IGNORE", you should set them to "INCLUDE" by whatever mechanism your SGML parser supports as necessary (i.e., Jade's -i flag). Added redefinitions for some ISO entities that aren't understood by most web browsers. Since this is for HTML output only, wrap it in a %output.html; marked section. Use these marked sections to put both print and HTML stylesheets in one .dsl file (freebsd.dsl). The print stylesheet now understands about the elements that have been added to DocBook (and won't try and render them in red). Updated Makefile to use output.html and output.print on the command line to Jade, instead of the earlier "html" and "print. Note: producing .tex (and thence .ps and .pdf) versions of the Handbook is broken. The Handbook tickles several bugs in the JadeTeX macros. Sebastian Rahz, the JadeTeX author, knows about this, and is working on fixing them.
1998-12-20 21:33:49 +01:00
<external-specification id="docbook" document="docbook.dsl">
This is a DSSSL stylesheet. It builds upon Norm Walsh's modular DocBook stylesheet (ports/textproc/dsssl-docbook-modular) and extends it in three ways. First, Norm's stylesheets have a number of documented 'knobs' that can be twiddled to produce specific effects. For example, one of the options I've turned on names the generated HTML files after the id attribute of a section. Say goodbye to c01234.html, and wave hello to 'kerneloptions.html'. Second, some of Norm's design choices don't follow our existing practice. For example, we indicate application names in bold, command names in a monospace font. Norm's sheets just render command names in bold. So we override his definition with our own for some elements. Thirdly, we tell the stylesheet about elements that don't exist in DocBook but do exist in our extended DTD. Tim Vanderhoek is probably sliding off his seat about now :-) There's more that needs doing to this, but it's enough to get start with.
1998-06-30 10:52:15 +02:00
</style-sheet>
Reference in a new issue Copy permalink