Commit graph

19 commits

Author SHA1 Message Date
Alan Coopersmith
b00a7ddff2 specs/XKB: Markup function names as <function> instead of <emphasis>
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:52 -07:00
Alan Coopersmith
bfbb58b767 specs/XKB: normalize <emphasis> layout in xml files
- Stop placing <emphasis> on empty space, commas, and periods.
- Move periods & commas after closing </emphasis> tag
- move <emphasis> open & close tags to same line, instead of mirroring
  nroff layout.

Simplifies automating further transformations of these tags.

Performed via:
 perl -i -0 -p \
    -e 's{<emphasis>(\s*)</emphasis>}{}msg;' \
    -e 's{<emphasis>([\s\.,]*)</emphasis>\s*}{\1}msg;' \
    -e 's{\n([\.,])\s*}{\1\n}msg;' \
    -e 's{([^\.])([\.,])\s*</emphasis>}{\1</emphasis>\2}msg;' \
    -e 's{\s*<emphasis>\n\s*}{\n<emphasis>}msg;' *xml

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:51 -07:00
Alan Coopersmith
b16ee69a01 specs/XKB: Convert to funcsynopsis+variablelist instead of informaltable
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 13:56:16 -07:00
Alan Coopersmith
b41d43d4cf specs/XKB: Add index
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-19 00:10:25 -07:00
Alan Coopersmith
72ae1d793b specs/XKB: Fix various markup issues in functiondecl tables
- Merge some functionargdecl entries incorrectly split across rows
- Add missing parameter name markup to some functionargdecls
- Add missing function prototype markup to a functiondecl
- Remove stray emphasis tags in a functiondecl

Allows them to correctly convert to funcsynopsis markup in next step.

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-18 22:56:40 -07:00
Alan Coopersmith
9fdb973012 specs/XKB: Convert header filenames to filename tags
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2014-07-18 22:56:40 -07:00
Alan Coopersmith
b64969f0e5 Add X11R7 sections to the libX11 & XKBlib credits to cover Docbook conversion
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2012-04-17 18:17:53 -07:00
Matt Dew
cadcbd376f informaltable & table 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>
2012-01-21 17:59:51 -07:00
Matt Dew
22ba43d198 Cleanup IDs and links in doc
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>
2011-10-07 22:52:30 -06:00
Gaetan Nadon
a23f3323f2 XKB: provide adequate quotes for the license text
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-19 15:27:44 -04:00
Gaetan Nadon
278ca8947c docs: merge copyright holder under the same copyright notice
As per the docbook markup dtd.

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-17 09:44:46 -04:00
Gaetan Nadon
0cc02a6df6 specs: use appropriate markup for Copyright statements
Also move <releaseinfo> to match order of appearance

Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-13 17:39:02 -04:00
Gaetan Nadon
afe13e19eb docs: use the &fullrelvers; entity to set X11 release information
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2011-09-12 20:38:12 -04:00
Alan Coopersmith
9a1ae7a90f Install xml versions of specs even if HAVE_XMLTO is false
Moves HAVE_XMLTO check into docbook.am, more closely matches behaviour
from before docbook.am changes (commit e8c76407d2)

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
2011-04-12 18:18:22 -07:00
Gaetan Nadon
e8c76407d2 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>
2011-03-30 20:18:35 -04:00
Fernando Carrijo
fa9747b9d4 specs: convert images from gif to svg format.
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-12-28 17:56:31 -05:00
Alan Coopersmith
6459f9a48a specs/XKB: make acknowlegement section <preface> instead of <chapter>
Fixes numbering of actual chapters to match their filenames and to
make the table/figure numbering match the references in the text.

Reported-by: jelmd on freenode irc
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
2010-12-21 13:57:10 -08:00
Alan Coopersmith
42c653d541 Add XKBlib spec images to dist_spec_DATA for distribution & installation
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Reviewed-by: Gaetan Nadon <memsize@videotron.ca>
2010-12-21 13:56:14 -08:00
Matt Dew
8f8a3c8c42 specs: convert XKBlib spec from Framemaker to DocBook.xml
Signed-off-by: Gaetan Nadon <memsize@videotron.ca>
2010-11-30 10:52:55 -05:00