summaryrefslogtreecommitdiffstats
path: root/release/doc/share/xml
diff options
context:
space:
mode:
authorgabor <gabor@FreeBSD.org>2012-10-01 11:26:49 +0000
committergabor <gabor@FreeBSD.org>2012-10-01 11:26:49 +0000
commit53bc32bb8f91732cb52721f120f0430b84dd588b (patch)
tree1410287c535afa9daa3f0a021c7d0562b63dc146 /release/doc/share/xml
parent8c57b62918e6bf3ed93d6642a8d2dada4149c6c5 (diff)
downloadFreeBSD-src-53bc32bb8f91732cb52721f120f0430b84dd588b.zip
FreeBSD-src-53bc32bb8f91732cb52721f120f0430b84dd588b.tar.gz
- Rename .sgml files to .xml to track the recent doc changes
MFC after: 1 day
Diffstat (limited to 'release/doc/share/xml')
-rw-r--r--release/doc/share/xml/Makefile15
-rw-r--r--release/doc/share/xml/catalog15
-rw-r--r--release/doc/share/xml/default.dsl14
-rw-r--r--release/doc/share/xml/release.dsl225
-rw-r--r--release/doc/share/xml/release.ent62
5 files changed, 331 insertions, 0 deletions
diff --git a/release/doc/share/xml/Makefile b/release/doc/share/xml/Makefile
new file mode 100644
index 0000000..d7112ec
--- /dev/null
+++ b/release/doc/share/xml/Makefile
@@ -0,0 +1,15 @@
+# $FreeBSD$
+
+RELN_ROOT?= ${.CURDIR}/../..
+
+.include "${RELN_ROOT}/share/mk/doc.relnotes.mk"
+.include "${DOC_PREFIX}/share/mk/doc.project.mk"
+
+dev-auto.xml: ${MAN4PAGES} ${ARCHLIST} ${MAN2HWNOTES_CMD} catalog-auto
+ ${PERL} ${MAN2HWNOTES_CMD} ${MAN2HWNOTES_FLAGS} -a ${ARCHLIST} -o ${.TARGET} ${MAN4PAGES}
+
+catalog-auto:
+ ${ECHO_CMD} 'PUBLIC "-//FreeBSD//ENTITIES Auto Generated Device Lists//EN"' \
+ '"dev-auto.xml"' > ${.TARGET}
+
+all: dev-auto.xml
diff --git a/release/doc/share/xml/catalog b/release/doc/share/xml/catalog
new file mode 100644
index 0000000..3f91cf0
--- /dev/null
+++ b/release/doc/share/xml/catalog
@@ -0,0 +1,15 @@
+ -- FreeBSD SGML Public Identifiers --
+ -- Release-specific --
+
+ -- $FreeBSD$ --
+
+PUBLIC "-//FreeBSD//ENTITIES Release Specification//EN"
+ "release.ent"
+
+PUBLIC "-//FreeBSD//DOCUMENT Release Notes DocBook Language Neutral Stylesheet//EN"
+ "release.dsl"
+
+PUBLIC "-//FreeBSD//DOCUMENT Release Notes DocBook Stylesheet//EN"
+ "../../en_US.ISO8859-1/share/xml/release.dsl"
+
+
diff --git a/release/doc/share/xml/default.dsl b/release/doc/share/xml/default.dsl
new file mode 100644
index 0000000..58d8231
--- /dev/null
+++ b/release/doc/share/xml/default.dsl
@@ -0,0 +1,14 @@
+<!-- $FreeBSD$ -->
+
+<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
+<!ENTITY release.dsl PUBLIC "-//FreeBSD//DOCUMENT Release Notes DocBook Stylesheet//EN" CDATA DSSSL>
+]>
+
+<style-sheet>
+ <style-specification use="docbook">
+ <style-specification-body>
+ </style-specification-body>
+ </style-specification>
+
+ <external-specification id="docbook" document="release.dsl">
+</style-sheet>
diff --git a/release/doc/share/xml/release.dsl b/release/doc/share/xml/release.dsl
new file mode 100644
index 0000000..66e9ae2
--- /dev/null
+++ b/release/doc/share/xml/release.dsl
@@ -0,0 +1,225 @@
+<!-- $FreeBSD$ -->
+
+<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [
+<!ENTITY % output.html "IGNORE">
+<!ENTITY % output.print "IGNORE">
+<!ENTITY freebsd.dsl PUBLIC "-//FreeBSD//DOCUMENT DocBook Stylesheet//EN" CDATA DSSSL>
+<!ENTITY % release.ent PUBLIC "-//FreeBSD//ENTITIES Release Specification//EN">
+%release.ent;
+]>
+
+<style-sheet>
+ <style-specification use="docbook">
+ <style-specification-body>
+
+; String manipulation functions
+(define (split-string-to-list STR)
+ ;; return list of STR separated with char #\ or #\,
+ (if (string? STR)
+ (let loop ((i (string-delim-index STR)))
+ (cond ((equal? (cdr i) '()) '())
+ (else (cons (substring STR (list-ref i 0) (- (list-ref i 1) 1))
+ (loop (cdr i))))))
+ '()))
+
+(define (string-delim-index STR)
+ ;; return indexes of STR separated with char #\ or #\,
+ (if (string? STR)
+ (let ((strlen (string-length STR)))
+ (let loop ((i 0))
+ (cond ((= i strlen) (cons (+ strlen 1) '()))
+ ((= i 0) (cons i (loop (+ i 1))))
+ ((or (equal? (string-ref STR i) #\ )
+ (equal? (string-ref STR i) #\,)) (cons (+ i 1) (loop (+ i 1))))
+ (else (loop (+ i 1))))))
+ '()
+ ))
+
+(define (string-list-match? STR STR-LIST)
+ (let loop ((s STR-LIST))
+ (cond
+ ((equal? s #f) #f)
+ ((equal? s '()) #f)
+ ((equal? (car s) #f) #f)
+ ((equal? STR (car s)) #t)
+ (else (loop (cdr s))))))
+
+; We might have some sect1 level elements where the modification times
+; are significant. An example of this is the "What's New" section in
+; the release notes. We enable the printing of pubdate entry in
+; sect1info elements to support this.
+(element (sect1info pubdate) (process-children))
+
+ <![ %output.print; [
+; Put URLs in footnotes, and put footnotes at the bottom of each page.
+ (define bop-footnotes #t)
+ (define %footnote-ulinks% #t)
+
+ (define ($paragraph$)
+ (let ((arch (attribute-string (normalize "arch")))
+ (role (attribute-string (normalize "role")))
+ (arch-string (entity-text "arch"))
+ (merged-string (entity-text "merged")))
+ (if (or (equal? (print-backend) 'tex)
+ (equal? (print-backend) #f))
+ ;; avoid using country: characteristic because of a JadeTeX bug...
+ (make paragraph
+ first-line-start-indent: (if (is-first-para)
+ %para-indent-firstpara%
+ %para-indent%)
+ space-before: %para-sep%
+ space-after: (if (INLIST?)
+ 0pt
+ %para-sep%)
+ quadding: %default-quadding%
+ hyphenate?: %hyphenation%
+ language: (dsssl-language-code)
+ (make sequence
+ (cond
+ ;; If arch= not specified, then print unconditionally. This clause
+ ;; handles the majority of cases.
+ ((or (equal? arch #f)
+ (equal? arch "")
+ (equal? arch "all"))
+ (process-children-trim))
+ (else
+ (make sequence
+ (literal "[")
+ (let loop ((prev (car (split-string-to-list arch)))
+ (rest (cdr (split-string-to-list arch))))
+ (make sequence
+ (literal prev)
+ (if (not (null? rest))
+ (make sequence
+ (literal ", ")
+ (loop (car rest) (cdr rest)))
+ (empty-sosofo))))
+ (literal "] ")
+ (process-children-trim))))
+ (if (and (not (null? role)) (equal? role "merged"))
+ (literal " [" merged-string "]")
+ (empty-sosofo))))
+ (make paragraph
+ first-line-start-indent: (if (is-first-para)
+ %para-indent-firstpara%
+ %para-indent%)
+ space-before: %para-sep%
+ space-after: (if (INLIST?)
+ 0pt
+ %para-sep%)
+ quadding: %default-quadding%
+ hyphenate?: %hyphenation%
+ language: (dsssl-language-code)
+ country: (dsssl-country-code)
+ (make sequence
+ (cond
+ ;; If arch= not specified, then print unconditionally. This clause
+ ;; handles the majority of cases.
+ ((or (equal? arch #f)
+ (equal? arch "")
+ (equal? arch "all"))
+ (process-children-trim))
+ (else
+ (make sequence
+ (literal "[")
+ (let loop ((prev (car (split-string-to-list arch)))
+ (rest (cdr (split-string-to-list arch))))
+ (make sequence
+ (literal prev)
+ (if (not (null? rest))
+ (make sequence
+ (literal ", ")
+ (loop (car rest) (cdr rest)))
+ (empty-sosofo))))
+ (literal "] ")
+ (process-children-trim))))
+ (if (and (not (null? role)) (equal? role "merged"))
+ (literal " [" merged-string "]")
+ (empty-sosofo)))))))
+ ]]>
+
+ <![ %output.html; [
+ (define %callout-graphics%
+ ;; Use graphics in callouts?
+ #f)
+
+ <!-- Convert " ... " to `` ... '' in the HTML output. -->
+ (element quote
+ (make sequence
+ (literal "&#8220;")
+ (process-children)
+ (literal "&#8221;")))
+
+ <!-- Specify how to generate the man page link HREF -->
+ (define ($create-refentry-xref-link$ #!optional (n (current-node)))
+ (let* ((r (select-elements (children n) (normalize "refentrytitle")))
+ (m (select-elements (children n) (normalize "manvolnum")))
+ (v (attribute-string (normalize "vendor") n))
+ (u (string-append "&release.man.url;?query="
+ (data r) "&" "sektion=" (data m))))
+ (case v
+ (("xorg") (string-append u "&" "manpath=Xorg+&release.manpath.xorg;" ))
+ (("netbsd") (string-append u "&" "manpath=NetBSD+&release.manpath.netbsd;"))
+ (("ports") (string-append u "&" "manpath=FreeBSD+&release.manpath.freebsd-ports;"))
+ (else (string-append u "&" "manpath=FreeBSD+&release.manpath.freebsd;")))))
+
+ ;; $paragraph$ function with arch attribute support.
+ (define ($paragraph$ #!optional (para-wrapper "P"))
+ (let ((footnotes (select-elements (descendants (current-node))
+ (normalize "footnote")))
+ (tgroup (have-ancestor? (normalize "tgroup")))
+ (arch (attribute-string (normalize "arch")))
+ (role (attribute-string (normalize "role")))
+ (arch-string (entity-text "arch"))
+ (merged-string (entity-text "merged")))
+ (make sequence
+ (make element gi: para-wrapper
+ attributes: (append
+ (if %default-quadding%
+ (list (list "ALIGN" %default-quadding%))
+ '()))
+ (make sequence
+ (cond
+ ;; If arch= not specified, then print unconditionally. This clause
+ ;; handles the majority of cases.
+ ((or (equal? arch #f)
+ (equal? arch "")
+ (equal? arch "all"))
+ (process-children))
+ (else
+ (sosofo-append
+ (make sequence
+ (literal "[")
+ (let loop ((prev (car (split-string-to-list arch)))
+ (rest (cdr (split-string-to-list arch))))
+ (make sequence
+ (literal prev)
+ (if (not (null? rest))
+ (make sequence
+ (literal ", ")
+ (loop (car rest) (cdr rest)))
+ (empty-sosofo))))
+ (literal "] ")
+ (process-children)))))
+ (if (and (not (null? role)) (equal? role "merged"))
+ (literal " [" merged-string "]")
+ (empty-sosofo))
+ (if (or %footnotes-at-end% tgroup (node-list-empty? footnotes))
+ (empty-sosofo)
+ (make element gi: "BLOCKQUOTE"
+ attributes: (list
+ (list "CLASS" "FOOTNOTES"))
+ (with-mode footnote-mode
+ (process-node-list footnotes)))))))))
+ ]]>
+
+ (define (toc-depth nd)
+ (if (string=? (gi nd) (normalize "book"))
+ 3
+ 3))
+
+ </style-specification-body>
+ </style-specification>
+
+ <external-specification id="docbook" document="freebsd.dsl">
+</style-sheet>
diff --git a/release/doc/share/xml/release.ent b/release/doc/share/xml/release.ent
new file mode 100644
index 0000000..60b7130
--- /dev/null
+++ b/release/doc/share/xml/release.ent
@@ -0,0 +1,62 @@
+<!-- -*- sgml -*-
+
+ $FreeBSD$
+
+ OS Release Information -->
+
+<!-- Version of the OS we're describing. This needs to be updated
+ with each new release. -->
+<!ENTITY release.current "9.0-CURRENT">
+
+<!-- The previous version used for comparison in the "What's New"
+ section. For -CURRENT, we might point back to the last
+ branchpoint. -->
+<!ENTITY release.prev "8.0-RELEASE">
+
+<!-- The previous stable release, useful for pointing user's at the
+ release they SHOULD be running if they don't want the bleeding
+ edge. -->
+<!ENTITY release.prev.stable "8.0-RELEASE">
+
+<!-- The next version to be released, usually used for snapshots. -->
+<!ENTITY release.next "9.0-RELEASE">
+
+<!-- The name of this branch. -->
+<!ENTITY release.branch "9-CURRENT">
+
+<!-- The URL for obtaining this version of FreeBSD. -->
+<!ENTITY release.url "http://www.FreeBSD.org/snapshots/">
+
+<!-- The type of release (usually this will be either "snapshot"
+ or "release" -->
+<!ENTITY release.type "snapshot">
+<!ENTITY % release.type.current "INCLUDE">
+<!ENTITY % release.type.snapshot "IGNORE">
+<!ENTITY % release.type.release "IGNORE">
+
+<!-- The manpaths for man page references -->
+<!ENTITY release.man.url "http://www.FreeBSD.org/cgi/man.cgi">
+<!ENTITY release.manpath.xorg "7.5.1">
+<!ENTITY release.manpath.netbsd "5.1">
+<!ENTITY release.manpath.freebsd-ports "Ports">
+<!ENTITY release.manpath.freebsd "9-current">
+
+<!-- Text constants which probably don't need to be changed.-->
+
+<!-- Name of our OS. This is almost certainly going to remain
+ FreeBSD, but we might want to try to do some other formatting or
+ other fancy markup on it in the future. -->
+<!ENTITY os "FreeBSD">
+
+<!-- Architecture names -->
+<!ENTITY arch.amd64 "amd64">
+<!ENTITY arch.arm "arm">
+<!ENTITY arch.i386 "i386">
+<!ENTITY arch.ia64 "ia64">
+<!ENTITY arch.mips "mips">
+<!ENTITY arch.pc98 "pc98">
+<!ENTITY arch.powerpc "powerpc">
+<!ENTITY arch.sparc64 "sparc64">
+
+<!-- The marker for MFCs. -->
+<!ENTITY merged "MERGED">
OpenPOWER on IntegriCloud