1 - fix the capitalization of the ID attributes 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.
Signed-off-by: Matt Dew <marcoz@osource.org>
The iso8859-1 Compose table includes an optional section which uses
Ctrl<T> as a substitute for <Multi_key>. In that section the sequence
to generate an @ (at) either was incorrectly copied from the Multi_key
section or was not kept in sync with the Multi_key section.
Fixing this eliminates the warning from compose-check.pl:
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
┃ Clash with existing sequence in iso8859-1/Compose.pre
┃ on line 661: Ctrl<T> <A> <A>
┃ line #661: Ctrl<T> <A> <A> : "\305" Aring
┃ line #480: Ctrl<T> <A> <A> : "@" at
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
Signed-off-by: James Cloos <cloos@jhcloos.com>
There is no XAllowAccess man page to see.
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Asking X Consortium permission to use The Open Group name makes no sense.
Even more so in 1994 before X Window System was passed on to the Open Group.
Using original text from xorg-docs/general/License
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Asking X Consortium permission to use The Open Group name makes no sense.
Even more so in 1994 before X Window System was passed on to the Open Group.
Using original text from xorg-docs/general/License
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
For documentation having multiple licenses, the copyright and legalnotice
elements sequence cannot instantiated multiple times.
The copyright notice and license text are therefore coded inside a
legalnotice element. The role attribute on the paragraph is used to allow
styling of the copyright notice text which should not be italicized.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
For documentation having multiple licenses, the copyright and legalnotice
elements sequence cannot instantiated multiple times.
The copyright notice and license text are therefore coded inside a legalnotice
element. The role attribute on the paragraph is used to allow styling of the
copyright notice text which should not be italicized.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Docbook groups all the <copyright> elements together and all the
<legalnotice> elements together.
We cannot have a sequence:
<copyright> <legalnotice> <copyright> <legalnotice> [...]
A workaround, which was done in some documents, is to put the copyright
notice inside the legalnotice in plain text without the <copyright> element.
A formal paragraph title is added here which makes the copyright notice bold,
and makes it much easier to locate.
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
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>
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>
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>
The essential differences over the regular docbook.am are:
Adding root.filename parameter for naming of chapters html files.
Using xhtml xmlto format and xorg-chunk.xsl stylesheet
Set olink.base.uri for pdf but not for chunked html
Olink is not applicable to ps and txt formats.
Html chapters are added to shelf_DATA as they are also installed.
The xml is generated from a perl script and not distributed.
Requires version 1.10 of xorg-sgml-doctools.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Currently, only $(XORG_SGML_PATH)/X11 is searched for xml entities.
A module may want to add entities that apply only to itself and
not to all modules, like the xserver does.
This feature may or may not be used in this module, but all modules
share a copy of docbook.am.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Normal evolution of make targets make it impractical to factor out
common command flags for xmlto.
The targets now list each command option as its presence or absence
needs to be justified.
xorg.ss is only needed by xmlto for html.
masterdb is only needed by xmlto.
img.src.path must not be used by html.
xsltproc need to use customization layer xorg-*.xsl.
txt format is not required to search masterdb.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
The stylesheets used to be only about style, fonts or colors.
Complex features are now used like olink and chunked html which
may cause a build break when stylesheets are missing or lead to hard
to find problem.
Some modules may be built when stylesheets are present while others
are built without. There is no requirement to build crippled docs.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Many tables had a questionnable layout and some had information dropped.
Each table was cross-referenced with a pre-docbook version
to ensure semantic integrity.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
There should be no toc for a simple preface with only one
Acknowledgments section.
Use <simplesect> markup rather than sect1.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Many, but not all, function synopsis have a paragraph that
nests the variable list. The code was generated by doclifter
and there is no apprent reasons as to why it was done this way.
Found while investigating a spacing issue.
Before the patch:
<para>Some blurb about the function
<funcsynopsis>
</funcsynopsis>
<variablelist>
</variablelist>
</para>
After the patch:
<para>Some blurb about the function</para>
<funcsynopsis>
</funcsynopsis>
<variablelist>
</variablelist>
There are no noticable differences when reading the doc
other than than the removed few pixels of spacing between
the function sysnopsis and the variable list block.
In some cases, there are no "blurb about the fucntion"
and the empty paragraph is removed.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
For large 600 page documents such as this one, chunked html
provide faster browser load time and better navigation.
Simply click on the locale of your choice in the toc and
the browser loads just that one file. Being a DocBook,
it benefits from all of the usual features and can be
integrated with the rest of the documentation.
Acked-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Build the tables article together with the rest of the specs.
Make it transparent that the source in generated in nls.
Reuse docbook.am and get all the features such as olink.
The docbook article file stem and id must be the same. The new name
for the main article is libX11-keys. The new installation location
is $docdir/libX11/i18n/compose.
The nls dir retains the role of generating the DocBook/XML source
but does not build neither installs output formats or generated source.
The tables article now has to specify that each included locale
section is a dependency. It did not matter before as they were web links.
The xorg-sgml-doctools masterdb shall be updated to include this new doc.
Install location moved from doc/libX11/Compose to doc/libX11/i18n/compose.
Acked-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
Looks more like a real article with a toc rather than individual
web pages. Looks nicer in pdf.
Each locale is a "section" rather than an "article".
Using XInclude to aggregate xml source files gets you the toc for free.
The single document is over 600 pages while there were 62 separate
documents previously. FOP version 1.0 is required to handle missing
character like capital sharp s.
Acked-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
OpenBSD prefers to use the -pthread to fetch pthread libs when needed.
Signed-off-by: Matthieu Herrb <matthieu.herrb@laas.fr>
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
New in version util-macros 1.15, the macro does the usual checking
for program path and provides an interface for makefile variables.
Reviewed-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
A new feature to test for a minimum version has been added.
The parameter position changed. Due to limited usage
and requiring 1.15, it turns out to be backward compatible.
There is no functional change to how docs are build.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
It is no longer used in the specs dir.
Remove html from CLEANFILES as it breaks. Make do not clean directories
Remove SUFFIXES as pattern rules are used rather than suffix rules.
Other improvements are possible, the first priority is to move it out
of the specs dir.
Acked-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
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
