x11proto-scrnsaver: Changes to 'upstream-unstable'
configure.ac | 13 ++--
docbook.am | 105 +++++++++++++++++++++++++++++++++++
specs/.gitignore | 3 -
specs/Makefile.am | 63 ++-------------------
specs/saver.xml | 162 ++++++++++++++++++++++++++++--------------------------
5 files changed, 204 insertions(+), 142 deletions(-)
New commits:
commit c33f4368e85d976b112dda4a34ca254944cb354d
Author: Alan Coopersmith <alan.coopersmith@oracle.com>
Date: Thu Mar 22 20:49:20 2012 -0700
scrnsaverproto 1.2.2
diff --git a/configure.ac b/configure.ac
index f89bd7d..6a70989 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1,5 +1,5 @@
AC_PREREQ([2.60])
-AC_INIT([ScrnSaverProto], [1.2.1],
+AC_INIT([ScrnSaverProto], [1.2.2],
[https://bugs.freedesktop.org/enter_bug.cgi?product=xorg])
AM_INIT_AUTOMAKE([foreign dist-bzip2])
AM_MAINTAINER_MODE
commit 27cf3d03cdd502c1228e59ba560eab77d8393405
Author: Matt Dew <marcoz@osource.org>
Date: Sat Jan 14 22:21:00 2012 -0700
informaltable cleanup
On certain tables, add top and bottom borders to table
header and a bottom border to the table. This matches
what those tables in the old pdfs looked like.
the <?dbfo keep-together='always'> prevents tables from
splitting across pages. Useful for tiny tables.
Converting the colwidth to a floating point,
IE, 1* -> 1.0* cleans up these build errors:
WARNING: table-layout="fixed" and column-width unspecified
=> falling back to proportional-column-width(1)
Signed-off-by: Matt Dew <marcoz@osource.org>
diff --git a/specs/saver.xml b/specs/saver.xml
index 5283290..2374218 100644
--- a/specs/saver.xml
+++ b/specs/saver.xml
@@ -149,18 +149,19 @@ In adition to the comon types described in the core protocol, the following
type is used in the request and event definitions in subsequent sections.
</para>
-<informaltable frame="none">
- <tgroup cols='2' align='left'>
- <colspec colname='c1' colsep="0"/>
- <colspec colname='c2' colsep="0"/>
+<informaltable frame="topbot">
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth="1.0*"/>
+ <colspec colname='c2' colwidth="1.5*"/>
<thead>
- <row>
+ <row rowsep='1'>
<entry>Name</entry>
<entry>Value</entry>
</row>
</thead>
<tbody>
- <row rowsep="0">
+ <row>
<entry>SCREENSAVEREVENT</entry>
<entry><emphasis role="bold">ScreenSaverNotify</emphasis>,
<emphasis role="bold">ScreenSaverCycle</emphasis></entry>
@@ -236,11 +237,12 @@ active and how the <emphasis remap='I'>til-or-since</emphasis> value should be i
</para>
<informaltable frame="none">
- <tgroup cols='2' align='left'>
- <colspec colname='c1' colsep="0"/>
- <colspec colname='c2' colsep="0"/>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth="1.0*"/>
+ <colspec colname='c2' colwidth="5.0*"/>
<tbody>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">Off</emphasis></entry>
<entry>
The screen is not currently being saved;
@@ -249,7 +251,7 @@ specifies the number of milliseconds until the screen saver is expected to
activate.
</entry>
</row>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">On</emphasis></entry>
<entry>
The screen is currently being saved;
@@ -257,7 +259,7 @@ The screen is currently being saved;
the number of milliseconds since the screen saver activated.
</entry>
</row>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">Disabled</emphasis></entry>
<entry>
The screen saver is currently disabled;
@@ -274,21 +276,22 @@ used or would have been were the screen being saved:
</para>
<informaltable frame="none">
- <tgroup cols='2' align='left'>
- <colspec colname='c1' colsep="0"/>
- <colspec colname='c2' colsep="0"/>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth="1.0*"/>
+ <colspec colname='c2' colwidth="5.0*"/>
<tbody>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">Blanked</emphasis></entry>
<entry>The video signal to the display monitor was disabled.</entry>
</row>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">Internal</emphasis></entry>
<entry>A server-dependent, built-in screen saver image was displayed; either no
client had set the screen saver window attributes or a different client
had the server grabbed when the screen saver activated.</entry>
</row>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">External</emphasis></entry>
<entry>The screen saver window was mapped with attributes set by a
client using the <function>ScreenSaverSetAttributes</function> request.</entry>
@@ -332,18 +335,19 @@ Otherwise, any combination of the following bits may be set:
</para>
<informaltable frame="none">
- <tgroup cols='2' align='center'>
- <colspec colname='c1' colsep="0"/>
- <colspec colname='c2' colsep="0"/>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth="1.0*"/>
+ <colspec colname='c2' colwidth="3.0*"/>
<tbody>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">ScreenSaverNotify</emphasis></entry>
<entry>
If this bit is set, <emphasis role="bold">ScreenSaverNotify</emphasis> events are generated whenever
the screen saver is activated or deactivated.
</entry>
</row>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">ScreenSaverCycle</emphasis></entry>
<entry>
If this bit is set, <emphasis role="bold">ScreenSaverNotify</emphasis> events are generated whenever
@@ -504,25 +508,26 @@ The <emphasis remap='I'>state</emphasis> field specifies the cause of the event:
</para>
<informaltable frame="none">
- <tgroup cols='2' align='left'>
- <colspec colname='c1' colsep="0"/>
- <colspec colname='c2' colsep="0"/>
+ <?dbfo keep-together="always" ?>
+ <tgroup cols='2' align='left' colsep='0' rowsep='0'>
+ <colspec colname='c1' colwidth="1.0*"/>
+ <colspec colname='c2' colwidth="5.0*"/>
<tbody>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">Off</emphasis></entry>
<entry>
The screen saver deactivated; this event is sent if the client has set the
ScreenSaverNotify bit in its event mask.
</entry>
</row>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">On</emphasis></entry>
<entry>
The screen saver activated. This event is sent if the client has set the
ScreenSaverNotify bit in its event mask.
</entry>
</row>
- <row rowsep="0">
+ <row>
<entry><emphasis role="bold">Cycle</emphasis></entry>
<entry>
The cycle interval passed and the client is expected to change the image on
commit ffbc319b69b1e3502a9b14195e7fa94f2beee3b6
Author: Matt Dew <marcoz@osource.org>
Date: Sat Sep 24 20:07:44 2011 -0600
Fix id attributes, linkend and olinks
#1 - fix the capitolization of the ID attriutes to match either the <title> or <funcdef> string it goes with.
#2 - fix any <linkend>'s that were affected by #1
#3 - any <function> in the docs that has an actual funcdef, will become an olink if external, xref if internal.
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
diff --git a/specs/saver.xml b/specs/saver.xml
index 0fcd83f..5283290 100644
--- a/specs/saver.xml
+++ b/specs/saver.xml
@@ -45,7 +45,7 @@ implied warranty.
</legalnotice>
</bookinfo>
-<chapter id="Introduction_">
+<chapter id='Introduction'>
<title>Introduction</title>
<para>
The X Window System provides support for changing the image on a display screen
@@ -470,7 +470,7 @@ window attributes.
</para>
</sect1>
-<sect1 id="Events_">
+<sect1 id="Events">
<title>Events</title>
<para>
The Screen Saver extension adds one event:
@@ -655,7 +655,7 @@ SETofSCREENSAVEREVENT
</literallayout>
</sect1>
-<sect1 id="Events">
+<sect1 id="Events_2">
<title>Events</title>
<literallayout class="monospaced">
@@ -679,7 +679,7 @@ SETofSCREENSAVEREVENT
</sect1>
</chapter>
-<chapter id="Inter_Client_Communications_Conventions_">
+<chapter id='Inter_Client_Communications_Conventions'>
<title>Inter-Client Communications Conventions</title>
<para>
Screen saver clients should create at least one resource value whose
@@ -711,7 +711,7 @@ The include file for this extension is
</para>
-<funcsynopsis id='xscreensaverqueryextension'>
+<funcsynopsis id='XScreenSaverQueryExtension'>
<funcprototype>
<funcdef>Bool <function>XScreenSaverQueryExtension</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -734,7 +734,7 @@ no additional errors are defined by this extension, the results
of <emphasis remap='I'>error_base</emphasis> are not defined.
</para>
-<funcsynopsis id='xscreensaverqueryversion'>
+<funcsynopsis id='XScreenSaverQueryVersion'>
<funcprototype>
<funcdef>Status <function>XScreenSaverQueryVersion</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -759,14 +759,14 @@ set and 0 is returned.
<para>
This routine allocates and returns an
<emphasis role="bold">XScreenSaverInfo</emphasis> structure
-for use in calls to <function>XScreenSaverQueryInfo</function>.
+for use in calls to <xref linkend='XScreenSaverQueryInfo' xrefstyle='select: title'/>.
All fields in the
structure are initialized to zero. If insufficient memory is available,
NULL is returned. The results of this routine can be released
-using <emphasis remap='I'>XFree</emphasis>.
+using <olink targetdoc='libX11' targetptr='XFree'><function>XFree</function></olink>.
</para>
-<funcsynopsis id='xscreensaverqueryinfo'>
+<funcsynopsis id='XScreenSaverQueryInfo'>
<funcprototype>
<funcdef>Status <function>XScreenSaverQueryInfo</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -801,7 +801,7 @@ description of the fields. If the extension is not supported,
is returned.
</para>
-<funcsynopsis id='xscreensaverselectinput'>
+<funcsynopsis id='XScreenSaverSelectInput'>
<funcprototype>
<funcdef>void <function>XScreenSaverSelectInput</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -838,7 +838,7 @@ See the definition of the
of the allowed event masks. <!-- xref ? -->
</para>
-<funcsynopsis id='xscreensaversetattributes'>
+<funcsynopsis id='XScreenSaverSetAttributes'>
<funcprototype>
<funcdef>void <function>XScreenSaverSetAttributes</function></funcdef>
<paramdef>Display <parameter>*dpy</parameter></paramdef>
@@ -864,7 +864,7 @@ of the <function>ScreenSaverSetAttributes</function> request for a
description of each of the arguments.
</para>
-<funcsynopsis id='xscreensaverunsetattributes'>
+<funcsynopsis id='XScreenSaverUnsetAttributes'>
<funcprototype>
<funcdef>void <function>XScreenSaverUnsetAttributes</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -878,7 +878,7 @@ extension, this routine instructs the server to discard
any previous screen saver window attributes set by this client.
</para>
-<funcsynopsis id='xscreensaverregister'>
+<funcsynopsis id='XScreenSaverRegister'>
<funcprototype>
<funcdef>Status <function>XScreenSaverRegister</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -897,7 +897,7 @@ is encountered and the property is not changed, otherwise it returns
non-zero.
</para>
-<funcsynopsis id='xscreensaverunregister'>
+<funcsynopsis id='XScreenSaverUnregister'>
<funcprototype>
<funcdef>Status <function>XScreenSaverUnregister</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -912,7 +912,7 @@ It returns zero if an error is encountered and the property is changed,
otherwise it returns non-zero.
</para>
-<funcsynopsis id='xscreensavergetregistered'>
+<funcsynopsis id='XScreenSaverGetRegistered'>
<funcprototype>
<funcdef>Status <function>XScreenSaverGetRegistered</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
commit 4aa72b32c7707bd78fc8dd8e287e3030eeb85d05
Author: Gaetan Nadon <memsize@videotron.ca>
Date: Tue Sep 20 20:17:40 2011 -0400
specs: fix markup for single license dual holder
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
diff --git a/specs/saver.xml b/specs/saver.xml
index 9d81ed9..0fcd83f 100644
--- a/specs/saver.xml
+++ b/specs/saver.xml
@@ -25,7 +25,10 @@ X Consortium, Laboratory for Computer Science, Massachusetts Institute of Techno
</author>
</authorgroup>
- <copyright><year>1992</year><holder>Massachusetts Institute of Technology and Network Computing Devices, Inc</holder></copyright>
+ <copyright><year>1992</year>
+ <holder>Massachusetts Institute of Technology</holder>
+ <holder>Network Computing Devices, Inc</holder>
+ </copyright>
<legalnotice>
commit d9c42cb0ba35e1c5e5a36a8cbde81eb311350931
Author: Gaetan Nadon <memsize@videotron.ca>
Date: Mon Sep 12 11:04:11 2011 -0400
docs: use the &fullrelvers; entity to set X11 release information
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
diff --git a/specs/saver.xml b/specs/saver.xml
index 0c83a4b..9d81ed9 100644
--- a/specs/saver.xml
+++ b/specs/saver.xml
@@ -1,12 +1,16 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
- "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";>
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd";
+[
+<!ENTITY % defs SYSTEM "defs.ent"> %defs;
+]>
<book id="saver">
<bookinfo>
<title>X11 Screen Saver Extension</title>
<subtitle>MIT X Consortium Proposed Standard</subtitle>
+ <releaseinfo>X Version 11, Release &fullrelvers;</releaseinfo>
<releaseinfo>Version 1.0</releaseinfo>
<authorgroup>
<author>
commit 378e4e73352a6bc11589460fdb4e6ceead2e82dc
Author: Gaetan Nadon <memsize@videotron.ca>
Date: Sun Sep 11 19:49:54 2011 -0400
docs: remove <productnumber> which is not used by default
This element is not rendered by default on the title. A template
customization is required to display it.
X Window System does not have a product number.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
diff --git a/specs/saver.xml b/specs/saver.xml
index b1e6f95..0c83a4b 100644
--- a/specs/saver.xml
+++ b/specs/saver.xml
@@ -23,7 +23,6 @@ X Consortium, Laboratory for Computer Science, Massachusetts Institute of Techno
<copyright><year>1992</year><holder>Massachusetts Institute of Technology and Network Computing Devices, Inc</holder></copyright>
- <productnumber>X Version 11, Release 5</productnumber>
<legalnotice>
<para>
commit feaac4aaccb25d79d29a6020e75fca5a9938bf8a
Author: Gaetan Nadon <memsize@videotron.ca>
Date: Thu Sep 8 20:00:00 2011 -0400
docbook.am: embed css styles inside the HTML HEAD element
Rather than referring to the external xorg.css stylesheet, embed the content
of the file in the html output produced. This is accomplished by using
version 1.10 of xorg-xhtml.xsl.
This makes the whole html docs tree much more relocatable.
In addition, it eliminates xorg.css as a runtime file which makes
xorg-sgml-doctools a build time only package.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
diff --git a/docbook.am b/docbook.am
index 9377f5b..bba4d54 100644
--- a/docbook.am
+++ b/docbook.am
@@ -30,11 +30,9 @@ XMLTO_HTML_OLINK_FLAGS = \
--stringparam target.database.document=$(XORG_SGML_PATH)/X11/dbs/masterdb.html.xml \
--stringparam current.docid="$(<:.xml=)"
XMLTO_HTML_STYLESHEET_FLAGS = -x $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl
-XMLTO_HTML_CSS_STYLESHEET_FLAGS = --stringparam html.stylesheet=$(STYLESHEET_SRCDIR)/xorg.css
XMLTO_HTML_FLAGS = \
$(XMLTO_SEARCHPATH_FLAGS) \
$(XMLTO_HTML_STYLESHEET_FLAGS) \
- $(XMLTO_HTML_CSS_STYLESHEET_FLAGS) \
$(XMLTO_HTML_OLINK_FLAGS)
shelf_DATA += $(docbook:.xml=.html)
commit 25764e51ecdea56df02063ae3b9d625d41a1209d
Author: Gaetan Nadon <memsize@videotron.ca>
Date: Wed Sep 7 10:31:04 2011 -0400
docbook.am: global maintenance update - entities, images and olinking
Adding support in libX11 for html chunking caused a reorg of docbook.am
as well as the xorg-sgml-doctools masterdb for olinking.
The parameter img.src.path is added for pdf images.
A searchpath to the root builddir is added for local entities, if present.
The docbook.am makefile hides all the details and is identical for
all 22 modules having DocBook documentation. It is included by a thin
Makefile.am which requires no docbook knowledge.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
diff --git a/docbook.am b/docbook.am
index 2ffb7e6..9377f5b 100644
--- a/docbook.am
+++ b/docbook.am
@@ -21,74 +21,84 @@ shelf_DATA =
dist_shelf_DATA = $(docbook) $(chapters)
if HAVE_XMLTO
-#
-# Generate DocBook/XML output formats with or without stylesheets
-#
-
-# Stylesheets are available if the package xorg-sgml-doctools is installed
if HAVE_STYLESHEETS
-# The location where all cross reference databases are installed
-sgmldbsdir = $(XORG_SGML_PATH)/X11/dbs
-masterdb = "$(sgmldbsdir)/masterdb$(suffix $@).xml"
-XMLTO_FLAGS = \
- --searchpath "$(XORG_SGML_PATH)/X11" \
- --stringparam target.database.document=$(masterdb) \
- --stringparam current.docid="$(<:.xml=)" \
- --stringparam collect.xref.targets="no"
-
-XMLTO_XHTML_FLAGS = \
- -x $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl \
- --stringparam html.stylesheet=$(STYLESHEET_SRCDIR)/xorg.css
-
-XMLTO_FO_FLAGS = \
- -x $(STYLESHEET_SRCDIR)/xorg-fo.xsl
-endif HAVE_STYLESHEETS
+XMLTO_SEARCHPATH_FLAGS = \
+ --searchpath "$(XORG_SGML_PATH)/X11" \
+ --searchpath "$(abs_top_builddir)"
+XMLTO_HTML_OLINK_FLAGS = \
+ --stringparam target.database.document=$(XORG_SGML_PATH)/X11/dbs/masterdb.html.xml \
+ --stringparam current.docid="$(<:.xml=)"
+XMLTO_HTML_STYLESHEET_FLAGS = -x $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl
+XMLTO_HTML_CSS_STYLESHEET_FLAGS = --stringparam html.stylesheet=$(STYLESHEET_SRCDIR)/xorg.css
+XMLTO_HTML_FLAGS = \
+ $(XMLTO_SEARCHPATH_FLAGS) \
+ $(XMLTO_HTML_STYLESHEET_FLAGS) \
+ $(XMLTO_HTML_CSS_STYLESHEET_FLAGS) \
+ $(XMLTO_HTML_OLINK_FLAGS)
shelf_DATA += $(docbook:.xml=.html)
-%.html: %.xml $(chapters)
- $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_XHTML_FLAGS) xhtml-nochunks $<
-
-if HAVE_FOP
-shelf_DATA += $(docbook:.xml=.pdf) $(docbook:.xml=.ps)
-%.pdf: %.xml $(chapters)
- $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_FO_FLAGS) --with-fop pdf $<
-%.ps: %.xml $(chapters)
- $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_FO_FLAGS) --with-fop ps $<
-endif HAVE_FOP
+%.html: %.xml $(chapters)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_HTML_FLAGS) xhtml-nochunks $<
if HAVE_XMLTO_TEXT
+
shelf_DATA += $(docbook:.xml=.txt)
%.txt: %.xml $(chapters)
- $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_XHTML_FLAGS) txt $<
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_HTML_FLAGS) txt $<
endif HAVE_XMLTO_TEXT
-#
-# Generate documents cross-reference target databases
-#
+if HAVE_FOP
+XMLTO_FO_IMAGEPATH_FLAGS = --stringparam img.src.path=$(abs_builddir)/
+XMLTO_PDF_OLINK_FLAGS = \
+ --stringparam target.database.document=$(XORG_SGML_PATH)/X11/dbs/masterdb.pdf.xml \
+ --stringparam current.docid="$(<:.xml=)"
+XMLTO_FO_STYLESHEET_FLAGS = -x $(STYLESHEET_SRCDIR)/xorg-fo.xsl
+
+XMLTO_FO_FLAGS = \
+ $(XMLTO_SEARCHPATH_FLAGS) \
+ $(XMLTO_FO_STYLESHEET_FLAGS) \
+ $(XMLTO_FO_IMAGEPATH_FLAGS) \
+ $(XMLTO_PDF_OLINK_FLAGS)
+
+shelf_DATA += $(docbook:.xml=.pdf)
+%.pdf: %.xml $(chapters)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_FO_FLAGS) --with-fop pdf $<
-# This is only possible if the xorg-sgml-doctools package is installed
-if HAVE_STYLESHEETS
-if HAVE_XSLTPROC
+shelf_DATA += $(docbook:.xml=.ps)
+%.ps: %.xml $(chapters)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_FO_FLAGS) --with-fop ps $<
+endif HAVE_FOP
-# DocBook/XML generated document cross-reference database
-shelf_DATA += $(docbook:.xml=.html.db) $(docbook:.xml=.fo.db)
+# Generate documents cross-reference target databases
+if HAVE_XSLTPROC
-# Generate DocBook/XML document cross-reference database
-# Flags for the XSL Transformation processor generating xref target databases
-XSLTPROC_FLAGS = \
+XSLT_SEARCHPATH_FLAGS = \
--path "$(XORG_SGML_PATH)/X11" \
- --stringparam targets.filename "$@" \
- --stringparam collect.xref.targets "only" \
- --nonet --xinclude
-
+ --path "$(abs_top_builddir)"
+XSLT_OLINK_FLAGS = \
+ --stringparam targets.filename "$@" \
+ --stringparam collect.xref.targets "only" \
+ --stringparam olink.base.uri "$(@:.db=)"
+
+XSLT_HTML_FLAGS = \
+ $(XSLT_SEARCHPATH_FLAGS) \
+ $(XSLT_OLINK_FLAGS) \
+ --nonet --xinclude \
+ $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl
+XSLT_PDF_FLAGS = \
+ $(XSLT_SEARCHPATH_FLAGS) \
+ $(XSLT_OLINK_FLAGS) \
+ --nonet --xinclude \
+ $(STYLESHEET_SRCDIR)/xorg-fo.xsl
+
+shelf_DATA += $(docbook:.xml=.html.db)
%.html.db: %.xml $(chapters)
- $(AM_V_GEN)$(XSLTPROC) $(XSLTPROC_FLAGS) \
- http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl $<
+ $(AM_V_GEN)$(XSLTPROC) $(XSLT_HTML_FLAGS) $<
-%.fo.db: %.xml $(chapters)
- $(AM_V_GEN)$(XSLTPROC) $(XSLTPROC_FLAGS) \
- http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl $<
+shelf_DATA += $(docbook:.xml=.pdf.db)
+%.pdf.db: %.xml $(chapters)
+ $(AM_V_GEN)$(XSLTPROC) $(XSLT_PDF_FLAGS) $<
endif HAVE_XSLTPROC
endif HAVE_STYLESHEETS
commit e80d85902dcd19edd9bdb5f574ca47d0811ac0aa
Author: Gaetan Nadon <memsize@videotron.ca>
Date: Sun Jun 12 17:54:50 2011 -0400
Install xml versions of specs even if HAVE_XMLTO is false
DocBook/XML input source is also a usefull output format that can be viewed
with an XML viewer or editor and by some O/S help system.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
diff --git a/docbook.am b/docbook.am
index 5864c9e..2ffb7e6 100644
--- a/docbook.am
+++ b/docbook.am
@@ -20,6 +20,7 @@ shelf_DATA =
# DocBook/XML file with chapters, appendix and images it includes
dist_shelf_DATA = $(docbook) $(chapters)
+if HAVE_XMLTO
#
# Generate DocBook/XML output formats with or without stylesheets
#
@@ -91,5 +92,6 @@ XSLTPROC_FLAGS = \
endif HAVE_XSLTPROC
endif HAVE_STYLESHEETS
+endif HAVE_XMLTO
CLEANFILES = $(shelf_DATA)
diff --git a/specs/Makefile.am b/specs/Makefile.am
index d73e038..f93e295 100644
--- a/specs/Makefile.am
+++ b/specs/Makefile.am
@@ -1,6 +1,5 @@
if ENABLE_SPECS
-if HAVE_XMLTO
# Main DocBook/XML files (DOCTYPE book)
docbook = saver.xml
@@ -11,5 +10,4 @@ shelfdir = $(docdir)
# Generate DocBook/XML output formats with or without stylesheets
include $(top_srcdir)/docbook.am
-endif HAVE_XMLTO
endif ENABLE_SPECS
commit 8f407c9417ffe2c1e01b37e18c71469d2baee970
Author: Gaetan Nadon <memsize@videotron.ca>
Date: Sun Jun 5 16:27:37 2011 -0400
Install target dbs alongside generated documents
This matches a change in xorg-sgml-docs whereby the masterdb will look for
the target dbs into the same location as the generated documents.
The target dbs are now installed alongside the generated documents.
Previously they are installed in $prefix/sgml/X11/dbs alongside masterdb which
has the potential of installing outside the package prefix and cause
distcheck to fail when user does not have write permission in this package.
Requires XORG_CHECK_SGML_DOCTOOLS(1.8) which was released 2011-06-11
diff --git a/configure.ac b/configure.ac
index fc43f9c..f89bd7d 100644
--- a/configure.ac
+++ b/configure.ac
@@ -13,7 +13,7 @@ XORG_ENABLE_SPECS
XORG_WITH_XMLTO(0.0.22)
XORG_WITH_FOP
XORG_WITH_XSLTPROC
-XORG_CHECK_SGML_DOCTOOLS(1.7)
+XORG_CHECK_SGML_DOCTOOLS(1.8)
AC_OUTPUT([Makefile
specs/Makefile
diff --git a/docbook.am b/docbook.am
index 3cf21e8..5864c9e 100644
--- a/docbook.am
+++ b/docbook.am
@@ -71,7 +71,7 @@ if HAVE_STYLESHEETS
if HAVE_XSLTPROC
# DocBook/XML generated document cross-reference database
-sgmldbs_DATA = $(docbook:.xml=.html.db) $(docbook:.xml=.fo.db)
+shelf_DATA += $(docbook:.xml=.html.db) $(docbook:.xml=.fo.db)
# Generate DocBook/XML document cross-reference database
# Flags for the XSL Transformation processor generating xref target databases
@@ -92,4 +92,4 @@ XSLTPROC_FLAGS = \
endif HAVE_XSLTPROC
endif HAVE_STYLESHEETS
-CLEANFILES = $(shelf_DATA) $(sgmldbs_DATA)
+CLEANFILES = $(shelf_DATA)
commit 2408165cb190a10e2d899bdc259866cbf7a8e125
Author: Matt Dew <marcoz@osource.org>
Date: Wed May 25 22:04:10 2011 -0600
add id attributes to funcsynopsis to allow other docs to olink to them.
Signed-off-by: Matt Dew <marcoz@osource.org>
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
diff --git a/specs/saver.xml b/specs/saver.xml
index d3a9d1c..b1e6f95 100644
--- a/specs/saver.xml
+++ b/specs/saver.xml
@@ -705,7 +705,7 @@ The include file for this extension is
</para>
-<funcsynopsis>
+<funcsynopsis id='xscreensaverqueryextension'>
<funcprototype>
<funcdef>Bool <function>XScreenSaverQueryExtension</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -728,7 +728,7 @@ no additional errors are defined by this extension, the results
of <emphasis remap='I'>error_base</emphasis> are not defined.
</para>
-<funcsynopsis>
+<funcsynopsis id='xscreensaverqueryversion'>
<funcprototype>
<funcdef>Status <function>XScreenSaverQueryVersion</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -760,7 +760,7 @@ NULL is returned. The results of this routine can be released
using <emphasis remap='I'>XFree</emphasis>.
</para>
-<funcsynopsis>
+<funcsynopsis id='xscreensaverqueryinfo'>
<funcprototype>
<funcdef>Status <function>XScreenSaverQueryInfo</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -795,7 +795,7 @@ description of the fields. If the extension is not supported,
is returned.
</para>
-<funcsynopsis>
+<funcsynopsis id='xscreensaverselectinput'>
<funcprototype>
<funcdef>void <function>XScreenSaverSelectInput</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -832,7 +832,7 @@ See the definition of the
of the allowed event masks. <!-- xref ? -->
</para>
-<funcsynopsis>
+<funcsynopsis id='xscreensaversetattributes'>
<funcprototype>
<funcdef>void <function>XScreenSaverSetAttributes</function></funcdef>
<paramdef>Display <parameter>*dpy</parameter></paramdef>
@@ -858,7 +858,7 @@ of the <function>ScreenSaverSetAttributes</function> request for a
description of each of the arguments.
</para>
-<funcsynopsis>
+<funcsynopsis id='xscreensaverunsetattributes'>
<funcprototype>
<funcdef>void <function>XScreenSaverUnsetAttributes</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -872,7 +872,7 @@ extension, this routine instructs the server to discard
any previous screen saver window attributes set by this client.
</para>
-<funcsynopsis>
+<funcsynopsis id='xscreensaverregister'>
<funcprototype>
<funcdef>Status <function>XScreenSaverRegister</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -891,7 +891,7 @@ is encountered and the property is not changed, otherwise it returns
non-zero.
</para>
-<funcsynopsis>
+<funcsynopsis id='xscreensaverunregister'>
<funcprototype>
<funcdef>Status <function>XScreenSaverUnregister</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
@@ -906,7 +906,7 @@ It returns zero if an error is encountered and the property is changed,
otherwise it returns non-zero.
</para>
-<funcsynopsis>
+<funcsynopsis id='xscreensavergetregistered'>
<funcprototype>
<funcdef>Status <function>XScreenSaverGetRegistered</function></funcdef>
<paramdef>Display <parameter>*display</parameter></paramdef>
commit 2cd4a9898644dde49a876eeb53037149c85a37f0
Author: Gaetan Nadon <memsize@videotron.ca>
Date: Sun Feb 27 15:06:18 2011 -0500
Documentation: add Docbook external references support
When writing technical documentation, it is often necessary to cross
reference to other information. When that other information is not in the
current document, additional support is needed, namely <olink>.
A new feature with version 1.7 of xorg-sgml-doctools adds references to
other documents within or outside this package.
This patch adds technical support for this feature but does not change
the content of the documentation as seen by the end user.
Each book or article must generate a database containing the href
of sections that can be referred to from another document. This database
is installed in DATAROOTDIR/sgml/X11/dbs. There is a requirement that
the value of DATAROOTDIR for xorg-sgml-doctools and for the package
documentation is the same. This forms a virtual document tree.
This database is consulted by other documents while they are being generated
in order to fulfill the missing information for linking.
Refer to the xorg-sgml-doctools for further technical information.
Co-authored-by: Matt Dew <marcoz@osource.org>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
diff --git a/configure.ac b/configure.ac
index 9938216..fc43f9c 100644
--- a/configure.ac
+++ b/configure.ac
@@ -4,15 +4,16 @@ AC_INIT([ScrnSaverProto], [1.2.1],
AM_INIT_AUTOMAKE([foreign dist-bzip2])
AM_MAINTAINER_MODE
-# Require xorg-macros minimum of 1.10 for HAVE_STYLESHEETS in XORG_CHECK_SGML_DOCTOOLS
+# Require xorg-macros minimum of 1.12 for DocBook external references
m4_ifndef([XORG_MACROS_VERSION],
- [m4_fatal([must install xorg-macros 1.10 or later before running autoconf/autogen])])
-XORG_MACROS_VERSION(1.10)
+ [m4_fatal([must install xorg-macros 1.12 or later before running autoconf/autogen])])
+XORG_MACROS_VERSION(1.12)
XORG_DEFAULT_OPTIONS
XORG_ENABLE_SPECS
-XORG_WITH_XMLTO(0.0.20)
+XORG_WITH_XMLTO(0.0.22)
XORG_WITH_FOP
-XORG_CHECK_SGML_DOCTOOLS(1.5)
+XORG_WITH_XSLTPROC
+XORG_CHECK_SGML_DOCTOOLS(1.7)
AC_OUTPUT([Makefile
specs/Makefile
diff --git a/docbook.am b/docbook.am
new file mode 100644
index 0000000..3cf21e8
--- /dev/null
+++ b/docbook.am
@@ -0,0 +1,95 @@
+#
+# Generate output formats for a single DocBook/XML with/without chapters
+#
+# Variables set by the calling Makefile:
+# shelfdir: the location where the docs/specs are installed. Typically $(docdir)
+# docbook: the main DocBook/XML file, no chapters, appendix or image files
+# chapters: all files pulled in by an XInclude statement and images.
+#
+
+#
+# This makefile is intended for Users Documentation and Functional Specifications.
+# Do not use for Developer Documentation which is not installed and does not require olink.
+# Refer to http://www.x.org/releases/X11R7.6/doc/xorg-docs/ReleaseNotes.html#id2584393
+# for an explanation on documents classification.
+#
+
+# DocBook/XML generated output formats to be installed
+shelf_DATA =
+
+# DocBook/XML file with chapters, appendix and images it includes
+dist_shelf_DATA = $(docbook) $(chapters)
+
+#
+# Generate DocBook/XML output formats with or without stylesheets
+#
+
+# Stylesheets are available if the package xorg-sgml-doctools is installed
+if HAVE_STYLESHEETS
+
+# The location where all cross reference databases are installed
+sgmldbsdir = $(XORG_SGML_PATH)/X11/dbs
+masterdb = "$(sgmldbsdir)/masterdb$(suffix $@).xml"
+XMLTO_FLAGS = \
+ --searchpath "$(XORG_SGML_PATH)/X11" \
+ --stringparam target.database.document=$(masterdb) \
+ --stringparam current.docid="$(<:.xml=)" \
+ --stringparam collect.xref.targets="no"
+
+XMLTO_XHTML_FLAGS = \
+ -x $(STYLESHEET_SRCDIR)/xorg-xhtml.xsl \
+ --stringparam html.stylesheet=$(STYLESHEET_SRCDIR)/xorg.css
+
+XMLTO_FO_FLAGS = \
+ -x $(STYLESHEET_SRCDIR)/xorg-fo.xsl
+endif HAVE_STYLESHEETS
+
+shelf_DATA += $(docbook:.xml=.html)
+%.html: %.xml $(chapters)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_XHTML_FLAGS) xhtml-nochunks $<
+
+if HAVE_FOP
+shelf_DATA += $(docbook:.xml=.pdf) $(docbook:.xml=.ps)
+%.pdf: %.xml $(chapters)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_FO_FLAGS) --with-fop pdf $<
+%.ps: %.xml $(chapters)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_FO_FLAGS) --with-fop ps $<
+endif HAVE_FOP
+
+if HAVE_XMLTO_TEXT
+shelf_DATA += $(docbook:.xml=.txt)
+%.txt: %.xml $(chapters)
+ $(AM_V_GEN)$(XMLTO) $(XMLTO_FLAGS) $(XMLTO_XHTML_FLAGS) txt $<
+endif HAVE_XMLTO_TEXT
+
+#
+# Generate documents cross-reference target databases
+#
+
+# This is only possible if the xorg-sgml-doctools package is installed
+if HAVE_STYLESHEETS
+if HAVE_XSLTPROC
+
+# DocBook/XML generated document cross-reference database
+sgmldbs_DATA = $(docbook:.xml=.html.db) $(docbook:.xml=.fo.db)
+
+# Generate DocBook/XML document cross-reference database
+# Flags for the XSL Transformation processor generating xref target databases
+XSLTPROC_FLAGS = \
+ --path "$(XORG_SGML_PATH)/X11" \
+ --stringparam targets.filename "$@" \
+ --stringparam collect.xref.targets "only" \
+ --nonet --xinclude
+
+%.html.db: %.xml $(chapters)
+ $(AM_V_GEN)$(XSLTPROC) $(XSLTPROC_FLAGS) \
+ http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl $<
+
+%.fo.db: %.xml $(chapters)
+ $(AM_V_GEN)$(XSLTPROC) $(XSLTPROC_FLAGS) \
+ http://docbook.sourceforge.net/release/xsl/current/fo/docbook.xsl $<
+
+endif HAVE_XSLTPROC
+endif HAVE_STYLESHEETS
+
+CLEANFILES = $(shelf_DATA) $(sgmldbs_DATA)
diff --git a/specs/.gitignore b/specs/.gitignore
index 6fa5c31..92946c9 100644
--- a/specs/.gitignore
+++ b/specs/.gitignore
@@ -2,3 +2,4 @@
*.ps
*.pdf
*.txt
+*.db
diff --git a/specs/Makefile.am b/specs/Makefile.am
index 61fb4e0..d73e038 100644
--- a/specs/Makefile.am
+++ b/specs/Makefile.am
@@ -1,61 +1,15 @@
-#
-# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a
-# copy of this software and associated documentation files (the "Software"),
-# to deal in the Software without restriction, including without limitation
-# the rights to use, copy, modify, merge, publish, distribute, sublicense,
-# and/or sell copies of the Software, and to permit persons to whom the
-# Software is furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice (including the next
-# paragraph) shall be included in all copies or substantial portions of the
-# Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
-# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-# DEALINGS IN THE SOFTWARE.
Reply to: