pax_global_header00006660000000000000000000000064116324536740014525gustar00rootroot0000000000000052 comment=2ce8b9381538e48b57e5ab7e11dad412fd9b8429 xorg-sgml-doctools-1.10/000075500000000000000000000000001163245367400152075ustar00rootroot00000000000000xorg-sgml-doctools-1.10/.gitignore000064400000000000000000000017631163245367400172060ustar00rootroot00000000000000# # X.Org module default exclusion patterns # The next section if for module specific patterns # # Do not edit the following section # GNU Build System (Autotools) aclocal.m4 autom4te.cache/ autoscan.log ChangeLog compile config.guess config.h config.h.in config.log config-ml.in config.py config.status config.status.lineno config.sub configure configure.scan depcomp .deps/ INSTALL install-sh .libs/ libtool libtool.m4 ltmain.sh lt~obsolete.m4 ltoptions.m4 ltsugar.m4 ltversion.m4 Makefile Makefile.in mdate-sh missing mkinstalldirs *.pc py-compile stamp-h? symlink-tree texinfo.tex ylwrap # Do not edit the following section # Edit Compile Debug Document Distribute *~ *.[0-9] *.[0-9]x *.bak *.bin core *.dll *.exe *-ISO*.bdf *-JIS*.bdf *-KOI8*.bdf *.kld *.ko *.ko.cmd *.lai *.l[oa] *.[oa] *.obj *.patch *.so *.pcf.gz *.pdb *.tar.bz2 *.tar.gz # # Add & Override patterns for xorg-sgml-doctools # # Edit the following section as needed # For example, !report.pc overrides *.pc. See 'man gitignore' # xorg-sgml-doctools-1.10/COPYING000064400000000000000000000043371163245367400162510ustar00rootroot00000000000000Copyright (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. ------------------------------------------------------------------ Copyright 2005 Red Hat, Inc. Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Red Hat not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission. Red Hat makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty. RED HAT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL RED HAT BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. xorg-sgml-doctools-1.10/Makefile.am000064400000000000000000000027221163245367400172460ustar00rootroot00000000000000# # Copyright 2005 Red Hat, Inc. # # Permission to use, copy, modify, distribute, and sell this software and its # documentation for any purpose is hereby granted without fee, provided that # the above copyright notice appear in all copies and that both that # copyright notice and this permission notice appear in supporting # documentation, and that the name of Red Hat not be used in # advertising or publicity pertaining to distribution of the software without # specific, written prior permission. Red Hat makes no # representations about the suitability of this software for any purpose. It # is provided "as is" without express or implied warranty. # # RED HAT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, # INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO # EVENT SHALL RED HAT BE LIABLE FOR ANY SPECIAL, INDIRECT OR # CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, # DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR # PERFORMANCE OF THIS SOFTWARE. SUBDIRS = masterdb dist_sgmlx11_DATA = \ defs.ent xorg.css \ xorg.xsl \ xorg-xhtml.xsl \ xorg-chunk.xsl \ xorg-fo.xsl pkgconfigdir = $(datadir)/pkgconfig pkgconfig_DATA = xorg-sgml-doctools.pc MAINTAINERCLEANFILES = ChangeLog INSTALL .PHONY: ChangeLog INSTALL INSTALL: $(INSTALL_CMD) ChangeLog: $(CHANGELOG_CMD) dist-hook: ChangeLog INSTALL xorg-sgml-doctools-1.10/README000064400000000000000000000163741163245367400161020ustar00rootroot00000000000000This package provides a common set of SGML entities and XML/CSS style sheets used in building/formatting the documentation provided in other X.Org packages. It's typically only needed by people building from source who want to produce formatted documentation from their builds, or those who have installed the HTML version of the documentation, which refers to the included common xorg.css stylesheet. Documents external references ----------------------------- A new feature with version 1.7 is references to documents in other packages. For example a protocol specifications may refer to another one or to a library implementing it. This feature works with PDF and HTML generated documents and will generate links to the other versions of the same type, i.e. html docs will link to other html docs, and pdf docs will link to other pdf docs. Due to the modular nature of the X window System and the flexibility it provides to O/S builders, one should not expect all links to be resolved all the time. A more recent version of a package may be installed or an older version may be retained for a long period of time. Not all packages are installed either. Build challenges ---------------- The X Window System is composed of over 200 packages. The documentation is included with the package it documents so the information matches the code. The build is organized to satisfy C code building requirements, but this paradigm does not fit very well for building documentation. For a document to build a reference to another document, it needs to have information about this document which may or may not be there, or may be at an unexpected version. The document it refers to may also wish to refer to the former document. Local X builds -------------- When building X as a sandbox on a workstation, using a simple build script to configure and build all packages in the right order is all you need to get a working system, including documentation. You will not get all the links in the documentation resolved correctly due to build order and/or bi-directional references. Unless you are updating or testing the documentation, you do not need to worry about this glitch. A simple workaround is to build each affected package using "make clean install && make clean install" in any order. This will give a chance to each package to get information about the other one through the installed files. O/S X builds ------------ O/S builders often repackage X code and documentation, however they face the same challenges as described above. Users can update packages through the package management system or install additional packages. To use the earlier example, if a protocol is installed without its implementing library there will be a broken reference. Build assumptions ----------------- Packages provide great flexibility, including the one to install each package documentation in a separate, totally unrelated directory using the --docdir configure option. For external references to work, it is assumed that the each package installs the documentation using the relative doc/${PACKAGE_TARNAME} location. It is also a requirement that all packages containing DocBook/XML documentation be installed under the same read-only architecture independent installation directory as evidenced by the DATAROOTDIR package value. This value should also be the same for the xorg-sgml-doctools package. The purpose of this requirement is to form a document tree of a known structure such that stylesheets, masterdb, target dbs and other files can be reached. The Docbook stylesheet technology will create references with paths relative to this location. It will navigate up to "doc" using ../ and then navigate down to the document it refers to. Diagnosing a broken reference ----------------------------- A document reference is created at build time while the document is being transformed from Docbook/XML to HTML or another format. If this reference is missing, the document must be rebuilt. To build the reference, the docbook stylesheet consults a database stored in this package which is called masterdb.xml. This database supplies the relative directory structure of where the documents are located as well as including target document references in the various *.db files. These files are generated and installed while the documents are being build. This is what a Docbook/XML reference from docA to docB looks like (docA.xml): Title This is what a non-chunked HTML reference from docA to docB looks like (docA.html): Title This is what an HTML targetdoc for docB looks like (docB.html.db):
This is what an HTML reference from docA to docB looks like (docA.html) when the reference cannot be resolved: Title This can be caused by one or more of the following: - docB may not longer contain the text (targetptr) docA is referring to. - docB.html.db file may not have been installed by docB package - masterdb.html.xml is missing a entry for docB - masterdb.html.xml cannot be loaded so all refs are broken. - an XSLT processor which does not support xinclude is being used - docB.html.db was generated without --xinclude option for the processor - xsltproc is not at version 1.1.26 or later - for PDF/PS formats, the fragment is ignored, always points to top of docB Some pitfalls ------------------------- in docA.xml: the id must match the file basename. In docs Makefile.am --stringparam current.docid="$(<:.xml=)" supplies docid for *.db. The document id must be unique across all documents. The baseuri attribute in masterdb.xml cannot be used as it conflicts for documents generated in chunked html. The pdf "inside the document" references only started working with docbook-xsl v 1.76.1 which is not yet available to your favorite O/S. In xorg-fo.xsl, insert.olink.pdf.frag must be set to zero which allows the reference to at least point to the top of the document. XSL toolchain ------------- The following minimum versions are needed for external references to work: XSLT processor: 1.1.26 libxml2: 2.7.6 libxslt1.1: 1.1.26 The exact triplet may vary by distribution, sometimes a version is skipped. If you are close enough, try it. References ---------- http://docbook.org/tdg/en/html/docbook.html http://docbook.sourceforge.net/release/xsl/current/doc/html/ http://docbook.sourceforge.net/release/xsl/current/doc/fo/ http://www.sagehill.net/docbookxsl/OlinkPrintOutput.html ------------------------------------------------------------------------------- All questions regarding this software should be directed at the Xorg mailing list: http://lists.freedesktop.org/mailman/listinfo/xorg Please submit bug reports to the Xorg bugzilla: https://bugs.freedesktop.org/enter_bug.cgi?product=xorg The master development code repository can be found at: git://anongit.freedesktop.org/git/xorg/doc/xorg-sgml-doctools http://cgit.freedesktop.org/xorg/doc/xorg-sgml-doctools For patch submission instructions, see: http://www.x.org/wiki/Development/Documentation/SubmittingPatches For more information on the git code manager, see: http://wiki.x.org/wiki/GitPage xorg-sgml-doctools-1.10/autogen.sh000075500000000000000000000003041163245367400172050ustar00rootroot00000000000000#! /bin/sh srcdir=`dirname $0` test -z "$srcdir" && srcdir=. ORIGDIR=`pwd` cd $srcdir autoreconf -v --install || exit 1 cd $ORIGDIR || exit $? $srcdir/configure --enable-maintainer-mode "$@" xorg-sgml-doctools-1.10/configure.ac000064400000000000000000000034741163245367400175050ustar00rootroot00000000000000# Copyright 2005 Red Hat, Inc. # # Permission to use, copy, modify, distribute, and sell this software and its # documentation for any purpose is hereby granted without fee, provided that # the above copyright notice appear in all copies and that both that # copyright notice and this permission notice appear in supporting # documentation, and that the name of Red Hat not be used in # advertising or publicity pertaining to distribution of the software without # specific, written prior permission. Red Hat makes no # representations about the suitability of this software for any purpose. It # is provided "as is" without express or implied warranty. # # RED HAT DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, # INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO # EVENT SHALL RED HAT BE LIABLE FOR ANY SPECIAL, INDIRECT OR # CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, # DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER # TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR # PERFORMANCE OF THIS SOFTWARE. # Initialize Autoconf AC_PREREQ([2.60]) AC_INIT([xorg-sgml-doctools], [1.10], [https://bugs.freedesktop.org/enter_bug.cgi?product=xorg], [xorg-sgml-doctools]) AC_CONFIG_SRCDIR([Makefile.am]) # Initialize Automake AM_INIT_AUTOMAKE([foreign dist-bzip2]) AM_MAINTAINER_MODE # Require X.Org macros 1.8 or later for AC_PROG_INSTALL m4_ifndef([XORG_MACROS_VERSION], [m4_fatal([must install xorg-macros 1.8 or later before running autoconf/autogen])]) XORG_MACROS_VERSION(1.8) XORG_DEFAULT_OPTIONS AC_SUBST([sgmlrootdir],['${datarootdir}/sgml']) AC_SUBST([sgmlx11dir],['${sgmlrootdir}/X11']) AC_SUBST([sgmldbsdir],['${sgmlx11dir}/dbs']) AC_CONFIG_FILES([Makefile masterdb/Makefile xorg-sgml-doctools.pc]) AC_OUTPUT xorg-sgml-doctools-1.10/defs.ent000064400000000000000000000023051163245367400166400ustar00rootroot00000000000000 xorg-sgml-doctools-1.10/masterdb/000075500000000000000000000000001163245367400170105ustar00rootroot00000000000000xorg-sgml-doctools-1.10/masterdb/.gitignore000064400000000000000000000001041163245367400207730ustar00rootroot00000000000000masterdb.html.xml masterdb.pdf.xml masterdb.ps.xml masterdb.txt.xml xorg-sgml-doctools-1.10/masterdb/Makefile.am000064400000000000000000000006051163245367400210450ustar00rootroot00000000000000 master_PRE = masterdb.xml sgmldbs_DATA = \ $(master_PRE:xml=html.xml) \ $(master_PRE:xml=pdf.xml) EXTRA_DIST = $(master_PRE) CLEANFILES = $(sgmldbs_DATA) %.html.xml: %.xml $(AM_V_GEN)$(SED) \ -e 's|__db__|html|g' \ -e 's|@datarootdir[@]|$(datarootdir)|g' < $< > $@ %.pdf.xml: %.xml $(AM_V_GEN)$(SED) \ -e 's|__db__|pdf|g' \ -e 's|@datarootdir[@]|$(datarootdir)|g' < $< > $@ xorg-sgml-doctools-1.10/masterdb/masterdb.xml000064400000000000000000000442551163245367400213450ustar00rootroot00000000000000 ] > This is the X.org document collection. All documentation in X is (should be) listed here. This allows crosslinking between documents. xorg-sgml-doctools-1.10/xorg-chunk.xsl000064400000000000000000000043571163245367400200350ustar00rootroot00000000000000 ]> xorg-sgml-doctools-1.10/xorg-fo.xsl000064400000000000000000000060771163245367400173320ustar00rootroot00000000000000 new blue green DejaVu Serif serif,Symbol,AR PL UMing CN,AR PL ShanHeiSun Uni,GNU Unifont xorg-sgml-doctools-1.10/xorg-sgml-doctools.pc.in000064400000000000000000000002671163245367400217100ustar00rootroot00000000000000prefix=@prefix@ datarootdir=@datarootdir@ sgmlrootdir=@sgmlrootdir@ Name: xorg-sgml-doctools Description: Stylesheets and entities for X.Org documentation Version: @PACKAGE_VERSION@ xorg-sgml-doctools-1.10/xorg-xhtml.xsl000064400000000000000000000037421163245367400200560ustar00rootroot00000000000000 ]> xorg-sgml-doctools-1.10/xorg.css000064400000000000000000000177271163245367400167160ustar00rootroot00000000000000/* * Copyright (c) 2011 Gaetan Nadon * 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. */ /* * Shared stylesheet for X.Org documentation translated to HTML format * http://www.sagehill.net/docbookxsl/UsingCSS.html * http://www.w3schools.com/css/default.asp * https://addons.mozilla.org/en-US/firefox/addon/web-developer/developers * https://addons.mozilla.org/en-US/firefox/addon/font-finder/ */ /* * The sans-serif fonts are considered more legible on a computer screen * http://dry.sailingissues.com/linux-equivalents-verdana-arial.html * */ body { font-family: "Bitstream Vera Sans", "DejaVu Sans", Tahoma, Geneva, Arial, Sans-serif; /* In support of using "em" font size unit, the w3c recommended method */ font-size: 100%; } /* * Selection: all elements requiring mono spaced fonts. * * The family names attempt to match the proportionally spaced font * family names such that the same font name is used for both. * We'd like to use Bitstream, for example, in both proportionally and * mono spaced font text. */ .command, .errorcode, .errorname, .errortype, .filename, .funcsynopsis, .function, .parameter, .programlisting, .property, .screen, .structname, .symbol, .synopsis, .type { font-family: "Bitstream Vera Sans Mono", "DejaVu Sans Mono", Courier, "Liberation Mono", Monospace; } /* * Books have a title page, a preface, some chapters and appendices, * a glossary, an index and a bibliography, in that order. * * An Article has no preface and no chapters. It has sections, appendices, * a glossary, an index and a bibliography. */ /* * Selection: book main title and subtitle */ div.book>div.titlepage h1.title, div.book>div.titlepage h2.subtitle { text-align: center; } /* * Selection: article main title and subtitle */ div.article>div.titlepage h2.title, div.article>div.titlepage h3.subtitle, div.article>div.sect1>div.titlepage h2.title, div.article>div.section>div.titlepage h2.title { text-align: center; } /* * Selection: various types of authors and collaborators, individuals or corporate * * These authors are not always contained inside an authorgroup. * They can be contained inside a lot of different parent types where they might * not be centered. * Reducing the margin at the bottom makes a visual separation between authors * We specify here the ones on the title page, others may be added based on merit. */ div.titlepage .authorgroup, div.titlepage .author, div.titlepage .collab, div.titlepage .corpauthor, div.titlepage .corpcredit, div.titlepage .editor, div.titlepage .othercredit { text-align: center; margin-bottom: 0.25em; } /* * Selection: the affiliation of various types of authors and collaborators, * individuals or corporate. */ div.titlepage .affiliation { text-align: center; } /* * Selection: product release information (X Version 11, Release 7) * * The releaseinfo element can be contained inside a lot of different parent * types where it might not be centered. * We specify here the one on the title page, others may be added based on merit. */ div.titlepage p.releaseinfo { font-weight: bold; text-align: center; } /* * Selection: publishing date */ div.titlepage .pubdate { text-align: center; } /* * The legal notices are displayed in smaller sized fonts * Justification is only supported in IE and therefore not requested. * */ .legalnotice { font-size: small; font-style: italic; } /* * Selection: book or article main ToC title * A paragraph is generated for the title rather than a level 2 heading. * We do not want to select chapters sub table of contents, only the main one */ div.book>div.toc>p, div.article>div.toc>p { font-size: 1.5em; text-align: center; } /* * Selection: major sections of a book or an article * * Unlike books, articles do not have a titlepage element for appendix. * Using the selector "div.titlepage h2.title" would be too general. */ div.book>div.preface>div.titlepage h2.title, div.book>div.chapter>div.titlepage h2.title, div.article>div.sect1>div.titlepage h2.title, div.article>div.section>div.titlepage h2.title, div.book>div.appendix>div.titlepage h2.title, div.article>div.appendix h2.title, div.glossary>div.titlepage h2.title, div.index>div.titlepage h2.title, div.bibliography>div.titlepage h2.title { /* Add a border top over the major parts, just like printed books */ /* The Gray color is already used for the ruler over the main ToC. */ border-top-style: solid; border-top-width: 2px; border-top-color: Gray; /* Put some space between the border and the title */ padding-top: 0.2em; text-align: center; } /* * A Screen is a verbatim environment for displaying text that the user might * see on a computer terminal. It is often used to display the results of a command. * * http://www.css3.info/preview/rounded-border/ */ .screen { background: #e0ffff; border-width: 1px; border-style: solid; border-color: #B0C4DE; border-radius: 1.0em; /* Browser's vendor properties prior to CSS 3 */ -moz-border-radius: 1.0em; -webkit-border-radius: 1.0em; -khtml-border-radius: 1.0em; margin-left: 1.0em; margin-right: 1.0em; padding: 0.5em; } /* * Emphasis program listings with a light shade of gray similar to what * DocBook XSL guide does: http://www.sagehill.net/docbookxsl/ProgramListings.html * Found many C API docs on the web using like shades of gray. */ .programlisting { background: #F4F4F4; border-width: 1px; border-style: solid; border-color: Gray; padding: 0.5em; } /* * Emphasis functions synopsis using a darker shade of gray. * Add a border such that it stands out more. * Set the padding so the text does not touch the border. */ .funcsynopsis, .synopsis { background: #e6e6fa; border-width: 1px; border-style: solid; border-color: Gray; clear: both; margin: 0.5em; padding: 0.25em; } /* * Selection: paragraphs inside synopsis * * Removes the default browser margin, let the container set the padding. * Paragraphs are not always used in synopsis */ .funcsynopsis p, .synopsis p { margin: 0; padding: 0; } /* * Selection: variable lists, informal tables and tables * * Note the parameter name "variablelist.as.table" in xorg-xhtml.xsl * A table with rows and columns is constructed inside div.variablelist * * Set the left margin so it is indented to the right * Display informal tables with single line borders */ table { margin-left: 0.5em; border-collapse: collapse; } /* * Selection: paragraphs inside tables * * Removes the default browser margin, let the container set the padding. * Paragraphs are not always used in tables */ td p { margin: 0; padding: 0; } /* * Add some space between the left and right column. * The vertical alignment helps the reader associate a term * with a multi-line definition. */ td, th { padding-left: 1.0em; padding-right: 1.0em; vertical-align: top; } .warning { border: 1px solid red; background: #FFFF66; padding-left: 0.5em; } xorg-sgml-doctools-1.10/xorg.xsl000064400000000000000000000065741163245367400167320ustar00rootroot00000000000000 yes blue DejaVu Serif serif,Symbol,AR PL UMing CN,AR PL ShanHeiSun Uni,GNU Unifont